« blib/lib/Paws/SESv2/CreateDeliverabilityTestReportResponse.pm
↑ Summary
blib/lib/Paws/SESv2/CreateEmailIdentityPolicy.pm »
| 1 | |||
| 2 | package Paws::SESv2::CreateEmailIdentity; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSetName => (is => 'ro', isa => 'Str'); | ||
| 5 | has DkimSigningAttributes => (is => 'ro', isa => 'Paws::SESv2::DkimSigningAttributes'); | ||
| 6 | has EmailIdentity => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SESv2::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateEmailIdentity'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/identities'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::CreateEmailIdentityResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::SESv2::CreateEmailIdentity - Arguments for method CreateEmailIdentity on L<Paws::SESv2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateEmailIdentity on the | ||
| 26 | L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateEmailIdentity. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEmailIdentity. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $email = Paws->service('SESv2'); | ||
| 34 | my $CreateEmailIdentityResponse = $email->CreateEmailIdentity( | ||
| 35 | EmailIdentity => 'MyIdentity', | ||
| 36 | ConfigurationSetName => 'MyConfigurationSetName', # OPTIONAL | ||
| 37 | DkimSigningAttributes => { | ||
| 38 | DomainSigningPrivateKey => 'MyPrivateKey', # min: 1, max: 20480 | ||
| 39 | DomainSigningSelector => 'MySelector', # min: 1, max: 63 | ||
| 40 | |||
| 41 | }, # OPTIONAL | ||
| 42 | Tags => [ | ||
| 43 | { | ||
| 44 | Key => 'MyTagKey', | ||
| 45 | Value => 'MyTagValue', | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $DkimAttributes = $CreateEmailIdentityResponse->DkimAttributes; | ||
| 54 | my $IdentityType = $CreateEmailIdentityResponse->IdentityType; | ||
| 55 | my $VerifiedForSendingStatus = | ||
| 56 | $CreateEmailIdentityResponse->VerifiedForSendingStatus; | ||
| 57 | |||
| 58 | # Returns a L<Paws::SESv2::CreateEmailIdentityResponse> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/CreateEmailIdentity> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ConfigurationSetName => Str | ||
| 67 | |||
| 68 | The configuration set to use by default when sending from this | ||
| 69 | identity. Note that any configuration set defined in the email sending | ||
| 70 | request takes precedence. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 DkimSigningAttributes => L<Paws::SESv2::DkimSigningAttributes> | ||
| 75 | |||
| 76 | If your request includes this object, Amazon SES configures the | ||
| 77 | identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication | ||
| 78 | purposes, as opposed to the default method, Easy DKIM | ||
| 79 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). | ||
| 80 | |||
| 81 | You can only specify this object if the email identity is a domain, as | ||
| 82 | opposed to an address. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> EmailIdentity => Str | ||
| 87 | |||
| 88 | The email address or domain that you want to verify. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Tags => ArrayRef[L<Paws::SESv2::Tag>] | ||
| 93 | |||
| 94 | An array of objects that define the tags (keys and values) that you | ||
| 95 | want to associate with the email identity. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, documenting arguments for method CreateEmailIdentity in L<Paws::SESv2> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |