Package software.amazon.awssdk.services.iam.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessKey.Builder

Method Summary

Modifier and Type	Method	Description
String	accessKeyId()	The ID for this access key.
static AccessKey.Builder	builder()
Instant	createDate()	The date when the access key was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
String	secretAccessKey()	The secret key used to sign requests.
static Class<? extends AccessKey.Builder>	serializableBuilderClass()
StatusType	status()	The status of the access key.
String	statusAsString()	The status of the access key.
AccessKey.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The name of the IAM user that the access key is associated with.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

StatusType

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:

StatusType

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

Specified by:

toBuilder in interface ToCopyableBuilder<AccessKey.Builder,AccessKey>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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