com.amazonaws.services.kms.model

Class ListRetirableGrantsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.ListRetirableGrantsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListRetirableGrantsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListRetirableGrants operation.

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

See Also:

AWSKMS.listRetirableGrants(ListRetirableGrantsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListRetirableGrantsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListRetirableGrantsRequest	clone()
boolean	equals(Object obj)
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.
String	getRetiringPrincipal() The retiring principal for which to list grants.
int	hashCode()
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.
void	setRetiringPrincipal(String retiringPrincipal) The retiring principal for which to list grants.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListRetirableGrantsRequest	withLimit(Integer limit) When paginating results, specify the maximum number of items to return in the response.
ListRetirableGrantsRequest	withMarker(String marker) Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results.
ListRetirableGrantsRequest	withRetiringPrincipal(String retiringPrincipal) The retiring principal for which to list grants.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ListRetirableGrantsRequest

public ListRetirableGrantsRequest()

Method Detail

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 100, inclusive. If you do not include a value, it defaults to 50.

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 100, inclusive. If you do not include a value, it defaults to 50.

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 100, inclusive. If you do not include a value, it defaults to 50.

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 100, inclusive. If you do not include a value, it defaults to 50.

withLimit

public ListRetirableGrantsRequest 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 100, inclusive. If you do not include a value, it defaults to 50.

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 100, inclusive. If you do not include a value, it defaults to 50.

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: [\u0020-\u00FF]*

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: [\u0020-\u00FF]*

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 ListRetirableGrantsRequest 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: [\u0020-\u00FF]*

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.

getRetiringPrincipal

public String getRetiringPrincipal()

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Constraints:
Length: 1 - 256

Returns:

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

setRetiringPrincipal

public void setRetiringPrincipal(String retiringPrincipal)

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Constraints:
Length: 1 - 256

Parameters:

retiringPrincipal - The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

withRetiringPrincipal

public ListRetirableGrantsRequest withRetiringPrincipal(String retiringPrincipal)

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

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

Constraints:
Length: 1 - 256

Parameters:

retiringPrincipal - The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

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

clone

public ListRetirableGrantsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest