sqs

package
v0.0.0-...-5c85c1b Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 22, 2022 License: Apache-2.0, Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package sqs provides a client for Amazon Simple Queue Service.

Index

Constants

View Source 
const (
	QueueAttributeNameApproximateNumberOfMessages           = "ApproximateNumberOfMessages"
	QueueAttributeNameApproximateNumberOfMessagesDelayed    = "ApproximateNumberOfMessagesDelayed"
	QueueAttributeNameApproximateNumberOfMessagesNotVisible = "ApproximateNumberOfMessagesNotVisible"
	QueueAttributeNameCreatedTimestamp                      = "CreatedTimestamp"
	QueueAttributeNameDelaySeconds                          = "DelaySeconds"
	QueueAttributeNameLastModifiedTimestamp                 = "LastModifiedTimestamp"
	QueueAttributeNameMaximumMessageSize                    = "MaximumMessageSize"
	QueueAttributeNameMessageRetentionPeriod                = "MessageRetentionPeriod"
	QueueAttributeNamePolicy                                = "Policy"
	QueueAttributeNameQueueARN                              = "QueueArn"
	QueueAttributeNameReceiveMessageWaitTimeSeconds         = "ReceiveMessageWaitTimeSeconds"
	QueueAttributeNameRedrivePolicy                         = "RedrivePolicy"
	QueueAttributeNameVisibilityTimeout                     = "VisibilityTimeout"
)

Possible values for SQS.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddPermissionRequest 

type AddPermissionRequest struct {
	AWSAccountIDs []string        `query:"AWSAccountId" xml:"AWSAccountId"`
	Actions       []string        `query:"ActionName" xml:"ActionName"`
	Label         aws.StringValue `query:"Label" xml:"Label"`
	QueueURL      aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
}

AddPermissionRequest is undocumented.

type AttributeMap 

type AttributeMap map[string]string

func (*AttributeMap) UnmarshalXML 

func (m *AttributeMap) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements xml.UnmarshalXML interface for map

type BatchResultErrorEntry 

type BatchResultErrorEntry struct {
	Code        aws.StringValue  `query:"Code" xml:"Code"`
	ID          aws.StringValue  `query:"Id" xml:"Id"`
	Message     aws.StringValue  `query:"Message" xml:"Message"`
	SenderFault aws.BooleanValue `query:"SenderFault" xml:"SenderFault"`
}

BatchResultErrorEntry is undocumented.

type ChangeMessageVisibilityBatchRequest 

type ChangeMessageVisibilityBatchRequest struct {
	Entries  []ChangeMessageVisibilityBatchRequestEntry `query:"ChangeMessageVisibilityBatchRequestEntry" xml:"ChangeMessageVisibilityBatchRequestEntry"`
	QueueURL aws.StringValue                            `query:"QueueUrl" xml:"QueueUrl"`
}

ChangeMessageVisibilityBatchRequest is undocumented.

type ChangeMessageVisibilityBatchRequestEntry 

type ChangeMessageVisibilityBatchRequestEntry struct {
	ID                aws.StringValue  `query:"Id" xml:"Id"`
	ReceiptHandle     aws.StringValue  `query:"ReceiptHandle" xml:"ReceiptHandle"`
	VisibilityTimeout aws.IntegerValue `query:"VisibilityTimeout" xml:"VisibilityTimeout"`
}

ChangeMessageVisibilityBatchRequestEntry is undocumented.

type ChangeMessageVisibilityBatchResult 

type ChangeMessageVisibilityBatchResult struct {
	Failed     []BatchResultErrorEntry                   `query:"BatchResultErrorEntry" xml:"ChangeMessageVisibilityBatchResult>BatchResultErrorEntry"`
	Successful []ChangeMessageVisibilityBatchResultEntry `` /* 128-byte string literal not displayed */
}

ChangeMessageVisibilityBatchResult is undocumented.

type ChangeMessageVisibilityBatchResultEntry 

type ChangeMessageVisibilityBatchResultEntry struct {
	ID aws.StringValue `query:"Id" xml:"Id"`
}

ChangeMessageVisibilityBatchResultEntry is undocumented.

type ChangeMessageVisibilityRequest 

type ChangeMessageVisibilityRequest struct {
	QueueURL          aws.StringValue  `query:"QueueUrl" xml:"QueueUrl"`
	ReceiptHandle     aws.StringValue  `query:"ReceiptHandle" xml:"ReceiptHandle"`
	VisibilityTimeout aws.IntegerValue `query:"VisibilityTimeout" xml:"VisibilityTimeout"`
}

