Documentation ¶
Overview ¶
Package sqs provides the client and types for making API requests to Amazon SQS.
Welcome to the Amazon Simple Queue Service API Reference.
Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
You can use AWS SDKs (http://aws.amazon.com/tools/#sdk) to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional Information
Amazon SQS Product Page (http://aws.amazon.com/sqs/)
Amazon Simple Queue Service Developer Guide Making API Requests (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html) Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) Amazon SQS Dead-Letter Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
Amazon SQS in the AWS CLI Command Reference (http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html)
Amazon Web Services General Reference Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region)
See https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05 for more information on this service.
See sqs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/
Using the Client ¶
To use Amazon SQS with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon SQS client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/#New
Index ¶
- Constants
- type AddPermissionInput
- type AddPermissionOutput
- type AddPermissionRequest
- type AddPermissionResponse
- type BatchResultErrorEntry
- type ChangeMessageVisibilityBatchInput
- type ChangeMessageVisibilityBatchOutput
- type ChangeMessageVisibilityBatchRequest
- type ChangeMessageVisibilityBatchRequestEntry
- type ChangeMessageVisibilityBatchResponse
- type ChangeMessageVisibilityBatchResultEntry
- type ChangeMessageVisibilityInput
- type ChangeMessageVisibilityOutput
- type ChangeMessageVisibilityRequest
- type ChangeMessageVisibilityResponse
- type Client
- func (c *Client) AddPermissionRequest(input *AddPermissionInput) AddPermissionRequest
- func (c *Client) ChangeMessageVisibilityBatchRequest(input *ChangeMessageVisibilityBatchInput) ChangeMessageVisibilityBatchRequest
- func (c *Client) ChangeMessageVisibilityRequest(input *ChangeMessageVisibilityInput) ChangeMessageVisibilityRequest
- func (c *Client) CreateQueueRequest(input *CreateQueueInput) CreateQueueRequest
- func (c *Client) DeleteMessageBatchRequest(input *DeleteMessageBatchInput) DeleteMessageBatchRequest
- func (c *Client) DeleteMessageRequest(input *DeleteMessageInput) DeleteMessageRequest
- func (c *Client) DeleteQueueRequest(input *DeleteQueueInput) DeleteQueueRequest
- func (c *Client) GetQueueAttributesRequest(input *GetQueueAttributesInput) GetQueueAttributesRequest
- func (c *Client) GetQueueUrlRequest(input *GetQueueUrlInput) GetQueueUrlRequest
- func (c *Client) ListDeadLetterSourceQueuesRequest(input *ListDeadLetterSourceQueuesInput) ListDeadLetterSourceQueuesRequest
- func (c *Client) ListQueueTagsRequest(input *ListQueueTagsInput) ListQueueTagsRequest
- func (c *Client) ListQueuesRequest(input *ListQueuesInput) ListQueuesRequest
- func (c *Client) PurgeQueueRequest(input *PurgeQueueInput) PurgeQueueRequest
- func (c *Client) ReceiveMessageRequest(input *ReceiveMessageInput) ReceiveMessageRequest
- func (c *Client) RemovePermissionRequest(input *RemovePermissionInput) RemovePermissionRequest
- func (c *Client) SendMessageBatchRequest(input *SendMessageBatchInput) SendMessageBatchRequest
- func (c *Client) SendMessageRequest(input *SendMessageInput) SendMessageRequest
- func (c *Client) SetQueueAttributesRequest(input *SetQueueAttributesInput) SetQueueAttributesRequest
- func (c *Client) TagQueueRequest(input *TagQueueInput) TagQueueRequest
- func (c *Client) UntagQueueRequest(input *UntagQueueInput) UntagQueueRequest
- type CreateQueueInput
- type CreateQueueOutput
- type CreateQueueRequest
- type CreateQueueResponse
- type DeleteMessageBatchInput
- type DeleteMessageBatchOutput
- type DeleteMessageBatchRequest
- type DeleteMessageBatchRequestEntry
- type DeleteMessageBatchResponse
- type DeleteMessageBatchResultEntry
- type DeleteMessageInput
- type DeleteMessageOutput
- type DeleteMessageRequest
- type DeleteMessageResponse
- type DeleteQueueInput
- type DeleteQueueOutput
- type DeleteQueueRequest
- type DeleteQueueResponse
- type GetQueueAttributesInput
- type GetQueueAttributesOutput
- type GetQueueAttributesRequest
- type GetQueueAttributesResponse
- type GetQueueUrlInput
- type GetQueueUrlOutput
- type GetQueueUrlRequest
- type GetQueueUrlResponse
- type InvalidChecksumError
- type ListDeadLetterSourceQueuesInput
- type ListDeadLetterSourceQueuesOutput
- type ListDeadLetterSourceQueuesPaginator
- type ListDeadLetterSourceQueuesRequest
- type ListDeadLetterSourceQueuesResponse
- type ListQueueTagsInput
- type ListQueueTagsOutput
- type ListQueueTagsRequest
- type ListQueueTagsResponse
- type ListQueuesInput
- type ListQueuesOutput
- type ListQueuesPaginator
- type ListQueuesRequest
- type ListQueuesResponse
- type Message
- type MessageAttributeValue
- type MessageSystemAttributeName
- type MessageSystemAttributeNameForSends
- type MessageSystemAttributeValue
- type PurgeQueueInput
- type PurgeQueueOutput
- type PurgeQueueRequest
- type PurgeQueueResponse
- type QueueAttributeName
- type ReceiveMessageInput
- type ReceiveMessageOutput
- type ReceiveMessageRequest
- type ReceiveMessageResponse
- type RemovePermissionInput
- type RemovePermissionOutput
- type RemovePermissionRequest
- type RemovePermissionResponse
- type SendMessageBatchInput
- type SendMessageBatchOutput
- type SendMessageBatchRequest
- type SendMessageBatchRequestEntry
- type SendMessageBatchResponse
- type SendMessageBatchResultEntry
- type SendMessageInput
- type SendMessageOutput
- type SendMessageRequest
- type SendMessageResponse
- type SetQueueAttributesInput
- type SetQueueAttributesOutput
- type SetQueueAttributesRequest
- type SetQueueAttributesResponse
- type TagQueueInput
- type TagQueueOutput
- type TagQueueRequest
- type TagQueueResponse
- type UntagQueueInput
- type UntagQueueOutput
- type UntagQueueRequest
- type UntagQueueResponse
Constants ¶
const ( ServiceName = "Amazon SQS" // Service's name ServiceID = "SQS" // Service's identifier EndpointsID = "sqs" // Service's Endpoint identifier )
const ( // ErrCodeBatchEntryIdsNotDistinct for service response error code // "AWS.SimpleQueueService.BatchEntryIdsNotDistinct". // // Two or more batch entries in the request have the same Id. ErrCodeBatchEntryIdsNotDistinct = "AWS.SimpleQueueService.BatchEntryIdsNotDistinct" // ErrCodeBatchRequestTooLong for service response error code // "AWS.SimpleQueueService.BatchRequestTooLong". // // The length of all the messages put together is more than the limit. ErrCodeBatchRequestTooLong = "AWS.SimpleQueueService.BatchRequestTooLong" // ErrCodeEmptyBatchRequest for service response error code // "AWS.SimpleQueueService.EmptyBatchRequest". // // The batch request doesn't contain any entries. ErrCodeEmptyBatchRequest = "AWS.SimpleQueueService.EmptyBatchRequest" // ErrCodeInvalidAttributeName for service response error code // "InvalidAttributeName". // // The specified attribute doesn't exist. ErrCodeInvalidAttributeName = "InvalidAttributeName" // ErrCodeInvalidBatchEntryId for service response error code // "AWS.SimpleQueueService.InvalidBatchEntryId". // // The Id of a batch entry in a batch request doesn't abide by the specification. ErrCodeInvalidBatchEntryId = "AWS.SimpleQueueService.InvalidBatchEntryId" // ErrCodeInvalidIdFormat for service response error code // "InvalidIdFormat". // // The specified receipt handle isn't valid for the current version. ErrCodeInvalidIdFormat = "InvalidIdFormat" // ErrCodeInvalidMessageContents for service response error code // "InvalidMessageContents". // // The message contains characters outside the allowed set. ErrCodeInvalidMessageContents = "InvalidMessageContents" // ErrCodeMessageNotInflight for service response error code // "AWS.SimpleQueueService.MessageNotInflight". // // The specified message isn't in flight. ErrCodeMessageNotInflight = "AWS.SimpleQueueService.MessageNotInflight" // ErrCodeOverLimit for service response error code // "OverLimit". // // The specified action violates a limit. For example, ReceiveMessage returns // this error if the maximum number of inflight messages is reached and AddPermission // returns this error if the maximum number of permissions for the queue is // reached. ErrCodeOverLimit = "OverLimit" // ErrCodePurgeQueueInProgress for service response error code // "AWS.SimpleQueueService.PurgeQueueInProgress". // // Indicates that the specified queue previously received a PurgeQueue request // within the last 60 seconds (the time it can take to delete the messages in // the queue). ErrCodePurgeQueueInProgress = "AWS.SimpleQueueService.PurgeQueueInProgress" // ErrCodeQueueDeletedRecently for service response error code // "AWS.SimpleQueueService.QueueDeletedRecently". // // You must wait 60 seconds after deleting a queue before you can create another // queue with the same name. ErrCodeQueueDeletedRecently = "AWS.SimpleQueueService.QueueDeletedRecently" // ErrCodeQueueDoesNotExist for service response error code // "AWS.SimpleQueueService.NonExistentQueue". // // The specified queue doesn't exist. ErrCodeQueueDoesNotExist = "AWS.SimpleQueueService.NonExistentQueue" // ErrCodeQueueNameExists for service response error code // "QueueAlreadyExists". // // A queue with this name already exists. Amazon SQS returns this error only // if the request includes attributes whose values differ from those of the // existing queue. ErrCodeQueueNameExists = "QueueAlreadyExists" // ErrCodeReceiptHandleIsInvalid for service response error code // "ReceiptHandleIsInvalid". // // The specified receipt handle isn't valid. ErrCodeReceiptHandleIsInvalid = "ReceiptHandleIsInvalid" // ErrCodeTooManyEntriesInBatchRequest for service response error code // "AWS.SimpleQueueService.TooManyEntriesInBatchRequest". // // The batch request contains more entries than permissible. ErrCodeTooManyEntriesInBatchRequest = "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" // ErrCodeUnsupportedOperation for service response error code // "AWS.SimpleQueueService.UnsupportedOperation". // // Error code 400. Unsupported operation. ErrCodeUnsupportedOperation = "AWS.SimpleQueueService.UnsupportedOperation" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddPermissionInput ¶
type AddPermissionInput struct { // The AWS account number of the principal (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P) // who is given permission. The principal must have an AWS account, but does // not need to be signed up for Amazon SQS. For information about locating the // AWS account identification, see Your AWS Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication) // in the Amazon Simple Queue Service Developer Guide. // // AWSAccountIds is a required field AWSAccountIds []string `locationNameList:"AWSAccountId" type:"list" flattened:"true" required:"true"` // The action the client wants to allow for the specified principal. Valid values: // the name of any action or *. // // For more information about these actions, see Overview of Managing Access // Permissions to Your Amazon Simple Queue Service Resource (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html) // in the Amazon Simple Queue Service Developer Guide. // // Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n // also grants permissions for the corresponding batch versions of those actions: // SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch. // // Actions is a required field Actions []string `locationNameList:"ActionName" type:"list" flattened:"true" required:"true"` // The unique identification of the permission you're setting (for example, // AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric // characters, hyphens (-), and underscores (_). // // Label is a required field Label *string `type:"string" required:"true"` // The URL of the Amazon SQS queue to which permissions are added. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (AddPermissionInput) String ¶
func (s AddPermissionInput) String() string
String returns the string representation
func (*AddPermissionInput) Validate ¶
func (s *AddPermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddPermissionOutput ¶
type AddPermissionOutput struct {
// contains filtered or unexported fields
}
func (AddPermissionOutput) String ¶
func (s AddPermissionOutput) String() string
String returns the string representation
type AddPermissionRequest ¶
type AddPermissionRequest struct { *aws.Request Input *AddPermissionInput Copy func(*AddPermissionInput) AddPermissionRequest }
AddPermissionRequest is the request type for the AddPermission API operation.
func (AddPermissionRequest) Send ¶
func (r AddPermissionRequest) Send(ctx context.Context) (*AddPermissionResponse, error)
Send marshals and sends the AddPermission API request.
type AddPermissionResponse ¶ added in v0.9.0
type AddPermissionResponse struct { *AddPermissionOutput // contains filtered or unexported fields }
AddPermissionResponse is the response type for the AddPermission API operation.
func (*AddPermissionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *AddPermissionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AddPermission request.
type BatchResultErrorEntry ¶
type BatchResultErrorEntry struct { // An error code representing why the action failed on this entry. // // Code is a required field Code *string `type:"string" required:"true"` // The Id of an entry in a batch request. // // Id is a required field Id *string `type:"string" required:"true"` // A message explaining why the action failed on this entry. Message *string `type:"string"` // Specifies whether the error happened due to the caller of the batch API action. // // SenderFault is a required field SenderFault *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
Gives a detailed description of the result of an action on each entry in the request.
func (BatchResultErrorEntry) String ¶
func (s BatchResultErrorEntry) String() string
String returns the string representation
type ChangeMessageVisibilityBatchInput ¶
type ChangeMessageVisibilityBatchInput struct { // A list of receipt handles of the messages for which the visibility timeout // must be changed. // // Entries is a required field Entries []ChangeMessageVisibilityBatchRequestEntry `locationNameList:"ChangeMessageVisibilityBatchRequestEntry" type:"list" flattened:"true" required:"true"` // The URL of the Amazon SQS queue whose messages' visibility is changed. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ChangeMessageVisibilityBatchInput) String ¶
func (s ChangeMessageVisibilityBatchInput) String() string
String returns the string representation
func (*ChangeMessageVisibilityBatchInput) Validate ¶
func (s *ChangeMessageVisibilityBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangeMessageVisibilityBatchOutput ¶
type ChangeMessageVisibilityBatchOutput struct { // A list of BatchResultErrorEntry items. // // Failed is a required field Failed []BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"` // A list of ChangeMessageVisibilityBatchResultEntry items. // // Successful is a required field Successful []ChangeMessageVisibilityBatchResultEntry `locationNameList:"ChangeMessageVisibilityBatchResultEntry" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
func (ChangeMessageVisibilityBatchOutput) String ¶
func (s ChangeMessageVisibilityBatchOutput) String() string
String returns the string representation
type ChangeMessageVisibilityBatchRequest ¶
type ChangeMessageVisibilityBatchRequest struct { *aws.Request Input *ChangeMessageVisibilityBatchInput Copy func(*ChangeMessageVisibilityBatchInput) ChangeMessageVisibilityBatchRequest }
ChangeMessageVisibilityBatchRequest is the request type for the ChangeMessageVisibilityBatch API operation.
func (ChangeMessageVisibilityBatchRequest) Send ¶
func (r ChangeMessageVisibilityBatchRequest) Send(ctx context.Context) (*ChangeMessageVisibilityBatchResponse, error)
Send marshals and sends the ChangeMessageVisibilityBatch API request.
type ChangeMessageVisibilityBatchRequestEntry ¶
type ChangeMessageVisibilityBatchRequestEntry struct { // An identifier for this particular receipt handle used to communicate the // result. // // The Ids of a batch request need to be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` // A receipt handle. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // The new value (in seconds) for the message's visibility timeout. VisibilityTimeout *int64 `type:"integer"` // contains filtered or unexported fields }
Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle
&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
func (ChangeMessageVisibilityBatchRequestEntry) String ¶
func (s ChangeMessageVisibilityBatchRequestEntry) String() string
String returns the string representation
func (*ChangeMessageVisibilityBatchRequestEntry) Validate ¶
func (s *ChangeMessageVisibilityBatchRequestEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangeMessageVisibilityBatchResponse ¶ added in v0.9.0
type ChangeMessageVisibilityBatchResponse struct { *ChangeMessageVisibilityBatchOutput // contains filtered or unexported fields }
ChangeMessageVisibilityBatchResponse is the response type for the ChangeMessageVisibilityBatch API operation.
func (*ChangeMessageVisibilityBatchResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ChangeMessageVisibilityBatchResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ChangeMessageVisibilityBatch request.
type ChangeMessageVisibilityBatchResultEntry ¶
type ChangeMessageVisibilityBatchResultEntry struct { // Represents a message whose visibility timeout has been changed successfully. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Encloses the Id of an entry in ChangeMessageVisibilityBatch.
func (ChangeMessageVisibilityBatchResultEntry) String ¶
func (s ChangeMessageVisibilityBatchResultEntry) String() string
String returns the string representation
type ChangeMessageVisibilityInput ¶
type ChangeMessageVisibilityInput struct { // The URL of the Amazon SQS queue whose message's visibility is changed. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The receipt handle associated with the message whose visibility timeout is // changed. This parameter is returned by the ReceiveMessage action. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // The new value for the message's visibility timeout (in seconds). Values values: // 0 to 43200. Maximum: 12 hours. // // VisibilityTimeout is a required field VisibilityTimeout *int64 `type:"integer" required:"true"` // contains filtered or unexported fields }
func (ChangeMessageVisibilityInput) String ¶
func (s ChangeMessageVisibilityInput) String() string
String returns the string representation
func (*ChangeMessageVisibilityInput) Validate ¶
func (s *ChangeMessageVisibilityInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangeMessageVisibilityOutput ¶
type ChangeMessageVisibilityOutput struct {
// contains filtered or unexported fields
}
func (ChangeMessageVisibilityOutput) String ¶
func (s ChangeMessageVisibilityOutput) String() string
String returns the string representation
type ChangeMessageVisibilityRequest ¶
type ChangeMessageVisibilityRequest struct { *aws.Request Input *ChangeMessageVisibilityInput Copy func(*ChangeMessageVisibilityInput) ChangeMessageVisibilityRequest }
ChangeMessageVisibilityRequest is the request type for the ChangeMessageVisibility API operation.
func (ChangeMessageVisibilityRequest) Send ¶
func (r ChangeMessageVisibilityRequest) Send(ctx context.Context) (*ChangeMessageVisibilityResponse, error)
Send marshals and sends the ChangeMessageVisibility API request.
type ChangeMessageVisibilityResponse ¶ added in v0.9.0
type ChangeMessageVisibilityResponse struct { *ChangeMessageVisibilityOutput // contains filtered or unexported fields }
ChangeMessageVisibilityResponse is the response type for the ChangeMessageVisibility API operation.
func (*ChangeMessageVisibilityResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ChangeMessageVisibilityResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ChangeMessageVisibility request.
type Client ¶ added in v0.9.0
type Client struct { *aws.Client // Disables the computation and validation of request and response checksums. DisableComputeChecksums bool }
Client provides the API operation methods for making requests to Amazon SQS. See this package's package overview docs for details on the service.
The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the client from the provided Config.
Example:
// Create a client from just a config. svc := sqs.New(myConfig)
func (*Client) AddPermissionRequest ¶ added in v0.9.0
func (c *Client) AddPermissionRequest(input *AddPermissionInput) AddPermissionRequest
AddPermissionRequest returns a request value for making API operation for Amazon Simple Queue Service.
Adds a permission to a queue for a specific principal (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P). This allows sharing access to the queue.
When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) in the Amazon Simple Queue Service Developer Guide.
AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) in the Amazon Simple Queue Service Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
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 Simple Queue Service Developer Guide.
// Example sending a request using AddPermissionRequest. req := client.AddPermissionRequest(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/AddPermission
func (*Client) ChangeMessageVisibilityBatchRequest ¶ added in v0.9.0
func (c *Client) ChangeMessageVisibilityBatchRequest(input *ChangeMessageVisibilityBatchInput) ChangeMessageVisibilityBatchRequest
ChangeMessageVisibilityBatchRequest returns a request value for making API operation for Amazon Simple Queue Service.
Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
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
// Example sending a request using ChangeMessageVisibilityBatchRequest. req := client.ChangeMessageVisibilityBatchRequest(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/ChangeMessageVisibilityBatch
func (*Client) ChangeMessageVisibilityRequest ¶ added in v0.9.0
func (c *Client) ChangeMessageVisibilityRequest(input *ChangeMessageVisibilityInput) ChangeMessageVisibilityRequest
ChangeMessageVisibilityRequest returns a request value for making API operation for Amazon Simple Queue Service.
Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon Simple Queue Service Developer Guide.
For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.
An Amazon SQS message has three basic states:
Sent to a queue by a producer.
Received from the queue by a consumer.
Deleted from the queue.
A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.
For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs).
For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
// Example sending a request using ChangeMessageVisibilityRequest. req := client.ChangeMessageVisibilityRequest(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/ChangeMessageVisibility
func (*Client) CreateQueueRequest ¶ added in v0.9.0
func (c *Client) CreateQueueRequest(input *CreateQueueInput) CreateQueueRequest
CreateQueueRequest returns a request value for making API operation for Amazon Simple Queue Service.
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 Simple Queue Service 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 Simple Queue Service Developer Guide.
// Example sending a request using CreateQueueRequest. req := client.CreateQueueRequest(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/CreateQueue
func (*Client) DeleteMessageBatchRequest ¶ added in v0.9.0
func (c *Client) DeleteMessageBatchRequest(input *DeleteMessageBatchInput) DeleteMessageBatchRequest
DeleteMessageBatchRequest returns a request value for making API operation for Amazon Simple Queue Service.
Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
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
// Example sending a request using DeleteMessageBatchRequest. req := client.DeleteMessageBatchRequest(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/DeleteMessageBatch
func (*Client) DeleteMessageRequest ¶ added in v0.9.0
func (c *Client) DeleteMessageRequest(input *DeleteMessageInput) DeleteMessageRequest
DeleteMessageRequest returns a request value for making API operation for Amazon Simple Queue Service.
Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted).
For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.
// Example sending a request using DeleteMessageRequest. req := client.DeleteMessageRequest(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/DeleteMessage
func (*Client) DeleteQueueRequest ¶ added in v0.9.0
func (c *Client) DeleteQueueRequest(input *DeleteQueueInput) DeleteQueueRequest
DeleteQueueRequest returns a request value for making API operation for Amazon Simple Queue Service.
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
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.
// Example sending a request using DeleteQueueRequest. req := client.DeleteQueueRequest(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/DeleteQueue
func (*Client) GetQueueAttributesRequest ¶ added in v0.9.0
func (c *Client) GetQueueAttributesRequest(input *GetQueueAttributesInput) GetQueueAttributesRequest
GetQueueAttributesRequest returns a request value for making API operation for Amazon Simple Queue Service.
Gets attributes for the specified queue.
To determine whether a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), you can check whether QueueName ends with the .fifo suffix.
// Example sending a request using GetQueueAttributesRequest. req := client.GetQueueAttributesRequest(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/GetQueueAttributes
func (*Client) GetQueueUrlRequest ¶ added in v0.9.0
func (c *Client) GetQueueUrlRequest(input *GetQueueUrlInput) GetQueueUrlRequest
GetQueueUrlRequest returns a request value for making API operation for Amazon Simple Queue Service.
Returns the URL of an existing Amazon SQS queue.
To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) in the Amazon Simple Queue Service Developer Guide.
// Example sending a request using GetQueueUrlRequest. req := client.GetQueueUrlRequest(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/GetQueueUrl
func (*Client) ListDeadLetterSourceQueuesRequest ¶ added in v0.9.0
func (c *Client) ListDeadLetterSourceQueuesRequest(input *ListDeadLetterSourceQueuesInput) ListDeadLetterSourceQueuesRequest
ListDeadLetterSourceQueuesRequest returns a request value for making API operation for Amazon Simple Queue Service.
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
For more information about using 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.
// Example sending a request using ListDeadLetterSourceQueuesRequest. req := client.ListDeadLetterSourceQueuesRequest(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/ListDeadLetterSourceQueues
func (*Client) ListQueueTagsRequest ¶ added in v0.9.0
func (c *Client) ListQueueTagsRequest(input *ListQueueTagsInput) ListQueueTagsRequest
ListQueueTagsRequest returns a request value for making API operation for Amazon Simple Queue Service.
List all cost allocation tags added 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 Simple Queue Service Developer Guide.
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.
// Example sending a request using ListQueueTagsRequest. req := client.ListQueueTagsRequest(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/ListQueueTags
func (*Client) ListQueuesRequest ¶ added in v0.9.0
func (c *Client) ListQueuesRequest(input *ListQueuesInput) ListQueuesRequest
ListQueuesRequest returns a request value for making API operation for Amazon Simple Queue Service.
Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
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.
// Example sending a request using ListQueuesRequest. req := client.ListQueuesRequest(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/ListQueues
func (*Client) PurgeQueueRequest ¶ added in v0.9.0
func (c *Client) PurgeQueueRequest(input *PurgeQueueInput) PurgeQueueRequest
PurgeQueueRequest returns a request value for making API operation for Amazon Simple Queue Service.
Deletes the messages in a queue specified by the QueueURL parameter.
When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.
Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.
Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.
// Example sending a request using PurgeQueueRequest. req := client.PurgeQueueRequest(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/PurgeQueue
func (*Client) ReceiveMessageRequest ¶ added in v0.9.0
func (c *Client) ReceiveMessageRequest(input *ReceiveMessageInput) ReceiveMessageRequest
ReceiveMessageRequest returns a request value for making API operation for Amazon Simple Queue Service.
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html) in the Amazon Simple Queue Service Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
For each message returned, the response includes the following:
The message body.
An MD5 digest of the message body. For information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).
The MessageId you received when you sent the message to the queue.
The receipt handle.
The message attributes.
An MD5 digest of the message attributes.
The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) in the Amazon Simple Queue Service Developer Guide.
You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon Simple Queue Service Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
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.
// Example sending a request using ReceiveMessageRequest. req := client.ReceiveMessageRequest(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/ReceiveMessage
func (*Client) RemovePermissionRequest ¶ added in v0.9.0
func (c *Client) RemovePermissionRequest(input *RemovePermissionInput) RemovePermissionRequest
RemovePermissionRequest returns a request value for making API operation for Amazon Simple Queue Service.
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
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 RemovePermissionRequest. req := client.RemovePermissionRequest(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/RemovePermission
func (*Client) SendMessageBatchRequest ¶ added in v0.9.0
func (c *Client) SendMessageBatchRequest(input *SendMessageBatchInput) SendMessageBatchRequest
SendMessageBatchRequest returns a request value for making API operation for Amazon Simple Queue Service.
Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
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
// Example sending a request using SendMessageBatchRequest. req := client.SendMessageBatchRequest(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/SendMessageBatch
func (*Client) SendMessageRequest ¶ added in v0.9.0
func (c *Client) SendMessageRequest(input *SendMessageInput) SendMessageRequest
SendMessageRequest returns a request value for making API operation for Amazon Simple Queue Service.
Delivers a message to the specified queue.
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).
// Example sending a request using SendMessageRequest. req := client.SendMessageRequest(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/SendMessage
func (*Client) SetQueueAttributesRequest ¶ added in v0.9.0
func (c *Client) SetQueueAttributesRequest(input *SetQueueAttributesInput) SetQueueAttributesRequest
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 (*Client) TagQueueRequest ¶ added in v0.9.0
func (c *Client) TagQueueRequest(input *TagQueueInput) TagQueueRequest
TagQueueRequest returns a request value for making API operation for Amazon Simple Queue Service.
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 Simple Queue Service 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 Limits Related to Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) in the Amazon Simple Queue Service Developer Guide.
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.
// Example sending a request using TagQueueRequest. req := client.TagQueueRequest(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/TagQueue
func (*Client) UntagQueueRequest ¶ added in v0.9.0
func (c *Client) UntagQueueRequest(input *UntagQueueInput) UntagQueueRequest
UntagQueueRequest returns a request value for making API operation for Amazon Simple Queue Service.
Remove cost allocation tags from 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 Simple Queue Service Developer Guide.
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.
// Example sending a request using UntagQueueRequest. req := client.UntagQueueRequest(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/UntagQueue
type CreateQueueInput ¶
type CreateQueueInput struct { // 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 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 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 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 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: true, 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.html#FIFO-queues-understanding-logic) // in the Amazon Simple Queue Service Developer Guide. // // * ContentBasedDeduplication – Enables content-based deduplication. Valid // values: true, false. 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 map[string]string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // 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. // // QueueName is a required field QueueName *string `type:"string" required:"true"` // 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 Simple Queue Service 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 Limits Related to Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) // in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide. Tags map[string]string `locationName:"Tag" locationNameKey:"Key" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
func (CreateQueueInput) String ¶
func (s CreateQueueInput) String() string
String returns the string representation
func (*CreateQueueInput) Validate ¶
func (s *CreateQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateQueueOutput ¶
type CreateQueueOutput struct { // The URL of the created Amazon SQS queue. QueueUrl *string `type:"string"` // contains filtered or unexported fields }
Returns the QueueUrl attribute of the created queue.
func (CreateQueueOutput) String ¶
func (s CreateQueueOutput) String() string
String returns the string representation
type CreateQueueRequest ¶
type CreateQueueRequest struct { *aws.Request Input *CreateQueueInput Copy func(*CreateQueueInput) CreateQueueRequest }
CreateQueueRequest is the request type for the CreateQueue API operation.
func (CreateQueueRequest) Send ¶
func (r CreateQueueRequest) Send(ctx context.Context) (*CreateQueueResponse, error)
Send marshals and sends the CreateQueue API request.
type CreateQueueResponse ¶ added in v0.9.0
type CreateQueueResponse struct { *CreateQueueOutput // contains filtered or unexported fields }
CreateQueueResponse is the response type for the CreateQueue API operation.
func (*CreateQueueResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateQueueResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateQueue request.
type DeleteMessageBatchInput ¶
type DeleteMessageBatchInput struct { // A list of receipt handles for the messages to be deleted. // // Entries is a required field Entries []DeleteMessageBatchRequestEntry `locationNameList:"DeleteMessageBatchRequestEntry" type:"list" flattened:"true" required:"true"` // The URL of the Amazon SQS queue from which messages are deleted. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteMessageBatchInput) String ¶
func (s DeleteMessageBatchInput) String() string
String returns the string representation
func (*DeleteMessageBatchInput) Validate ¶
func (s *DeleteMessageBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMessageBatchOutput ¶
type DeleteMessageBatchOutput struct { // A list of BatchResultErrorEntry items. // // Failed is a required field Failed []BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"` // A list of DeleteMessageBatchResultEntry items. // // Successful is a required field Successful []DeleteMessageBatchResultEntry `locationNameList:"DeleteMessageBatchResultEntry" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.
func (DeleteMessageBatchOutput) String ¶
func (s DeleteMessageBatchOutput) String() string
String returns the string representation
type DeleteMessageBatchRequest ¶
type DeleteMessageBatchRequest struct { *aws.Request Input *DeleteMessageBatchInput Copy func(*DeleteMessageBatchInput) DeleteMessageBatchRequest }
DeleteMessageBatchRequest is the request type for the DeleteMessageBatch API operation.
func (DeleteMessageBatchRequest) Send ¶
func (r DeleteMessageBatchRequest) Send(ctx context.Context) (*DeleteMessageBatchResponse, error)
Send marshals and sends the DeleteMessageBatch API request.
type DeleteMessageBatchRequestEntry ¶
type DeleteMessageBatchRequestEntry struct { // An identifier for this particular receipt handle. This is used to communicate // the result. // // The Ids of a batch request need to be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` // A receipt handle. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // contains filtered or unexported fields }
Encloses a receipt handle and an identifier for it.
func (DeleteMessageBatchRequestEntry) String ¶
func (s DeleteMessageBatchRequestEntry) String() string
String returns the string representation
func (*DeleteMessageBatchRequestEntry) Validate ¶
func (s *DeleteMessageBatchRequestEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMessageBatchResponse ¶ added in v0.9.0
type DeleteMessageBatchResponse struct { *DeleteMessageBatchOutput // contains filtered or unexported fields }
DeleteMessageBatchResponse is the response type for the DeleteMessageBatch API operation.
func (*DeleteMessageBatchResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteMessageBatchResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteMessageBatch request.
type DeleteMessageBatchResultEntry ¶
type DeleteMessageBatchResultEntry struct { // Represents a successfully deleted message. // // Id is a required field Id *string `type:"string" required:"true"` // contains filtered or unexported fields }
Encloses the Id of an entry in DeleteMessageBatch.
func (DeleteMessageBatchResultEntry) String ¶
func (s DeleteMessageBatchResultEntry) String() string
String returns the string representation
type DeleteMessageInput ¶
type DeleteMessageInput struct { // The URL of the Amazon SQS queue from which messages are deleted. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The receipt handle associated with the message to delete. // // ReceiptHandle is a required field ReceiptHandle *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteMessageInput) String ¶
func (s DeleteMessageInput) String() string
String returns the string representation
func (*DeleteMessageInput) Validate ¶
func (s *DeleteMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteMessageOutput ¶
type DeleteMessageOutput struct {
// contains filtered or unexported fields
}
func (DeleteMessageOutput) String ¶
func (s DeleteMessageOutput) String() string
String returns the string representation
type DeleteMessageRequest ¶
type DeleteMessageRequest struct { *aws.Request Input *DeleteMessageInput Copy func(*DeleteMessageInput) DeleteMessageRequest }
DeleteMessageRequest is the request type for the DeleteMessage API operation.
func (DeleteMessageRequest) Send ¶
func (r DeleteMessageRequest) Send(ctx context.Context) (*DeleteMessageResponse, error)
Send marshals and sends the DeleteMessage API request.
type DeleteMessageResponse ¶ added in v0.9.0
type DeleteMessageResponse struct { *DeleteMessageOutput // contains filtered or unexported fields }
DeleteMessageResponse is the response type for the DeleteMessage API operation.
func (*DeleteMessageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteMessageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteMessage request.
type DeleteQueueInput ¶
type DeleteQueueInput struct { // The URL of the Amazon SQS queue to delete. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteQueueInput) String ¶
func (s DeleteQueueInput) String() string
String returns the string representation
func (*DeleteQueueInput) Validate ¶
func (s *DeleteQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteQueueOutput ¶
type DeleteQueueOutput struct {
// contains filtered or unexported fields
}
func (DeleteQueueOutput) String ¶
func (s DeleteQueueOutput) String() string
String returns the string representation
type DeleteQueueRequest ¶
type DeleteQueueRequest struct { *aws.Request Input *DeleteQueueInput Copy func(*DeleteQueueInput) DeleteQueueRequest }
DeleteQueueRequest is the request type for the DeleteQueue API operation.
func (DeleteQueueRequest) Send ¶
func (r DeleteQueueRequest) Send(ctx context.Context) (*DeleteQueueResponse, error)
Send marshals and sends the DeleteQueue API request.
type DeleteQueueResponse ¶ added in v0.9.0
type DeleteQueueResponse struct { *DeleteQueueOutput // contains filtered or unexported fields }
DeleteQueueResponse is the response type for the DeleteQueue API operation.
func (*DeleteQueueResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteQueueResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteQueue request.
type GetQueueAttributesInput ¶
type GetQueueAttributesInput struct { // A list of attributes for which to retrieve information. // // 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. // // The following attributes are supported: // // The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, // and ApproximateNumberOfMessagesVisible metrics may not achieve consistency // until at least 1 minute after the producers stop sending messages. This period // is required for the queue metadata to reach eventual consistency. // // * All – Returns all values. // // * ApproximateNumberOfMessages – Returns the approximate number of messages // available for retrieval from the queue. // // * ApproximateNumberOfMessagesDelayed – Returns the approximate number // of messages in the queue that are delayed and not available for reading // immediately. This can happen when the queue is configured as a delay queue // or when a message has been sent with a delay parameter. // // * ApproximateNumberOfMessagesNotVisible – Returns the approximate number // of messages that are in flight. Messages are considered to be in flight // if they have been sent to a client but have not yet been deleted or have // not yet reached the end of their visibility window. // // * CreatedTimestamp – Returns the time when the queue was created in // seconds (epoch time (http://en.wikipedia.org/wiki/Unix_time)). // // * DelaySeconds – Returns the default delay on the queue in seconds. // // * LastModifiedTimestamp – Returns the time when the queue was last changed // in seconds (epoch time (http://en.wikipedia.org/wiki/Unix_time)). // // * MaximumMessageSize – Returns the limit of how many bytes a message // can contain before Amazon SQS rejects it. // // * MessageRetentionPeriod – Returns the length of time, in seconds, for // which Amazon SQS retains a message. // // * Policy – Returns the policy of the queue. // // * QueueArn – Returns the Amazon resource name (ARN) of the queue. // // * ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, // for which the ReceiveMessage action waits for a message to arrive. // // * 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 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. // // * VisibilityTimeout – Returns the visibility timeout for the queue. // 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 – Returns 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). // // * KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, // for which Amazon SQS can reuse a data key to encrypt or decrypt messages // before calling AWS KMS again. 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 attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html): // // * FifoQueue – Returns whether the queue is FIFO. For more information, // see FIFO Queue Logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic) // in the Amazon Simple Queue Service Developer Guide. To determine whether // a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), // you can check whether QueueName ends with the .fifo suffix. // // * ContentBasedDeduplication – Returns whether content-based deduplication // is enabled for the queue. 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. AttributeNames []QueueAttributeName `locationNameList:"AttributeName" type:"list" flattened:"true"` // The URL of the Amazon SQS queue whose attribute information is retrieved. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (GetQueueAttributesInput) String ¶
func (s GetQueueAttributesInput) String() string
String returns the string representation
func (*GetQueueAttributesInput) Validate ¶
func (s *GetQueueAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetQueueAttributesOutput ¶
type GetQueueAttributesOutput struct { // A map of attributes to their respective values. Attributes map[string]string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
A list of returned queue attributes.
func (GetQueueAttributesOutput) String ¶
func (s GetQueueAttributesOutput) String() string
String returns the string representation
type GetQueueAttributesRequest ¶
type GetQueueAttributesRequest struct { *aws.Request Input *GetQueueAttributesInput Copy func(*GetQueueAttributesInput) GetQueueAttributesRequest }
GetQueueAttributesRequest is the request type for the GetQueueAttributes API operation.
func (GetQueueAttributesRequest) Send ¶
func (r GetQueueAttributesRequest) Send(ctx context.Context) (*GetQueueAttributesResponse, error)
Send marshals and sends the GetQueueAttributes API request.
type GetQueueAttributesResponse ¶ added in v0.9.0
type GetQueueAttributesResponse struct { *GetQueueAttributesOutput // contains filtered or unexported fields }
GetQueueAttributesResponse is the response type for the GetQueueAttributes API operation.
func (*GetQueueAttributesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetQueueAttributesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetQueueAttributes request.
type GetQueueUrlInput ¶
type GetQueueUrlInput struct { // The name of the queue whose URL must be fetched. Maximum 80 characters. Valid // values: alphanumeric characters, hyphens (-), and underscores (_). // // Queue URLs and names are case-sensitive. // // QueueName is a required field QueueName *string `type:"string" required:"true"` // The AWS account ID of the account that created the queue. QueueOwnerAWSAccountId *string `type:"string"` // contains filtered or unexported fields }
func (GetQueueUrlInput) String ¶
func (s GetQueueUrlInput) String() string
String returns the string representation
func (*GetQueueUrlInput) Validate ¶
func (s *GetQueueUrlInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetQueueUrlOutput ¶
type GetQueueUrlOutput struct { // The URL of the queue. QueueUrl *string `type:"string"` // contains filtered or unexported fields }
For more information, see Interpreting Responses (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html) in the Amazon Simple Queue Service Developer Guide.
func (GetQueueUrlOutput) String ¶
func (s GetQueueUrlOutput) String() string
String returns the string representation
type GetQueueUrlRequest ¶
type GetQueueUrlRequest struct { *aws.Request Input *GetQueueUrlInput Copy func(*GetQueueUrlInput) GetQueueUrlRequest }
GetQueueUrlRequest is the request type for the GetQueueUrl API operation.
func (GetQueueUrlRequest) Send ¶
func (r GetQueueUrlRequest) Send(ctx context.Context) (*GetQueueUrlResponse, error)
Send marshals and sends the GetQueueUrl API request.
type GetQueueUrlResponse ¶ added in v0.9.0
type GetQueueUrlResponse struct { *GetQueueUrlOutput // contains filtered or unexported fields }
GetQueueUrlResponse is the response type for the GetQueueUrl API operation.
func (*GetQueueUrlResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *GetQueueUrlResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the GetQueueUrl request.
type InvalidChecksumError ¶ added in v0.20.0
InvalidChecksumError provides the error type for invalid checksum errors.
func (*InvalidChecksumError) Error ¶ added in v0.20.0
func (e *InvalidChecksumError) Error() string
func (*InvalidChecksumError) RetryableError ¶ added in v0.20.0
func (e *InvalidChecksumError) RetryableError() bool
RetryableError decorates this error as retryable.
func (*InvalidChecksumError) Unwrap ¶ added in v0.20.0
func (e *InvalidChecksumError) Unwrap() error
Unwrap returns the underlying error if there was one.
type ListDeadLetterSourceQueuesInput ¶
type ListDeadLetterSourceQueuesInput struct { // Maximum number of results to include in the response. MaxResults *int64 `type:"integer"` // Pagination token to request the next set of results. NextToken *string `type:"string"` // The URL of a dead-letter queue. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListDeadLetterSourceQueuesInput) String ¶
func (s ListDeadLetterSourceQueuesInput) String() string
String returns the string representation
func (*ListDeadLetterSourceQueuesInput) Validate ¶
func (s *ListDeadLetterSourceQueuesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDeadLetterSourceQueuesOutput ¶
type ListDeadLetterSourceQueuesOutput struct { // Pagination token to include in the next request. NextToken *string `type:"string"` // A list of source queue URLs that have the RedrivePolicy queue attribute configured // with a dead-letter queue. // // QueueUrls is a required field QueueUrls []string `locationName:"queueUrls" locationNameList:"QueueUrl" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
A list of your dead letter source queues.
func (ListDeadLetterSourceQueuesOutput) String ¶
func (s ListDeadLetterSourceQueuesOutput) String() string
String returns the string representation
type ListDeadLetterSourceQueuesPaginator ¶ added in v0.24.0
ListDeadLetterSourceQueuesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListDeadLetterSourceQueuesPaginator ¶ added in v0.24.0
func NewListDeadLetterSourceQueuesPaginator(req ListDeadLetterSourceQueuesRequest) ListDeadLetterSourceQueuesPaginator
NewListDeadLetterSourceQueuesRequestPaginator returns a paginator for ListDeadLetterSourceQueues. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListDeadLetterSourceQueuesRequest(input) p := sqs.NewListDeadLetterSourceQueuesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListDeadLetterSourceQueuesPaginator) CurrentPage ¶ added in v0.24.0
func (p *ListDeadLetterSourceQueuesPaginator) CurrentPage() *ListDeadLetterSourceQueuesOutput
type ListDeadLetterSourceQueuesRequest ¶
type ListDeadLetterSourceQueuesRequest struct { *aws.Request Input *ListDeadLetterSourceQueuesInput Copy func(*ListDeadLetterSourceQueuesInput) ListDeadLetterSourceQueuesRequest }
ListDeadLetterSourceQueuesRequest is the request type for the ListDeadLetterSourceQueues API operation.
func (ListDeadLetterSourceQueuesRequest) Send ¶
func (r ListDeadLetterSourceQueuesRequest) Send(ctx context.Context) (*ListDeadLetterSourceQueuesResponse, error)
Send marshals and sends the ListDeadLetterSourceQueues API request.
type ListDeadLetterSourceQueuesResponse ¶ added in v0.9.0
type ListDeadLetterSourceQueuesResponse struct { *ListDeadLetterSourceQueuesOutput // contains filtered or unexported fields }
ListDeadLetterSourceQueuesResponse is the response type for the ListDeadLetterSourceQueues API operation.
func (*ListDeadLetterSourceQueuesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListDeadLetterSourceQueuesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListDeadLetterSourceQueues request.
type ListQueueTagsInput ¶ added in v0.2.0
type ListQueueTagsInput struct { // The URL of the queue. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListQueueTagsInput) String ¶ added in v0.2.0
func (s ListQueueTagsInput) String() string
String returns the string representation
func (*ListQueueTagsInput) Validate ¶ added in v0.2.0
func (s *ListQueueTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListQueueTagsOutput ¶ added in v0.2.0
type ListQueueTagsOutput struct { // The list of all tags added to the specified queue. Tags map[string]string `locationName:"Tag" locationNameKey:"Key" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
func (ListQueueTagsOutput) String ¶ added in v0.2.0
func (s ListQueueTagsOutput) String() string
String returns the string representation
type ListQueueTagsRequest ¶ added in v0.2.0
type ListQueueTagsRequest struct { *aws.Request Input *ListQueueTagsInput Copy func(*ListQueueTagsInput) ListQueueTagsRequest }
ListQueueTagsRequest is the request type for the ListQueueTags API operation.
func (ListQueueTagsRequest) Send ¶ added in v0.2.0
func (r ListQueueTagsRequest) Send(ctx context.Context) (*ListQueueTagsResponse, error)
Send marshals and sends the ListQueueTags API request.
type ListQueueTagsResponse ¶ added in v0.9.0
type ListQueueTagsResponse struct { *ListQueueTagsOutput // contains filtered or unexported fields }
ListQueueTagsResponse is the response type for the ListQueueTags API operation.
func (*ListQueueTagsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListQueueTagsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListQueueTags request.
type ListQueuesInput ¶
type ListQueuesInput struct { // Maximum number of results to include in the response. MaxResults *int64 `type:"integer"` // Pagination token to request the next set of results. NextToken *string `type:"string"` // A string to use for filtering the list results. Only those queues whose name // begins with the specified string are returned. // // Queue URLs and names are case-sensitive. QueueNamePrefix *string `type:"string"` // contains filtered or unexported fields }
func (ListQueuesInput) String ¶
func (s ListQueuesInput) String() string
String returns the string representation
type ListQueuesOutput ¶
type ListQueuesOutput struct { // Pagination token to include in the next request. NextToken *string `type:"string"` // A list of queue URLs, up to 1,000 entries, or the value of MaxResults that // you sent in the request. QueueUrls []string `locationNameList:"QueueUrl" type:"list" flattened:"true"` // contains filtered or unexported fields }
A list of your queues.
func (ListQueuesOutput) String ¶
func (s ListQueuesOutput) String() string
String returns the string representation
type ListQueuesPaginator ¶ added in v0.24.0
ListQueuesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.
func NewListQueuesPaginator ¶ added in v0.24.0
func NewListQueuesPaginator(req ListQueuesRequest) ListQueuesPaginator
NewListQueuesRequestPaginator returns a paginator for ListQueues. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.
Note: This operation can generate multiple requests to a service.
// Example iterating over pages. req := client.ListQueuesRequest(input) p := sqs.NewListQueuesRequestPaginator(req) for p.Next(context.TODO()) { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (*ListQueuesPaginator) CurrentPage ¶ added in v0.24.0
func (p *ListQueuesPaginator) CurrentPage() *ListQueuesOutput
type ListQueuesRequest ¶
type ListQueuesRequest struct { *aws.Request Input *ListQueuesInput Copy func(*ListQueuesInput) ListQueuesRequest }
ListQueuesRequest is the request type for the ListQueues API operation.
func (ListQueuesRequest) Send ¶
func (r ListQueuesRequest) Send(ctx context.Context) (*ListQueuesResponse, error)
Send marshals and sends the ListQueues API request.
type ListQueuesResponse ¶ added in v0.9.0
type ListQueuesResponse struct { *ListQueuesOutput // contains filtered or unexported fields }
ListQueuesResponse is the response type for the ListQueues API operation.
func (*ListQueuesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListQueuesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListQueues request.
type Message ¶
type Message struct { // A map of the attributes requested in ReceiveMessage to their respective values. // Supported attributes: // // * ApproximateReceiveCount // // * ApproximateFirstReceiveTimestamp // // * MessageDeduplicationId // // * MessageGroupId // // * SenderId // // * SentTimestamp // // * SequenceNumber // // ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an // integer representing the epoch time (http://en.wikipedia.org/wiki/Unix_time) // in milliseconds. Attributes map[string]string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The message's contents (not URL-encoded). Body *string `type:"string"` // An MD5 digest of the non-URL-encoded message body string. MD5OfBody *string `type:"string"` // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageAttributes *string `type:"string"` // Each message attribute consists of a Name, Type, and Value. For more information, // see Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) // in the Amazon Simple Queue Service Developer Guide. MessageAttributes map[string]MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // A unique identifier for the message. A MessageIdis considered unique across // all AWS accounts for an extended period of time. MessageId *string `type:"string"` // An identifier associated with the act of receiving the message. A new receipt // handle is returned every time you receive a message. When deleting a message, // you provide the last received receipt handle to delete the message. ReceiptHandle *string `type:"string"` // contains filtered or unexported fields }
An Amazon SQS message.
type MessageAttributeValue ¶
type MessageAttributeValue struct { // Not implemented. Reserved for future use. BinaryListValues [][]byte `locationName:"BinaryListValue" locationNameList:"BinaryListValue" type:"list" flattened:"true"` // Binary type attributes can store any binary data, such as compressed data, // encrypted data, or images. // // BinaryValue is automatically base64 encoded/decoded by the SDK. BinaryValue []byte `type:"blob"` // Amazon SQS supports the following logical data types: String, Number, and // Binary. For the Number data type, you must use StringValue. // // You can also append custom labels. For more information, see Amazon SQS Message // Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) // in the Amazon Simple Queue Service Developer Guide. // // DataType is a required field DataType *string `type:"string" required:"true"` // Not implemented. Reserved for future use. StringListValues []string `locationName:"StringListValue" locationNameList:"StringListValue" type:"list" flattened:"true"` // Strings are Unicode with UTF-8 binary encoding. For a list of code values, // see ASCII Printable Characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). StringValue *string `type:"string"` // contains filtered or unexported fields }
The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
func (MessageAttributeValue) String ¶
func (s MessageAttributeValue) String() string
String returns the string representation
func (*MessageAttributeValue) Validate ¶
func (s *MessageAttributeValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MessageSystemAttributeName ¶
type MessageSystemAttributeName string
const ( MessageSystemAttributeNameSenderId MessageSystemAttributeName = "SenderId" MessageSystemAttributeNameSentTimestamp MessageSystemAttributeName = "SentTimestamp" MessageSystemAttributeNameApproximateReceiveCount MessageSystemAttributeName = "ApproximateReceiveCount" MessageSystemAttributeNameApproximateFirstReceiveTimestamp MessageSystemAttributeName = "ApproximateFirstReceiveTimestamp" MessageSystemAttributeNameSequenceNumber MessageSystemAttributeName = "SequenceNumber" MessageSystemAttributeNameMessageDeduplicationId MessageSystemAttributeName = "MessageDeduplicationId" MessageSystemAttributeNameMessageGroupId MessageSystemAttributeName = "MessageGroupId" MessageSystemAttributeNameAwstraceHeader MessageSystemAttributeName = "AWSTraceHeader" )
Enum values for MessageSystemAttributeName
func (MessageSystemAttributeName) MarshalValue ¶ added in v0.3.0
func (enum MessageSystemAttributeName) MarshalValue() (string, error)
func (MessageSystemAttributeName) MarshalValueBuf ¶ added in v0.3.0
func (enum MessageSystemAttributeName) MarshalValueBuf(b []byte) ([]byte, error)
type MessageSystemAttributeNameForSends ¶ added in v0.12.0
type MessageSystemAttributeNameForSends string
const (
MessageSystemAttributeNameForSendsAwstraceHeader MessageSystemAttributeNameForSends = "AWSTraceHeader"
)
Enum values for MessageSystemAttributeNameForSends
func (MessageSystemAttributeNameForSends) MarshalValue ¶ added in v0.12.0
func (enum MessageSystemAttributeNameForSends) MarshalValue() (string, error)
func (MessageSystemAttributeNameForSends) MarshalValueBuf ¶ added in v0.12.0
func (enum MessageSystemAttributeNameForSends) MarshalValueBuf(b []byte) ([]byte, error)
type MessageSystemAttributeValue ¶ added in v0.12.0
type MessageSystemAttributeValue struct { // Not implemented. Reserved for future use. BinaryListValues [][]byte `locationName:"BinaryListValue" locationNameList:"BinaryListValue" type:"list" flattened:"true"` // Binary type attributes can store any binary data, such as compressed data, // encrypted data, or images. // // BinaryValue is automatically base64 encoded/decoded by the SDK. BinaryValue []byte `type:"blob"` // Amazon SQS supports the following logical data types: String, Number, and // Binary. For the Number data type, you must use StringValue. // // You can also append custom labels. For more information, see Amazon SQS Message // Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) // in the Amazon Simple Queue Service Developer Guide. // // DataType is a required field DataType *string `type:"string" required:"true"` // Not implemented. Reserved for future use. StringListValues []string `locationName:"StringListValue" locationNameList:"StringListValue" type:"list" flattened:"true"` // Strings are Unicode with UTF-8 binary encoding. For a list of code values, // see ASCII Printable Characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters). StringValue *string `type:"string"` // contains filtered or unexported fields }
The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.
Name, type, value and the message body must not be empty or null.
func (MessageSystemAttributeValue) String ¶ added in v0.12.0
func (s MessageSystemAttributeValue) String() string
String returns the string representation
func (*MessageSystemAttributeValue) Validate ¶ added in v0.12.0
func (s *MessageSystemAttributeValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PurgeQueueInput ¶
type PurgeQueueInput struct { // The URL of the queue from which the PurgeQueue action deletes messages. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (PurgeQueueInput) String ¶
func (s PurgeQueueInput) String() string
String returns the string representation
func (*PurgeQueueInput) Validate ¶
func (s *PurgeQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PurgeQueueOutput ¶
type PurgeQueueOutput struct {
// contains filtered or unexported fields
}
func (PurgeQueueOutput) String ¶
func (s PurgeQueueOutput) String() string
String returns the string representation
type PurgeQueueRequest ¶
type PurgeQueueRequest struct { *aws.Request Input *PurgeQueueInput Copy func(*PurgeQueueInput) PurgeQueueRequest }
PurgeQueueRequest is the request type for the PurgeQueue API operation.
func (PurgeQueueRequest) Send ¶
func (r PurgeQueueRequest) Send(ctx context.Context) (*PurgeQueueResponse, error)
Send marshals and sends the PurgeQueue API request.
type PurgeQueueResponse ¶ added in v0.9.0
type PurgeQueueResponse struct { *PurgeQueueOutput // contains filtered or unexported fields }
PurgeQueueResponse is the response type for the PurgeQueue API operation.
func (*PurgeQueueResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *PurgeQueueResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the PurgeQueue request.
type QueueAttributeName ¶
type QueueAttributeName string
const ( QueueAttributeNameAll QueueAttributeName = "All" QueueAttributeNamePolicy QueueAttributeName = "Policy" QueueAttributeNameVisibilityTimeout QueueAttributeName = "VisibilityTimeout" QueueAttributeNameMaximumMessageSize QueueAttributeName = "MaximumMessageSize" QueueAttributeNameMessageRetentionPeriod QueueAttributeName = "MessageRetentionPeriod" QueueAttributeNameApproximateNumberOfMessages QueueAttributeName = "ApproximateNumberOfMessages" QueueAttributeNameApproximateNumberOfMessagesNotVisible QueueAttributeName = "ApproximateNumberOfMessagesNotVisible" QueueAttributeNameCreatedTimestamp QueueAttributeName = "CreatedTimestamp" QueueAttributeNameLastModifiedTimestamp QueueAttributeName = "LastModifiedTimestamp" QueueAttributeNameQueueArn QueueAttributeName = "QueueArn" QueueAttributeNameApproximateNumberOfMessagesDelayed QueueAttributeName = "ApproximateNumberOfMessagesDelayed" QueueAttributeNameDelaySeconds QueueAttributeName = "DelaySeconds" QueueAttributeNameReceiveMessageWaitTimeSeconds QueueAttributeName = "ReceiveMessageWaitTimeSeconds" QueueAttributeNameRedrivePolicy QueueAttributeName = "RedrivePolicy" QueueAttributeNameFifoQueue QueueAttributeName = "FifoQueue" QueueAttributeNameContentBasedDeduplication QueueAttributeName = "ContentBasedDeduplication" QueueAttributeNameKmsMasterKeyId QueueAttributeName = "KmsMasterKeyId" QueueAttributeNameKmsDataKeyReusePeriodSeconds QueueAttributeName = "KmsDataKeyReusePeriodSeconds" )
Enum values for QueueAttributeName
func (QueueAttributeName) MarshalValue ¶ added in v0.3.0
func (enum QueueAttributeName) MarshalValue() (string, error)
func (QueueAttributeName) MarshalValueBuf ¶ added in v0.3.0
func (enum QueueAttributeName) MarshalValueBuf(b []byte) ([]byte, error)
type ReceiveMessageInput ¶
type ReceiveMessageInput struct { // A list of attributes that need to be returned along with each message. These // attributes include: // // * All – Returns all values. // // * ApproximateFirstReceiveTimestamp – Returns the time the message was // first received from the queue (epoch time (http://en.wikipedia.org/wiki/Unix_time) // in milliseconds). // // * ApproximateReceiveCount – Returns the number of times a message has // been received across all queues but not deleted. // // * AWSTraceHeader – Returns the AWS X-Ray trace header string. // // * SenderId For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R. // For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456. // // * SentTimestamp – Returns the time the message was sent to the queue // (epoch time (http://en.wikipedia.org/wiki/Unix_time) in milliseconds). // // * MessageDeduplicationId – Returns the value provided by the producer // that calls the SendMessage action. // // * MessageGroupId – Returns the value provided by the producer that calls // the SendMessage action. Messages with the same MessageGroupId are returned // in sequence. // // * SequenceNumber – Returns the value provided by Amazon SQS. AttributeNames []QueueAttributeName `locationNameList:"AttributeName" type:"list" flattened:"true"` // The maximum number of messages to return. Amazon SQS never returns more messages // than this value (however, fewer messages might be returned). Valid values: // 1 to 10. Default: 1. MaxNumberOfMessages *int64 `type:"integer"` // The name of the message attribute, where N is the index. // // * The name can contain alphanumeric characters and the underscore (_), // hyphen (-), and period (.). // // * The name is case-sensitive and must be unique among all attribute names // for the message. // // * The name must not start with AWS-reserved prefixes such as AWS. or Amazon. // (or any casing variants). // // * The name must not start or end with a period (.), and it should not // have periods in succession (..). // // * The name can be up to 256 characters long. // // When using ReceiveMessage, you can send a list of attribute names to receive, // or you can return all of the attributes by specifying All or .* in your request. // You can also use all message attributes starting with a prefix, for example // bar.*. MessageAttributeNames []string `locationNameList:"MessageAttributeName" type:"list" flattened:"true"` // The URL of the Amazon SQS queue from which messages are received. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The token used for deduplication of ReceiveMessage calls. If a networking // issue occurs after a ReceiveMessage action, and instead of a response you // receive a generic error, it is possible to retry the same action with an // identical ReceiveRequestAttemptId to retrieve the same set of messages, even // if their visibility timeout has not yet expired. // // * You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage // action. // // * When you set FifoQueue, a caller of the ReceiveMessage action can provide // a ReceiveRequestAttemptId explicitly. // // * If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, // Amazon SQS generates a ReceiveRequestAttemptId. // // * It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId // if none of the messages have been modified (deleted or had their visibility // changes). // // * During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId // return the same messages and receipt handles. If a retry occurs within // the deduplication interval, it resets the visibility timeout. For more // information, see Visibility Timeout (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) // in the Amazon Simple Queue Service Developer Guide. If a caller of the // ReceiveMessage action still processes messages when the visibility timeout // expires and messages become visible, another worker consuming from the // same queue can receive the same messages and therefore process duplicates. // Also, if a consumer whose message processing time is longer than the visibility // timeout tries to delete the processed messages, the action fails with // an error. To mitigate this effect, ensure that your application observes // a safe threshold before the visibility timeout expires and extend the // visibility timeout as necessary. // // * While messages with a particular MessageGroupId are invisible, no more // messages belonging to the same MessageGroupId are returned until the visibility // timeout expires. You can still receive messages with another MessageGroupId // as long as it is also visible. // // * If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, // no retries work until the original visibility timeout expires. As a result, // delays might occur but the messages in the queue remain in a strict order. // // The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId // Request Parameter (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html) // in the Amazon Simple Queue Service Developer Guide. ReceiveRequestAttemptId *string `type:"string"` // The duration (in seconds) that the received messages are hidden from subsequent // retrieve requests after being retrieved by a ReceiveMessage request. VisibilityTimeout *int64 `type:"integer"` // The duration (in seconds) for which the call waits for a message to arrive // in the queue before returning. If a message is available, the call returns // sooner than WaitTimeSeconds. If no messages are available and the wait time // expires, the call returns successfully with an empty list of messages. // // To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage // requests is longer than the WaitTimeSeconds parameter. For example, with // the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient // (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html) // for asynchronous clients, or the ApacheHttpClient (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html) // for synchronous clients. WaitTimeSeconds *int64 `type:"integer"` // contains filtered or unexported fields }
func (ReceiveMessageInput) String ¶
func (s ReceiveMessageInput) String() string
String returns the string representation
func (*ReceiveMessageInput) Validate ¶
func (s *ReceiveMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ReceiveMessageOutput ¶
type ReceiveMessageOutput struct { // A list of messages. Messages []Message `locationNameList:"Message" type:"list" flattened:"true"` // contains filtered or unexported fields }
A list of received messages.
func (ReceiveMessageOutput) String ¶
func (s ReceiveMessageOutput) String() string
String returns the string representation
type ReceiveMessageRequest ¶
type ReceiveMessageRequest struct { *aws.Request Input *ReceiveMessageInput Copy func(*ReceiveMessageInput) ReceiveMessageRequest }
ReceiveMessageRequest is the request type for the ReceiveMessage API operation.
func (ReceiveMessageRequest) Send ¶
func (r ReceiveMessageRequest) Send(ctx context.Context) (*ReceiveMessageResponse, error)
Send marshals and sends the ReceiveMessage API request.
type ReceiveMessageResponse ¶ added in v0.9.0
type ReceiveMessageResponse struct { *ReceiveMessageOutput // contains filtered or unexported fields }
ReceiveMessageResponse is the response type for the ReceiveMessage API operation.
func (*ReceiveMessageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ReceiveMessageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ReceiveMessage request.
type RemovePermissionInput ¶
type RemovePermissionInput struct { // The identification of the permission to remove. This is the label added using // the AddPermission action. // // Label is a required field Label *string `type:"string" required:"true"` // The URL of the Amazon SQS queue from which permissions are removed. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (RemovePermissionInput) String ¶
func (s RemovePermissionInput) String() string
String returns the string representation
func (*RemovePermissionInput) Validate ¶
func (s *RemovePermissionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemovePermissionOutput ¶
type RemovePermissionOutput struct {
// contains filtered or unexported fields
}
func (RemovePermissionOutput) String ¶
func (s RemovePermissionOutput) String() string
String returns the string representation
type RemovePermissionRequest ¶
type RemovePermissionRequest struct { *aws.Request Input *RemovePermissionInput Copy func(*RemovePermissionInput) RemovePermissionRequest }
RemovePermissionRequest is the request type for the RemovePermission API operation.
func (RemovePermissionRequest) Send ¶
func (r RemovePermissionRequest) Send(ctx context.Context) (*RemovePermissionResponse, error)
Send marshals and sends the RemovePermission API request.
type RemovePermissionResponse ¶ added in v0.9.0
type RemovePermissionResponse struct { *RemovePermissionOutput // contains filtered or unexported fields }
RemovePermissionResponse is the response type for the RemovePermission API operation.
func (*RemovePermissionResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *RemovePermissionResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the RemovePermission request.
type SendMessageBatchInput ¶
type SendMessageBatchInput struct { // A list of SendMessageBatchRequestEntry items. // // Entries is a required field Entries []SendMessageBatchRequestEntry `locationNameList:"SendMessageBatchRequestEntry" type:"list" flattened:"true" required:"true"` // The URL of the Amazon SQS queue to which batched messages are sent. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (SendMessageBatchInput) String ¶
func (s SendMessageBatchInput) String() string
String returns the string representation
func (*SendMessageBatchInput) Validate ¶
func (s *SendMessageBatchInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendMessageBatchOutput ¶
type SendMessageBatchOutput struct { // A list of BatchResultErrorEntry items with error details about each message // that can't be enqueued. // // Failed is a required field Failed []BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"` // A list of SendMessageBatchResultEntry items. // // Successful is a required field Successful []SendMessageBatchResultEntry `locationNameList:"SendMessageBatchResultEntry" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.
func (SendMessageBatchOutput) String ¶
func (s SendMessageBatchOutput) String() string
String returns the string representation
type SendMessageBatchRequest ¶
type SendMessageBatchRequest struct { *aws.Request Input *SendMessageBatchInput Copy func(*SendMessageBatchInput) SendMessageBatchRequest }
SendMessageBatchRequest is the request type for the SendMessageBatch API operation.
func (SendMessageBatchRequest) Send ¶
func (r SendMessageBatchRequest) Send(ctx context.Context) (*SendMessageBatchResponse, error)
Send marshals and sends the SendMessageBatch API request.
type SendMessageBatchRequestEntry ¶
type SendMessageBatchRequestEntry struct { // The length of time, in seconds, for which a specific message is delayed. // Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds // value become available for processing after the delay period is finished. // If you don't specify a value, the default value for the queue is applied. // // When you set FifoQueue, you can't set DelaySeconds per message. You can set // this parameter only on a queue level. DelaySeconds *int64 `type:"integer"` // An identifier for a message in this batch used to communicate the result. // // The Ids of a batch request need to be unique within a request. // // This identifier can have up to 80 characters. The following characters are // accepted: alphanumeric characters, hyphens(-), and underscores (_). // // Id is a required field Id *string `type:"string" required:"true"` // Each message attribute consists of a Name, Type, and Value. For more information, // see Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) // in the Amazon Simple Queue Service Developer Guide. MessageAttributes map[string]MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The body of the message. // // MessageBody is a required field MessageBody *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The token used for deduplication of messages within a 5-minute minimum deduplication // interval. If a message with a particular MessageDeduplicationId is sent successfully, // subsequent messages with the same MessageDeduplicationId are accepted successfully // but aren't delivered. 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. // // The MessageDeduplicationId is available to the consumer of the message (this // can be useful for troubleshooting delivery issues). // // If a message is sent successfully but the acknowledgement is lost and the // message is resent with the same MessageDeduplicationId after the deduplication // interval, Amazon SQS can't detect duplicate messages. // // Amazon SQS continues to keep track of the message deduplication ID even after // the message is received and deleted. // // The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon Simple Queue Service Developer Guide. MessageDeduplicationId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The tag that specifies that a message belongs to a specific message group. // Messages that belong to the same message group are processed in a FIFO manner // (however, messages in different message groups might be processed out of // order). To interleave multiple ordered streams within a single queue, use // MessageGroupId values (for example, session data for multiple users). In // this scenario, multiple consumers can process the queue, but the session // data of each user is processed in a FIFO fashion. // // * You must associate a non-empty MessageGroupId with a message. If you // don't provide a MessageGroupId, the action fails. // // * ReceiveMessage might return messages with multiple MessageGroupId values. // For each MessageGroupId, the messages are sorted by time sent. The caller // can't specify a MessageGroupId. // // The length of MessageGroupId is 128 characters. Valid values: alphanumeric // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageGroupId, see Using the MessageGroupId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) // in the Amazon Simple Queue Service Developer Guide. // // MessageGroupId is required for FIFO queues. You can't use it for Standard // queues. MessageGroupId *string `type:"string"` // The message system attribute to send Each message system attribute consists // of a Name, Type, and Value. // // * Currently, the only supported message system attribute is AWSTraceHeader. // Its type must be String and its value must be a correctly formatted AWS // X-Ray trace header string. // // * The size of a message system attribute doesn't count towards the total // size of a message. MessageSystemAttributes map[string]MessageSystemAttributeValue `locationName:"MessageSystemAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // contains filtered or unexported fields }
Contains the details of a single Amazon SQS message along with an Id.
func (SendMessageBatchRequestEntry) String ¶
func (s SendMessageBatchRequestEntry) String() string
String returns the string representation
func (*SendMessageBatchRequestEntry) Validate ¶
func (s *SendMessageBatchRequestEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendMessageBatchResponse ¶ added in v0.9.0
type SendMessageBatchResponse struct { *SendMessageBatchOutput // contains filtered or unexported fields }
SendMessageBatchResponse is the response type for the SendMessageBatch API operation.
func (*SendMessageBatchResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SendMessageBatchResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SendMessageBatch request.
type SendMessageBatchResultEntry ¶
type SendMessageBatchResultEntry struct { // An identifier for the message in this batch. // // Id is a required field Id *string `type:"string" required:"true"` // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageAttributes *string `type:"string"` // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). // // MD5OfMessageBody is a required field MD5OfMessageBody *string `type:"string" required:"true"` // An MD5 digest of the non-URL-encoded message system attribute string. You // can use this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageSystemAttributes *string `type:"string"` // An identifier for the message. // // MessageId is a required field MessageId *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The large, non-consecutive number that Amazon SQS assigns to each message. // // The length of SequenceNumber is 128 bits. As SequenceNumber continues to // increase for a particular MessageGroupId. SequenceNumber *string `type:"string"` // contains filtered or unexported fields }
Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.
func (SendMessageBatchResultEntry) String ¶
func (s SendMessageBatchResultEntry) String() string
String returns the string representation
type SendMessageInput ¶
type SendMessageInput struct { // The length of time, in seconds, for which to delay a specific message. Valid // values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds // value become available for processing after the delay period is finished. // If you don't specify a value, the default value for the queue applies. // // When you set FifoQueue, you can't set DelaySeconds per message. You can set // this parameter only on a queue level. DelaySeconds *int64 `type:"integer"` // Each message attribute consists of a Name, Type, and Value. For more information, // see Amazon SQS Message Attributes (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html) // in the Amazon Simple Queue Service Developer Guide. MessageAttributes map[string]MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The message to send. The maximum string size is 256 KB. // // A message can include only XML, JSON, and unformatted text. The following // Unicode characters are allowed: // // #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF // // Any characters not included in this list will be rejected. For more information, // see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets). // // MessageBody is a required field MessageBody *string `type:"string" required:"true"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The token used for deduplication of sent messages. If a message with a particular // MessageDeduplicationId is sent successfully, any messages sent with the same // MessageDeduplicationId are accepted successfully but aren't delivered during // the 5-minute deduplication interval. 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. // // The MessageDeduplicationId is available to the consumer of the message (this // can be useful for troubleshooting delivery issues). // // If a message is sent successfully but the acknowledgement is lost and the // message is resent with the same MessageDeduplicationId after the deduplication // interval, Amazon SQS can't detect duplicate messages. // // Amazon SQS continues to keep track of the message deduplication ID even after // the message is received and deleted. // // The maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId // can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) // in the Amazon Simple Queue Service Developer Guide. MessageDeduplicationId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The tag that specifies that a message belongs to a specific message group. // Messages that belong to the same message group are processed in a FIFO manner // (however, messages in different message groups might be processed out of // order). To interleave multiple ordered streams within a single queue, use // MessageGroupId values (for example, session data for multiple users). In // this scenario, multiple consumers can process the queue, but the session // data of each user is processed in a FIFO fashion. // // * You must associate a non-empty MessageGroupId with a message. If you // don't provide a MessageGroupId, the action fails. // // * ReceiveMessage might return messages with multiple MessageGroupId values. // For each MessageGroupId, the messages are sorted by time sent. The caller // can't specify a MessageGroupId. // // The length of MessageGroupId is 128 characters. Valid values: alphanumeric // characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). // // For best practices of using MessageGroupId, see Using the MessageGroupId // Property (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) // in the Amazon Simple Queue Service Developer Guide. // // MessageGroupId is required for FIFO queues. You can't use it for Standard // queues. MessageGroupId *string `type:"string"` // The message system attribute to send. Each message system attribute consists // of a Name, Type, and Value. // // * Currently, the only supported message system attribute is AWSTraceHeader. // Its type must be String and its value must be a correctly formatted AWS // X-Ray trace header string. // // * The size of a message system attribute doesn't count towards the total // size of a message. MessageSystemAttributes map[string]MessageSystemAttributeValue `locationName:"MessageSystemAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"` // The URL of the Amazon SQS queue to which a message is sent. // // Queue URLs and names are case-sensitive. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (SendMessageInput) String ¶
func (s SendMessageInput) String() string
String returns the string representation
func (*SendMessageInput) Validate ¶
func (s *SendMessageInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SendMessageOutput ¶
type SendMessageOutput struct { // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageAttributes *string `type:"string"` // An MD5 digest of the non-URL-encoded message attribute string. You can use // this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. For information // about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). MD5OfMessageBody *string `type:"string"` // An MD5 digest of the non-URL-encoded message system attribute string. You // can use this attribute to verify that Amazon SQS received the message correctly. // Amazon SQS URL-decodes the message before creating the MD5 digest. MD5OfMessageSystemAttributes *string `type:"string"` // An attribute containing the MessageId of the message sent to the queue. For // more information, see Queue and Message Identifiers (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) // in the Amazon Simple Queue Service Developer Guide. MessageId *string `type:"string"` // This parameter applies only to FIFO (first-in-first-out) queues. // // The large, non-consecutive number that Amazon SQS assigns to each message. // // The length of SequenceNumber is 128 bits. SequenceNumber continues to increase // for a particular MessageGroupId. SequenceNumber *string `type:"string"` // contains filtered or unexported fields }
The MD5OfMessageBody and MessageId elements.
func (SendMessageOutput) String ¶
func (s SendMessageOutput) String() string
String returns the string representation
type SendMessageRequest ¶
type SendMessageRequest struct { *aws.Request Input *SendMessageInput Copy func(*SendMessageInput) SendMessageRequest }
SendMessageRequest is the request type for the SendMessage API operation.
func (SendMessageRequest) Send ¶
func (r SendMessageRequest) Send(ctx context.Context) (*SendMessageResponse, error)
Send marshals and sends the SendMessage API request.
type SendMessageResponse ¶ added in v0.9.0
type SendMessageResponse struct { *SendMessageOutput // contains filtered or unexported fields }
SendMessageResponse is the response type for the SendMessage API operation.
func (*SendMessageResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SendMessageResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SendMessage request.
type SetQueueAttributesInput ¶
type SetQueueAttributesInput struct { // 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 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 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"` // contains filtered or unexported fields }
func (SetQueueAttributesInput) String ¶
func (s SetQueueAttributesInput) String() string
String returns the string representation
func (*SetQueueAttributesInput) Validate ¶
func (s *SetQueueAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetQueueAttributesOutput ¶
type SetQueueAttributesOutput struct {
// contains filtered or unexported fields
}
func (SetQueueAttributesOutput) String ¶
func (s SetQueueAttributesOutput) String() string
String returns the string representation
type SetQueueAttributesRequest ¶
type SetQueueAttributesRequest struct { *aws.Request Input *SetQueueAttributesInput Copy func(*SetQueueAttributesInput) SetQueueAttributesRequest }
SetQueueAttributesRequest is the request type for the SetQueueAttributes API operation.
func (SetQueueAttributesRequest) Send ¶
func (r SetQueueAttributesRequest) Send(ctx context.Context) (*SetQueueAttributesResponse, error)
Send marshals and sends the SetQueueAttributes API request.
type SetQueueAttributesResponse ¶ added in v0.9.0
type SetQueueAttributesResponse struct { *SetQueueAttributesOutput // contains filtered or unexported fields }
SetQueueAttributesResponse is the response type for the SetQueueAttributes API operation.
func (*SetQueueAttributesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *SetQueueAttributesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the SetQueueAttributes request.
type TagQueueInput ¶ added in v0.2.0
type TagQueueInput struct { // The URL of the queue. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The list of tags to be added to the specified queue. // // Tags is a required field Tags map[string]string `locationName:"Tag" locationNameKey:"Key" locationNameValue:"Value" type:"map" flattened:"true" required:"true"` // contains filtered or unexported fields }
func (TagQueueInput) String ¶ added in v0.2.0
func (s TagQueueInput) String() string
String returns the string representation
func (*TagQueueInput) Validate ¶ added in v0.2.0
func (s *TagQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagQueueOutput ¶ added in v0.2.0
type TagQueueOutput struct {
// contains filtered or unexported fields
}
func (TagQueueOutput) String ¶ added in v0.2.0
func (s TagQueueOutput) String() string
String returns the string representation
type TagQueueRequest ¶ added in v0.2.0
type TagQueueRequest struct { *aws.Request Input *TagQueueInput Copy func(*TagQueueInput) TagQueueRequest }
TagQueueRequest is the request type for the TagQueue API operation.
func (TagQueueRequest) Send ¶ added in v0.2.0
func (r TagQueueRequest) Send(ctx context.Context) (*TagQueueResponse, error)
Send marshals and sends the TagQueue API request.
type TagQueueResponse ¶ added in v0.9.0
type TagQueueResponse struct { *TagQueueOutput // contains filtered or unexported fields }
TagQueueResponse is the response type for the TagQueue API operation.
func (*TagQueueResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *TagQueueResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagQueue request.
type UntagQueueInput ¶ added in v0.2.0
type UntagQueueInput struct { // The URL of the queue. // // QueueUrl is a required field QueueUrl *string `type:"string" required:"true"` // The list of tags to be removed from the specified queue. // // TagKeys is a required field TagKeys []string `locationNameList:"TagKey" type:"list" flattened:"true" required:"true"` // contains filtered or unexported fields }
func (UntagQueueInput) String ¶ added in v0.2.0
func (s UntagQueueInput) String() string
String returns the string representation
func (*UntagQueueInput) Validate ¶ added in v0.2.0
func (s *UntagQueueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagQueueOutput ¶ added in v0.2.0
type UntagQueueOutput struct {
// contains filtered or unexported fields
}
func (UntagQueueOutput) String ¶ added in v0.2.0
func (s UntagQueueOutput) String() string
String returns the string representation
type UntagQueueRequest ¶ added in v0.2.0
type UntagQueueRequest struct { *aws.Request Input *UntagQueueInput Copy func(*UntagQueueInput) UntagQueueRequest }
UntagQueueRequest is the request type for the UntagQueue API operation.
func (UntagQueueRequest) Send ¶ added in v0.2.0
func (r UntagQueueRequest) Send(ctx context.Context) (*UntagQueueResponse, error)
Send marshals and sends the UntagQueue API request.
type UntagQueueResponse ¶ added in v0.9.0
type UntagQueueResponse struct { *UntagQueueOutput // contains filtered or unexported fields }
UntagQueueResponse is the response type for the UntagQueue API operation.
func (*UntagQueueResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UntagQueueResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagQueue request.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_AddPermission.go
- api_op_ChangeMessageVisibility.go
- api_op_ChangeMessageVisibilityBatch.go
- api_op_CreateQueue.go
- api_op_DeleteMessage.go
- api_op_DeleteMessageBatch.go
- api_op_DeleteQueue.go
- api_op_GetQueueAttributes.go
- api_op_GetQueueUrl.go
- api_op_ListDeadLetterSourceQueues.go
- api_op_ListQueueTags.go
- api_op_ListQueues.go
- api_op_PurgeQueue.go
- api_op_ReceiveMessage.go
- api_op_RemovePermission.go
- api_op_SendMessage.go
- api_op_SendMessageBatch.go
- api_op_SetQueueAttributes.go
- api_op_TagQueue.go
- api_op_UntagQueue.go
- api_types.go
- checksums.go
- customizations.go