AssumeRoleWithSAMLResult (aws-android-sdk-core 2.80.0 API)

java.lang.Object
- com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult

All Implemented Interfaces:

java.io.Serializable
```
public class AssumeRoleWithSAMLResult
extends java.lang.Object
implements java.io.Serializable
```
Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AssumeRoleWithSAMLResult()

Constructors
Constructor and Description
`AssumeRoleWithSAMLResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`AssumedRoleUser`	`getAssumedRoleUser()` The identifiers for the temporary security credentials that the operation returns.
`java.lang.String`	`getAudience()` The value of the `Recipient` attribute of the `SubjectConfirmationData` element of the SAML assertion.
`Credentials`	`getCredentials()` The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
`java.lang.String`	`getIssuer()` The value of the `Issuer` element of the SAML assertion.
`java.lang.String`	`getNameQualifier()` A hash value based on the concatenation of the following:
`java.lang.Integer`	`getPackedPolicySize()` A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
`java.lang.String`	`getSourceIdentity()` The value in the `SourceIdentity` attribute in the SAML assertion.
`java.lang.String`	`getSubject()` The value of the `NameID` element in the `Subject` element of the SAML assertion.
`java.lang.String`	`getSubjectType()` The format of the name ID, as defined by the `Format` attribute in the `NameID` element of the SAML assertion.
`int`	`hashCode()`
`void`	`setAssumedRoleUser(AssumedRoleUser assumedRoleUser)` The identifiers for the temporary security credentials that the operation returns.
`void`	`setAudience(java.lang.String audience)` The value of the `Recipient` attribute of the `SubjectConfirmationData` element of the SAML assertion.
`void`	`setCredentials(Credentials credentials)` The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
`void`	`setIssuer(java.lang.String issuer)` The value of the `Issuer` element of the SAML assertion.
`void`	`setNameQualifier(java.lang.String nameQualifier)` A hash value based on the concatenation of the following:
`void`	`setPackedPolicySize(java.lang.Integer packedPolicySize)` A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
`void`	`setSourceIdentity(java.lang.String sourceIdentity)` The value in the `SourceIdentity` attribute in the SAML assertion.
`void`	`setSubject(java.lang.String subject)` The value of the `NameID` element in the `Subject` element of the SAML assertion.
`void`	`setSubjectType(java.lang.String subjectType)` The format of the name ID, as defined by the `Format` attribute in the `NameID` element of the SAML assertion.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AssumeRoleWithSAMLResult`	`withAssumedRoleUser(AssumedRoleUser assumedRoleUser)` The identifiers for the temporary security credentials that the operation returns.
`AssumeRoleWithSAMLResult`	`withAudience(java.lang.String audience)` The value of the `Recipient` attribute of the `SubjectConfirmationData` element of the SAML assertion.
`AssumeRoleWithSAMLResult`	`withCredentials(Credentials credentials)` The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
`AssumeRoleWithSAMLResult`	`withIssuer(java.lang.String issuer)` The value of the `Issuer` element of the SAML assertion.
`AssumeRoleWithSAMLResult`	`withNameQualifier(java.lang.String nameQualifier)` A hash value based on the concatenation of the following:
`AssumeRoleWithSAMLResult`	`withPackedPolicySize(java.lang.Integer packedPolicySize)` A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
`AssumeRoleWithSAMLResult`	`withSourceIdentity(java.lang.String sourceIdentity)` The value in the `SourceIdentity` attribute in the SAML assertion.
`AssumeRoleWithSAMLResult`	`withSubject(java.lang.String subject)` The value of the `NameID` element in the `Subject` element of the SAML assertion.
`AssumeRoleWithSAMLResult`	`withSubjectType(java.lang.String subjectType)` The format of the name ID, as defined by the `Format` attribute in the `NameID` element of the SAML assertion.

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

- Constructor Detail
  - AssumeRoleWithSAMLResult
```
public AssumeRoleWithSAMLResult()
```
- Method Detail
  - getCredentials
```
public Credentials getCredentials()
```
    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.
    
    Returns:
    
    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.
  - setCredentials
```
public void setCredentials(Credentials credentials)
```
    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.
    
    Parameters:
    
    credentials -
    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.
  - withCredentials
```
public AssumeRoleWithSAMLResult withCredentials(Credentials credentials)
```
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    credentials -
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAssumedRoleUser
```
public AssumedRoleUser getAssumedRoleUser()
```
    The identifiers for the temporary security credentials that the operation returns.
    
    Returns:
    
    The identifiers for the temporary security credentials that the operation returns.
  - setAssumedRoleUser
```
public void setAssumedRoleUser(AssumedRoleUser assumedRoleUser)
```
    The identifiers for the temporary security credentials that the operation returns.
    
    Parameters:
    
    assumedRoleUser -
    The identifiers for the temporary security credentials that the operation returns.
  - withAssumedRoleUser
