-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_CreateQueue.go
369 lines (353 loc) · 15.3 KB
/
api_op_CreateQueue.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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
// Code generated by smithy-go-codegen DO NOT EDIT.
package sqs
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"
)
// Creates a new standard or FIFO queue. You can pass one or more attributes in the
// request. Keep the following in mind:
//
// * If you don't specify the FifoQueue
// attribute, Amazon SQS creates a standard queue. You can't change the queue type
// after you create it and you can't convert an existing standard queue into a FIFO
// queue. You must either create a new FIFO queue for your application or delete
// your existing standard queue and recreate it as a FIFO queue. For more
// information, see Moving From a Standard Queue to a FIFO Queue
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving)
// in the Amazon SQS Developer Guide.
//
// * If you don't provide a value for an
// attribute, the queue is created with the default value for the attribute.
//
// * If
// you delete a queue, you must wait at least 60 seconds before creating a queue
// with the same name.
//
// To successfully create a new queue, you must provide a
// queue name that adheres to the limits related to queues
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html)
// and is unique within the scope of your queues. After you create a queue, you
// must wait at least one second after the queue is created to be able to use the
// queue. To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires
// only the QueueName parameter. be aware of existing queue names:
//
// * If you
// provide the name of an existing queue along with the exact names and values of
// all the queue's attributes, CreateQueue returns the queue URL for the existing
// queue.
//
// * If the queue name, attribute names, or attribute values don't match an
// existing queue, CreateQueue returns an error.
//
// Some actions take lists of
// parameters. These lists are specified using the param.n notation. Values of n
// are integers starting from 1. For example, a parameter list with two elements
// looks like this: &AttributeName.1=first&AttributeName.2=second Cross-account
// permissions don't apply to this action. For more information, see Grant
// cross-account permissions to a role and a user name
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name)
// in the Amazon SQS Developer Guide.
func (c *Client) CreateQueue(ctx context.Context, params *CreateQueueInput, optFns ...func(*Options)) (*CreateQueueOutput, error) {
if params == nil {
params = &CreateQueueInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateQueue", params, optFns, c.addOperationCreateQueueMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateQueueOutput)
out.ResultMetadata = metadata
return out, nil
}
//
type CreateQueueInput struct {
// The name of the new queue. The following limits apply to this name:
//
// * A queue
// name can have up to 80 characters.
//
// * Valid values: alphanumeric characters,
// hyphens (-), and underscores (_).
//
// * A FIFO queue name must end with the .fifo
// suffix.
//
// Queue URLs and names are case-sensitive.
//
// This member is required.
QueueName *string
// A map of attributes with their corresponding values. The following lists the
// names, descriptions, and values of the special request parameters that the
// CreateQueue action uses:
//
// * DelaySeconds – The length of time, in seconds, for
// which the delivery of all messages in the queue is delayed. Valid values: An
// integer from 0 to 900 seconds (15 minutes). Default: 0.
//
// * MaximumMessageSize –
// The limit of how many bytes a message can contain before Amazon SQS rejects it.
// Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB).
// Default: 262,144 (256 KiB).
//
// * MessageRetentionPeriod – The length of time, in
// seconds, for which Amazon SQS retains a message. Valid values: An integer from
// 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4
// days).
//
// * Policy – The queue's policy. A valid Amazon Web Services policy. For
// more information about policy structure, see Overview of Amazon Web Services IAM
// Policies
// (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html) in the
// Amazon IAM User Guide.
//
// * ReceiveMessageWaitTimeSeconds – The length of time, in
// seconds, for which a ReceiveMessage action waits for a message to arrive. Valid
// values: An integer from 0 to 20 (seconds). Default: 0.
//
// * RedrivePolicy – The
// string that includes the parameters for the dead-letter queue functionality of
// the source queue as a JSON object. For more information about the redrive policy
// and dead-letter queues, see Using Amazon SQS Dead-Letter Queues
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
// in the Amazon SQS Developer Guide.
//
// * deadLetterTargetArn – The Amazon Resource
// Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the
// value of maxReceiveCount is exceeded.
//
// * maxReceiveCount – The number of times a
// message is delivered to the source queue before being moved to the dead-letter
// queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a
// queue, Amazon SQS moves the message to the dead-letter-queue.
//
// The dead-letter
// queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter
// queue of a standard queue must also be a standard queue.
//
// * VisibilityTimeout –
// The visibility timeout for the queue, in seconds. Valid values: An integer from
// 0 to 43,200 (12 hours). Default: 30. For more information about the visibility
// timeout, see Visibility Timeout
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
// in the Amazon SQS Developer Guide.
//
// The following attributes apply only to
// server-side-encryption
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
//
// *
// KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key
// (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
// While the alias of the Amazon Web Services managed CMK for Amazon SQS is always
// alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias .
// For more examples, see KeyId
// (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
// in the Key Management Service API Reference.
//
// * KmsDataKeyReusePeriodSeconds –
// The length of time, in seconds, for which Amazon SQS can reuse a data key
// (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)
// to encrypt or decrypt messages before calling KMS again. An integer representing
// seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
// 300 (5 minutes). A shorter time period provides better security but results in
// more calls to KMS which might incur charges after Free Tier. For more
// information, see How Does the Data Key Reuse Period Work?
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work).
//
// *
// SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned
// encryption keys. Only one server-side encryption option is supported per queue
// (e.g. SSE-KMS
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html)
// or SSE-SQS
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)).
//
// The
// following attributes apply only to FIFO (first-in-first-out) queues
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
//
// *
// FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you
// don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You
// can provide this attribute only during queue creation. You can't change it for
// an existing queue. When you set this attribute, you must also provide the
// MessageGroupId for your messages explicitly. For more information, see FIFO
// queue logic
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html)
// in the Amazon SQS Developer Guide.
//
// * ContentBasedDeduplication – Enables
// content-based deduplication. Valid values are true and false. For more
// information, see Exactly-once processing
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html)
// in the Amazon SQS Developer Guide. Note the following:
//
// * Every message must
// have a unique MessageDeduplicationId.
//
// * You may provide a
// MessageDeduplicationId explicitly.
//
// * If you aren't able to provide a
// MessageDeduplicationId and you enable ContentBasedDeduplication for your queue,
// Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the
// body of the message (but not the attributes of the message).
//
// * If you don't
// provide a MessageDeduplicationId and the queue doesn't have
// ContentBasedDeduplication set, the action fails with an error.
//
// * If the queue
// has ContentBasedDeduplication set, your MessageDeduplicationId overrides the
// generated one.
//
// * When ContentBasedDeduplication is in effect, messages with
// identical content sent within the deduplication interval are treated as
// duplicates and only one copy of the message is delivered.
//
// * If you send one
// message with ContentBasedDeduplication enabled and then another message with a
// MessageDeduplicationId that is the same as the one generated for the first
// MessageDeduplicationId, the two messages are treated as duplicates and only one
// copy of the message is delivered.
//
// The following attributes apply only to high
// throughput for FIFO queues
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html):
//
// *
// DeduplicationScope – Specifies whether message deduplication occurs at the
// message group or queue level. Valid values are messageGroup and queue.
//
// *
// FifoThroughputLimit – Specifies whether the FIFO queue throughput quota applies
// to the entire queue or per message group. Valid values are perQueue and
// perMessageGroupId. The perMessageGroupId value is allowed only when the value
// for DeduplicationScope is messageGroup.
//
// To enable high throughput for FIFO
// queues, do the following:
//
// * Set DeduplicationScope to messageGroup.
//
// * Set
// FifoThroughputLimit to perMessageGroupId.
//
// If you set these attributes to
// anything other than the values shown for enabling high throughput, normal
// throughput is in effect and deduplication occurs as specified. For information
// on throughput quotas, see Quotas related to messages
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html)
// in the Amazon SQS Developer Guide.
Attributes map[string]string
// Add cost allocation tags to the specified Amazon SQS queue. For an overview, see
// Tagging Your Amazon SQS Queues
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html)
// in the Amazon SQS Developer Guide. When you use queue tags, keep the following
// guidelines in mind:
//
// * Adding more than 50 tags to a queue isn't recommended.
//
// *
// Tags don't have any semantic meaning. Amazon SQS interprets tags as character
// strings.
//
// * Tags are case-sensitive.
//
// * A new tag with a key identical to that
// of an existing tag overwrites the existing tag.
//
// For a full list of tag
// restrictions, see Quotas related to queues
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues)
// in the Amazon SQS Developer Guide. To be able to tag a queue on creation, you
// must have the sqs:CreateQueue and sqs:TagQueue permissions. Cross-account
// permissions don't apply to this action. For more information, see Grant
// cross-account permissions to a role and a user name
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name)
// in the Amazon SQS Developer Guide.
Tags map[string]string
noSmithyDocumentSerde
}
// Returns the QueueUrl attribute of the created queue.
type CreateQueueOutput struct {
// The URL of the created Amazon SQS queue.
QueueUrl *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateQueueMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpCreateQueue{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpCreateQueue{}, 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 = addOpCreateQueueValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateQueue(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_opCreateQueue(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "sqs",
OperationName: "CreateQueue",
}
}