@Generated(value="software.amazon.awssdk:codegen") public 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.
Modifier and Type | Class and Description |
---|---|
static interface |
AssumeRoleWithWebIdentityResponse.Builder |
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) |
<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.
|
String |
provider()
The issuing authority of the web identity token presented.
|
static Class<? extends AssumeRoleWithWebIdentityResponse.Builder> |
serializableBuilderClass() |
String |
subjectFromWebIdentityToken()
The unique user identifier that is returned by the identity provider.
|
AssumeRoleWithWebIdentityResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public Credentials credentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security 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.
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.
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.
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.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
.
RoleSessionName
that you specified when you called AssumeRole
.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.
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.
iss
field. For OAuth 2.0 access tokens, this contains the value of the
ProviderId
parameter that was passed in the AssumeRoleWithWebIdentity
request.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.
public AssumeRoleWithWebIdentityResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>
toBuilder
in class AwsResponse
public static AssumeRoleWithWebIdentityResponse.Builder builder()
public static Class<? extends AssumeRoleWithWebIdentityResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
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.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.