ChangeMessageVisibilityRequest is undocumented.

type CreateQueueRequest 

type CreateQueueRequest struct {
	Attributes AttributeMap    `query:"Attribute" xml:"Attribute"`
	QueueName  aws.StringValue `query:"QueueName" xml:"QueueName"`
}

CreateQueueRequest is undocumented.

type CreateQueueResult 

type CreateQueueResult struct {
	QueueURL aws.StringValue `query:"QueueUrl" xml:"CreateQueueResult>QueueUrl"`
}

CreateQueueResult is undocumented.

type DeleteMessageBatchRequest 

type DeleteMessageBatchRequest struct {
	Entries  []DeleteMessageBatchRequestEntry `query:"DeleteMessageBatchRequestEntry" xml:"DeleteMessageBatchRequestEntry"`
	QueueURL aws.StringValue                  `query:"QueueUrl" xml:"QueueUrl"`
}

DeleteMessageBatchRequest is undocumented.

type DeleteMessageBatchRequestEntry 

type DeleteMessageBatchRequestEntry struct {
	ID            aws.StringValue `query:"Id" xml:"Id"`
	ReceiptHandle aws.StringValue `query:"ReceiptHandle" xml:"ReceiptHandle"`
}

DeleteMessageBatchRequestEntry is undocumented.

type DeleteMessageBatchResult 

type DeleteMessageBatchResult struct {
	Failed     []BatchResultErrorEntry         `query:"BatchResultErrorEntry" xml:"DeleteMessageBatchResult>BatchResultErrorEntry"`
	Successful []DeleteMessageBatchResultEntry `query:"DeleteMessageBatchResultEntry" xml:"DeleteMessageBatchResult>DeleteMessageBatchResultEntry"`
}

DeleteMessageBatchResult is undocumented.

type DeleteMessageBatchResultEntry 

type DeleteMessageBatchResultEntry struct {
	ID aws.StringValue `query:"Id" xml:"Id"`
}

DeleteMessageBatchResultEntry is undocumented.

type DeleteMessageRequest 

type DeleteMessageRequest struct {
	QueueURL      aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
	ReceiptHandle aws.StringValue `query:"ReceiptHandle" xml:"ReceiptHandle"`
}

DeleteMessageRequest is undocumented.

type DeleteQueueRequest 

type DeleteQueueRequest struct {
	QueueURL aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
}

DeleteQueueRequest is undocumented.

type GetQueueAttributesRequest 

type GetQueueAttributesRequest struct {
	AttributeNames []string        `query:"AttributeName" xml:"AttributeName"`
	QueueURL       aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
}

GetQueueAttributesRequest is undocumented.

type GetQueueAttributesResult 

type GetQueueAttributesResult struct {
	Attributes AttributeMap `query:"Attribute" xml:"GetQueueAttributesResult>Attribute"`
}

GetQueueAttributesResult is undocumented.

type GetQueueURLRequest 

type GetQueueURLRequest struct {
	QueueName              aws.StringValue `query:"QueueName" xml:"QueueName"`
	QueueOwnerAWSAccountID aws.StringValue `query:"QueueOwnerAWSAccountId" xml:"QueueOwnerAWSAccountId"`
}

GetQueueURLRequest is undocumented.

type GetQueueURLResult 

type GetQueueURLResult struct {
	QueueURL aws.StringValue `query:"QueueUrl" xml:"GetQueueUrlResult>QueueUrl"`
}

GetQueueURLResult is undocumented.

type ListDeadLetterSourceQueuesRequest 

type ListDeadLetterSourceQueuesRequest struct {
	QueueURL aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
}

ListDeadLetterSourceQueuesRequest is undocumented.

type ListDeadLetterSourceQueuesResult 

type ListDeadLetterSourceQueuesResult struct {
	QueueURLs []string `query:"QueueUrl" xml:"ListDeadLetterSourceQueuesResult>QueueUrl"`
}

ListDeadLetterSourceQueuesResult is undocumented.

type ListQueuesRequest 

type ListQueuesRequest struct {
	QueueNamePrefix aws.StringValue `query:"QueueNamePrefix" xml:"QueueNamePrefix"`
}

ListQueuesRequest is undocumented.

type ListQueuesResult 

type ListQueuesResult struct {
	QueueURLs []string `query:"QueueUrl" xml:"ListQueuesResult>QueueUrl"`
}

ListQueuesResult is undocumented.

type Message 

