Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- defaultService :: Service
- _ExpiredTokenException :: AsError a => Fold a ServiceError
- _IDPCommunicationErrorException :: AsError a => Fold a ServiceError
- _IDPRejectedClaimException :: AsError a => Fold a ServiceError
- _InvalidAuthorizationMessageException :: AsError a => Fold a ServiceError
- _InvalidIdentityTokenException :: AsError a => Fold a ServiceError
- _MalformedPolicyDocumentException :: AsError a => Fold a ServiceError
- _PackedPolicyTooLargeException :: AsError a => Fold a ServiceError
- _RegionDisabledException :: AsError a => Fold a ServiceError
- data AssumedRoleUser = AssumedRoleUser' {
- assumedRoleId :: Text
- arn :: Text
- newAssumedRoleUser :: Text -> Text -> AssumedRoleUser
- assumedRoleUser_assumedRoleId :: Lens' AssumedRoleUser Text
- assumedRoleUser_arn :: Lens' AssumedRoleUser Text
- data FederatedUser = FederatedUser' {
- federatedUserId :: Text
- arn :: Text
- newFederatedUser :: Text -> Text -> FederatedUser
- federatedUser_federatedUserId :: Lens' FederatedUser Text
- federatedUser_arn :: Lens' FederatedUser Text
- data PolicyDescriptorType = PolicyDescriptorType' {}
- newPolicyDescriptorType :: PolicyDescriptorType
- policyDescriptorType_arn :: Lens' PolicyDescriptorType (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2011-06-15
of the Amazon Security Token Service SDK configuration.
Errors
_ExpiredTokenException :: AsError a => Fold a ServiceError Source #
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.
_IDPCommunicationErrorException :: AsError a => Fold a ServiceError Source #
The request could not be fulfilled because the 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 identity provider might be down or not responding.
_IDPRejectedClaimException :: AsError a => Fold a ServiceError Source #
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.
_InvalidAuthorizationMessageException :: AsError a => Fold a ServiceError Source #
The error returned if the message passed to DecodeAuthorizationMessage
was invalid. This can happen if the token contains invalid characters,
such as linebreaks.
_InvalidIdentityTokenException :: AsError a => Fold a ServiceError Source #
The web identity token that was passed could not be validated by Amazon Web Services. Get a new identity token from the identity provider and then retry the request.
_MalformedPolicyDocumentException :: AsError a => Fold a ServiceError Source #
The request was rejected because the policy document was malformed. The error message describes the specific error.
_PackedPolicyTooLargeException :: AsError a => Fold a ServiceError Source #
The request was rejected because the total packed size of the session policies and session tags combined was too large. An Amazon Web Services conversion compresses the session policy document, session policy ARNs, and session tags into a packed binary format that has a separate limit. The error message indicates by percentage how close the policies and tags are to the upper size limit. For more information, see Passing Session Tags in STS in the IAM User Guide.
You could receive this error even though you meet other defined session policy and session tag limits. For more information, see IAM and STS Entity Character Limits in the IAM User Guide.
_RegionDisabledException :: AsError a => Fold a ServiceError Source #
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 Amazon Web Services STS in an Amazon Web Services Region in the IAM User Guide.
AssumedRoleUser
data AssumedRoleUser Source #
The identifiers for the temporary security credentials that the operation returns.
See: newAssumedRoleUser
smart constructor.
AssumedRoleUser' | |
|
Instances
Create a value of AssumedRoleUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assumedRoleId:AssumedRoleUser'
, assumedRoleUser_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 Amazon
Web Services when the role is created.
$sel:arn:AssumedRoleUser'
, assumedRoleUser_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 the IAM User Guide.
assumedRoleUser_assumedRoleId :: Lens' AssumedRoleUser Text Source #
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 Amazon Web Services when the role is created.
assumedRoleUser_arn :: Lens' AssumedRoleUser Text Source #
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 the IAM User Guide.
FederatedUser
data FederatedUser Source #
Identifiers for the federated user that is associated with the credentials.
See: newFederatedUser
smart constructor.
FederatedUser' | |
|
Instances
Create a value of FederatedUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:federatedUserId:FederatedUser'
, federatedUser_federatedUserId
- The string that identifies the federated user associated with the
credentials, similar to the unique ID of an IAM user.
$sel:arn:FederatedUser'
, federatedUser_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 the IAM User Guide.
federatedUser_federatedUserId :: Lens' FederatedUser Text Source #
The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.
federatedUser_arn :: Lens' FederatedUser Text Source #
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 the IAM User Guide.
PolicyDescriptorType
data PolicyDescriptorType Source #
A reference to the IAM managed policy that is passed as a session policy for a role session or a federated user session.
See: newPolicyDescriptorType
smart constructor.
PolicyDescriptorType' | |
|
Instances
newPolicyDescriptorType :: PolicyDescriptorType Source #
Create a value of PolicyDescriptorType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:PolicyDescriptorType'
, policyDescriptorType_arn
- The Amazon Resource Name (ARN) of the IAM managed policy to use as a
session policy for the role. For more information about ARNs, see
Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces
in the Amazon Web Services General Reference.
policyDescriptorType_arn :: Lens' PolicyDescriptorType (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy for the role. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
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 Amazon Web Services STS Sessions in the IAM User Guide.
See: newTag
smart constructor.
Tag' | |
|
Instances
ToQuery Tag Source # | |
Defined in Amazonka.STS.Types.Tag toQuery :: Tag -> QueryString # | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.STS.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.STS.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.STS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.STS.Types.Tag" "amazonka-sts-2.0-4mYLKqRkMcBDaDLjBZpuhO" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- The key for a session tag.
You can pass up to 50 session tags. The plain text session tag keys can’t exceed 128 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
$sel:value:Tag'
, tag_value
- The value for a session tag.
You can pass up to 50 session tags. The plain text session tag values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.