class Aws::STS::Types::AssumeRoleWithWebIdentityRequest

@see docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentityRequest AWS API Documentation
@return [Integer]<br>: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html<br>[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session<br><br><br><br></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]<br>: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html<br><br><br><br></note>
100% equaling the maximum allowed size.
percentage how close to the upper size limit the policy is, with
separate limit. The PackedPolicySize response element indicates by
internal conversion compresses it into a packed binary format with a
<note markdown=“1”> The policy plain text must be 2048 bytes or shorter. However, an
(\u000D) characters.
include the tab (\u0009), linefeed (\u000A), and carriage return
the end of the valid character list (\u0020-\u00FF). It can also
characters can be any ASCII character from the space character to
a string of characters up to 2048 characters in length. The
The format for this parameter, as described by its regex pattern, is
in the *IAM User Guide*.
more information, see [Permissions for AssumeRoleWithWebIdentity][1]
allowed by the access policy of the role that is being assumed. For
passed policy to grant permissions that are in excess of those
for the resulting temporary security credentials. You cannot use the
you pass. This gives you a way to further restrict the permissions
the role that is being assumed, and the policy that
have the permissions that are allowed by both the access policy of
temporary security credentials that are returned by the operation
The policy parameter is optional. If you pass a policy, the
An IAM policy in JSON format.
@!attribute [rw] policy
@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”,
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