com.amazonaws.services.securitytoken.model

Class AssumeRoleWithSAMLResult

java.lang.Object

com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult

All Implemented Interfaces:

Serializable, Cloneable

public class AssumeRoleWithSAMLResult
extends Object
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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssumeRoleWithSAMLResult()

Method Summary

Methods

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() AWS credentials for API authentication.
String	getIssuer() The value of the Issuer element of the SAML assertion.
String	getNameQualifier() A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM.
Integer	getPackedPolicySize() A percentage value that indicates the size of the policy in packed form.
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) AWS credentials for API authentication.
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 Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM.
void	setPackedPolicySize(Integer packedPolicySize) A percentage value that indicates the size of the policy in packed form.
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; useful for testing and debugging.
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) AWS credentials for API authentication.
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 Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM.
AssumeRoleWithSAMLResult	withPackedPolicySize(Integer packedPolicySize) A percentage value that indicates the size of the policy in packed form.
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 java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssumeRoleWithSAMLResult

public AssumeRoleWithSAMLResult()

Method Detail

getCredentials

public Credentials getCredentials()

AWS credentials for API authentication.

Returns:

AWS credentials for API authentication.

setCredentials

public void setCredentials(Credentials credentials)

AWS credentials for API authentication.

Parameters:

credentials - AWS credentials for API authentication.

withCredentials

public AssumeRoleWithSAMLResult withCredentials(Credentials credentials)

AWS credentials for API authentication.

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

Parameters:

credentials - AWS credentials for API authentication.

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 Integer getPackedPolicySize()

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Constraints:
Range: 0 -

Returns:

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

setPackedPolicySize

public void setPackedPolicySize(Integer packedPolicySize)

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Constraints:
Range: 0 -

Parameters:

packedPolicySize - A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

withPackedPolicySize

public AssumeRoleWithSAMLResult withPackedPolicySize(Integer packedPolicySize)

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy 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 size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Returns:

A reference to this updated object so that method calls can be chained together.

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.

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.

withSubject

public AssumeRoleWithSAMLResult withSubject(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 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(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(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 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(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(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 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(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(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 String getNameQualifier()

A hash value based on the concatenation of the Issuer response value, the AWS account ID, and 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 Issuer response value, the AWS account ID, and 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" ) )

setNameQualifier

public void setNameQualifier(String nameQualifier)

A hash value based on the concatenation of the Issuer response value, the AWS account ID, and 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 Issuer response value, the AWS account ID, and 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 Issuer response value, the AWS account ID, and 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 reference to this object so that method calls can be chained together.

Parameters:

nameQualifier - A hash value based on the concatenation of the Issuer response value, the AWS account ID, and 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 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

clone

public AssumeRoleWithSAMLResult clone()

Overrides:

clone in class Object