```
public AssumeRoleWithSAMLResult withAssumedRoleUser(AssumedRoleUser assumedRoleUser)
```
    The identifiers for the temporary security credentials that the operation returns.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    assumedRoleUser -
    The identifiers for the temporary security credentials that the operation returns.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPackedPolicySize
```
public java.lang.Integer getPackedPolicySize()
```
    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.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    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.
  - setPackedPolicySize
```
public void setPackedPolicySize(java.lang.Integer packedPolicySize)
```
    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.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    packedPolicySize -
    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.
  - withPackedPolicySize
```
public AssumeRoleWithSAMLResult withPackedPolicySize(java.lang.Integer packedPolicySize)
```
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    packedPolicySize -
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubject
```
public java.lang.String getSubject()
```
    The value of the NameID element in the Subject element of the SAML assertion.
    
    Returns:
    
    The value of the NameID element in the Subject element of the SAML assertion.
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    The value of the NameID element in the Subject element of the SAML assertion.
    
    Parameters:
    
    subject -
    The value of the NameID element in the Subject element of the SAML assertion.
  - withSubject
```
public AssumeRoleWithSAMLResult withSubject(java.lang.String subject)
```
    The value of the NameID element in the Subject element of the SAML assertion.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    subject -
    The value of the NameID element in the Subject element of the SAML assertion.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubjectType
```
public java.lang.String getSubjectType()
```
    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.
    
    Returns:
    
    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.
  - setSubjectType
```
public void setSubjectType(java.lang.String subjectType)
```
    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.
    
    Parameters:
    
    subjectType -
    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.
  - withSubjectType
```
public AssumeRoleWithSAMLResult withSubjectType(java.lang.String subjectType)
```
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    subjectType -
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIssuer
```
public java.lang.String getIssuer()
```
    The value of the Issuer element of the SAML assertion.
    
    Returns:
    
    The value of the Issuer element of the SAML assertion.
  - setIssuer
```
public void setIssuer(java.lang.String issuer)
```
    The value of the Issuer element of the SAML assertion.
    
    Parameters:
    
    issuer -
    The value of the Issuer element of the SAML assertion.
  - withIssuer
```
public AssumeRoleWithSAMLResult withIssuer(java.lang.String issuer)
```
    The value of the Issuer element of the SAML assertion.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    issuer -
    The value of the Issuer element of the SAML assertion.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAudience
```
public java.lang.String getAudience()
```
    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
    
    Returns:
    
    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
  - setAudience
```
public void setAudience(java.lang.String audience)
```
    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
    
    Parameters:
    
    audience -
    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
  - withAudience
```
public AssumeRoleWithSAMLResult withAudience(java.lang.String audience)
```
    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    audience -
    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNameQualifier
```
public java.lang.String getNameQualifier()
```
    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 user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
    Returns:
    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 user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
  - setNameQualifier
```
public void setNameQualifier(java.lang.String nameQualifier)
```
    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 user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
    Parameters:
    nameQualifier -
    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 user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
  - withNameQualifier
```
public AssumeRoleWithSAMLResult withNameQualifier(java.lang.String nameQualifier)
```
    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 user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
    
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    nameQualifier -
    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 user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSourceIdentity
```
public java.lang.String getSourceIdentity()
```
    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: =,.@-
    
    Constraints:
    Length: 2 - 64
    Pattern: [\w+=,.@-]*
    
    Returns:
    
    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: =,.@-
  - setSourceIdentity
```
public void setSourceIdentity(java.lang.String sourceIdentity)
```
    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: =,.@-
    
    Constraints:
    Length: 2 - 64
    Pattern: [\w+=,.@-]*
    
    Parameters:
    
    sourceIdentity -
    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: =,.@-
  - withSourceIdentity
```
public AssumeRoleWithSAMLResult withSourceIdentity(java.lang.String sourceIdentity)
```
    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: =,.@-
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 2 - 64
    Pattern: [\w+=,.@-]*
    
    Parameters:
    
    sourceIdentity -
    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: =,.@-
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AssumeRoleWithSAMLResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssumeRoleWithSAMLResult

Method Detail

getCredentials

setCredentials

withCredentials

getAssumedRoleUser

setAssumedRoleUser

withAssumedRoleUser

getPackedPolicySize

setPackedPolicySize

withPackedPolicySize

getSubject

setSubject

withSubject

getSubjectType

setSubjectType

withSubjectType

getIssuer

setIssuer

withIssuer

getAudience

setAudience

withAudience

getNameQualifier

setNameQualifier

withNameQualifier

getSourceIdentity

setSourceIdentity

withSourceIdentity

toString

hashCode

equals