ListGrantsRequest (AWS SDK for Android

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

All Implemented Interfaces:

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

You must specify the CMK in all requests. You can filter the grant list by grant ID or grantee principal.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

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

Required permissions: kms:ListGrants (key policy)

Related operations:
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(java.lang.Object obj)`
`java.lang.String`	`getGranteePrincipal()` Returns only grants where the specified principal is the grantee principal for the grant.
`java.lang.String`	`getGrantId()` Returns only the grant with the specified grant ID.
`java.lang.String`	`getKeyId()` Returns only grants for the specified customer master key (CMK).
`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`	`setGranteePrincipal(java.lang.String granteePrincipal)` Returns only grants where the specified principal is the grantee principal for the grant.
`void`	`setGrantId(java.lang.String grantId)` Returns only the grant with the specified grant ID.
`void`	`setKeyId(java.lang.String keyId)` Returns only grants for the specified customer master key (CMK).
`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.
`ListGrantsRequest`	`withGranteePrincipal(java.lang.String granteePrincipal)` Returns only grants where the specified principal is the grantee principal for the grant.
`ListGrantsRequest`	`withGrantId(java.lang.String grantId)` Returns only the grant with the specified grant ID.
`ListGrantsRequest`	`withKeyId(java.lang.String keyId)` Returns only grants for the specified customer master key (CMK).
`ListGrantsRequest`	`withLimit(java.lang.Integer limit)` Use this parameter to specify the maximum number of items to return.
`ListGrantsRequest`	`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
  - ListGrantsRequest
```
public ListGrantsRequest()
```
- 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 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(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 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(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 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 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 ListGrantsRequest 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.
  - getKeyId
```
public java.lang.String getKeyId()
```
    Returns only grants for the specified customer master key (CMK). This parameter is required.
    
    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:
    Returns only grants for the specified customer master key (CMK). This parameter is required.
    
    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(java.lang.String keyId)
```
    Returns only grants for the specified customer master key (CMK). This parameter is required.
    
    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 -
    Returns only grants for the specified customer master key (CMK). This parameter is required.
    
    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(java.lang.String keyId)
```
    Returns only grants for the specified customer master key (CMK). This parameter is required.
    
    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 -
    Returns only grants for the specified customer master key (CMK). This parameter is required.
    
    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.
  - getGrantId
```
public java.lang.String getGrantId()
```
    Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
    
    Constraints:
    Length: 1 - 128
    
    Returns:
    
    Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
  - setGrantId
```
public void setGrantId(java.lang.String grantId)
```
    Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
    
    Constraints:
    Length: 1 - 128
    
    Parameters:
    
    grantId -
    Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
  - withGrantId
```
public ListGrantsRequest withGrantId(java.lang.String grantId)
```
    Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    
    Parameters:
    
    grantId -
    Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getGranteePrincipal
```
public java.lang.String getGranteePrincipal()
```
    Returns only grants where the specified principal is the grantee principal for the grant.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^[\w+=,.@:/-]+$
    
    Returns:
    
    Returns only grants where the specified principal is the grantee principal for the grant.
  - setGranteePrincipal
```
public void setGranteePrincipal(java.lang.String granteePrincipal)
```
    Returns only grants where the specified principal is the grantee principal for the grant.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^[\w+=,.@:/-]+$
    
    Parameters:
    
    granteePrincipal -
    Returns only grants where the specified principal is the grantee principal for the grant.
  - withGranteePrincipal
```
public ListGrantsRequest withGranteePrincipal(java.lang.String granteePrincipal)
```
    Returns only grants where the specified principal is the grantee principal for the grant.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: ^[\w+=,.@:/-]+$
    
    Parameters:
    
    granteePrincipal -
    Returns only grants where the specified principal is the grantee principal for the grant.
    
    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

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

getGrantId

setGrantId

withGrantId

getGranteePrincipal

setGranteePrincipal

withGranteePrincipal

toString

hashCode

equals