« blib/lib/Paws/KMS/UpdateCustomKeyStoreResponse.pm
↑ Summary
blib/lib/Paws/KMS/UpdatePrimaryRegion.pm »
| 1 | |||
| 2 | package Paws::KMS::UpdateKeyDescription; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateKeyDescription'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::KMS::UpdateKeyDescription - Arguments for method UpdateKeyDescription on L<Paws::KMS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method UpdateKeyDescription on the | ||
| 23 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 24 | as arguments to method UpdateKeyDescription. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateKeyDescription. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kms = Paws->service('KMS'); | ||
| 31 | # To update the description of a customer master key (CMK) | ||
| 32 | # The following example updates the description of the specified CMK. | ||
| 33 | $kms->UpdateKeyDescription( | ||
| 34 | 'Description' => | ||
| 35 | 'Example description that indicates the intended use of this CMK.', | ||
| 36 | 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' | ||
| 37 | ); | ||
| 38 | |||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/UpdateKeyDescription> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> Description => Str | ||
| 47 | |||
| 48 | New description for the CMK. | ||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> KeyId => Str | ||
| 53 | |||
| 54 | Updates the description of the specified customer master key (CMK). | ||
| 55 | |||
| 56 | Specify the key ID or key ARN of the CMK. | ||
| 57 | |||
| 58 | For example: | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | Key ARN: | ||
| 69 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 70 | |||
| 71 | =back | ||
| 72 | |||
| 73 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method UpdateKeyDescription in L<Paws::KMS> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |