com.amazonaws.services.securitytoken.model

Class AssumeRoleWithSAMLResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AssumeRoleWithSAMLResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssumeRoleWithSAMLResult()

Method Summary

Modifier and Type	Method and Description
AssumeRoleWithSAMLResult	clone()
boolean	equals(Object obj)
AssumedRoleUser	getAssumedRoleUser() The identifiers for the temporary security credentials that the operation returns.
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.
String	getIssuer() The value of the Issuer element of the SAML assertion.
String	getNameQualifier() A hash value based on the concatenation of the following:
Integer	getPackedPolicySize() A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
String	getSourceIdentity() The value in the SourceIdentity attribute in the SAML assertion.
String	getSubject() The value of the NameID element in the Subject element of the SAML assertion.
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(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(String issuer) The value of the Issuer element of the SAML assertion.
void	setNameQualifier(String nameQualifier) A hash value based on the concatenation of the following:
void	setPackedPolicySize(Integer packedPolicySize) A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
void	setSourceIdentity(String sourceIdentity) The value in the SourceIdentity attribute in the SAML assertion.
void	setSubject(String subject) The value of the NameID element in the Subject element of the SAML assertion.
void	setSubjectType(String subjectType) The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion.
String	toString() Returns a string representation of this object.
AssumeRoleWithSAMLResult	withAssumedRoleUser(AssumedRoleUser assumedRoleUser) The identifiers for the temporary security credentials that the operation returns.
AssumeRoleWithSAMLResult	withAudience(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(String issuer) The value of the Issuer element of the SAML assertion.
AssumeRoleWithSAMLResult	withNameQualifier(String nameQualifier) A hash value based on the concatenation of the following:
AssumeRoleWithSAMLResult	withPackedPolicySize(Integer packedPolicySize) A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
AssumeRoleWithSAMLResult	withSourceIdentity(String sourceIdentity) The value in the SourceIdentity attribute in the SAML assertion.
AssumeRoleWithSAMLResult	withSubject(String subject) The value of the NameID element in the Subject element of the SAML assertion.
AssumeRoleWithSAMLResult	withSubjectType(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 com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssumeRoleWithSAMLResult

public AssumeRoleWithSAMLResult()

Method Detail

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.

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.

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.

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:

Returns a reference to this object so that method calls can be chained together.

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.

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.

withAssumedRoleUser

public AssumeRoleWithSAMLResult withAssumedRoleUser(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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPackedPolicySize

public void setPackedPolicySize(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.

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.

getPackedPolicySize

public 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.

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.

withPackedPolicySize

public AssumeRoleWithSAMLResult withPackedPolicySize(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.

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:

Returns a reference to this object so that method calls can be chained together.

setSubject

public void setSubject(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.

getSubject

public 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.

withSubject

public AssumeRoleWithSAMLResult withSubject(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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSubjectType

public void setSubjectType(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.

getSubjectType

public 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.

withSubjectType

public AssumeRoleWithSAMLResult withSubjectType(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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIssuer

public void setIssuer(String issuer)

The value of the Issuer element of the SAML assertion.

Parameters:

issuer - The value of the Issuer element of the SAML assertion.

getIssuer

public String getIssuer()

The value of the Issuer element of the SAML assertion.

Returns:

The value of the Issuer element of the SAML assertion.

withIssuer

public AssumeRoleWithSAMLResult withIssuer(String issuer)

The value of the Issuer element of the SAML assertion.

Parameters:

issuer - The value of the Issuer element of the SAML assertion.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAudience

public void setAudience(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.

getAudience

public 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.

withAudience

public AssumeRoleWithSAMLResult withAudience(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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNameQualifier

public void setNameQualifier(String nameQualifier)

A hash value based on the concatenation of the following:

• The Issuer response value.

• The AWS 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 federated 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 AWS 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 federated user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

getNameQualifier

public String getNameQualifier()

A hash value based on the concatenation of the following:

• The Issuer response value.

• The AWS 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 federated 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 AWS 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 federated user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

withNameQualifier

public AssumeRoleWithSAMLResult withNameQualifier(String nameQualifier)

A hash value based on the concatenation of the following:

• The Issuer response value.

• The AWS 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 federated 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 AWS 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 federated user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceIdentity

public void setSourceIdentity(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: =,.@-

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: =,.@-

getSourceIdentity

public 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: =,.@-

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: =,.@-

withSourceIdentity

public AssumeRoleWithSAMLResult withSourceIdentity(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: =,.@-

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:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AssumeRoleWithSAMLResult clone()

Overrides:

clone in class Object