software.amazon.awssdk.services.iam.model

Class UpdateAccessKeyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iam.model.IamRequest

software.amazon.awssdk.services.iam.model.UpdateAccessKeyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAccessKeyRequest.Builder,UpdateAccessKeyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateAccessKeyRequest
extends IamRequest
implements ToCopyableBuilder<UpdateAccessKeyRequest.Builder,UpdateAccessKeyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateAccessKeyRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accessKeyId() The access key ID of the secret access key you want to update.
static UpdateAccessKeyRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAccessKeyRequest.Builder>	serializableBuilderClass()
StatusType	status() The status you want to assign to the secret access key.
String	statusAsString() The status you want to assign to the secret access key.
UpdateAccessKeyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userName() The name of the user whose key you want to update.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

userName

public String userName()

The name of the user whose key you want to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Returns:

The name of the user whose key you want to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

accessKeyId

public String accessKeyId()

The access key ID of the secret access key you want to update.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Returns:

The access key ID of the secret access key you want to update.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

status

public StatusType status()

The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

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 you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

See Also:

StatusType

statusAsString

public String statusAsString()

The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

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 you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

See Also:

StatusType

toBuilder

public UpdateAccessKeyRequest.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<UpdateAccessKeyRequest.Builder,UpdateAccessKeyRequest>

Specified by:

toBuilder in class IamRequest

Returns:

a builder for type T

builder

public static UpdateAccessKeyRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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