class Aws::STS::Types::AssumeRoleWithWebIdentityRequest

@see docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentityRequest AWS API Documentation
@return [Integer] : docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html [1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session </note>
Management Console] in the *IAM User Guide*.
[Creating a URL that Enables Federated Users to Access the AWS
maximum length of the console session. For more information, see
sign-in token takes a ‘SessionDuration` parameter that specifies the
credentials. The request to the federation endpoint for a console
console session that you might request using the returned
<note markdown=“1”> The `DurationSeconds` parameter is separate from the duration of a
By default, the value is set to `3600` seconds.
for a Role] in the *IAM User Guide*.
value for your role, see [View the Maximum Session Duration Setting
6 hours, your operation fails. To learn how to view the maximum
12 hours, but your administrator set the maximum session duration to
operation fails. For example, if you specify a session duration of
12 hours. If you specify a value higher than this setting, the
setting for the role. This setting can have a value from 1 hour to
from 900 seconds (15 minutes) up to the maximum session duration
The duration, in seconds, of the role session. The value can range
@!attribute [rw] duration_seconds
@return [String] : docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session </note>
request are to the upper size limit.
indicates by percentage how close the policies and tags for your
other requirements. The `PackedPolicySize` response element
request can fail for this limit even if your plain text meets the
tags into a packed binary format that has a separate limit. Your
<note markdown=“1”> An AWS conversion compresses the passed session policies and session
(\u000D) characters.
include the tab (\u0009), linefeed (\u000A), and carriage return
the valid character list (\u0020 through \u00FF). It can also
can be any ASCII character from the space character to the end of
policies can’t exceed 2,048 characters. The JSON policy characters
The plain text that you use for both inline and managed session Policies] in the *IAM User Guide*.
the role that is being assumed. For more information, see [Session
more permissions than those allowed by the identity-based policy of
account that owns the role. You cannot use session policies to grant
credentials in subsequent AWS API calls to access resources in the
policy and the session policies. You can use the role’s temporary
permissions are the intersection of the role’s identity-based
returns new temporary credentials. The resulting session’s
This parameter is optional. Passing policies to this operation
session policy.
An IAM policy in JSON format that you want to use as an inline
@!attribute [rw] policy
@return [Array<Types::PolicyDescriptorType>] : docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html Policies][2] in the *IAM User Guide*.
role that is being assumed. For more information, see [Session
permissions than those allowed by the identity-based policy of the
owns the role. You cannot use session policies to grant more
subsequent AWS API calls to access resources in the account that
policies. You can use the role’s temporary credentials in
intersection of the role’s identity-based policy and the session
credentials. The resulting session’s permissions are the
Passing policies to this operation returns new temporary
</note>
request are to the upper size limit.
indicates by percentage how close the policies and tags for your
other requirements. The ‘PackedPolicySize` response element
request can fail for this limit even if your plain text meets the
tags into a packed binary format that has a separate limit. Your
<note markdown=“1”> An AWS conversion compresses the passed session policies and session
Service Namespaces] in the AWS General Reference.
information about ARNs, see [Amazon Resource Names (ARNs) and AWS
managed session policies can’t exceed 2,048 characters. For more
ARNs. However, the plain text that you use for both inline and
This parameter is optional. You can provide up to 10 managed policy
in the same account as the role.
you want to use as managed session policies. The policies must exist
The Amazon Resource Names (ARNs) of the IAM managed policies that
@!attribute [rw] policy_arns
@return [String]
Do not specify this value for OpenID Connect ID tokens.
schemes and port numbers.
identity providers for OAuth 2.0 access tokens. Do not include URL
`www.amazon.com` and ‘graph.facebook.com` are the only supported
Specify this value only for OAuth 2.0 access tokens. Currently
identity provider.
The fully qualified host component of the domain name of the
@!attribute [rw] provider_id
@return [String]
`AssumeRoleWithWebIdentity` call.
a web identity provider before the application makes an
token by authenticating the user who is using your application with
provided by the identity provider. Your application must get this
The OAuth 2.0 access token or OpenID Connect ID token that is
@!attribute [rw] web_identity_token
@return [String]
characters: =,.@-
spaces. You can also include underscores or any of the following
consisting of upper- and lower-case alphanumeric characters with no
The regex used to validate this parameter is a string of characters
the `AssumedRoleUser` response element.
session name is included as part of the ARN and assumed role ID in
your application will use are associated with that user. This
your application. That way, the temporary security credentials that
name or identifier that is associated with the user who is using
An identifier for the assumed role session. Typically, you pass the
@!attribute [rw] role_session_name
@return [String]
assuming.
The Amazon Resource Name (ARN) of the role that the caller is
@!attribute [rw] role_arn
}
duration_seconds: 1,
policy: “sessionPolicyDocumentType”,
],
},
arn: “arnType”,
{
policy_arns: [
provider_id: “urlType”,
web_identity_token: “clientTokenType”, # required
role_session_name: “roleSessionNameType”, # required
role_arn: “arnType”, # required
{
data as a hash:
@note When making an API call, you may pass AssumeRoleWithWebIdentityRequest

class Aws::STS::Types::AssumeRoleWithWebIdentityRequest

Namespace

Included Modules

Defined in