/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::KMS::ListGrants

NAME

Paws::KMS::ListGrants - Arguments for method ListGrants on Paws::KMS

DESCRIPTION

This class represents the parameters used for calling the method ListGrants on the AWS Key Management Service service. Use the attributes of this class as arguments to method ListGrants.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGrants.

SYNOPSIS

my $kms = Paws->service('KMS');
# To list grants for a customer master key (CMK)
# The following example lists grants for the specified CMK.
my $ListGrantsResponse =
  $kms->ListGrants( 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' );

# Results:
my $Grants    = $ListGrantsResponse->Grants;
my $Truncated = $ListGrantsResponse->Truncated;

# Returns a L<Paws::KMS::ListGrantsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kms/ListGrants

ATTRIBUTES

GranteePrincipal => Str

Returns only grants where the specified principal is the grantee principal for the grant.

GrantId => Str

Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.

REQUIRED KeyId => Str

Returns only grants for the specified customer master key (CMK). This parameter is required.

Specify the key ID or key ARN of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Limit => Int

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 => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListGrants in Paws::KMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues