Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- getCallerIdentityResponse_arn :: Lens' GetCallerIdentityResponse (Maybe Text)
- getCallerIdentityResponse_account :: Lens' GetCallerIdentityResponse (Maybe Text)
- getCallerIdentityResponse_userId :: Lens' GetCallerIdentityResponse (Maybe Text)
- getCallerIdentityResponse_httpStatus :: Lens' GetCallerIdentityResponse Int
- assumeRole_transitiveTagKeys :: Lens' AssumeRole (Maybe [Text])
- assumeRole_tokenCode :: Lens' AssumeRole (Maybe Text)
- assumeRole_policyArns :: Lens' AssumeRole (Maybe [PolicyDescriptorType])
- assumeRole_durationSeconds :: Lens' AssumeRole (Maybe Natural)
- assumeRole_policy :: Lens' AssumeRole (Maybe Text)
- assumeRole_externalId :: Lens' AssumeRole (Maybe Text)
- assumeRole_sourceIdentity :: Lens' AssumeRole (Maybe Text)
- assumeRole_serialNumber :: Lens' AssumeRole (Maybe Text)
- assumeRole_tags :: Lens' AssumeRole (Maybe [Tag])
- assumeRole_roleArn :: Lens' AssumeRole Text
- assumeRole_roleSessionName :: Lens' AssumeRole Text
- assumeRoleResponse_packedPolicySize :: Lens' AssumeRoleResponse (Maybe Natural)
- assumeRoleResponse_credentials :: Lens' AssumeRoleResponse (Maybe AuthEnv)
- assumeRoleResponse_assumedRoleUser :: Lens' AssumeRoleResponse (Maybe AssumedRoleUser)
- assumeRoleResponse_sourceIdentity :: Lens' AssumeRoleResponse (Maybe Text)
- assumeRoleResponse_httpStatus :: Lens' AssumeRoleResponse Int
- getAccessKeyInfo_accessKeyId :: Lens' GetAccessKeyInfo AccessKey
- getAccessKeyInfoResponse_account :: Lens' GetAccessKeyInfoResponse (Maybe Text)
- getAccessKeyInfoResponse_httpStatus :: Lens' GetAccessKeyInfoResponse Int
- decodeAuthorizationMessage_encodedMessage :: Lens' DecodeAuthorizationMessage Text
- decodeAuthorizationMessageResponse_decodedMessage :: Lens' DecodeAuthorizationMessageResponse (Maybe Text)
- decodeAuthorizationMessageResponse_httpStatus :: Lens' DecodeAuthorizationMessageResponse Int
- assumeRoleWithWebIdentity_providerId :: Lens' AssumeRoleWithWebIdentity (Maybe Text)
- assumeRoleWithWebIdentity_policyArns :: Lens' AssumeRoleWithWebIdentity (Maybe [PolicyDescriptorType])
- assumeRoleWithWebIdentity_durationSeconds :: Lens' AssumeRoleWithWebIdentity (Maybe Natural)
- assumeRoleWithWebIdentity_policy :: Lens' AssumeRoleWithWebIdentity (Maybe Text)
- assumeRoleWithWebIdentity_roleArn :: Lens' AssumeRoleWithWebIdentity Text
- assumeRoleWithWebIdentity_roleSessionName :: Lens' AssumeRoleWithWebIdentity Text
- assumeRoleWithWebIdentity_webIdentityToken :: Lens' AssumeRoleWithWebIdentity Text
- assumeRoleWithWebIdentityResponse_audience :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text)
- assumeRoleWithWebIdentityResponse_subjectFromWebIdentityToken :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text)
- assumeRoleWithWebIdentityResponse_packedPolicySize :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Natural)
- assumeRoleWithWebIdentityResponse_credentials :: Lens' AssumeRoleWithWebIdentityResponse (Maybe AuthEnv)
- assumeRoleWithWebIdentityResponse_assumedRoleUser :: Lens' AssumeRoleWithWebIdentityResponse (Maybe AssumedRoleUser)
- assumeRoleWithWebIdentityResponse_sourceIdentity :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text)
- assumeRoleWithWebIdentityResponse_provider :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text)
- assumeRoleWithWebIdentityResponse_httpStatus :: Lens' AssumeRoleWithWebIdentityResponse Int
- getFederationToken_policyArns :: Lens' GetFederationToken (Maybe [PolicyDescriptorType])
- getFederationToken_durationSeconds :: Lens' GetFederationToken (Maybe Natural)
- getFederationToken_policy :: Lens' GetFederationToken (Maybe Text)
- getFederationToken_tags :: Lens' GetFederationToken (Maybe [Tag])
- getFederationToken_name :: Lens' GetFederationToken Text
- getFederationTokenResponse_packedPolicySize :: Lens' GetFederationTokenResponse (Maybe Natural)
- getFederationTokenResponse_credentials :: Lens' GetFederationTokenResponse (Maybe AuthEnv)
- getFederationTokenResponse_federatedUser :: Lens' GetFederationTokenResponse (Maybe FederatedUser)
- getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int
- getSessionToken_tokenCode :: Lens' GetSessionToken (Maybe Text)
- getSessionToken_durationSeconds :: Lens' GetSessionToken (Maybe Natural)
- getSessionToken_serialNumber :: Lens' GetSessionToken (Maybe Text)
- getSessionTokenResponse_credentials :: Lens' GetSessionTokenResponse (Maybe AuthEnv)
- getSessionTokenResponse_httpStatus :: Lens' GetSessionTokenResponse Int
- assumeRoleWithSAML_policyArns :: Lens' AssumeRoleWithSAML (Maybe [PolicyDescriptorType])
- assumeRoleWithSAML_durationSeconds :: Lens' AssumeRoleWithSAML (Maybe Natural)
- assumeRoleWithSAML_policy :: Lens' AssumeRoleWithSAML (Maybe Text)
- assumeRoleWithSAML_roleArn :: Lens' AssumeRoleWithSAML Text
- assumeRoleWithSAML_principalArn :: Lens' AssumeRoleWithSAML Text
- assumeRoleWithSAML_sAMLAssertion :: Lens' AssumeRoleWithSAML Text
- assumeRoleWithSAMLResponse_subject :: Lens' AssumeRoleWithSAMLResponse (Maybe Text)
- assumeRoleWithSAMLResponse_audience :: Lens' AssumeRoleWithSAMLResponse (Maybe Text)
- assumeRoleWithSAMLResponse_packedPolicySize :: Lens' AssumeRoleWithSAMLResponse (Maybe Natural)
- assumeRoleWithSAMLResponse_credentials :: Lens' AssumeRoleWithSAMLResponse (Maybe AuthEnv)
- assumeRoleWithSAMLResponse_subjectType :: Lens' AssumeRoleWithSAMLResponse (Maybe Text)
- assumeRoleWithSAMLResponse_nameQualifier :: Lens' AssumeRoleWithSAMLResponse (Maybe Text)
- assumeRoleWithSAMLResponse_assumedRoleUser :: Lens' AssumeRoleWithSAMLResponse (Maybe AssumedRoleUser)
- assumeRoleWithSAMLResponse_sourceIdentity :: Lens' AssumeRoleWithSAMLResponse (Maybe Text)
- assumeRoleWithSAMLResponse_issuer :: Lens' AssumeRoleWithSAMLResponse (Maybe Text)
- assumeRoleWithSAMLResponse_httpStatus :: Lens' AssumeRoleWithSAMLResponse Int
- assumedRoleUser_assumedRoleId :: Lens' AssumedRoleUser Text
- assumedRoleUser_arn :: Lens' AssumedRoleUser Text
- federatedUser_federatedUserId :: Lens' FederatedUser Text
- federatedUser_arn :: Lens' FederatedUser Text
- policyDescriptorType_arn :: Lens' PolicyDescriptorType (Maybe Text)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Operations
GetCallerIdentity
getCallerIdentityResponse_arn :: Lens' GetCallerIdentityResponse (Maybe Text) Source #
The Amazon Web Services ARN associated with the calling entity.
getCallerIdentityResponse_account :: Lens' GetCallerIdentityResponse (Maybe Text) Source #
The Amazon Web Services account ID number of the account that owns or contains the calling entity.
getCallerIdentityResponse_userId :: Lens' GetCallerIdentityResponse (Maybe Text) Source #
The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the /IAM User Guide/.
getCallerIdentityResponse_httpStatus :: Lens' GetCallerIdentityResponse Int Source #
The response's http status code.
AssumeRole
assumeRole_transitiveTagKeys :: Lens' AssumeRole (Maybe [Text]) Source #
A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide.
This parameter is optional. When you set session tags as transitive, the session policy and session tags packed binary limit is not affected.
If you choose not to specify a transitive tag key, then no tags are passed from this session to any subsequent sessions.
assumeRole_tokenCode :: Lens' AssumeRole (Maybe Text) Source #
The value provided by the MFA device, if the trust policy of the role
being assumed requires MFA. (In other words, 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.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
assumeRole_policyArns :: Lens' AssumeRole (Maybe [PolicyDescriptorType]) Source #
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
assumeRole_durationSeconds :: Lens' AssumeRole (Maybe Natural) Source #
The duration, in seconds, of the role session. The value specified can can range from 900 seconds (15 minutes) up to the maximum session duration that is set for the role. The maximum session duration setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting or the administrator setting (whichever is lower), the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.
By default, the value is set to 3600
seconds.
The DurationSeconds
parameter is separate from the duration of a
console session that you might request using the returned credentials.
The request to the federation endpoint for a console sign-in token takes
a SessionDuration
parameter that specifies the maximum length of the
console session. For more information, see
Creating a URL that Enables Federated Users to Access the Management Console
in the IAM User Guide.
assumeRole_policy :: Lens' AssumeRole (Maybe Text) Source #
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
assumeRole_externalId :: Lens' AssumeRole (Maybe Text) Source #
A unique identifier that might be required when you assume a role in
another account. If the administrator of the account to which the role
belongs provided you with an external ID, then provide that value in the
ExternalId
parameter. This value can be any string, such as a
passphrase or account number. A cross-account role is usually set up to
trust everyone in an account. Therefore, the administrator of the
trusting account might send an external ID to the administrator of the
trusted account. That way, only someone with the ID can assume the role,
rather than everyone in the account. For more information about the
external ID, see
How to Use an External ID When Granting Access to Your Amazon Web Services Resources to a Third Party
in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
assumeRole_sourceIdentity :: Lens' AssumeRole (Maybe Text) Source #
The source identity specified by the principal that is calling the
AssumeRole
operation.
You can require users to specify a source identity when they assume a
role. You do this by using the sts:SourceIdentity
condition key in a
role trust policy. You can use source identity information in CloudTrail
logs to determine who took actions with a role. You can use the
aws:SourceIdentity
condition key to further control access to Amazon
Web Services resources based on the value of source identity. For more
information about using source identity, see
Monitor and control actions taken with assumed roles
in the IAM User Guide.
The regex used to validate this parameter is a string of characters
consisting of upper- and lower-case alphanumeric characters with no
spaces. You can also include underscores or any of the following
characters: =,.@-. You cannot use a value that begins with the text
aws:
. This prefix is reserved for Amazon Web Services internal use.
assumeRole_serialNumber :: Lens' AssumeRole (Maybe Text) Source #
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
).
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
assumeRole_tags :: Lens' AssumeRole (Maybe [Tag]) Source #
A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging STS Sessions in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters, and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the role. When you do, session tags override a role tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This
means that you cannot have separate Department
and department
tag
keys. Assume that the role has the Department
=Marketing
tag and you
pass the department
=engineering
session tag. Department
and
department
are not saved as separate tags, and the session tag passed
in the request takes precedence over the role tag.
Additionally, if you used temporary credentials to perform this operation, the new session inherits any transitive session tags from the calling session. If you pass a session tag with the same key as an inherited tag, the operation fails. To view the inherited tags for a session, see the CloudTrail logs. For more information, see Viewing Session Tags in CloudTrail in the IAM User Guide.
assumeRole_roleArn :: Lens' AssumeRole Text Source #
The Amazon Resource Name (ARN) of the role to assume.
assumeRole_roleSessionName :: Lens' AssumeRole Text Source #
An identifier for the assumed role session.
Use the role session name to uniquely identify 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 that use the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
assumeRoleResponse_packedPolicySize :: Lens' AssumeRoleResponse (Maybe Natural) Source #
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
assumeRoleResponse_credentials :: Lens' AssumeRoleResponse (Maybe AuthEnv) Source #
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
assumeRoleResponse_assumedRoleUser :: Lens' AssumeRoleResponse (Maybe AssumedRoleUser) Source #
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
.
assumeRoleResponse_sourceIdentity :: Lens' AssumeRoleResponse (Maybe Text) Source #
The source identity specified by the principal that is calling the
AssumeRole
operation.
You can require users to specify a source identity when they assume a
role. You do this by using the sts:SourceIdentity
condition key in a
role trust policy. You can use source identity information in CloudTrail
logs to determine who took actions with a role. You can use the
aws:SourceIdentity
condition key to further control access to Amazon
Web Services resources based on the value of source identity. For more
information about using source identity, see
Monitor and control actions taken with assumed roles
in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
assumeRoleResponse_httpStatus :: Lens' AssumeRoleResponse Int Source #
The response's http status code.
GetAccessKeyInfo
getAccessKeyInfo_accessKeyId :: Lens' GetAccessKeyInfo AccessKey Source #
The identifier of an access key.
This parameter allows (through its regex pattern) a string of characters that can consist of any upper- or lowercase letter or digit.
getAccessKeyInfoResponse_account :: Lens' GetAccessKeyInfoResponse (Maybe Text) Source #
The number used to identify the Amazon Web Services account.
getAccessKeyInfoResponse_httpStatus :: Lens' GetAccessKeyInfoResponse Int Source #
The response's http status code.
DecodeAuthorizationMessage
decodeAuthorizationMessage_encodedMessage :: Lens' DecodeAuthorizationMessage Text Source #
The encoded message that was returned with the response.
decodeAuthorizationMessageResponse_decodedMessage :: Lens' DecodeAuthorizationMessageResponse (Maybe Text) Source #
An XML document that contains the decoded message.
decodeAuthorizationMessageResponse_httpStatus :: Lens' DecodeAuthorizationMessageResponse Int Source #
The response's http status code.
AssumeRoleWithWebIdentity
assumeRoleWithWebIdentity_providerId :: Lens' AssumeRoleWithWebIdentity (Maybe Text) Source #
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.
assumeRoleWithWebIdentity_policyArns :: Lens' AssumeRoleWithWebIdentity (Maybe [PolicyDescriptorType]) Source #
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
assumeRoleWithWebIdentity_durationSeconds :: Lens' AssumeRoleWithWebIdentity (Maybe Natural) Source #
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.
By default, the value is set to 3600
seconds.
The DurationSeconds
parameter is separate from the duration of a
console session that you might request using the returned credentials.
The request to the federation endpoint for a console sign-in token takes
a SessionDuration
parameter that specifies the maximum length of the
console session. For more information, see
Creating a URL that Enables Federated Users to Access the Management Console
in the IAM User Guide.
assumeRoleWithWebIdentity_policy :: Lens' AssumeRoleWithWebIdentity (Maybe Text) Source #
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
assumeRoleWithWebIdentity_roleArn :: Lens' AssumeRoleWithWebIdentity Text Source #
The Amazon Resource Name (ARN) of the role that the caller is assuming.
assumeRoleWithWebIdentity_roleSessionName :: Lens' AssumeRoleWithWebIdentity Text Source #
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.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
assumeRoleWithWebIdentity_webIdentityToken :: Lens' AssumeRoleWithWebIdentity Text Source #
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.
assumeRoleWithWebIdentityResponse_audience :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text) Source #
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.
assumeRoleWithWebIdentityResponse_subjectFromWebIdentityToken :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text) Source #
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.
assumeRoleWithWebIdentityResponse_packedPolicySize :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Natural) Source #
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
assumeRoleWithWebIdentityResponse_credentials :: Lens' AssumeRoleWithWebIdentityResponse (Maybe AuthEnv) Source #
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
assumeRoleWithWebIdentityResponse_assumedRoleUser :: Lens' AssumeRoleWithWebIdentityResponse (Maybe AssumedRoleUser) Source #
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
.
assumeRoleWithWebIdentityResponse_sourceIdentity :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text) Source #
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
You can require users to set a source identity value when they assume a
role. You do this by using the sts:SourceIdentity
condition key in a
role trust policy. That way, actions that are taken with the role are
associated with that user. After the source identity is set, the value
cannot be changed. It is present in the request for all actions that are
taken by the role and persists across
chained role
sessions. You can configure your identity provider to use an attribute
associated with your users, like user name or email, as the source
identity when calling AssumeRoleWithWebIdentity
. You do this by adding
a claim to the JSON web token. To learn more about OIDC tokens and
claims, see
Using Tokens with User Pools
in the Amazon Cognito Developer Guide. For more information about
using source identity, see
Monitor and control actions taken with assumed roles
in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
assumeRoleWithWebIdentityResponse_provider :: Lens' AssumeRoleWithWebIdentityResponse (Maybe Text) Source #
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.
assumeRoleWithWebIdentityResponse_httpStatus :: Lens' AssumeRoleWithWebIdentityResponse Int Source #
The response's http status code.
GetFederationToken
getFederationToken_policyArns :: Lens' GetFederationToken (Maybe [PolicyDescriptorType]) Source #
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The resulting credentials can be used to access a resource that has a
resource-based policy. If that policy specifically references the
federated user session in the Principal
element of the policy, the
session has the permissions allowed by the policy. These permissions are
granted in addition to the permissions that are granted by the session
policies.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
getFederationToken_durationSeconds :: Lens' GetFederationToken (Maybe Natural) Source #
The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using Amazon Web Services account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour.
getFederationToken_policy :: Lens' GetFederationToken (Maybe Text) Source #
An IAM policy in JSON format that you want to use as an inline session policy.
You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.
This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions.
When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.
The resulting credentials can be used to access a resource that has a
resource-based policy. If that policy specifically references the
federated user session in the Principal
element of the policy, the
session has the permissions allowed by the policy. These permissions are
granted in addition to the permissions that are granted by the session
policies.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
getFederationToken_tags :: Lens' GetFederationToken (Maybe [Tag]) Source #
A list of session tags. Each session tag consists of a key name and an associated value. For more information about session tags, see Passing Session Tags in STS in the IAM User Guide.
This parameter is optional. You can pass up to 50 session tags. The plaintext session tag keys can’t exceed 128 characters and the values can’t exceed 256 characters. For these and additional limits, see IAM and STS Character Limits in the IAM User Guide.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
You can pass a session tag with the same key as a tag that is already attached to the user you are federating. When you do, session tags override a user tag with the same key.
Tag key–value pairs are not case sensitive, but case is preserved. This
means that you cannot have separate Department
and department
tag
keys. Assume that the role has the Department
=Marketing
tag and you
pass the department
=engineering
session tag. Department
and
department
are not saved as separate tags, and the session tag passed
in the request takes precedence over the role tag.
getFederationToken_name :: Lens' GetFederationToken Text Source #
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.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
getFederationTokenResponse_packedPolicySize :: Lens' GetFederationTokenResponse (Maybe Natural) Source #
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
getFederationTokenResponse_credentials :: Lens' GetFederationTokenResponse (Maybe AuthEnv) Source #
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
getFederationTokenResponse_federatedUser :: Lens' GetFederationTokenResponse (Maybe FederatedUser) Source #
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.
getFederationTokenResponse_httpStatus :: Lens' GetFederationTokenResponse Int Source #
The response's http status code.
GetSessionToken
getSessionToken_tokenCode :: Lens' GetSessionToken (Maybe Text) Source #
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, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.
The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.
getSessionToken_durationSeconds :: Lens' GetSessionToken (Maybe Natural) Source #
The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for Amazon Web Services account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for Amazon Web Services account owners defaults to one hour.
getSessionToken_serialNumber :: Lens' GetSessionToken (Maybe Text) Source #
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 Management Console and viewing the user's
security credentials.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
getSessionTokenResponse_credentials :: Lens' GetSessionTokenResponse (Maybe AuthEnv) Source #
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
getSessionTokenResponse_httpStatus :: Lens' GetSessionTokenResponse Int Source #
The response's http status code.
AssumeRoleWithSAML
assumeRoleWithSAML_policyArns :: Lens' AssumeRoleWithSAML (Maybe [PolicyDescriptorType]) Source #
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
assumeRoleWithSAML_durationSeconds :: Lens' AssumeRoleWithSAML (Maybe Natural) Source #
The duration, in seconds, of the role session. Your role session lasts
for the duration that you specify for the DurationSeconds
parameter,
or until the time specified in the SAML authentication response's
SessionNotOnOrAfter
value, whichever is shorter. You can provide a
DurationSeconds
value from 900 seconds (15 minutes) up to the maximum
session duration setting for the role. This setting can have a value
from 1 hour to 12 hours. If you specify a value higher than this
setting, the operation fails. For example, if you specify a session
duration of 12 hours, but your administrator set the maximum session
duration to 6 hours, your operation fails. To learn how to view the
maximum value for your role, see
View the Maximum Session Duration Setting for a Role
in the IAM User Guide.
By default, the value is set to 3600
seconds.
The DurationSeconds
parameter is separate from the duration of a
console session that you might request using the returned credentials.
The request to the federation endpoint for a console sign-in token takes
a SessionDuration
parameter that specifies the maximum length of the
console session. For more information, see
Creating a URL that Enables Federated Users to Access the Management Console
in the IAM User Guide.
assumeRoleWithSAML_policy :: Lens' AssumeRoleWithSAML (Maybe Text) Source #
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent Amazon Web Services API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plaintext that you use for both inline and managed session policies can't exceed 2,048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
An Amazon Web Services conversion compresses the passed session policies
and session tags into a packed binary format that has a separate limit.
Your request can fail for this limit even if your plaintext meets the
other requirements. The PackedPolicySize
response element indicates by
percentage how close the policies and tags for your request are to the
upper size limit.
assumeRoleWithSAML_roleArn :: Lens' AssumeRoleWithSAML Text Source #
The Amazon Resource Name (ARN) of the role that the caller is assuming.
assumeRoleWithSAML_principalArn :: Lens' AssumeRoleWithSAML Text Source #
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
assumeRoleWithSAML_sAMLAssertion :: Lens' AssumeRoleWithSAML Text Source #
The base64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
assumeRoleWithSAMLResponse_subject :: Lens' AssumeRoleWithSAMLResponse (Maybe Text) Source #
The value of the NameID
element in the Subject
element of the SAML
assertion.
assumeRoleWithSAMLResponse_audience :: Lens' AssumeRoleWithSAMLResponse (Maybe Text) Source #
The value of the Recipient
attribute of the SubjectConfirmationData
element of the SAML assertion.
assumeRoleWithSAMLResponse_packedPolicySize :: Lens' AssumeRoleWithSAMLResponse (Maybe Natural) Source #
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
assumeRoleWithSAMLResponse_credentials :: Lens' AssumeRoleWithSAMLResponse (Maybe AuthEnv) Source #
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
assumeRoleWithSAMLResponse_subjectType :: Lens' AssumeRoleWithSAMLResponse (Maybe Text) Source #
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.
assumeRoleWithSAMLResponse_nameQualifier :: Lens' AssumeRoleWithSAMLResponse (Maybe Text) Source #
A hash value based on the concatenation of the following:
- The
Issuer
response value. - The Amazon Web Services account ID.
- 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" ) )
assumeRoleWithSAMLResponse_assumedRoleUser :: Lens' AssumeRoleWithSAMLResponse (Maybe AssumedRoleUser) Source #
The identifiers for the temporary security credentials that the operation returns.
assumeRoleWithSAMLResponse_sourceIdentity :: Lens' AssumeRoleWithSAMLResponse (Maybe Text) Source #
The value in the SourceIdentity
attribute in the SAML assertion.
You can require users to set a source identity value when they assume a
role. You do this by using the sts:SourceIdentity
condition key in a
role trust policy. That way, actions that are taken with the role are
associated with that user. After the source identity is set, the value
cannot be changed. It is present in the request for all actions that are
taken by the role and persists across
chained role
sessions. You can configure your SAML identity provider to use an
attribute associated with your users, like user name or email, as the
source identity when calling AssumeRoleWithSAML
. You do this by adding
an attribute to the SAML assertion. For more information about using
source identity, see
Monitor and control actions taken with assumed roles
in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
assumeRoleWithSAMLResponse_issuer :: Lens' AssumeRoleWithSAMLResponse (Maybe Text) Source #
The value of the Issuer
element of the SAML assertion.
assumeRoleWithSAMLResponse_httpStatus :: Lens' AssumeRoleWithSAMLResponse Int Source #
The response's http status code.
Types
AssumedRoleUser
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
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
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.