Class AccessKey

java.lang.Object
software.amazon.awssdk.services.iam.model.AccessKey
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AccessKey.Builder,AccessKey>
@Generated("software.amazon.awssdk:codegen") public final class AccessKey extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AccessKey.Builder,AccessKey>

Contains information about an Amazon Web Services access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

See Also:

  • Method Details

    • userName

      public final String userName()

      The name of the IAM user that the access key is associated with.

      Returns:
      The name of the IAM user that the access key is associated with.

    • accessKeyId

      public final String accessKeyId()

      The ID for this access key.

      Returns:
      The ID for this access key.

    • status

      public final StatusType status()

      The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

      If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

      If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.
      See Also:

    • secretAccessKey

      public final String secretAccessKey()

      The secret key used to sign requests.

      Returns:
      The secret key used to sign requests.

    • createDate

      public final Instant createDate()

      The date when the access key was created.

      Returns:
      The date when the access key was created.

    • toBuilder

      public AccessKey.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<AccessKey.Builder,AccessKey>
      Returns:
      a builder for type T

    • builder

      public static AccessKey.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AccessKey.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

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