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

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::ListRetirableGrantsRequest

Defined in:

gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #retiring_service_principal ⇒ String

  The retiring service 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, 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)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5376

class ListRetirableGrantsRequest < Struct.new(
  :limit,
  :marker,
  :retiring_principal,
  :retiring_service_principal)
  SENSITIVE = []
  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.

Returns:

• (String)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5376

class ListRetirableGrantsRequest < Struct.new(
  :limit,
  :marker,
  :retiring_principal,
  :retiring_service_principal)
  SENSITIVE = []
  include Aws::Structure
end

#retiring_principal ⇒ String

The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

You must specify either RetiringPrincipal or RetiringServicePrincipal, but not both.

Returns:

• (String)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5376

class ListRetirableGrantsRequest < Struct.new(
  :limit,
  :marker,
  :retiring_principal,
  :retiring_service_principal)
  SENSITIVE = []
  include Aws::Structure
end

#retiring_service_principal ⇒ String

The retiring service principal for which to list grants. This filter is only usable by callers in a service principal.

You must specify either RetiringPrincipal or RetiringServicePrincipal, but not both.

Returns:

• (String)

# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 5376

class ListRetirableGrantsRequest < Struct.new(
  :limit,
  :marker,
  :retiring_principal,
  :retiring_service_principal)
  SENSITIVE = []
  include Aws::Structure
end