VBT.Aws (vbt v0.1.0) View Source

Helper module for working with AWS.

This module together with other VBT.Aws.* modules provide various helper functions for working with AWS. These modules are wrappers around ExAws.

If you need to directly interact with AWS, feel free to use ExAws function. For simplified testing, instead of directly invoking ExAws functions, use the client/0 function from this module to obtain the implementation of ExAws.Behaviour. See VBT.Aws.Test for details.

Link to this section Summary

Types

response()

response(success_type)

Functions

client()

Returns AWS client module.

Link to this section Types

response()

Specs

response() :: response(any())

response(success_type)

Specs

response(success_type) :: {:ok, success_type} | {:error, reason :: any()}

Link to this section Functions

client()

Specs

client() :: module()

Returns AWS client module.

Invoke this function when making AWS requests to obtain the module which implements ExAws.Behaviour. For example, to make a request:

VBT.Aws.client().request(ExAws.S3.list_buckets(), region: "eu-west-1")

By default, this function returns ExAws. In tests, you can setup a mock module using the VBT.Aws.Test module.