-
Notifications
You must be signed in to change notification settings - Fork 598
/
api_op_SetQueueAttributes.go
229 lines (205 loc) · 10.7 KB
/
api_op_SetQueueAttributes.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package sqs
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
"github.com/aws/aws-sdk-go-v2/private/protocol/query"
)
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest
type SetQueueAttributesInput struct {
_ struct{} `type:"structure"`
// A map of attributes to set.
//
// The following lists the names, descriptions, and values of the special request
// parameters that the SetQueueAttributes 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 (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) up 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 representing seconds,
// from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
//
// * Policy - The queue's policy. A valid AWS policy. For more information
// about policy structure, see Overview of AWS 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. 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 Simple Queue Service 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 Simple Queue Service 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 AWS-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 AWS-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 AWS 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 AWS 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).
//
// The following attribute applies only to FIFO (first-in-first-out) queues
// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
//
// * ContentBasedDeduplication - Enables content-based deduplication. For
// more information, see Exactly-Once Processing (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
// in the Amazon Simple Queue Service Developer Guide. 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.
//
// Attributes is a required field
Attributes map[string]string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true" required:"true"`
// The URL of the Amazon SQS queue whose attributes are set.
//
// Queue URLs and names are case-sensitive.
//
// QueueUrl is a required field
QueueUrl *string `type:"string" required:"true"`
}
// String returns the string representation
func (s SetQueueAttributesInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *SetQueueAttributesInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "SetQueueAttributesInput"}
if s.Attributes == nil {
invalidParams.Add(aws.NewErrParamRequired("Attributes"))
}
if s.QueueUrl == nil {
invalidParams.Add(aws.NewErrParamRequired("QueueUrl"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesOutput
type SetQueueAttributesOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s SetQueueAttributesOutput) String() string {
return awsutil.Prettify(s)
}
const opSetQueueAttributes = "SetQueueAttributes"
// SetQueueAttributesRequest returns a request value for making API operation for
// Amazon Simple Queue Service.
//
// Sets the value of one or more queue attributes. When you change a queue's
// attributes, the change can take up to 60 seconds for most of the attributes
// to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod
// attribute can take up to 15 minutes.
//
// * In the future, new attributes might be added. If you write code that
// calls this action, we recommend that you structure your code so that it
// can handle new attributes gracefully.
//
// * 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 Simple Queue Service Developer Guide.
//
// * To remove the ability to change queue permissions, you must deny permission
// to the AddPermission, RemovePermission, and SetQueueAttributes actions
// in your IAM policy.
//
// // Example sending a request using SetQueueAttributesRequest.
// req := client.SetQueueAttributesRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributes
func (c *Client) SetQueueAttributesRequest(input *SetQueueAttributesInput) SetQueueAttributesRequest {
op := &aws.Operation{
Name: opSetQueueAttributes,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SetQueueAttributesInput{}
}
req := c.newRequest(op, input, &SetQueueAttributesOutput{})
req.Handlers.Unmarshal.Remove(query.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
return SetQueueAttributesRequest{Request: req, Input: input, Copy: c.SetQueueAttributesRequest}
}
// SetQueueAttributesRequest is the request type for the
// SetQueueAttributes API operation.
type SetQueueAttributesRequest struct {
*aws.Request
Input *SetQueueAttributesInput
Copy func(*SetQueueAttributesInput) SetQueueAttributesRequest
}
// Send marshals and sends the SetQueueAttributes API request.
func (r SetQueueAttributesRequest) Send(ctx context.Context) (*SetQueueAttributesResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &SetQueueAttributesResponse{
SetQueueAttributesOutput: r.Request.Data.(*SetQueueAttributesOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// SetQueueAttributesResponse is the response type for the
// SetQueueAttributes API operation.
type SetQueueAttributesResponse struct {
*SetQueueAttributesOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// SetQueueAttributes request.
func (r *SetQueueAttributesResponse) SDKResponseMetdata() *aws.Response {
return r.response
}