type Message struct {
	Attributes             AttributeMap        `query:"Attribute" xml:"Attribute"`
	Body                   aws.StringValue     `query:"Body" xml:"Body"`
	MD5OfBody              aws.StringValue     `query:"MD5OfBody" xml:"MD5OfBody"`
	MD5OfMessageAttributes aws.StringValue     `query:"MD5OfMessageAttributes" xml:"MD5OfMessageAttributes"`
	MessageAttributes      MessageAttributeMap `query:"MessageAttribute" xml:"MessageAttribute"`
	MessageID              aws.StringValue     `query:"MessageId" xml:"MessageId"`
	ReceiptHandle          aws.StringValue     `query:"ReceiptHandle" xml:"ReceiptHandle"`
}

Message is undocumented.

type MessageAttributeMap 

type MessageAttributeMap map[string]MessageAttributeValue

func (*MessageAttributeMap) UnmarshalXML 

func (m *MessageAttributeMap) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements xml.UnmarshalXML interface for map

type MessageAttributeValue 

type MessageAttributeValue struct {
	BinaryListValues [][]byte        `query:"BinaryListValue.member" xml:"BinaryListValue>BinaryListValue"`
	BinaryValue      []byte          `query:"BinaryValue" xml:"BinaryValue"`
	DataType         aws.StringValue `query:"DataType" xml:"DataType"`
	StringListValues []string        `query:"StringListValue.member" xml:"StringListValue>StringListValue"`
	StringValue      aws.StringValue `query:"StringValue" xml:"StringValue"`
}

MessageAttributeValue is undocumented.

type PurgeQueueRequest 

type PurgeQueueRequest struct {
	QueueURL aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
}

PurgeQueueRequest is undocumented.

type ReceiveMessageRequest 

type ReceiveMessageRequest struct {
	AttributeNames        []string         `query:"AttributeName" xml:"AttributeName"`
	MaxNumberOfMessages   aws.IntegerValue `query:"MaxNumberOfMessages" xml:"MaxNumberOfMessages"`
	MessageAttributeNames []string         `query:"MessageAttributeName" xml:"MessageAttributeName"`
	QueueURL              aws.StringValue  `query:"QueueUrl" xml:"QueueUrl"`
	VisibilityTimeout     aws.IntegerValue `query:"VisibilityTimeout" xml:"VisibilityTimeout"`
	WaitTimeSeconds       aws.IntegerValue `query:"WaitTimeSeconds" xml:"WaitTimeSeconds"`
}

ReceiveMessageRequest is undocumented.

type ReceiveMessageResult 

type ReceiveMessageResult struct {
	Messages []Message `query:"Message" xml:"ReceiveMessageResult>Message"`
}

ReceiveMessageResult is undocumented.

type RemovePermissionRequest 

type RemovePermissionRequest struct {
	Label    aws.StringValue `query:"Label" xml:"Label"`
	QueueURL aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
}

RemovePermissionRequest is undocumented.

type SQS 

type SQS struct {
	// contains filtered or unexported fields
}

SQS is a client for Amazon Simple Queue Service.

func New 

func New(creds aws.CredentialsProvider, region string, client *http.Client) *SQS

New returns a new SQS client.

func (*SQS) AddPermission 

func (c *SQS) AddPermission(req *AddPermissionRequest) (err error)

AddPermission adds a permission to a queue for a specific principal . This allows for sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide AddPermission writes an Amazon SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide Some API 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:

func (*SQS) ChangeMessageVisibility 

func (c *SQS) ChangeMessageVisibility(req *ChangeMessageVisibilityRequest) (err error)

ChangeMessageVisibility changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes. There is a 120,000 limit for the number of inflight messages per queue. Messages are inflight after they have been received from the queue by a consuming component, but have not yet been deleted from the queue. If you reach the 120,000 limit, you will receive an OverLimit error message from Amazon To help avoid reaching the limit, you should delete the messages from the queue after they have been processed. You can also increase the number of queues you use to process the messages. If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining. Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.

func (*SQS) ChangeMessageVisibilityBatch 

func (c *SQS) ChangeMessageVisibilityBatch(req *ChangeMessageVisibilityBatchRequest) (resp *ChangeMessageVisibilityBatchResult, err error)

ChangeMessageVisibilityBatch 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 status code of 200. Some API 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:

func (*SQS) CreateQueue 

func (c *SQS) CreateQueue(req *CreateQueueRequest) (resp *CreateQueueResult, err error)

CreateQueue creates a new queue, or returns the URL of an existing one. When you request CreateQueue , you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. You may pass one or more attributes in the request. If you do not provide a value for any attribute, the queue will have the default value for that attribute. Permitted attributes are the same that can be set using SetQueueAttributes Use GetQueueUrl to get a queue's GetQueueUrl requires only the QueueName parameter. 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 do not match an existing queue, CreateQueue returns an error. Some API 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:

