ListGrantsRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.ListGrantsRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class ListGrantsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Gets a list of all grants for the specified customer master key (CMK).

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListGrantsRequest()

Constructors
Constructor and Description
`ListGrantsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getKeyId()` A unique identifier for the customer master key (CMK).
`Integer`	`getLimit()` Use this parameter to specify the maximum number of items to return.
`String`	`getMarker()` Use this parameter 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)` Use this parameter to specify the maximum number of items to return.
`void`	`setMarker(String marker)` Use this parameter 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.
`ListGrantsRequest`	`withKeyId(String keyId)` A unique identifier for the customer master key (CMK).
`ListGrantsRequest`	`withLimit(Integer limit)` Use this parameter to specify the maximum number of items to return.
`ListGrantsRequest`	`withMarker(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, 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
  - ListGrantsRequest
```
public ListGrantsRequest()
```
- Method Detail
  - getLimit
```
public 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 100, inclusive. If you do not include a value, it defaults to 50.
    
    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 100, inclusive. If you do not include a value, it defaults to 50.
  - setLimit
```
public void setLimit(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 100, inclusive. If you do not include a value, it defaults to 50.
    
    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 100, inclusive. If you do not include a value, it defaults to 50.
  - withLimit
```
public ListGrantsRequest withLimit(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 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 -
    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 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 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(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 ListGrantsRequest withMarker(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.
  - getKeyId
```
public String getKeyId()
```
    A unique identifier for the customer master key (CMK).
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    
    Constraints:
    Length: 1 - 2048
    Returns:
    A unique identifier for the customer master key (CMK).
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
  - setKeyId
```
public void setKeyId(String keyId)
```
    A unique identifier for the customer master key (CMK).
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    A unique identifier for the customer master key (CMK).
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
  - withKeyId
```
public ListGrantsRequest withKeyId(String keyId)
```
    A unique identifier for the customer master key (CMK).
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
    
    For example:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    A unique identifier for the customer master key (CMK).
    
    Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
    
    For example:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    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

Class ListGrantsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListGrantsRequest

Method Detail

getLimit

setLimit

withLimit

getMarker

setMarker

withMarker

getKeyId

setKeyId

withKeyId

toString

hashCode

equals