Class GetScopedCredentialsResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetScopedCredentialsResponse.Builder,GetScopedCredentialsResponse>

@Generated("software.amazon.awssdk:codegen") public final class GetScopedCredentialsResponse extends StsResponse implements 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.

  • Method Details

    • credentials

      public final Credentials 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

      public final ScopedSession 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

      public final Integer sessionTokenUtilization()
      Returns the value of the SessionTokenUtilization property for this object.
      Returns:
      The value of the SessionTokenUtilization property for this object.
    • sessionTokenSize

      public final Integer sessionTokenSize()
      Returns the value of the SessionTokenSize property for this object.
      Returns:
      The value of the SessionTokenSize property for this object.
    • scopedPoliciesCount

      public final Integer scopedPoliciesCount()

      GetScopedCredentials can be called recursively and ScopedPoliciesCount specifies 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 3 GetScopedCredentials scope-down policies, a subsequent GetScopedCredentials call that supplies a Policy (attempting to append a fourth scope-down policy) is denied.

      Returns:
      GetScopedCredentials can be called recursively and ScopedPoliciesCount specifies 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 3 GetScopedCredentials scope-down policies, a subsequent GetScopedCredentials call that supplies a Policy (attempting to append a fourth scope-down policy) is denied.
    • sourceIdentity

      public final String 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: 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<GetScopedCredentialsResponse.Builder,GetScopedCredentialsResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static GetScopedCredentialsResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends GetScopedCredentialsResponse.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      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
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.