Module Smaws_Client_STS

STS client library built on EIO.

Types

module Types : sig ... end

Builders

val make_tag : value:Types.tag_value_type -> key:Types.tag_key_type -> unit -> Types.tag
val make_policy_descriptor_type : ?arn:Types.arn_type -> unit -> Types.policy_descriptor_type
val make_provided_context : ?context_assertion:Types.context_assertion_type -> ?provider_arn:Types.arn_type -> unit -> Types.provided_context
val make_get_web_identity_token_response : ?expiration:Types.date_type -> ?web_identity_token:Types.web_identity_token_type -> unit -> Types.get_web_identity_token_response
val make_get_web_identity_token_request : ?tags:Types.tag_list_type -> ?duration_seconds:Types.web_identity_token_duration_seconds_type -> signing_algorithm:Types.jwt_algorithm_type -> audience:Types.web_identity_token_audience_list_type -> unit -> Types.get_web_identity_token_request
val make_credentials : expiration:Types.date_type -> session_token:Types.token_type -> secret_access_key:Types.access_key_secret_type -> access_key_id:Types.access_key_id_type -> unit -> Types.credentials
val make_get_session_token_response : ?credentials:Types.credentials -> unit -> Types.get_session_token_response
val make_get_session_token_request : ?token_code:Types.token_code_type -> ?serial_number:Types.serial_number_type -> ?duration_seconds:Types.duration_seconds_type -> unit -> Types.get_session_token_request
val make_federated_user : arn:Types.arn_type -> federated_user_id:Types.federated_id_type -> unit -> Types.federated_user
val make_get_federation_token_response : ?packed_policy_size:Types.non_negative_integer_type -> ?federated_user:Types.federated_user -> ?credentials:Types.credentials -> unit -> Types.get_federation_token_response
val make_get_federation_token_request : ?tags:Types.tag_list_type -> ?duration_seconds:Types.duration_seconds_type -> ?policy_arns:Types.policy_descriptor_list_type -> ?policy:Types.session_policy_document_type -> name:Types.user_name_type -> unit -> Types.get_federation_token_request
val make_get_delegated_access_token_response : ?assumed_principal:Types.arn_type -> ?packed_policy_size:Types.non_negative_integer_type -> ?credentials:Types.credentials -> unit -> Types.get_delegated_access_token_response
val make_get_delegated_access_token_request : trade_in_token:Types.trade_in_token_type -> unit -> Types.get_delegated_access_token_request
val make_get_caller_identity_response : ?arn:Types.arn_type -> ?account:Types.account_type -> ?user_id:Types.user_id_type -> unit -> Types.get_caller_identity_response
val make_get_caller_identity_request : unit -> unit
val make_get_access_key_info_response : ?account:Types.account_type -> unit -> Types.get_access_key_info_response
val make_get_access_key_info_request : access_key_id:Types.access_key_id_type -> unit -> Types.get_access_key_info_request
val make_decode_authorization_message_response : ?decoded_message:Types.decoded_message_type -> unit -> Types.decode_authorization_message_response
val make_decode_authorization_message_request : encoded_message:Types.encoded_message_type -> unit -> Types.decode_authorization_message_request
val make_assumed_role_user : arn:Types.arn_type -> assumed_role_id:Types.assumed_role_id_type -> unit -> Types.assumed_role_user
val make_assume_root_response : ?source_identity:Types.source_identity_type -> ?credentials:Types.credentials -> unit -> Types.assume_root_response
val make_assume_root_request : ?duration_seconds:Types.root_duration_seconds_type -> task_policy_arn:Types.policy_descriptor_type -> target_principal:Types.target_principal_type -> unit -> Types.assume_root_request
val make_assume_role_with_web_identity_response : ?source_identity:Types.source_identity_type -> ?audience:Types.audience -> ?provider:Types.issuer -> ?packed_policy_size:Types.non_negative_integer_type -> ?assumed_role_user:Types.assumed_role_user -> ?subject_from_web_identity_token:Types.web_identity_subject_type -> ?credentials:Types.credentials -> unit -> Types.assume_role_with_web_identity_response
val make_assume_role_with_web_identity_request : ?duration_seconds:Types.role_duration_seconds_type -> ?policy:Types.session_policy_document_type -> ?policy_arns:Types.policy_descriptor_list_type -> ?provider_id:Types.url_type -> web_identity_token:Types.client_token_type -> role_session_name:Types.role_session_name_type -> role_arn:Types.arn_type -> unit -> Types.assume_role_with_web_identity_request
val make_assume_role_with_saml_response : ?source_identity:Types.source_identity_type -> ?name_qualifier:Types.name_qualifier -> ?audience:Types.audience -> ?issuer:Types.issuer -> ?subject_type:Types.subject_type -> ?subject:Types.subject -> ?packed_policy_size:Types.non_negative_integer_type -> ?assumed_role_user:Types.assumed_role_user -> ?credentials:Types.credentials -> unit -> Types.assume_role_with_saml_response
val make_assume_role_with_saml_request : ?duration_seconds:Types.role_duration_seconds_type -> ?policy:Types.session_policy_document_type -> ?policy_arns:Types.policy_descriptor_list_type -> saml_assertion:Types.saml_assertion_type -> principal_arn:Types.arn_type -> role_arn:Types.arn_type -> unit -> Types.assume_role_with_saml_request
val make_assume_role_response : ?source_identity:Types.source_identity_type -> ?packed_policy_size:Types.non_negative_integer_type -> ?assumed_role_user:Types.assumed_role_user -> ?credentials:Types.credentials -> unit -> Types.assume_role_response
val make_assume_role_request : ?provided_contexts:Types.provided_contexts_list_type -> ?source_identity:Types.source_identity_type -> ?token_code:Types.token_code_type -> ?serial_number:Types.serial_number_type -> ?external_id:Types.external_id_type -> ?transitive_tag_keys:Types.tag_key_list_type -> ?tags:Types.tag_list_type -> ?duration_seconds:Types.role_duration_seconds_type -> ?policy:Types.unrestricted_session_policy_document_type -> ?policy_arns:Types.policy_descriptor_list_type -> role_session_name:Types.role_session_name_type -> role_arn:Types.arn_type -> unit -> Types.assume_role_request

