Class: Aws::KMS::Types::ListRetirableGrantsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

Note:

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

Instance Attribute Details

#limitInteger

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:

  • (Integer)


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

#markerString

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:

  • (String)


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_principalString

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

Returns:

  • (String)


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