« blib/lib/Paws/Pinpoint/UpdateSmsChannelResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/UpdateSmsTemplateResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::UpdateSmsTemplate; | ||
| 3 | use Moose; | ||
| 4 | has CreateNewVersion => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'create-new-version'); | ||
| 5 | has SMSTemplateRequest => (is => 'ro', isa => 'Paws::Pinpoint::SMSTemplateRequest', required => 1); | ||
| 6 | has TemplateName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'template-name', required => 1); | ||
| 7 | has Version => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'version'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | class_has _stream_param => (is => 'ro', default => 'SMSTemplateRequest'); | ||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateSmsTemplate'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/templates/{template-name}/sms'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::UpdateSmsTemplateResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Pinpoint::UpdateSmsTemplate - Arguments for method UpdateSmsTemplate on L<Paws::Pinpoint> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateSmsTemplate on the | ||
| 26 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateSmsTemplate. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateSmsTemplate. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 34 | my $UpdateSmsTemplateResponse = $pinpoint->UpdateSmsTemplate( | ||
| 35 | SMSTemplateRequest => { | ||
| 36 | Body => 'My__string', # OPTIONAL | ||
| 37 | DefaultSubstitutions => 'My__string', # OPTIONAL | ||
| 38 | RecommenderId => 'My__string', # OPTIONAL | ||
| 39 | Tags => { | ||
| 40 | 'My__string' => 'My__string', # key: OPTIONAL, value: OPTIONAL | ||
| 41 | }, # OPTIONAL | ||
| 42 | TemplateDescription => 'My__string', # OPTIONAL | ||
| 43 | }, | ||
| 44 | TemplateName => 'My__string', | ||
| 45 | CreateNewVersion => 1, # OPTIONAL | ||
| 46 | Version => 'My__string', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $MessageBody = $UpdateSmsTemplateResponse->MessageBody; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Pinpoint::UpdateSmsTemplateResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/UpdateSmsTemplate> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 CreateNewVersion => Bool | ||
| 61 | |||
| 62 | Specifies whether to save the updates as a new version of the message | ||
| 63 | template. Valid values are: true, save the updates as a new version; | ||
| 64 | and, false, save the updates to (overwrite) the latest existing version | ||
| 65 | of the template. | ||
| 66 | |||
| 67 | If you don't specify a value for this parameter, Amazon Pinpoint saves | ||
| 68 | the updates to (overwrites) the latest existing version of the | ||
| 69 | template. If you specify a value of true for this parameter, don't | ||
| 70 | specify a value for the version parameter. Otherwise, an error will | ||
| 71 | occur. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> SMSTemplateRequest => L<Paws::Pinpoint::SMSTemplateRequest> | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> TemplateName => Str | ||
| 82 | |||
| 83 | The name of the message template. A template name must start with an | ||
| 84 | alphanumeric character and can contain a maximum of 128 characters. The | ||
| 85 | characters can be alphanumeric characters, underscores (_), or hyphens | ||
| 86 | (-). Template names are case sensitive. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 Version => Str | ||
| 91 | |||
| 92 | The unique identifier for the version of the message template to | ||
| 93 | update, retrieve information about, or delete. To retrieve identifiers | ||
| 94 | and other information for all the versions of a template, use the | ||
| 95 | |||
| 96 | Template Versions resource. | ||
| 97 | |||
| 98 | If specified, this value must match the identifier for an existing | ||
| 99 | template version. If specified for an update operation, this value must | ||
| 100 | match the identifier for the latest existing version of the template. | ||
| 101 | This restriction helps ensure that race conditions don't occur. | ||
| 102 | |||
| 103 | If you don't specify a value for this parameter, Amazon Pinpoint does | ||
| 104 | the following: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | For a get operation, retrieves information about the active version of | ||
| 111 | the template. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | For an update operation, saves the updates to (overwrites) the latest | ||
| 116 | existing version of the template, if the create-new-version parameter | ||
| 117 | isn't used or is set to false. | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | For a delete operation, deletes the template, including all versions of | ||
| 122 | the template. | ||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method UpdateSmsTemplate in L<Paws::Pinpoint> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |