com.amazonaws.services.identitymanagement.model

Class UpdateAccessKeyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.UpdateAccessKeyRequest

All Implemented Interfaces:

Serializable

public class UpdateAccessKeyRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateAccessKey operation.

Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, this API can be used to manage root credentials even if the AWS account has no associated users.

For information about rotating keys, see Managing Keys and Certificates in the Using IAM guide.

See Also:

AmazonIdentityManagement.updateAccessKey(UpdateAccessKeyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateAccessKeyRequest() Default constructor for a new UpdateAccessKeyRequest object.
UpdateAccessKeyRequest(String accessKeyId, StatusType status) Constructs a new UpdateAccessKeyRequest object.
UpdateAccessKeyRequest(String accessKeyId, String status) Constructs a new UpdateAccessKeyRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessKeyId() The access key ID of the secret access key you want to update.
String	getStatus() The status you want to assign to the secret access key.
String	getUserName() Name of the user whose key you want to update.
int	hashCode()
void	setAccessKeyId(String accessKeyId) The access key ID of the secret access key you want to update.
void	setStatus(StatusType status) The status you want to assign to the secret access key.
void	setStatus(String status) The status you want to assign to the secret access key.
void	setUserName(String userName) Name of the user whose key you want to update.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateAccessKeyRequest	withAccessKeyId(String accessKeyId) The access key ID of the secret access key you want to update.
UpdateAccessKeyRequest	withStatus(StatusType status) The status you want to assign to the secret access key.
UpdateAccessKeyRequest	withStatus(String status) The status you want to assign to the secret access key.
UpdateAccessKeyRequest	withUserName(String userName) Name of the user whose key you want to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateAccessKeyRequest

public UpdateAccessKeyRequest()

Default constructor for a new UpdateAccessKeyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

UpdateAccessKeyRequest

public UpdateAccessKeyRequest(String accessKeyId,
                      String status)

Constructs a new UpdateAccessKeyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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

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

UpdateAccessKeyRequest

public UpdateAccessKeyRequest(String accessKeyId,
                      StatusType status)

Constructs a new UpdateAccessKeyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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

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

Method Detail

getUserName

public String getUserName()

Name of the user whose key you want to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Returns:

Name of the user whose key you want to update.

setUserName

public void setUserName(String userName)

Name of the user whose key you want to update.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

userName - Name of the user whose key you want to update.

withUserName

public UpdateAccessKeyRequest withUserName(String userName)

Name of the user whose key you want to update.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

userName - Name of the user whose key you want to update.

Returns:

A reference to this updated object so that method calls can be chained together.

getAccessKeyId

public String getAccessKeyId()

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

Constraints:
Length: 16 - 32
Pattern: [\w]*

Returns:

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

setAccessKeyId

public void setAccessKeyId(String accessKeyId)

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

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

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

withAccessKeyId

public UpdateAccessKeyRequest withAccessKeyId(String accessKeyId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getStatus

public String getStatus()

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

Constraints:
Allowed Values: Active, Inactive

Returns:

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

See Also:

StatusType

setStatus

public void setStatus(String status)

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

Constraints:
Allowed Values: Active, Inactive

Parameters:

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

See Also:

StatusType

withStatus

public UpdateAccessKeyRequest withStatus(String status)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Active, Inactive

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StatusType

setStatus

public void setStatus(StatusType status)

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

Constraints:
Allowed Values: Active, Inactive

Parameters:

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

See Also:

StatusType

withStatus

public UpdateAccessKeyRequest withStatus(StatusType status)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Active, Inactive

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StatusType

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object