1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package pinpoint
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/pinpoint/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Deletes a message template for messages that were sent through the SMS channel.
15func (c *Client) DeleteSmsTemplate(ctx context.Context, params *DeleteSmsTemplateInput, optFns ...func(*Options)) (*DeleteSmsTemplateOutput, error) {
16	if params == nil {
17		params = &DeleteSmsTemplateInput{}
18	}
19
20	result, metadata, err := c.invokeOperation(ctx, "DeleteSmsTemplate", params, optFns, addOperationDeleteSmsTemplateMiddlewares)
21	if err != nil {
22		return nil, err
23	}
24
25	out := result.(*DeleteSmsTemplateOutput)
26	out.ResultMetadata = metadata
27	return out, nil
28}
29
30type DeleteSmsTemplateInput struct {
31
32	// The name of the message template. A template name must start with an
33	// alphanumeric character and can contain a maximum of 128 characters. The
34	// characters can be alphanumeric characters, underscores (_), or hyphens (-).
35	// Template names are case sensitive.
36	//
37	// This member is required.
38	TemplateName *string
39
40	// The unique identifier for the version of the message template to update,
41	// retrieve information about, or delete. To retrieve identifiers and other
42	// information for all the versions of a template, use the Template Versions
43	// resource. If specified, this value must match the identifier for an existing
44	// template version. If specified for an update operation, this value must match
45	// the identifier for the latest existing version of the template. This restriction
46	// helps ensure that race conditions don't occur. If you don't specify a value for
47	// this parameter, Amazon Pinpoint does the following:
48	//
49	// * For a get operation,
50	// retrieves information about the active version of the template.
51	//
52	// * For an update
53	// operation, saves the updates to (overwrites) the latest existing version of the
54	// template, if the create-new-version parameter isn't used or is set to false.
55	//
56	// *
57	// For a delete operation, deletes the template, including all versions of the
58	// template.
59	Version *string
60}
61
62type DeleteSmsTemplateOutput struct {
63
64	// Provides information about an API request or response.
65	//
66	// This member is required.
67	MessageBody *types.MessageBody
68
69	// Metadata pertaining to the operation's result.
70	ResultMetadata middleware.Metadata
71}
72
73func addOperationDeleteSmsTemplateMiddlewares(stack *middleware.Stack, options Options) (err error) {
74	err = stack.Serialize.Add(&awsRestjson1_serializeOpDeleteSmsTemplate{}, middleware.After)
75	if err != nil {
76		return err
77	}
78	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDeleteSmsTemplate{}, middleware.After)
79	if err != nil {
80		return err
81	}
82	if err = addSetLoggerMiddleware(stack, options); err != nil {
83		return err
84	}
85	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
86		return err
87	}
88	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
89		return err
90	}
91	if err = addResolveEndpointMiddleware(stack, options); err != nil {
92		return err
93	}
94	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
95		return err
96	}
97	if err = addRetryMiddlewares(stack, options); err != nil {
98		return err
99	}
100	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
104		return err
105	}
106	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
107		return err
108	}
109	if err = addClientUserAgent(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
116		return err
117	}
118	if err = addOpDeleteSmsTemplateValidationMiddleware(stack); err != nil {
119		return err
120	}
121	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteSmsTemplate(options.Region), middleware.Before); err != nil {
122		return err
123	}
124	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addResponseErrorMiddleware(stack); err != nil {
128		return err
129	}
130	if err = addRequestResponseLogging(stack, options); err != nil {
131		return err
132	}
133	return nil
134}
135
136func newServiceMetadataMiddleware_opDeleteSmsTemplate(region string) *awsmiddleware.RegisterServiceMetadata {
137	return &awsmiddleware.RegisterServiceMetadata{
138		Region:        region,
139		ServiceID:     ServiceID,
140		SigningName:   "mobiletargeting",
141		OperationName: "DeleteSmsTemplate",
142	}
143}
144