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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
```
@Generated("software.amazon.awssdk:codegen")
public final class AssumeRoleWithSamlResponse
extends StsResponse
implements ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
```
Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AssumeRoleWithSamlResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AssumedRoleUser`	`assumedRoleUser()`	The identifiers for the temporary security credentials that the operation returns.
`String`	`audience()`	The value of the `Recipient` attribute of the `SubjectConfirmationData` element of the SAML assertion.
`static AssumeRoleWithSamlResponse.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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`issuer()`	The value of the `Issuer` element of the SAML assertion.
`String`	`nameQualifier()`	A hash value based on the concatenation of the following:
`Integer`	`packedPolicySize()`	A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AssumeRoleWithSamlResponse.Builder>`	`serializableBuilderClass()`
`String`	`sourceIdentity()`	The value in the `SourceIdentity` attribute in the SAML assertion.
`String`	`subject()`	The value of the `NameID` element in the `Subject` element of the SAML assertion.
`String`	`subjectType()`	The format of the name ID, as defined by the `Format` attribute in the `NameID` element of the SAML assertion.
`AssumeRoleWithSamlResponse.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 final Credentials credentials()
```
    The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) 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 (or session) 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.
  - assumedRoleUser
```
public final AssumedRoleUser assumedRoleUser()
```
    The identifiers for the temporary security credentials that the operation returns.
    
    Returns:
    
    The identifiers for the temporary security credentials that the operation returns.
  - packedPolicySize
```
public final 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.
  - subject
```
public final String subject()
```
    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.
  - subjectType
```
public final 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:
    
    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.
  - issuer
```
public final String issuer()
```
    The value of the Issuer element of the SAML assertion.
    
    Returns:
    
    The value of the Issuer element of the SAML assertion.
  - audience
```
public final String audience()
```
    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.
  - nameQualifier
```
public final String nameQualifier()
```
    A hash value based on the concatenation of the following:
    
    The Issuer response value.
    
    The Amazon Web Services account ID.
    
    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 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 following:
    
    The Issuer response value.
    
    The Amazon Web Services account ID.
    
    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 user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
  - sourceIdentity
```
public final String sourceIdentity()
```
    The value in the SourceIdentity attribute in the SAML assertion. The source identity value persists across chained role sessions.
    
    You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.
    
    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
    
    Returns:
    
    The value in the SourceIdentity attribute in the SAML assertion. The source identity value persists across chained role sessions.
    
    You can require users to set a source identity value when they assume a role. You do this by using the sts:SourceIdentity condition key in a role trust policy. That way, actions that are taken with the role are associated with that user. After the source identity is set, the value cannot be changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your SAML identity provider to use an attribute associated with your users, like user name or email, as the source identity when calling AssumeRoleWithSAML. You do this by adding an attribute to the SAML assertion. For more information about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.
    
    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
  - toBuilder
```
public AssumeRoleWithSamlResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static AssumeRoleWithSamlResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AssumeRoleWithSamlResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AssumeRoleWithSamlResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

credentials

assumedRoleUser

packedPolicySize

subject

subjectType

issuer

audience

nameQualifier

sourceIdentity

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField