AssumeRoleWithSAMLRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class AssumeRoleWithSAMLRequest
extends AmazonWebServiceRequest
implements Serializable
```
Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.

Session Duration

By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, 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. 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. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

Permissions

The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies 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 plain text that you use for both inline and managed session policies can't exceed 2,048 characters. 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 AWS 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.

Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.

Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the persistent identifier ( urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).

Tags

(Optional) You can configure your IdP to pass attributes into your SAML assertion as 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.

You can pass up to 50 session tags. The plain text 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 AWS 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 plain text 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 attached to the role. When you do, session tags override the role's tags with the same key.

An administrator must grant you the permissions necessary to pass session tags. The administrator can also create granular permissions to allow you to pass only specific session tags. For more information, see Tutorial: Using Tags for Attribute-Based Access Control in the IAM User Guide.

You can set the session tags as transitive. Transitive tags persist during role chaining. For more information, see Chaining Roles with Session Tags in the IAM User Guide.

SAML Configuration

Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy.

For more information, see the following resources:
- About SAML 2.0-based Federation in the IAM User Guide.
- Creating SAML Identity Providers in the IAM User Guide.
- Configuring a Relying Party and Claims in the IAM User Guide.
- Creating a Role for SAML 2.0 Federation in the IAM User Guide.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssumeRoleWithSAMLRequest()

Constructors
Constructor and Description
`AssumeRoleWithSAMLRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Integer`	`getDurationSeconds()` The duration, in seconds, of the role session.
`String`	`getPolicy()` An IAM policy in JSON format that you want to use as an inline session policy.
`List<PolicyDescriptorType>`	`getPolicyArns()` The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.
`String`	`getPrincipalArn()` The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role that the caller is assuming.
`String`	`getSAMLAssertion()` The base-64 encoded SAML authentication response provided by the IdP.
`int`	`hashCode()`
`void`	`setDurationSeconds(Integer durationSeconds)` The duration, in seconds, of the role session.
`void`	`setPolicy(String policy)` An IAM policy in JSON format that you want to use as an inline session policy.
`void`	`setPolicyArns(Collection<PolicyDescriptorType> policyArns)` The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.
`void`	`setPrincipalArn(String principalArn)` The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that the caller is assuming.
`void`	`setSAMLAssertion(String sAMLAssertion)` The base-64 encoded SAML authentication response provided by the IdP.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AssumeRoleWithSAMLRequest`	`withDurationSeconds(Integer durationSeconds)` The duration, in seconds, of the role session.
`AssumeRoleWithSAMLRequest`	`withPolicy(String policy)` An IAM policy in JSON format that you want to use as an inline session policy.
`AssumeRoleWithSAMLRequest`	`withPolicyArns(Collection<PolicyDescriptorType> policyArns)` The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.
`AssumeRoleWithSAMLRequest`	`withPolicyArns(PolicyDescriptorType... policyArns)` The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies.
`AssumeRoleWithSAMLRequest`	`withPrincipalArn(String principalArn)` The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
`AssumeRoleWithSAMLRequest`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that the caller is assuming.
`AssumeRoleWithSAMLRequest`	`withSAMLAssertion(String sAMLAssertion)` The base-64 encoded SAML authentication response provided by the IdP.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AssumeRoleWithSAMLRequest
```
public AssumeRoleWithSAMLRequest()
```
- Method Detail
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    
    Constraints:
    Length: 20 - 2048
    Pattern: [ -~ -퟿-�က0-ჿFF]+
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    
    Constraints:
    Length: 20 - 2048
    Pattern: [ -~ -퟿-�က0-ჿFF]+
    
    Parameters:
    
    roleArn -
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
  - withRoleArn
