@Generated(value="software.amazon.awssdk:codegen") public final class AssumeRoleWithSamlRequest extends StsRequest implements ToCopyableBuilder<AssumeRoleWithSamlRequest.Builder,AssumeRoleWithSamlRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
AssumeRoleWithSamlRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static AssumeRoleWithSamlRequest.Builder |
builder() |
Integer |
durationSeconds()
The duration, in seconds, of the role session.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasPolicyArns()
For responses, this returns true if the service returned a value for the PolicyArns property.
|
String |
policy()
An IAM policy in JSON format that you want to use as an inline session policy.
|
List<PolicyDescriptorType> |
policyArns()
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.
|
String |
principalArn()
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
|
String |
roleArn()
The Amazon Resource Name (ARN) of the role that the caller is assuming.
|
String |
samlAssertion()
The base64 encoded SAML authentication response provided by the IdP.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AssumeRoleWithSamlRequest.Builder> |
serializableBuilderClass() |
AssumeRoleWithSamlRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String roleArn()
The Amazon Resource Name (ARN) of the role that the caller is assuming.
public final String principalArn()
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
public final String samlAssertion()
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.
For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
public final boolean hasPolicyArns()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<PolicyDescriptorType> policyArns()
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 inline session policy, managed policy ARNs, 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPolicyArns()
method.
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 inline session policy, managed policy ARNs, 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.
public final String policy()
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 ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, 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.
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 ( through ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.
An Amazon Web Services conversion compresses the passed inline session policy, managed policy ARNs, 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.
public final Integer durationSeconds()
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 Amazon Web Services Management Console in the
IAM User Guide.
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 Amazon Web Services Management Console in
the IAM User Guide.
public AssumeRoleWithSamlRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<AssumeRoleWithSamlRequest.Builder,AssumeRoleWithSamlRequest>
toBuilder
in class StsRequest
public static AssumeRoleWithSamlRequest.Builder builder()
public static Class<? extends AssumeRoleWithSamlRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.