com.amazonaws.services.securitytoken.model

Class GetFederationTokenResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.securitytoken.model.GetFederationTokenResult

All Implemented Interfaces:

Serializable, Cloneable

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

Contains the response to a successful GetFederationToken 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
GetFederationTokenResult()

Method Summary

Modifier and Type	Method and Description
GetFederationTokenResult	clone()
boolean	equals(Object obj)
Credentials	getCredentials() The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
FederatedUser	getFederatedUser() Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).
Integer	getPackedPolicySize() A percentage value indicating the size of the policy in packed form.
int	hashCode()
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	setFederatedUser(FederatedUser federatedUser) Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).
void	setPackedPolicySize(Integer packedPolicySize) A percentage value indicating the size of the policy in packed form.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetFederationTokenResult	withCredentials(Credentials credentials) The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
GetFederationTokenResult	withFederatedUser(FederatedUser federatedUser) Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob).
GetFederationTokenResult	withPackedPolicySize(Integer packedPolicySize) A percentage value indicating the size of the policy in packed form.

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

GetFederationTokenResult

public GetFederationTokenResult()

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.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

Parameters:

credentials - The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

getCredentials

public Credentials getCredentials()

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

Returns:

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

withCredentials

public GetFederationTokenResult withCredentials(Credentials credentials)

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

Parameters:

credentials - The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

Returns:

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

setFederatedUser

public void setFederatedUser(FederatedUser federatedUser)

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

Parameters:

federatedUser - Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

getFederatedUser

public FederatedUser getFederatedUser()

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

Returns:

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

withFederatedUser

public GetFederationTokenResult withFederatedUser(FederatedUser federatedUser)

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

Parameters:

federatedUser - Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

Returns:

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

setPackedPolicySize

public void setPackedPolicySize(Integer packedPolicySize)

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

Parameters:

packedPolicySize - A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

getPackedPolicySize

public Integer getPackedPolicySize()

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

Returns:

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

withPackedPolicySize

public GetFederationTokenResult withPackedPolicySize(Integer packedPolicySize)

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

Parameters:

packedPolicySize - A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

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; useful for testing and debugging.

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 GetFederationTokenResult clone()

Overrides:

clone in class Object