```
public AssumeRoleWithSAMLRequest withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: [ -~ -퟿-�က0-ჿFF]+
    
    Parameters:
    
    roleArn -
    The Amazon Resource Name (ARN) of the role that the caller is assuming.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPrincipalArn
```
public String getPrincipalArn()
```
    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
    
    Constraints:
    Length: 20 - 2048
    Pattern: [ -~ -퟿-�က0-ჿFF]+
    
    Returns:
    
    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
  - setPrincipalArn
```
public void setPrincipalArn(String principalArn)
```
    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
    
    Constraints:
    Length: 20 - 2048
    Pattern: [ -~ -퟿-�က0-ჿFF]+
    
    Parameters:
    
    principalArn -
    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
  - withPrincipalArn
```
public AssumeRoleWithSAMLRequest withPrincipalArn(String principalArn)
```
    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: [ -~ -퟿-�က0-ჿFF]+
    
    Parameters:
    
    principalArn -
    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSAMLAssertion
```
public String getSAMLAssertion()
```
    The base-64 encoded SAML authentication response provided by the IdP.
    
    For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
    
    Constraints:
    Length: 4 - 100000
    
    Returns:
    
    The base-64 encoded SAML authentication response provided by the IdP.
    
    For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
  - setSAMLAssertion
```
public void setSAMLAssertion(String sAMLAssertion)
```
    The base-64 encoded SAML authentication response provided by the IdP.
    
    For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
    
    Constraints:
    Length: 4 - 100000
    
    Parameters:
    
    sAMLAssertion -
    The base-64 encoded SAML authentication response provided by the IdP.
    
    For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
  - withSAMLAssertion
```
public AssumeRoleWithSAMLRequest withSAMLAssertion(String sAMLAssertion)
```
    The base-64 encoded SAML authentication response provided by the IdP.
    
    For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 4 - 100000
    
    Parameters:
    
    sAMLAssertion -
    The base-64 encoded SAML authentication response provided by the IdP.
    
    For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicyArns
```
public List<PolicyDescriptorType> getPolicyArns()
```
    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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
    
    Returns:
    
    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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
  - setPolicyArns
```
public void setPolicyArns(Collection<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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
    
    Parameters:
    
    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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
  - withPolicyArns
```
public AssumeRoleWithSAMLRequest withPolicyArns(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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withPolicyArns
```
public AssumeRoleWithSAMLRequest withPolicyArns(Collection<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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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 plain text 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 AWS Service Namespaces in the AWS General Reference.
    
    An AWS 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 plain text 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 AWS 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicy
```
public String getPolicy()
```
    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 AWS 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 plain text 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 AWS 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 plain text 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.
    
    Constraints:
    Length: 1 - 2048
    Pattern: [ -ÿ]+
    
    Returns:
    
    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 AWS 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 plain text 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 AWS 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 plain text 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.
  - setPolicy
```
public void setPolicy(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 AWS 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 plain text 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 AWS 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 plain text 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.
    
    Constraints:
    Length: 1 - 2048
    Pattern: [ -ÿ]+
    
    Parameters:
    
    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 AWS 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 plain text 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 AWS 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 plain text 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.
  - withPolicy
```
public AssumeRoleWithSAMLRequest withPolicy(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 AWS 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 plain text 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 AWS 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 plain text 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Pattern: [ -ÿ]+
    
    Parameters:
    
    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 AWS 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 plain text 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 AWS 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 plain text 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDurationSeconds
```
public Integer getDurationSeconds()
```
    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 AWS Management Console in the IAM User Guide.
    
    Constraints:
    Range: 900 - 43200
    
    Returns:
    
    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 AWS Management Console in the IAM User Guide.
  - setDurationSeconds
```
public void setDurationSeconds(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 AWS Management Console in the IAM User Guide.
    
    Constraints:
    Range: 900 - 43200
    
    Parameters:
    
    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 AWS Management Console in the IAM User Guide.
  - withDurationSeconds
```
public AssumeRoleWithSAMLRequest withDurationSeconds(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 AWS Management Console in the IAM User Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 900 - 43200
    
    Parameters:
    
    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 AWS Management Console in the IAM User Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class AssumeRoleWithSAMLRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AssumeRoleWithSAMLRequest

Method Detail

getRoleArn

setRoleArn

withRoleArn

getPrincipalArn

setPrincipalArn

withPrincipalArn

getSAMLAssertion

setSAMLAssertion

withSAMLAssertion

getPolicyArns

setPolicyArns

withPolicyArns

withPolicyArns

getPolicy

setPolicy

withPolicy

getDurationSeconds

setDurationSeconds

withDurationSeconds

toString

hashCode

equals