Serialized Form

Package com.amazonaws.services.securitytoken.model

Class com.amazonaws.services.securitytoken.model.AssumedRoleUser extends Object implements Serializable

Serialized Fields

assumedRoleId

String assumedRoleId

A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*

arn

String arn

The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.securitytoken.model.AssumeRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleArn

String roleArn

The Amazon Resource Name (ARN) of the role to assume.

Constraints:
Length: 20 - 2048

roleSessionName

String roleSessionName

An identifier for the assumed role session.

Use the role session name to uniquely identity a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

policy

String policy

An IAM policy in JSON format.

This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in Using Temporary Security Credentials. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

durationSeconds

Integer durationSeconds

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

Constraints:
Range: 900 - 3600

externalId

String externalId

A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use External ID When Granting Access to Your AWS Resources in Using Temporary Security Credentials.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@:-]*

serialNumber

String serialNumber

The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

tokenCode

String tokenCode

The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an "access denied" error.

Constraints:
Length: 6 - 6
Pattern: [\d]*

Class com.amazonaws.services.securitytoken.model.AssumeRoleResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

assumedRoleUser

AssumedRoleUser assumedRoleUser

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

packedPolicySize

Integer packedPolicySize

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Constraints:
Range: 0 -

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleArn

String roleArn

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Constraints:
Length: 20 - 2048

principalArn

String principalArn

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

Constraints:
Length: 20 - 2048

sAMLAssertion

String sAMLAssertion

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.

Constraints:
Length: 4 - 50000

policy

String policy

An IAM policy in JSON format.

The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithSAML in Using Temporary Security Credentials. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

durationSeconds

Integer durationSeconds

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter. The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

Constraints:
Range: 900 - 129600

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

AWS credentials for API authentication.

assumedRoleUser

AssumedRoleUser assumedRoleUser

The identifiers for the temporary security credentials that the operation returns.

packedPolicySize

Integer packedPolicySize

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Constraints:
Range: 0 -

subject

String subject

The value of the NameID element in the Subject element of the SAML assertion.

subjectType

String subjectType

The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

issuer

String issuer

The value of the Issuer element of the SAML assertion.

audience

String audience

The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

nameQualifier

String nameQualifier

A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleArn

String roleArn

The Amazon Resource Name (ARN) of the role that the caller is assuming.

Constraints:
Length: 20 - 2048

roleSessionName

String roleSessionName

An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

webIdentityToken

String webIdentityToken

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.

Constraints:
Length: 4 - 2048

providerId

String providerId

The fully qualified host component of the domain name of the identity provider.

Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

Do not specify this value for OpenID Connect ID tokens.

Constraints:
Length: 4 - 2048

policy

String policy

An IAM policy in JSON format.

The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

durationSeconds

Integer durationSeconds

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

Constraints:
Range: 900 - 129600

Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security token.

subjectFromWebIdentityToken

String subjectFromWebIdentityToken

The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

Constraints:
Length: 6 - 255

assumedRoleUser

AssumedRoleUser assumedRoleUser

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

packedPolicySize

Integer packedPolicySize

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Constraints:
Range: 0 -

provider

String provider

The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

audience

String audience

The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

Class com.amazonaws.services.securitytoken.model.Credentials extends Object implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

The access key ID that identifies the temporary security credentials.

Constraints:
Length: 16 - 32
Pattern: [\w]*

secretAccessKey

String secretAccessKey

The secret access key that can be used to sign requests.

sessionToken

String sessionToken

The token that users must pass to the service API to use the temporary credentials.

expiration

Date expiration

The date on which the current credentials expire.

Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encodedMessage

String encodedMessage

The encoded message that was returned with the response.

Constraints:
Length: 1 - 10240

Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageResult extends Object implements Serializable

Serialized Fields

decodedMessage

String decodedMessage

An XML document that contains the decoded message. For more information, see DecodeAuthorizationMessage.

Class com.amazonaws.services.securitytoken.model.ExpiredTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.FederatedUser extends Object implements Serializable

Serialized Fields

federatedUserId

String federatedUserId

The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

Constraints:
Length: 2 - 96
Pattern: [\w+=,.@\:-]*

arn

String arn

The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

Constraints:
Length: 20 - 2048

Class com.amazonaws.services.securitytoken.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

Constraints:
Length: 2 - 32
Pattern: [\w+=,.@-]*

policy

String policy

An IAM policy in JSON format that is passed with the GetFederationToken call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.

If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

For more information about how permissions work, see Permissions for GetFederationToken.

Constraints:
Length: 1 - 2048
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

durationSeconds

Integer durationSeconds

The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.

Constraints:
Range: 900 - 129600

Class com.amazonaws.services.securitytoken.model.GetFederationTokenResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

Credentials for the service API authentication.

federatedUser

FederatedUser federatedUser

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

packedPolicySize

Integer packedPolicySize

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

Constraints:
Range: 0 -

Class com.amazonaws.services.securitytoken.model.GetSessionTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

durationSeconds

Integer durationSeconds

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

Constraints:
Range: 900 - 129600

serialNumber

String serialNumber

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

Constraints:
Length: 9 - 256
Pattern: [\w+=/:,.@-]*

tokenCode

String tokenCode

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication.

Constraints:
Length: 6 - 6
Pattern: [\d]*

Class com.amazonaws.services.securitytoken.model.GetSessionTokenResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

The session credentials for API authentication.

Class com.amazonaws.services.securitytoken.model.IDPCommunicationErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.IDPRejectedClaimException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.InvalidAuthorizationMessageException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.InvalidIdentityTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.securitytoken.model.PackedPolicyTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L