| 1 | |||
| 2 | package Paws::KMS::RetireGrant; | ||
| 3 | use Moose; | ||
| 4 | has GrantId => (is => 'ro', isa => 'Str'); | ||
| 5 | has GrantToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has KeyId => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RetireGrant'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::KMS::RetireGrant - Arguments for method RetireGrant on L<Paws::KMS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method RetireGrant on the | ||
| 24 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 25 | as arguments to method RetireGrant. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RetireGrant. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kms = Paws->service('KMS'); | ||
| 32 | # To retire a grant | ||
| 33 | # The following example retires a grant. | ||
| 34 | $kms->RetireGrant( | ||
| 35 | 'GrantId' => | ||
| 36 | '0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60', | ||
| 37 | 'KeyId' => | ||
| 38 | 'arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab' | ||
| 39 | ); | ||
| 40 | |||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/RetireGrant> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 GrantId => Str | ||
| 49 | |||
| 50 | Identifies the grant to retire. To get the grant ID, use CreateGrant, | ||
| 51 | ListGrants, or ListRetirableGrants. | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | Grant ID Example - | ||
| 58 | 0123456789012345678901234567890123456789012345678901234567890123 | ||
| 59 | |||
| 60 | =back | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 GrantToken => Str | ||
| 66 | |||
| 67 | Identifies the grant to be retired. You can use a grant token to | ||
| 68 | identify a new grant even before it has achieved eventual consistency. | ||
| 69 | |||
| 70 | Only the CreateGrant operation returns a grant token. For details, see | ||
| 71 | Grant token | ||
| 72 | (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token) | ||
| 73 | and Eventual consistency | ||
| 74 | (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency) | ||
| 75 | in the I<AWS Key Management Service Developer Guide>. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 KeyId => Str | ||
| 80 | |||
| 81 | The key ARN CMK associated with the grant. To find the key ARN, use the | ||
| 82 | ListKeys operation. | ||
| 83 | |||
| 84 | For example: | ||
| 85 | C<arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method RetireGrant in L<Paws::KMS> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |