software.amazon.awssdk.services.sts.model

Class AssumeRoleResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sts.model.StsResponse

software.amazon.awssdk.services.sts.model.AssumeRoleResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssumeRoleResponse.Builder,AssumeRoleResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class AssumeRoleResponse
extends StsResponse
implements ToCopyableBuilder<AssumeRoleResponse.Builder,AssumeRoleResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssumeRoleResponse.Builder

Method Summary

Modifier and Type	Method and Description
AssumedRoleUser	assumedRoleUser() The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.
static AssumeRoleResponse.Builder	builder()
Credentials	credentials() The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
Integer	packedPolicySize() A percentage value that indicates the size of the policy in packed form.
List<SdkField<?>>	sdkFields()
static Class<? extends AssumeRoleResponse.Builder>	serializableBuilderClass()
AssumeRoleResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.services.sts.model.StsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

credentials

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

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.

assumedRoleUser

public AssumedRoleUser assumedRoleUser()

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

Returns:

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

packedPolicySize

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

toBuilder

public AssumeRoleResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AssumeRoleResponse.Builder,AssumeRoleResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static AssumeRoleResponse.Builder builder()

serializableBuilderClass

public static Class<? extends AssumeRoleResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.