-
Notifications
You must be signed in to change notification settings - Fork 595
/
api_op_Subscribe.go
245 lines (227 loc) · 7.96 KB
/
api_op_Subscribe.go
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
// Code generated by smithy-go-codegen DO NOT EDIT.
package sns
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or
// email, or if the endpoint and the topic are not in the same account, the
// endpoint owner must run the ConfirmSubscription action to confirm the
// subscription. You call the ConfirmSubscription action with the token from the
// subscription response. Confirmation tokens are valid for three days. This action
// is throttled at 100 transactions per second (TPS).
func (c *Client) Subscribe(ctx context.Context, params *SubscribeInput, optFns ...func(*Options)) (*SubscribeOutput, error) {
if params == nil {
params = &SubscribeInput{}
}
result, metadata, err := c.invokeOperation(ctx, "Subscribe", params, optFns, c.addOperationSubscribeMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SubscribeOutput)
out.ResultMetadata = metadata
return out, nil
}
// Input for Subscribe action.
type SubscribeInput struct {
// The protocol that you want to use. Supported protocols include:
//
// * http –
// delivery of JSON-encoded message via HTTP POST
//
// * https – delivery of
// JSON-encoded message via HTTPS POST
//
// * email – delivery of message via SMTP
//
// *
// email-json – delivery of JSON-encoded message via SMTP
//
// * sms – delivery of
// message via SMS
//
// * sqs – delivery of JSON-encoded message to an Amazon SQS
// queue
//
// * application – delivery of JSON-encoded message to an EndpointArn for a
// mobile app and device
//
// * lambda – delivery of JSON-encoded message to an Lambda
// function
//
// * firehose – delivery of JSON-encoded message to an Amazon Kinesis
// Data Firehose delivery stream.
//
// This member is required.
Protocol *string
// The ARN of the topic you want to subscribe to.
//
// This member is required.
TopicArn *string
// A map of attributes with their corresponding values. The following lists the
// names, descriptions, and values of the special request parameters that the
// Subscribe action uses:
//
// * DeliveryPolicy – The policy that defines how Amazon
// SNS retries failed deliveries to HTTP/S endpoints.
//
// * FilterPolicy – The simple
// JSON object that lets your subscriber receive only a subset of messages, rather
// than receiving every message published to the topic.
//
// * RawMessageDelivery –
// When set to true, enables raw message delivery to Amazon SQS or HTTP/S
// endpoints. This eliminates the need for the endpoints to process JSON
// formatting, which is otherwise created for Amazon SNS metadata.
//
// * RedrivePolicy
// – When specified, sends undeliverable messages to the specified Amazon SQS
// dead-letter queue. Messages that can't be delivered due to client errors (for
// example, when the subscribed endpoint is unreachable) or server errors (for
// example, when the service that powers the subscribed endpoint becomes
// unavailable) are held in the dead-letter queue for further analysis or
// reprocessing.
//
// The following attribute applies only to Amazon Kinesis Data
// Firehose delivery stream subscriptions:
//
// * SubscriptionRoleArn – The ARN of the
// IAM role that has the following:
//
// * Permission to write to the Kinesis Data
// Firehose delivery stream
//
// * Amazon SNS listed as a trusted entity
//
// Specifying a
// valid ARN for this attribute is required for Kinesis Data Firehose delivery
// stream subscriptions. For more information, see Fanout to Kinesis Data Firehose
// delivery streams
// (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) in
// the Amazon SNS Developer Guide.
Attributes map[string]string
// The endpoint that you want to receive notifications. Endpoints vary by
// protocol:
//
// * For the http protocol, the (public) endpoint is a URL beginning
// with http://.
//
// * For the https protocol, the (public) endpoint is a URL
// beginning with https://.
//
// * For the email protocol, the endpoint is an email
// address.
//
// * For the email-json protocol, the endpoint is an email address.
//
// *
// For the sms protocol, the endpoint is a phone number of an SMS-enabled
// device.
//
// * For the sqs protocol, the endpoint is the ARN of an Amazon SQS
// queue.
//
// * For the application protocol, the endpoint is the EndpointArn of a
// mobile app and device.
//
// * For the lambda protocol, the endpoint is the ARN of an
// Lambda function.
//
// * For the firehose protocol, the endpoint is the ARN of an
// Amazon Kinesis Data Firehose delivery stream.
Endpoint *string
// Sets whether the response from the Subscribe request includes the subscription
// ARN, even if the subscription is not yet confirmed. If you set this parameter to
// true, the response includes the ARN in all cases, even if the subscription is
// not yet confirmed. In addition to the ARN for confirmed subscriptions, the
// response also includes the pending subscription ARN value for subscriptions that
// aren't yet confirmed. A subscription becomes confirmed when the subscriber calls
// the ConfirmSubscription action with a confirmation token. The default value is
// false.
ReturnSubscriptionArn bool
noSmithyDocumentSerde
}
// Response for Subscribe action.
type SubscribeOutput struct {
// The ARN of the subscription if it is confirmed, or the string "pending
// confirmation" if the subscription requires confirmation. However, if the API
// request parameter ReturnSubscriptionArn is true, then the value is always the
// subscription ARN, even if the subscription requires confirmation.
SubscriptionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSubscribeMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpSubscribe{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpSubscribe{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSubscribeValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSubscribe(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opSubscribe(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "sns",
OperationName: "Subscribe",
}
}