Operations

module AssumeRole : sig ... end

Returns a set of temporary security credentials that you can use to access Amazon Web Services resources. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Compare STS credentials in the IAM User Guide.

module AssumeRoleWithSAML : sig ... end

Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based Amazon Web Services access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Compare STS credentials in the IAM User Guide.

module AssumeRoleWithWebIdentity : sig ... end

Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include the OAuth 2.0 providers Login with Amazon and Facebook, or any OpenID Connect-compatible identity provider such as Google or Amazon Cognito federated identities.

module AssumeRoot : sig ... end

Returns a set of short term credentials you can use to perform privileged tasks on a member account in your organization. You must use credentials from an Organizations management account or a delegated administrator account for IAM to call AssumeRoot. You cannot use root user credentials to make this call.

module DecodeAuthorizationMessage : sig ... end

Decodes additional information about the authorization status of a request from an encoded message returned in response to an Amazon Web Services request.

module GetAccessKeyInfo : sig ... end

Returns the account identifier for the specified access key ID.

module GetCallerIdentity : sig ... end

Returns details about the IAM user or role whose credentials are used to call the operation.

module GetDelegatedAccessToken : sig ... end

Exchanges a trade-in token for temporary Amazon Web Services credentials with the permissions associated with the assumed principal. This operation allows you to obtain credentials for a specific principal based on a trade-in token, enabling delegation of access to Amazon Web Services resources.

module GetFederationToken : sig ... end

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network.

module GetSessionToken : sig ... end

Returns a set of temporary credentials for an Amazon Web Services account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific Amazon Web Services API operations like Amazon EC2 StopInstances.

module GetWebIdentityToken : sig ... end
module Query_serializers : sig ... end
module Query_deserializers : sig ... end