1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package pinpoint
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/pinpoint/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates an existing message template for messages that are sent through the SMS
// channel.
func (c *Client) UpdateSmsTemplate(ctx context.Context, params *UpdateSmsTemplateInput, optFns ...func(*Options)) (*UpdateSmsTemplateOutput, error) {
if params == nil {
params = &UpdateSmsTemplateInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateSmsTemplate", params, optFns, c.addOperationUpdateSmsTemplateMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateSmsTemplateOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateSmsTemplateInput struct {
// Specifies the content and settings for a message template that can be used in
// text messages that are sent through the SMS channel.
//
// This member is required.
SMSTemplateRequest *types.SMSTemplateRequest
// The name of the message template. A template name must start with an
// alphanumeric character and can contain a maximum of 128 characters. The
// characters can be alphanumeric characters, underscores (_), or hyphens (-).
// Template names are case sensitive.
//
// This member is required.
TemplateName *string
// Specifies whether to save the updates as a new version of the message template.
// Valid values are: true, save the updates as a new version; and, false, save the
// updates to (overwrite) the latest existing version of the template.
//
// If you don't specify a value for this parameter, Amazon Pinpoint saves the
// updates to (overwrites) the latest existing version of the template. If you
// specify a value of true for this parameter, don't specify a value for the
// version parameter. Otherwise, an error will occur.
CreateNewVersion *bool
// The unique identifier for the version of the message template to update,
// retrieve information about, or delete. To retrieve identifiers and other
// information for all the versions of a template, use the Template Versions
// resource.
//
// If specified, this value must match the identifier for an existing template
// version. If specified for an update operation, this value must match the
// identifier for the latest existing version of the template. This restriction
// helps ensure that race conditions don't occur.
//
// If you don't specify a value for this parameter, Amazon Pinpoint does the
// following:
//
// - For a get operation, retrieves information about the active version of the
// template.
//
// - For an update operation, saves the updates to (overwrites) the latest
// existing version of the template, if the create-new-version parameter isn't used
// or is set to false.
//
// - For a delete operation, deletes the template, including all versions of the
// template.
Version *string
noSmithyDocumentSerde
}
type UpdateSmsTemplateOutput struct {
// Provides information about an API request or response.
//
// This member is required.
MessageBody *types.MessageBody
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateSmsTemplateMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateSmsTemplate{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateSmsTemplate{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateSmsTemplate"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpUpdateSmsTemplateValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateSmsTemplate(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateSmsTemplate(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateSmsTemplate",
}
}
|
