com.amazonaws.services.kms.model

Class ListKeysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.ListKeysRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListKeysRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:ListKeys (IAM policy)

Related operations:

• CreateKey

• DescribeKey

• ListAliases

• ListResourceTags

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListKeysRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getLimit() Use this parameter to specify the maximum number of items to return.
java.lang.String	getMarker() Use this parameter in a subsequent request after you receive a response with truncated results.
int	hashCode()
void	setLimit(java.lang.Integer limit) Use this parameter to specify the maximum number of items to return.
void	setMarker(java.lang.String marker) Use this parameter in a subsequent request after you receive a response with truncated results.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListKeysRequest	withLimit(java.lang.Integer limit) Use this parameter to specify the maximum number of items to return.
ListKeysRequest	withMarker(java.lang.String marker) Use this parameter in a subsequent request after you receive a response with truncated results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListKeysRequest

public ListKeysRequest()

Method Detail

getLimit

public java.lang.Integer getLimit()

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Constraints:
Range: 1 - 1000

Returns:

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

setLimit

public void setLimit(java.lang.Integer limit)

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Constraints:
Range: 1 - 1000

Parameters:

limit -

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

withLimit

public ListKeysRequest withLimit(java.lang.Integer limit)

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

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

Constraints:
Range: 1 - 1000

Parameters:

limit -

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Returns:

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

getMarker

public java.lang.String getMarker()

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Returns:

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

setMarker

public void setMarker(java.lang.String marker)

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Parameters:

marker -

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

withMarker

public ListKeysRequest withMarker(java.lang.String marker)

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

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

Constraints:
Length: 1 - 1024
Pattern: [ -ÿ]*

Parameters:

marker -

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object