Class GetScopedCredentialsResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetScopedCredentialsResponse.Builder,GetScopedCredentialsResponse>
Contains the response to a successful GetScopedCredentials request, including the scoped-down temporary Amazon Web Services credentials and metadata about the resulting session.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final CredentialsThe temporary security credentials for the scoped down session, which include an access key ID, a secret access key, and a security token.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse.final inthashCode()final IntegerGetScopedCredentialscan be called recursively andScopedPoliciesCountspecifies the number of scope down policies applied to the session.static Class<? extends GetScopedCredentialsResponse.Builder> final ScopedSessionMetadata about the resulting scoped session, including its identifier and ARN.final IntegerReturns the value of the SessionTokenSize property for this object.final IntegerReturns the value of the SessionTokenUtilization property for this object.final StringThe source identity of the calling session, carried forward unchanged.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.sts.model.StsResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
credentials
The temporary security credentials for the scoped down session, 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 for the scoped down session, 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.
-
sessionInfo
Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.
- Returns:
- Metadata about the resulting scoped session, including its identifier and ARN. Because the identity does not change, the identifiers reflect the same principal and session name as the calling session.
-
sessionTokenUtilization
Returns the value of the SessionTokenUtilization property for this object.- Returns:
- The value of the SessionTokenUtilization property for this object.
-
sessionTokenSize
Returns the value of the SessionTokenSize property for this object.- Returns:
- The value of the SessionTokenSize property for this object.
-
scopedPoliciesCount
GetScopedCredentialscan be called recursively andScopedPoliciesCountspecifies the number of scope down policies applied to the session. Each recursive call adds another scope down policy layer. A maximum of 3 scope down policy layers are allowed per session. If a session already has 3GetScopedCredentialsscope-down policies, a subsequentGetScopedCredentialscall that supplies aPolicy(attempting to append a fourth scope-down policy) is denied.- Returns:
GetScopedCredentialscan be called recursively andScopedPoliciesCountspecifies the number of scope down policies applied to the session. Each recursive call adds another scope down policy layer. A maximum of 3 scope down policy layers are allowed per session. If a session already has 3GetScopedCredentialsscope-down policies, a subsequentGetScopedCredentialscall that supplies aPolicy(attempting to append a fourth scope-down policy) is denied.
-
sourceIdentity
The source identity of the calling session, carried forward unchanged. This operation never sets or modifies the source identity; it reflects the value established when the source identity was first set. For more information, see Monitor and control actions taken with assumed roles in the IAM User Guide.
- Returns:
- The source identity of the calling session, carried forward unchanged. This operation never sets or modifies the source identity; it reflects the value established when the source identity was first set. For more information, see Monitor and control actions taken with assumed roles in the IAM User Guide.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetScopedCredentialsResponse.Builder,GetScopedCredentialsResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. 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, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- 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
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-