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
189
190
191
192
193
194
195
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package pinpointsmsvoicev2
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoicev2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Releases an existing origination phone number in your account. Once released, a
// phone number is no longer available for sending messages. If the origination
// phone number has deletion protection enabled or is associated with a pool, an
// error is returned.
func (c *Client) ReleasePhoneNumber(ctx context.Context, params *ReleasePhoneNumberInput, optFns ...func(*Options)) (*ReleasePhoneNumberOutput, error) {
if params == nil {
params = &ReleasePhoneNumberInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ReleasePhoneNumber", params, optFns, c.addOperationReleasePhoneNumberMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ReleasePhoneNumberOutput)
out.ResultMetadata = metadata
return out, nil
}
type ReleasePhoneNumberInput struct {
// The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use
// DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
//
// This member is required.
PhoneNumberId *string
noSmithyDocumentSerde
}
type ReleasePhoneNumberOutput struct {
// The time when the phone number was created, in UNIX epoch time (https://www.epochconverter.com/)
// format.
CreatedTimestamp *time.Time
// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
IsoCountryCode *string
// The message type that was associated with the phone number.
MessageType types.MessageType
// The monthly price of the phone number, in US dollars.
MonthlyLeasingPrice *string
// Specifies if the number could be used for text messages, voice, or both.
NumberCapabilities []types.NumberCapability
// The type of number that was released.
NumberType types.NumberType
// The name of the OptOutList that was associated with the phone number.
OptOutListName *string
// The phone number that was released.
PhoneNumber *string
// The PhoneNumberArn of the phone number that was released.
PhoneNumberArn *string
// The PhoneNumberId of the phone number that was released.
PhoneNumberId *string
// The unique identifier for the registration.
RegistrationId *string
// By default this is set to false. When an end recipient sends a message that
// begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint
// automatically replies with a customizable message and adds the end recipient to
// the OptOutList. When set to true you're responsible for responding to HELP and
// STOP requests. You're also responsible for tracking and honoring opt-out
// requests.
SelfManagedOptOutsEnabled bool
// The current status of the request.
Status types.NumberStatus
// The Amazon Resource Name (ARN) of the TwoWayChannel.
TwoWayChannelArn *string
// An optional IAM Role Arn for a service to assume, to be able to post inbound
// SMS messages.
TwoWayChannelRole *string
// By default this is set to false. When set to true you can receive incoming text
// messages from your end recipients.
TwoWayEnabled bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationReleasePhoneNumberMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpReleasePhoneNumber{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpReleasePhoneNumber{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ReleasePhoneNumber"); 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 = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.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 = addOpReleasePhoneNumberValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opReleasePhoneNumber(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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_opReleasePhoneNumber(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ReleasePhoneNumber",
}
}
|
