« blib/lib/Paws/SES/PutConfigurationSetDeliveryOptionsResponse.pm
↑ Summary
blib/lib/Paws/SES/PutIdentityPolicyResponse.pm »
| 1 | |||
| 2 | package Paws::SES::PutIdentityPolicy; | ||
| 3 | use Moose; | ||
| 4 | has Identity => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Policy => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has PolicyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutIdentityPolicy'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SES::PutIdentityPolicyResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'PutIdentityPolicyResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SES::PutIdentityPolicy - Arguments for method PutIdentityPolicy on L<Paws::SES> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PutIdentityPolicy on the | ||
| 24 | L<Amazon Simple Email Service|Paws::SES> service. Use the attributes of this class | ||
| 25 | as arguments to method PutIdentityPolicy. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutIdentityPolicy. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $email = Paws->service('SES'); | ||
| 32 | # PutIdentityPolicy | ||
| 33 | # The following example adds a sending authorization policy to an identity: | ||
| 34 | my $PutIdentityPolicyResponse = $email->PutIdentityPolicy( | ||
| 35 | 'Identity' => 'example.com', | ||
| 36 | 'Policy' => | ||
| 37 | '{"Version":"2008-10-17","Statement":[{"Sid":"stmt1469123904194","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789012:root"},"Action":["ses:SendEmail","ses:SendRawEmail"],"Resource":"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com"}]}', | ||
| 38 | 'PolicyName' => 'MyPolicy' | ||
| 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/email/PutIdentityPolicy> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> Identity => Str | ||
| 49 | |||
| 50 | The identity that the policy will apply to. You can specify an identity | ||
| 51 | by using its name or by using its Amazon Resource Name (ARN). Examples: | ||
| 52 | C<user@example.com>, C<example.com>, | ||
| 53 | C<arn:aws:ses:us-east-1:123456789012:identity/example.com>. | ||
| 54 | |||
| 55 | To successfully call this API, you must own the identity. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> Policy => Str | ||
| 60 | |||
| 61 | The text of the policy in JSON format. The policy cannot exceed 4 KB. | ||
| 62 | |||
| 63 | For information about the syntax of sending authorization policies, see | ||
| 64 | the Amazon SES Developer Guide | ||
| 65 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html). | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> PolicyName => Str | ||
| 70 | |||
| 71 | The name of the policy. | ||
| 72 | |||
| 73 | The policy name cannot exceed 64 characters and can only include | ||
| 74 | alphanumeric characters, dashes, and underscores. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, documenting arguments for method PutIdentityPolicy in L<Paws::SES> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |