Expand description
AWS Security Token Service (STS) enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more information about using this service, see Temporary Security Credentials.
If you’re using the service, you’re probably looking for StsClient and Sts.
Structs§
- Assume
Role Request - Assume
Role Response Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to make AWS requests.
- Assume
Role WithSAML Request - Assume
Role WithSAML Response Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.
- Assume
Role With WebIdentity Request - Assume
Role With WebIdentity Response Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary AWS credentials that can be used to make AWS requests.
- Assumed
Role User The identifiers for the temporary security credentials that the operation returns.
- Credentials
AWS credentials for API authentication.
- Decode
Authorization Message Request - Decode
Authorization Message Response A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request.
- Federated
User Identifiers for the federated user that is associated with the credentials.
- GetAccess
KeyInfo Request - GetAccess
KeyInfo Response - GetCaller
Identity Request - GetCaller
Identity Response Contains the response to a successful GetCallerIdentity request, including information about the entity making the request.
- GetFederation
Token Request - GetFederation
Token Response Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.
- GetSession
Token Request - GetSession
Token Response Contains the response to a successful GetSessionToken request, including temporary AWS credentials that can be used to make AWS requests.
- Policy
Descriptor Type A reference to the IAM managed policy that is passed as a session policy for a role session or a federated user session.
- StsAssume
Role Session Credentials Provider - AwsCredentials provider that calls
AssumeRoleusing the provided StsClient. To use with MFA, pass in the MFA serial number then set the MFA code. You will need to ensure the provider has a valid code each time you acquire a new STS token. - StsClient
- A client for the AWS STS API.
- StsSession
Credentials Provider - AwsCredentials provider that calls
GetSessionTokenusing the provided StsClient. To use with MFA, pass in the MFA serial number then set the MFA code. You will need to ensure the provider has a valid code each time you acquire a new STS token. - StsWeb
Identity Federation Session Credentials Provider - AwsCredentials provider that calls
AssumeRoleWithWebIdentityusing the provided StsClient. - Tag
You can pass custom key-value pair attributes when you assume a role or federate a user. These are called session tags. You can then use the session tags to control access to resources. For more information, see Tagging AWS STS Sessions in the IAM User Guide.
- WebIdentity
Provider - WebIdentityProvider using OpenID Connect bearer token to retrieve AWS IAM credentials.
Enums§
- Assume
Role Error - Errors returned by AssumeRole
- Assume
Role WithSAML Error - Errors returned by AssumeRoleWithSAML
- Assume
Role With WebIdentity Error - Errors returned by AssumeRoleWithWebIdentity
- Decode
Authorization Message Error - Errors returned by DecodeAuthorizationMessage
- GetAccess
KeyInfo Error - Errors returned by GetAccessKeyInfo
- GetCaller
Identity Error - Errors returned by GetCallerIdentity
- GetFederation
Token Error - Errors returned by GetFederationToken
- GetSession
Token Error - Errors returned by GetSessionToken
Traits§
- NewAws
Creds ForSts Creds - Trait for conversions from STS Credentials to AWS Credentials.
- Sts
- Trait representing the capabilities of the AWS STS API. AWS STS clients implement this trait.