AssumeRoleWithSAMLResponse (AWS SDK for Java

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:

ToCopyableBuilder<AssumeRoleWithSAMLResponse.Builder,AssumeRoleWithSAMLResponse>
```
@Generated(value="software.amazon.awssdk:codegen")
public class AssumeRoleWithSAMLResponse
extends STSResponse
implements ToCopyableBuilder<AssumeRoleWithSAMLResponse.Builder,AssumeRoleWithSAMLResponse>
```
Contains the response to a successful AssumeRoleWithSAML 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 AssumeRoleWithSAMLResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AssumeRoleWithSAMLResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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)`
`<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()`
`String`	`issuer()` The value of the `Issuer` element of the SAML assertion.
`String`	`nameQualifier()` A hash value based on the concatenation of the `Issuer` response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM.
`Integer`	`packedPolicySize()` A percentage value that indicates the size of the policy in packed form.
`static Class<? extends AssumeRoleWithSAMLResponse.Builder>`	`serializableBuilderClass()`
`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()` 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.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 identifiers for the temporary security credentials that the operation returns.
    
    Returns:
    
    The identifiers for the temporary security credentials that the operation returns.
  - 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.
  - subject
```
public 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 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 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 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 String nameQualifier()
```
    A hash value based on the concatenation of the Issuer response value, the AWS account ID, and 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 federated 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 Issuer response value, the AWS account ID, and 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 federated user.
    
    The following pseudocode shows how the hash value is calculated:
    
    BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )
  - toBuilder
```
public AssumeRoleWithSAMLResponse.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<AssumeRoleWithSAMLResponse.Builder,AssumeRoleWithSAMLResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static AssumeRoleWithSAMLResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AssumeRoleWithSAMLResponse.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

Class AssumeRoleWithSAMLResponse

Nested Class Summary

Method Summary

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField