com.amazonaws.services.kms.model

Class ListKeyPoliciesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.ListKeyPoliciesRequest

All Implemented Interfaces:

Serializable, Cloneable

public class ListKeyPoliciesRequest
extends AmazonWebServiceRequest
implements Serializable

Retrieves a list of policies attached to a key.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListKeyPoliciesRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getKeyId() A unique identifier for the customer master key (CMK).
Integer	getLimit() When paginating results, specify the maximum number of items to return in the response.
String	getMarker() Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.
int	hashCode()
void	setKeyId(String keyId) A unique identifier for the customer master key (CMK).
void	setLimit(Integer limit) When paginating results, specify the maximum number of items to return in the response.
void	setMarker(String marker) Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListKeyPoliciesRequest	withKeyId(String keyId) A unique identifier for the customer master key (CMK).
ListKeyPoliciesRequest	withLimit(Integer limit) When paginating results, specify the maximum number of items to return in the response.
ListKeyPoliciesRequest	withMarker(String marker) Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListKeyPoliciesRequest

public ListKeyPoliciesRequest()

Method Detail

getKeyId

public String getKeyId()

A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Constraints:
Length: 1 - 256

Returns:

A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

setKeyId

public void setKeyId(String keyId)

A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Constraints:
Length: 1 - 256

Parameters:

keyId -

A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

withKeyId

public ListKeyPoliciesRequest withKeyId(String keyId)

A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

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

Constraints:
Length: 1 - 256

Parameters:

keyId -

A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

• Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Returns:

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

getLimit

public Integer getLimit()

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

Currently only 1 policy can be attached to a key.

Constraints:
Range: 1 - 1000

Returns:

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

Currently only 1 policy can be attached to a key.

setLimit

public void setLimit(Integer limit)

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

Currently only 1 policy can be attached to a key.

Constraints:
Range: 1 - 1000

Parameters:

limit -

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

Currently only 1 policy can be attached to a key.

withLimit

public ListKeyPoliciesRequest withLimit(Integer limit)

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

Currently only 1 policy can be attached to a key.

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

Constraints:
Range: 1 - 1000

Parameters:

limit -

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

Currently only 1 policy can be attached to a key.

Returns:

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

getMarker

public String getMarker()

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

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

Returns:

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

setMarker

public void setMarker(String marker)

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

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

Parameters:

marker -

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

withMarker

public ListKeyPoliciesRequest withMarker(String marker)

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

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

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

Parameters:

marker -

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

Returns:

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

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