ListRetirableGrantsRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class ListRetirableGrantsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Returns all grants in which the specified principal is the RetiringPrincipal in the grant.

You can specify any principal in your AWS account. The grants that are returned include grants for CMKs in your AWS account and other AWS accounts.

You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.

Cross-account use: You must specify a principal in your AWS account. However, this operation can return grants in any AWS account. You do not need kms:ListRetirableGrants permission (or any other additional permission) in any AWS account other than your own.

Required permissions: kms:ListRetirableGrants (IAM policy) in your AWS account.

Related operations:
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListRetirableGrantsRequest()

Constructors
Constructor and Description
`ListRetirableGrantsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`java.lang.String`	`getRetiringPrincipal()` The retiring principal for which to list grants.
`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.
`void`	`setRetiringPrincipal(java.lang.String retiringPrincipal)` The retiring principal for which to list grants.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListRetirableGrantsRequest`	`withLimit(java.lang.Integer limit)` Use this parameter to specify the maximum number of items to return.
`ListRetirableGrantsRequest`	`withMarker(java.lang.String marker)` Use this parameter in a subsequent request after you receive a response with truncated results.
`ListRetirableGrantsRequest`	`withRetiringPrincipal(java.lang.String retiringPrincipal)` The retiring principal for which to list grants.

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
  - ListRetirableGrantsRequest
```
public ListRetirableGrantsRequest()
```
- 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 ListRetirableGrantsRequest 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 ListRetirableGrantsRequest 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.
  - getRetiringPrincipal
```
public java.lang.String getRetiringPrincipal()
```
    The retiring principal for which to list grants. Enter a principal in your AWS account.
    
    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, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^[\w+=,.@:/-]+$
    
    Returns:
    
    The retiring principal for which to list grants. Enter a principal in your AWS account.
    
    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, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
  - setRetiringPrincipal
```
public void setRetiringPrincipal(java.lang.String retiringPrincipal)
```
    The retiring principal for which to list grants. Enter a principal in your AWS account.
    
    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, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^[\w+=,.@:/-]+$
    
    Parameters:
    
    retiringPrincipal -
    The retiring principal for which to list grants. Enter a principal in your AWS account.
    
    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, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
  - withRetiringPrincipal
```
public ListRetirableGrantsRequest withRetiringPrincipal(java.lang.String retiringPrincipal)
```
    The retiring principal for which to list grants. Enter a principal in your AWS account.
    
    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, see 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
    Pattern: ^[\w+=,.@:/-]+$
    
    Parameters:
    
    retiringPrincipal -
    The retiring principal for which to list grants. Enter a principal in your AWS account.
    
    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, see 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 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 ListRetirableGrantsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListRetirableGrantsRequest

Method Detail

getLimit

setLimit

withLimit

getMarker

setMarker

withMarker

getRetiringPrincipal

setRetiringPrincipal

withRetiringPrincipal

toString

hashCode

equals