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.

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

STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.

_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

Methods

(==) :: AssumedRoleUser -> AssumedRoleUser -> Bool

(/=) :: AssumedRoleUser -> AssumedRoleUser -> Bool

Data AssumedRoleUser

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AssumedRoleUser -> c AssumedRoleUser

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AssumedRoleUser

toConstr :: AssumedRoleUser -> Constr

dataTypeOf :: AssumedRoleUser -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AssumedRoleUser)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AssumedRoleUser)

gmapT :: (forall b. Data b => b -> b) -> AssumedRoleUser -> AssumedRoleUser

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AssumedRoleUser -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AssumedRoleUser -> r

gmapQ :: (forall d. Data d => d -> u) -> AssumedRoleUser -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AssumedRoleUser -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AssumedRoleUser -> m AssumedRoleUser

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AssumedRoleUser -> m AssumedRoleUser

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AssumedRoleUser -> m AssumedRoleUser

Read AssumedRoleUser

Methods

readsPrec :: Int -> ReadS AssumedRoleUser

readList :: ReadS [AssumedRoleUser]

readPrec :: ReadPrec AssumedRoleUser

readListPrec :: ReadPrec [AssumedRoleUser]

Show AssumedRoleUser

Methods

showsPrec :: Int -> AssumedRoleUser -> ShowS

show :: AssumedRoleUser -> String

showList :: [AssumedRoleUser] -> ShowS

Generic AssumedRoleUser

Associated Types

type Rep AssumedRoleUser :: * -> *

Methods

from :: AssumedRoleUser -> Rep AssumedRoleUser x

to :: Rep AssumedRoleUser x -> AssumedRoleUser

Hashable AssumedRoleUser

Methods

hashWithSalt :: Int -> AssumedRoleUser -> Int

hash :: AssumedRoleUser -> Int

NFData AssumedRoleUser

Methods

rnf :: AssumedRoleUser -> ()

FromXML AssumedRoleUser

Methods

parseXML :: [Node] -> Either String AssumedRoleUser

type Rep AssumedRoleUser

type Rep AssumedRoleUser = D1 (MetaData "AssumedRoleUser" "Network.AWS.STS.Types.Product" "amazonka-sts-1.4.3-2pc5gPFqvgpJHKaT4vecCt" False) (C1 (MetaCons "AssumedRoleUser'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_aruAssumedRoleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_aruARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

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

Methods

(==) :: Credentials -> Credentials -> Bool

(/=) :: Credentials -> Credentials -> Bool

Data Credentials

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Credentials -> c Credentials

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Credentials

toConstr :: Credentials -> Constr

dataTypeOf :: Credentials -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Credentials)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Credentials)

gmapT :: (forall b. Data b => b -> b) -> Credentials -> Credentials

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Credentials -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Credentials -> r

gmapQ :: (forall d. Data d => d -> u) -> Credentials -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Credentials -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Credentials -> m Credentials

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Credentials -> m Credentials

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Credentials -> m Credentials

Read Credentials

Methods

readsPrec :: Int -> ReadS Credentials

readList :: ReadS [Credentials]

readPrec :: ReadPrec Credentials

readListPrec :: ReadPrec [Credentials]

Show Credentials

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

Generic Credentials

Associated Types

type Rep Credentials :: * -> *

Methods

from :: Credentials -> Rep Credentials x

to :: Rep Credentials x -> Credentials

Hashable Credentials

Methods

hashWithSalt :: Int -> Credentials -> Int

hash :: Credentials -> Int

NFData Credentials

Methods

rnf :: Credentials -> ()

FromXML Credentials

Methods

parseXML :: [Node] -> Either String Credentials

type Rep Credentials

type Rep Credentials = D1 (MetaData "Credentials" "Network.AWS.STS.Types.Product" "amazonka-sts-1.4.3-2pc5gPFqvgpJHKaT4vecCt" False) (C1 (MetaCons "Credentials'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cAccessKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cSecretAccessKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cSessionToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cExpiration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ISO8601)))))

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

Methods

(==) :: FederatedUser -> FederatedUser -> Bool

(/=) :: FederatedUser -> FederatedUser -> Bool

Data FederatedUser

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FederatedUser -> c FederatedUser

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FederatedUser

toConstr :: FederatedUser -> Constr

dataTypeOf :: FederatedUser -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FederatedUser)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FederatedUser)

gmapT :: (forall b. Data b => b -> b) -> FederatedUser -> FederatedUser

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FederatedUser -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FederatedUser -> r

gmapQ :: (forall d. Data d => d -> u) -> FederatedUser -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FederatedUser -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FederatedUser -> m FederatedUser

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FederatedUser -> m FederatedUser

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FederatedUser -> m FederatedUser

Read FederatedUser

Methods

readsPrec :: Int -> ReadS FederatedUser

readList :: ReadS [FederatedUser]

readPrec :: ReadPrec FederatedUser

readListPrec :: ReadPrec [FederatedUser]

Show FederatedUser

Methods

showsPrec :: Int -> FederatedUser -> ShowS

show :: FederatedUser -> String

showList :: [FederatedUser] -> ShowS

Generic FederatedUser

Associated Types

type Rep FederatedUser :: * -> *

Methods

from :: FederatedUser -> Rep FederatedUser x

to :: Rep FederatedUser x -> FederatedUser

Hashable FederatedUser

Methods

hashWithSalt :: Int -> FederatedUser -> Int

hash :: FederatedUser -> Int

NFData FederatedUser

Methods

rnf :: FederatedUser -> ()

FromXML FederatedUser

Methods

parseXML :: [Node] -> Either String FederatedUser

type Rep FederatedUser

type Rep FederatedUser = D1 (MetaData "FederatedUser" "Network.AWS.STS.Types.Product" "amazonka-sts-1.4.3-2pc5gPFqvgpJHKaT4vecCt" False) (C1 (MetaCons "FederatedUser'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_fuFederatedUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_fuARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

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.