ExAws.STS (ExAws.STS v2.3.0) View Source

Operations on AWS STS.

See https://docs.aws.amazon.com/STS/latest/APIReference/API_Operations.html

Link to this section Summary

Link to this section Types

Specs

assume_role_opt() ::
  {:duration, pos_integer()}
  | {:serial_number, binary()}
  | {:token_code, binary()}
  | {:external_id, binary()}
  | {:policy, policy()}
Link to this type

assume_role_with_saml_opt()

View Source

Specs

assume_role_with_saml_opt() :: {:duration, pos_integer()} | {:policy, policy()}
Link to this type

assume_role_with_web_identity_opt()

View Source

Specs

assume_role_with_web_identity_opt() ::
  {:duration, pos_integer()} | {:provider_id, binary()} | {:policy, policy()}
Link to this type

get_federation_token_opt()

View Source

Specs

get_federation_token_opt() :: {:duration, pos_integer()} | {:policy, policy()}
Link to this type

get_session_token_opt()

View Source

Specs

get_session_token_opt() ::
  {:duration, pos_integer()}
  | {:serial_number, binary()}
  | {:token_code, binary()}

Specs

policy() :: %{required(binary()) => :all}

Link to this section Functions

Link to this function

assume_role(role_arn, role_session_name, opts \\ [])

View Source

Specs

assume_role(role_arn :: String.t(), role_session_name :: String.t(), [
  assume_role_opt()
]) :: ExAws.Operation.Query.t()

Assume Role.

Link to this function

assume_role_with_saml(principal_arn, role_arn, saml_assertion, opts \\ [])

View Source

Specs

assume_role_with_saml(
  principal_arn :: String.t(),
  role_arn :: String.t(),
  saml_assertion :: String.t(),
  [assume_role_with_saml_opt()]
) :: ExAws.Operation.Query.t()

Assume Role with SAML.

Link to this function

assume_role_with_web_identity(role_arn, role_session_name, web_identity_token, opts \\ [])

View Source

Specs

assume_role_with_web_identity(
  role_arn :: String.t(),
  role_session_name :: String.t(),
  web_identity_token :: String.t(),
  [assume_role_with_web_identity_opt()]
) :: ExAws.Operation.Query.t()

Assume Role with Web Identity.

Link to this function

decode_authorization_message(message)

View Source

Specs

decode_authorization_message(message :: String.t()) :: ExAws.Operation.Query.t()

Decode Authorization Message.

Link to this function

get_access_key_info(key_id)

View Source

Specs

get_access_key_info(key_id :: String.t()) :: ExAws.Operation.Query.t()

Get Access Key Info.

Specs

get_caller_identity() :: ExAws.Operation.Query.t()

Get Caller Identity.

Link to this function

get_federation_token(name, opts \\ [])

View Source

Specs

get_federation_token(name :: String.t(), [get_federation_token_opt()]) ::
  ExAws.Operation.Query.t()

Get Federation Token.

Link to this function

get_session_token(opts \\ [])

View Source

Specs

get_session_token([get_session_token_opt()]) :: ExAws.Operation.Query.t()

Get Session Token.