@Generated(value="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 AWS credentials that can be used to make AWS requests.
Modifier and Type | Class and Description |
---|---|
static interface |
AssumeRoleWithSamlResponse.Builder |
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) |
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
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 packed size of the session policies and session tags combined passed in the
request.
|
List<SdkField<?>> |
sdkFields() |
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() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public 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.
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.
public AssumedRoleUser assumedRoleUser()
The identifiers for the temporary security credentials that the operation returns.
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.
public String subject()
The value of the NameID
element in the Subject
element of the SAML assertion.
NameID
element in the Subject
element of the SAML assertion.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.
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.
public String issuer()
The value of the Issuer
element of the SAML assertion.
Issuer
element of the SAML assertion.public String audience()
The value of the Recipient
attribute of the SubjectConfirmationData
element of the SAML
assertion.
Recipient
attribute of the SubjectConfirmationData
element of
the SAML assertion.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" ) )
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" ) )
public AssumeRoleWithSamlResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<AssumeRoleWithSamlResponse.Builder,AssumeRoleWithSamlResponse>
toBuilder
in class AwsResponse
public static AssumeRoleWithSamlResponse.Builder builder()
public static Class<? extends AssumeRoleWithSamlResponse.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsResponse
public boolean equals(Object obj)
equals
in class AwsResponse
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2020. All rights reserved.