Network.AWS.STS.Types

Service Configuration

sTS :: Service

API version '2011-06-15' of the Amazon Security Token Service SDK configuration.

Errors

_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the policy document was malformed. The error message describes the specific error.

_InvalidAuthorizationMessageException :: AsError a => Getting (First ServiceError) a ServiceError

The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.

_PackedPolicyTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError

The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.

_IdPCommunicationErrorException :: AsError a => Getting (First ServiceError) a ServiceError

The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding.

_InvalidIdentityTokenException :: AsError a => Getting (First ServiceError) a ServiceError

The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.

_ExpiredTokenException :: AsError a => Getting (First ServiceError) a ServiceError

The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.

_IdPRejectedClaimException :: AsError a => Getting (First ServiceError) a ServiceError

The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.

If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.

AssumedRoleUser

data AssumedRoleUser

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

See: assumedRoleUser smart constructor.

Instances

Eq AssumedRoleUser

Data AssumedRoleUser

Read AssumedRoleUser

Show AssumedRoleUser

Generic AssumedRoleUser

FromXML AssumedRoleUser

Typeable * AssumedRoleUser

type Rep AssumedRoleUser

assumedRoleUser

Arguments

:: Text

aruAssumedRoleId

-> Text

aruARN

-> AssumedRoleUser

Creates a value of AssumedRoleUser with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aruAssumedRoleId
• aruARN

aruAssumedRoleId :: Lens' AssumedRoleUser Text

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.

aruARN :: Lens' AssumedRoleUser Text

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.

Credentials

data Credentials

AWS credentials for API authentication.

See: credentials smart constructor.

Instances

Eq Credentials

Data Credentials

Read Credentials

Show Credentials

Generic Credentials

FromXML Credentials

Typeable * Credentials

type Rep Credentials

credentials

Arguments

:: Text

cAccessKeyId

-> Text

cSecretAccessKey

-> Text

cSessionToken

-> UTCTime

cExpiration

-> Credentials

Creates a value of Credentials with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cAccessKeyId
• cSecretAccessKey
• cSessionToken
• cExpiration

cAccessKeyId :: Lens' Credentials Text

The access key ID that identifies the temporary security credentials.

cSecretAccessKey :: Lens' Credentials Text

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

cSessionToken :: Lens' Credentials Text

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

cExpiration :: Lens' Credentials UTCTime

The date on which the current credentials expire.

FederatedUser

data FederatedUser

Identifiers for the federated user that is associated with the credentials.

See: federatedUser smart constructor.

Instances

Eq FederatedUser

Data FederatedUser

Read FederatedUser

Show FederatedUser

Generic FederatedUser

FromXML FederatedUser

Typeable * FederatedUser

type Rep FederatedUser

federatedUser

Arguments

:: Text

fuFederatedUserId

-> Text

fuARN

-> FederatedUser

Creates a value of FederatedUser with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fuFederatedUserId
• fuARN

fuFederatedUserId :: Lens' FederatedUser Text

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

fuARN :: Lens' FederatedUser Text

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.