Package-level declarations

Types

Link copied to clipboard
interface StsClient : SdkClient

Security Token Service (STS) enables you to request temporary, limited-privilege credentials for users. This guide provides descriptions of the STS API. For more information about using this service, see Temporary Security Credentials.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard
inline suspend fun StsClient.assumeRole(crossinline block: AssumeRoleRequest.Builder.() -> Unit): AssumeRoleResponse

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun StsClient.assumeRoot(crossinline block: AssumeRootRequest.Builder.() -> Unit): AssumeRootResponse

Returns a set of short term credentials you can use to perform privileged tasks on a member account in your organization.

Link copied to clipboard

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

Link copied to clipboard

Returns the account identifier for the specified access key ID.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.