Class: Aws::KMS::Types::ListRetirableGrantsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::KMS::Types::ListRetirableGrantsRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kms/types.rb
Overview
When making an API call, you may pass ListRetirableGrantsRequest data as a 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.
2314 2315 2316 2317 2318 2319 |
# File 'lib/aws-sdk-kms/types.rb', line 2314 class ListRetirableGrantsRequest < Struct.new( :limit, :marker, :retiring_principal) include Aws::Structure end |
#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.
2314 2315 2316 2317 2318 2319 |
# File 'lib/aws-sdk-kms/types.rb', line 2314 class ListRetirableGrantsRequest < Struct.new( :limit, :marker, :retiring_principal) include Aws::Structure end |
#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*.
[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
2314 2315 2316 2317 2318 2319 |
# File 'lib/aws-sdk-kms/types.rb', line 2314 class ListRetirableGrantsRequest < Struct.new( :limit, :marker, :retiring_principal) include Aws::Structure end |