func (*SQS) DeleteMessage 

func (c *SQS) DeleteMessage(req *DeleteMessageRequest) (err error)

DeleteMessage deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the message you received when you sent the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes it. The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. When you request DeleteMessage , if you don't provide the most recently received receipt handle for the message, the request will still succeed, but the message might not be deleted. It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem.

func (*SQS) DeleteMessageBatch 

func (c *SQS) DeleteMessageBatch(req *DeleteMessageBatchRequest) (resp *DeleteMessageBatchResult, err error)

DeleteMessageBatch deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage . The result of the delete 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 status code of 200. Some API 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:

func (*SQS) DeleteQueue 

func (c *SQS) DeleteQueue(req *DeleteQueueRequest) (err error)

DeleteQueue deletes the queue specified by the queue , regardless of whether the queue is empty. If the specified queue does not exist, Amazon SQS returns a successful response. Use DeleteQueue with care; once you delete your 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 the 60 seconds, the queue and that message you sent no longer exist. Also, when you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. We reserve the right to delete queues that have had no activity for more than 30 days. For more information, see How Amazon SQS Queues Work in the Amazon SQS Developer Guide .

func (*SQS) GetQueueAttributes 

func (c *SQS) GetQueueAttributes(req *GetQueueAttributesRequest) (resp *GetQueueAttributesResult, err error)

GetQueueAttributes gets attributes for the specified queue. The following attributes are supported: All - returns all values. ApproximateNumberOfMessages - returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide ApproximateNumberOfMessagesNotVisible - returns the approximate number of messages that are not timed-out and not deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide VisibilityTimeout - returns the visibility timeout for the queue. For more information about visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide CreatedTimestamp - returns the time when the queue was created (epoch time in seconds). LastModifiedTimestamp - returns the time when the queue was last changed (epoch time in seconds). Policy - returns the queue's policy. MaximumMessageSize - returns the limit of how many bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod - returns the number of seconds Amazon SQS retains a message. QueueArn - returns the queue's Amazon resource name ApproximateNumberOfMessagesDelayed - returns the approximate number of messages that are pending to be added to the queue. DelaySeconds - returns the default delay on the queue in seconds. ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage call will wait for a message to arrive. RedrivePolicy - returns the parameters for dead letter queue functionality of the source queue. For more information about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully. Some API 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:

func (*SQS) GetQueueURL 

func (c *SQS) GetQueueURL(req *GetQueueURLRequest) (resp *GetQueueURLResult, err error)

GetQueueURL returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an 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 go to Shared Queues in the Amazon SQS Developer Guide .

func (*SQS) ListDeadLetterSourceQueues 

func (c *SQS) ListDeadLetterSourceQueues(req *ListDeadLetterSourceQueuesRequest) (resp *ListDeadLetterSourceQueuesResult, err error)

ListDeadLetterSourceQueues 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

func (*SQS) ListQueues 

func (c *SQS) ListQueues(req *ListQueuesRequest) (resp *ListQueuesResult, err error)

ListQueues returns a list of your queues. The maximum number of queues that can be returned is 1000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name beginning with the specified value are returned.

func (*SQS) PurgeQueue 

func (c *SQS) PurgeQueue(req *PurgeQueueRequest) (err error)

PurgeQueue deletes the messages in a queue specified by the queue When you use the PurgeQueue the deleted messages in the queue cannot be retrieved. When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue was called may be received, but will be deleted within the next minute.

func (*SQS) ReceiveMessage 

func (c *SQS) ReceiveMessage(req *ReceiveMessageRequest) (resp *ReceiveMessageResult, err error)

ReceiveMessage retrieves one or more messages, with a maximum limit of 10 messages, from the specified queue. Long poll support is enabled by using the WaitTimeSeconds parameter. For more information, see Amazon SQS Long Poll in the Amazon SQS Developer Guide . Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. This means only the messages on the sampled machines are returned. If the number of messages in the queue is small (less than 1000), it is likely you will 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; in which case you should repeat the request. For each message returned, the response includes the following: MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html . Message ID you received when you sent the message to the queue. Receipt handle. 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 in the Amazon SQS Developer Guide . You can provide the VisibilityTimeout parameter in your request, which will be applied to the messages that Amazon SQS returns in the response. If you do not include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide . Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

func (*SQS) RemovePermission 

func (c *SQS) RemovePermission(req *RemovePermissionRequest) (err error)

RemovePermission revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

func (*SQS) SendMessage 

