You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::KMS::Types::ListRetirableGrantsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::ListRetirableGrantsRequest
- Defined in:
- (unknown)
Overview
When passing ListRetirableGrantsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
limit: 1,
marker: "MarkerType",
retiring_principal: "PrincipalIdType", # required
}
Instance Attribute Summary collapse
-
#limit ⇒ Integer
Use this parameter to specify the maximum number of items to return.
-
#marker ⇒ String
Use this parameter in a subsequent request after you receive a response with truncated results.
-
#retiring_principal ⇒ String
The retiring principal for which to list grants.
Instance Attribute Details
#limit ⇒ Integer
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.
#marker ⇒ String
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.
#retiring_principal ⇒ String
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, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.