« blib/lib/Paws/CognitoIdp/UsernameConfigurationType.pm
↑ Summary
blib/lib/Paws/CognitoIdp/VerifySoftwareToken.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CognitoIdp::VerificationMessageTemplateType; | ||
| 3 | use Moose; | ||
| 4 | has DefaultEmailOption => (is => 'ro', isa => 'Str'); | ||
| 5 | has EmailMessage => (is => 'ro', isa => 'Str'); | ||
| 6 | has EmailMessageByLink => (is => 'ro', isa => 'Str'); | ||
| 7 | has EmailSubject => (is => 'ro', isa => 'Str'); | ||
| 8 | has EmailSubjectByLink => (is => 'ro', isa => 'Str'); | ||
| 9 | has SmsMessage => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CognitoIdp::VerificationMessageTemplateType | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CognitoIdp::VerificationMessageTemplateType object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { DefaultEmailOption => $value, ..., SmsMessage => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoIdp::VerificationMessageTemplateType object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->DefaultEmailOption | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The template for verification messages. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 DefaultEmailOption => Str | ||
| 47 | |||
| 48 | The default email option. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 EmailMessage => Str | ||
| 52 | |||
| 53 | The email message template. EmailMessage is allowed only if | ||
| 54 | EmailSendingAccount | ||
| 55 | (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) | ||
| 56 | is DEVELOPER. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 EmailMessageByLink => Str | ||
| 60 | |||
| 61 | The email message template for sending a confirmation link to the user. | ||
| 62 | EmailMessageByLink is allowed only if EmailSendingAccount | ||
| 63 | (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) | ||
| 64 | is DEVELOPER. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 EmailSubject => Str | ||
| 68 | |||
| 69 | The subject line for the email message template. EmailSubject is | ||
| 70 | allowed only if EmailSendingAccount | ||
| 71 | (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) | ||
| 72 | is DEVELOPER. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 EmailSubjectByLink => Str | ||
| 76 | |||
| 77 | The subject line for the email message template for sending a | ||
| 78 | confirmation link to the user. EmailSubjectByLink is allowed only | ||
| 79 | EmailSendingAccount | ||
| 80 | (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount) | ||
| 81 | is DEVELOPER. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 SmsMessage => Str | ||
| 85 | |||
| 86 | The SMS message template. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, describing an object used in L<Paws::CognitoIdp> | ||
| 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 |