func (c *SQS) SendMessage(req *SendMessageRequest) (resp *SendMessageResult, err error)

SendMessage delivers a message to the specified queue. With Amazon you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size. To send large payloads, you must use an AWS SDK that supports SigV4 signing. To verify whether SigV4 is supported for an AWS check the SDK release notes. The following list shows the characters (in Unicode) allowed in your message, according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets If you send any characters not included in the list, your request will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]

func (*SQS) SendMessageBatch 

func (c *SQS) SendMessageBatch(req *SendMessageBatchRequest) (resp *SendMessageBatchResult, err error)

SendMessageBatch delivers up to ten messages to the specified queue. This is a batch version of SendMessage . The result of the send action on each message is reported individually in the response. The maximum allowed individual message size is 256 KB (262,144 bytes). The maximum total payload size (i.e., the sum of all a batch's individual message lengths) is also 256 KB (262,144 bytes). If the DelaySeconds parameter is not specified for an entry, the default for the queue is used. The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification. For more information, go to http://www.faqs.org/rfcs/rfc1321.html . If you send any characters that are not included in the list, your request will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF] 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 status code of 200. Some API 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:

func (*SQS) SetQueueAttributes 

func (c *SQS) SetQueueAttributes(req *SetQueueAttributesRequest) (err error)

SetQueueAttributes 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 SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes. Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

type SendMessageBatchRequest 

type SendMessageBatchRequest struct {
	Entries  []SendMessageBatchRequestEntry `query:"SendMessageBatchRequestEntry" xml:"SendMessageBatchRequestEntry"`
	QueueURL aws.StringValue                `query:"QueueUrl" xml:"QueueUrl"`
}

SendMessageBatchRequest is undocumented.

type SendMessageBatchRequestEntry 

type SendMessageBatchRequestEntry struct {
	DelaySeconds      aws.IntegerValue    `query:"DelaySeconds" xml:"DelaySeconds"`
	ID                aws.StringValue     `query:"Id" xml:"Id"`
	MessageAttributes MessageAttributeMap `query:"MessageAttribute" xml:"MessageAttribute"`
	MessageBody       aws.StringValue     `query:"MessageBody" xml:"MessageBody"`
}

SendMessageBatchRequestEntry is undocumented.

type SendMessageBatchResult 

type SendMessageBatchResult struct {
	Failed     []BatchResultErrorEntry       `query:"BatchResultErrorEntry" xml:"SendMessageBatchResult>BatchResultErrorEntry"`
	Successful []SendMessageBatchResultEntry `query:"SendMessageBatchResultEntry" xml:"SendMessageBatchResult>SendMessageBatchResultEntry"`
}

SendMessageBatchResult is undocumented.

type SendMessageBatchResultEntry 

type SendMessageBatchResultEntry struct {
	ID                     aws.StringValue `query:"Id" xml:"Id"`
	MD5OfMessageAttributes aws.StringValue `query:"MD5OfMessageAttributes" xml:"MD5OfMessageAttributes"`
	MD5OfMessageBody       aws.StringValue `query:"MD5OfMessageBody" xml:"MD5OfMessageBody"`
	MessageID              aws.StringValue `query:"MessageId" xml:"MessageId"`
}

SendMessageBatchResultEntry is undocumented.

type SendMessageRequest 

type SendMessageRequest struct {
	DelaySeconds      aws.IntegerValue    `query:"DelaySeconds" xml:"DelaySeconds"`
	MessageAttributes MessageAttributeMap `query:"MessageAttribute" xml:"MessageAttribute"`
	MessageBody       aws.StringValue     `query:"MessageBody" xml:"MessageBody"`
	QueueURL          aws.StringValue     `query:"QueueUrl" xml:"QueueUrl"`
}

SendMessageRequest is undocumented.

type SendMessageResult 

type SendMessageResult struct {
	MD5OfMessageAttributes aws.StringValue `query:"MD5OfMessageAttributes" xml:"SendMessageResult>MD5OfMessageAttributes"`
	MD5OfMessageBody       aws.StringValue `query:"MD5OfMessageBody" xml:"SendMessageResult>MD5OfMessageBody"`
	MessageID              aws.StringValue `query:"MessageId" xml:"SendMessageResult>MessageId"`
}

SendMessageResult is undocumented.

type SetQueueAttributesRequest 

type SetQueueAttributesRequest struct {
	Attributes AttributeMap    `query:"Attribute" xml:"Attribute"`
	QueueURL   aws.StringValue `query:"QueueUrl" xml:"QueueUrl"`
}

SetQueueAttributesRequest is undocumented.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.