software.amazon.awssdk.services.sts.model

Class AssumeRoleWithWebIdentityResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>

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

Contains the response to a successful AssumeRoleWithWebIdentity 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	AssumeRoleWithWebIdentityResponse.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.
String	audience() The intended audience (also known as client ID) of the web identity token.
static AssumeRoleWithWebIdentityResponse.Builder	builder()
Credentials	credentials() The temporary security credentials, which include an access key ID, a secret access key, and a security token.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	packedPolicySize() A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
String	provider() The issuing authority of the web identity token presented.
List<SdkField<?>>	sdkFields()
static Class<? extends AssumeRoleWithWebIdentityResponse.Builder>	serializableBuilderClass()
String	subjectFromWebIdentityToken() The unique user identifier that is returned by the identity provider.
AssumeRoleWithWebIdentityResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

clone, finalize, 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 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 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.

subjectFromWebIdentityToken

public String subjectFromWebIdentityToken()

The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

Returns:

The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

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

provider

public String provider()

The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

Returns:

The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

audience

public String audience()

The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

Returns:

The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

toBuilder

public AssumeRoleWithWebIdentityResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static AssumeRoleWithWebIdentityResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo