NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $kms = Paws->service('KMS');
    # To retrieve a key policy
    # The following example retrieves the key policy for the specified customer
    # master key (CMK).
    my $GetKeyPolicyResponse = $kms->GetKeyPolicy(
      {
        'KeyId'      => '1234abcd-12ab-34cd-56ef-1234567890ab',
        'PolicyName' => 'default'
      }
    );

    # Results:
    my $Policy = $GetKeyPolicyResponse->Policy;

    # Returns a L<Paws::KMS::GetKeyPolicyResponse> 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/GetKeyPolicy

ATTRIBUTES

REQUIRED KeyId => Str

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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.

REQUIRED PolicyName => Str

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetKeyPolicy 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