sqs

package
v1.4.21-0...-9e5bedb Latest Latest
Warning

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

 Go to latest Published: Oct 24, 2016 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package sqs provides a client for Amazon Simple Queue Service.

Index

Examples

Constants

View Source 
const (
	// QueueAttributeNamePolicy is a QueueAttributeName enum value
	QueueAttributeNamePolicy = "Policy"

	// QueueAttributeNameVisibilityTimeout is a QueueAttributeName enum value
	QueueAttributeNameVisibilityTimeout = "VisibilityTimeout"

	// QueueAttributeNameMaximumMessageSize is a QueueAttributeName enum value
	QueueAttributeNameMaximumMessageSize = "MaximumMessageSize"

	// QueueAttributeNameMessageRetentionPeriod is a QueueAttributeName enum value
	QueueAttributeNameMessageRetentionPeriod = "MessageRetentionPeriod"

	// QueueAttributeNameApproximateNumberOfMessages is a QueueAttributeName enum value
	QueueAttributeNameApproximateNumberOfMessages = "ApproximateNumberOfMessages"

	// QueueAttributeNameApproximateNumberOfMessagesNotVisible is a QueueAttributeName enum value
	QueueAttributeNameApproximateNumberOfMessagesNotVisible = "ApproximateNumberOfMessagesNotVisible"

	// QueueAttributeNameCreatedTimestamp is a QueueAttributeName enum value
	QueueAttributeNameCreatedTimestamp = "CreatedTimestamp"

	// QueueAttributeNameLastModifiedTimestamp is a QueueAttributeName enum value
	QueueAttributeNameLastModifiedTimestamp = "LastModifiedTimestamp"

	// QueueAttributeNameQueueArn is a QueueAttributeName enum value
	QueueAttributeNameQueueArn = "QueueArn"

	// QueueAttributeNameApproximateNumberOfMessagesDelayed is a QueueAttributeName enum value
	QueueAttributeNameApproximateNumberOfMessagesDelayed = "ApproximateNumberOfMessagesDelayed"

	// QueueAttributeNameDelaySeconds is a QueueAttributeName enum value
	QueueAttributeNameDelaySeconds = "DelaySeconds"

	// QueueAttributeNameReceiveMessageWaitTimeSeconds is a QueueAttributeName enum value
	QueueAttributeNameReceiveMessageWaitTimeSeconds = "ReceiveMessageWaitTimeSeconds"

	// QueueAttributeNameRedrivePolicy is a QueueAttributeName enum value
	QueueAttributeNameRedrivePolicy = "RedrivePolicy"
)
View Source 
const ServiceName = "sqs"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddPermissionInput 

type AddPermissionInput struct {

	// The AWS account number of the principal (http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P)
	// who will be 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html)
	// in the Amazon SQS 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. The following
	// are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility
	// | GetQueueAttributes | GetQueueUrl. For more information about these actions,
	// see Understanding Permissions (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes)
	// in the Amazon SQS Developer Guide.
	//
	// Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for the
	// 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 (e.g., AliceSendMessage).
	// Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-),
	// and underscores (_) are allowed.
	//
	// Label is a required field
	Label *string `type:"string" required:"true"`

	// The URL of the Amazon SQS queue to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddPermissionInput) GoString 

func (s AddPermissionInput) GoString() string

GoString returns the string representation

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) GoString 

func (s AddPermissionOutput) GoString() string

GoString returns the string representation

func (AddPermissionOutput) String 

func (s AddPermissionOutput) String() string

String returns the string representation

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"`

	// Whether the error happened due to the sender's fault.
	//
	// SenderFault is a required field
	SenderFault *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.

func (BatchResultErrorEntry) GoString 

func (s BatchResultErrorEntry) GoString() string

GoString returns the string representation

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 to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ChangeMessageVisibilityBatchInput) GoString 

func (s ChangeMessageVisibilityBatchInput) GoString() string

GoString returns the string representation

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) GoString 

func (s ChangeMessageVisibilityBatchOutput) GoString() string

GoString returns the string representation

func (ChangeMessageVisibilityBatchOutput) String 

func (s ChangeMessageVisibilityBatchOutput) String() string

String returns the string representation

type ChangeMessageVisibilityBatchRequestEntry 

type ChangeMessageVisibilityBatchRequestEntry struct {

	// An identifier for this particular receipt handle. This is used to communicate
	// the result. Note that the Ids of a batch request need to be unique within
	// the request.
	//
	// 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 parameters are list parameters that 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:

Your_Receipt_Handle]]>

func (ChangeMessageVisibilityBatchRequestEntry) GoString 

func (s ChangeMessageVisibilityBatchRequestEntry) GoString() string

GoString returns the string representation

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 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) GoString 

func (s ChangeMessageVisibilityBatchResultEntry) GoString() string

GoString returns the string representation

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 to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`

	// The receipt handle associated with the message whose visibility timeout should
	// be changed. This parameter is returned by the ReceiveMessage action.
	//
	// ReceiptHandle is a required field
	ReceiptHandle *string `type:"string" required:"true"`

	// The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's
	// visibility timeout.
	//
	// VisibilityTimeout is a required field
	VisibilityTimeout *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (ChangeMessageVisibilityInput) GoString 

func (s ChangeMessageVisibilityInput) GoString() string

GoString returns the string representation

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) GoString 

func (s ChangeMessageVisibilityOutput) GoString() string

GoString returns the string representation

func (ChangeMessageVisibilityOutput) String 

func (s ChangeMessageVisibilityOutput) String() string

String returns the string representation

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 the CreateQueue action uses:
	//
	//    * DelaySeconds - The time in seconds that the delivery of all messages
	//    in the queue will be delayed. An integer from 0 to 900 (15 minutes). The
	//    default for this attribute is 0 (zero).
	//
	//    * MaximumMessageSize - The limit of how many bytes a message can contain
	//    before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to
	//    262144 bytes (256 KiB). The default for this attribute is 262144 (256
	//    KiB).
	//
	//    * MessageRetentionPeriod - The number of seconds Amazon SQS retains a
	//    message. Integer representing seconds, from 60 (1 minute) to 1209600 (14
	//    days). The default for this attribute is 345600 (4 days).
	//
	//    * Policy - The queue's policy. A valid AWS policy. For more information
	//    about policy structure, see Overview of AWS IAM Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html)
	//    in the Amazon IAM User Guide.
	//
	//    * ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage
	//    call will wait for a message to arrive. An integer from 0 to 20 (seconds).
	//    The default for this attribute is 0.
	//
	//    * RedrivePolicy - 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html)
	//    in the Amazon SQS Developer Guide.
	//
	//    * VisibilityTimeout - The visibility timeout for the queue. An integer
	//    from 0 to 43200 (12 hours). The default for this attribute is 30. For
	//    more information about visibility timeout, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html)
	//    in the Amazon SQS Developer Guide.
	//
	// Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages,
	// ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible,
	// CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.
	Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// The name for the queue to be created.
	//
	// Queue names are case-sensitive.
	//
	// QueueName is a required field
	QueueName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateQueueInput) GoString 

func (s CreateQueueInput) GoString() string

GoString returns the string representation

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 for the created Amazon SQS queue.
	QueueUrl *string `type:"string"`
	// contains filtered or unexported fields
}

Returns the QueueUrl element of the created queue.

func (CreateQueueOutput) GoString 

func (s CreateQueueOutput) GoString() string

GoString returns the string representation

func (CreateQueueOutput) String 

func (s CreateQueueOutput) String() string

String returns the string representation

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 to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteMessageBatchInput) GoString 

func (s DeleteMessageBatchInput) GoString() string

GoString returns the string representation

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 cannot be deleted.

func (DeleteMessageBatchOutput) GoString 

func (s DeleteMessageBatchOutput) GoString() string

GoString returns the string representation

func (DeleteMessageBatchOutput) String 

func (s DeleteMessageBatchOutput) String() string

String returns the string representation

type DeleteMessageBatchRequestEntry 

type DeleteMessageBatchRequestEntry struct {

	// An identifier for this particular receipt handle. This is used to communicate
	// the result. Note that the Ids of a batch request need to be unique within
	// the request.
	//
	// 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) GoString 

func (s DeleteMessageBatchRequestEntry) GoString() string

GoString returns the string representation

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 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 an entry in DeleteMessageBatch.

func (DeleteMessageBatchResultEntry) GoString 

func (s DeleteMessageBatchResultEntry) GoString() string

GoString returns the string representation

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 to take action on.
	//
	// Queue URLs 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) GoString 

func (s DeleteMessageInput) GoString() string

GoString returns the string representation

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) GoString 

func (s DeleteMessageOutput) GoString() string

GoString returns the string representation

func (DeleteMessageOutput) String 

func (s DeleteMessageOutput) String() string

String returns the string representation

type DeleteQueueInput 

type DeleteQueueInput struct {

	// The URL of the Amazon SQS queue to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteQueueInput) GoString 

func (s DeleteQueueInput) GoString() string

GoString returns the string representation

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) GoString 

func (s DeleteQueueOutput) GoString() string

GoString returns the string representation

func (DeleteQueueOutput) String 

func (s DeleteQueueOutput) String() string

String returns the string representation

type GetQueueAttributesInput 

type GetQueueAttributesInput struct {

	// A list of attributes to retrieve information for. 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html)
	//    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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html)
	//    in the Amazon SQS Developer Guide.
	//
	//    * VisibilityTimeout - returns the visibility timeout for the queue. For
	//    more information about visibility timeout, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html)
	//    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 (ARN).
	//
	//    * 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html)
	//    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.
	AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true"`

	// The URL of the Amazon SQS queue to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueueAttributesInput) GoString 

func (s GetQueueAttributesInput) GoString() string

GoString returns the string representation

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 the 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) GoString 

func (s GetQueueAttributesOutput) GoString() string

GoString returns the string representation

func (GetQueueAttributesOutput) String 

func (s GetQueueAttributesOutput) String() string

String returns the string representation

type GetQueueUrlInput 

type GetQueueUrlInput struct {

	// The name of the queue whose URL must be fetched. Maximum 80 characters; alphanumeric
	// characters, hyphens (-), and underscores (_) are allowed.
	//
	// Queue 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) GoString 

func (s GetQueueUrlInput) GoString() string

GoString returns the string representation

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 for the queue.
	QueueUrl *string `type:"string"`
	// contains filtered or unexported fields
}

For more information, see Responses (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/UnderstandingResponses.html) in the Amazon SQS Developer Guide.

func (GetQueueUrlOutput) GoString 

func (s GetQueueUrlOutput) GoString() string

GoString returns the string representation

func (GetQueueUrlOutput) String 

func (s GetQueueUrlOutput) String() string

String returns the string representation

type ListDeadLetterSourceQueuesInput 

type ListDeadLetterSourceQueuesInput struct {

	// The queue URL of a dead letter queue.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListDeadLetterSourceQueuesInput) GoString 

func (s ListDeadLetterSourceQueuesInput) GoString() string

GoString returns the string representation

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 {

	// 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) GoString 

func (s ListDeadLetterSourceQueuesOutput) GoString() string

GoString returns the string representation

func (ListDeadLetterSourceQueuesOutput) String 

func (s ListDeadLetterSourceQueuesOutput) String() string

String returns the string representation

type ListQueuesInput 

type ListQueuesInput struct {

	// A string to use for filtering the list results. Only those queues whose name
	// begins with the specified string are returned.
	//
	// Queue names are case-sensitive.
	QueueNamePrefix *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListQueuesInput) GoString 

func (s ListQueuesInput) GoString() string

GoString returns the string representation

func (ListQueuesInput) String 

func (s ListQueuesInput) String() string

String returns the string representation

type ListQueuesOutput 

type ListQueuesOutput struct {

	// A list of queue URLs, up to 1000 entries.
	QueueUrls []*string `locationNameList:"QueueUrl" type:"list" flattened:"true"`
	// contains filtered or unexported fields
}

A list of your queues.

func (ListQueuesOutput) GoString 

func (s ListQueuesOutput) GoString() string

GoString returns the string representation

func (ListQueuesOutput) String 

func (s ListQueuesOutput) String() string

String returns the string representation

type Message 

type Message struct {

	// SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp.
	// SentTimestamp and ApproximateFirstReceiveTimestamp 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. This can be
	// used to verify that Amazon SQS received the message correctly. Amazon SQS
	// first URL decodes the message before creating the MD5 digest. For information
	// about MD5, go to http://www.faqs.org/rfcs/rfc1321.html (http://www.faqs.org/rfcs/rfc1321.html).
	MD5OfMessageAttributes *string `type:"string"`

	// Each message attribute consists of a Name, Type, and Value. For more information,
	// see Message Attribute Items (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV).
	MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// A unique identifier for the message. Message IDs are 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.

func (Message) GoString 

func (s Message) GoString() string

GoString returns the string representation

func (Message) String 

func (s Message) String() string

String returns the string representation

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, for example, 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 Message Attribute
	// Data Types (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributes.DataTypes).
	//
	// 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 UTF8 binary encoding. For a list of code values,
	// see http://en.wikipedia.org/wiki/ASCII#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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html).

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).

func (MessageAttributeValue) GoString 

func (s MessageAttributeValue) GoString() string

GoString returns the string representation

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 PurgeQueueInput 

type PurgeQueueInput struct {

	// The queue URL of the queue to delete the messages from when using the PurgeQueue
	// API.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PurgeQueueInput) GoString 

func (s PurgeQueueInput) GoString() string

GoString returns the string representation

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) GoString 

func (s PurgeQueueOutput) GoString() string

GoString returns the string representation

func (PurgeQueueOutput) String 

func (s PurgeQueueOutput) String() string

String returns the string representation

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 when the message
	//    was first received from the queue (epoch time in milliseconds).
	//
	//    * ApproximateReceiveCount - returns the number of times a message has
	//    been received from the queue but not deleted.
	//
	//    * SenderId - returns the AWS account number (or the IP address, if anonymous
	//    access is allowed) of the sender.
	//
	//    * SentTimestamp - returns the time when the message was sent to the queue
	//    (epoch time in milliseconds).
	//
	// Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages,
	// ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible,
	// CreatedTimestamp, DelaySeconds, LastModifiedTimestamp, MaximumMessageSize,
	// MessageRetentionPeriod, Policy, QueueArn, ReceiveMessageWaitTimeSeconds,
	// RedrivePolicy, and VisibilityTimeout) will be ignored.
	AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true"`

	// The maximum number of messages to return. Amazon SQS never returns more messages
	// than this value but may return fewer. Values can be from 1 to 10. Default
	// is 1.
	//
	// All of the messages are not necessarily returned.
	MaxNumberOfMessages *int64 `type:"integer"`

	// The name of the message attribute, where N is the index. The message attribute
	// name can contain the following characters: A-Z, a-z, 0-9, underscore (_),
	// hyphen (-), and period (.). The name must not start or end with a period,
	// and it should not have successive periods. The name is case sensitive and
	// must be unique among all attribute names for the message. The name can be
	// up to 256 characters long. The name cannot start with "AWS." or "Amazon."
	// (or any variations in casing), because these prefixes are reserved for use
	// by Amazon Web Services.
	//
	// 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 "bar.*" to return all message attributes starting
	// with the "bar" prefix.
	MessageAttributeNames []*string `locationNameList:"MessageAttributeName" type:"list" flattened:"true"`

	// The URL of the Amazon SQS queue to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`

	// 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 will wait for a message to arrive
	// in the queue before returning. If a message is available, the call will return
	// sooner than WaitTimeSeconds.
	WaitTimeSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (ReceiveMessageInput) GoString 

func (s ReceiveMessageInput) GoString() string

GoString returns the string representation

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) GoString 

func (s ReceiveMessageOutput) GoString() string

GoString returns the string representation

func (ReceiveMessageOutput) String 

func (s ReceiveMessageOutput) String() string

String returns the string representation

type RemovePermissionInput 

type RemovePermissionInput struct {

	// The identification of the permission to remove. This is the label added with
	// the AddPermission action.
	//
	// Label is a required field
	Label *string `type:"string" required:"true"`

	// The URL of the Amazon SQS queue to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemovePermissionInput) GoString 

func (s RemovePermissionInput) GoString() string

GoString returns the string representation

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) GoString 

func (s RemovePermissionOutput) GoString() string

GoString returns the string representation

func (RemovePermissionOutput) String 

func (s RemovePermissionOutput) String() string

String returns the string representation

type SQS 

type SQS struct {
	*client.Client
}

Welcome to the Amazon Simple Queue Service API Reference. This section describes who should read this guide, how the guide is organized, and other resources related to the Amazon Simple Queue Service (Amazon SQS).

Amazon SQS offers reliable and scalable hosted queues for storing messages as they travel between computers. By using Amazon SQS, you can move data between distributed components of your applications that perform different tasks without losing messages or requiring each component to be always available.

Helpful Links:

We also provide SDKs that enable you to access Amazon SQS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as:

  • Cryptographically signing your service requests

  • Retrying requests

  • Handling error responses

For a list of available SDKs, go to Tools for Amazon Web Services (http://aws.amazon.com/tools/). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SQS

New creates a new instance of the SQS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a SQS client from just a session.
svc := sqs.New(mySession)

// Create a SQS client with additional configuration
svc := sqs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SQS) AddPermission 

func (c *SQS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error)

AddPermission API operation for Amazon Simple Queue Service.

Adds a permission to a queue for a specific principal (http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P). 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html) 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html) 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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation AddPermission for usage and error information.

Returned Error Codes:

  • OverLimit The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. AddPermission returns this error if the maximum number of permissions for the queue has already been reached.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.AddPermissionInput{
		AWSAccountIds: []*string{ // Required
			aws.String("String"), // Required
			// More values...
		},
		Actions: []*string{ // Required
			aws.String("String"), // Required
			// More values...
		},
		Label:    aws.String("String"), // Required
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.AddPermission(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) AddPermissionRequest 

func (c *SQS) AddPermissionRequest(input *AddPermissionInput) (req *request.Request, output *AddPermissionOutput)

AddPermissionRequest generates a "aws/request.Request" representing the client's request for the AddPermission operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See AddPermission for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddPermission method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the AddPermissionRequest method.
req, resp := client.AddPermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) ChangeMessageVisibility 

func (c *SQS) ChangeMessageVisibility(input *ChangeMessageVisibilityInput) (*ChangeMessageVisibilityOutput, error)

ChangeMessageVisibility API operation for Amazon Simple Queue Service.

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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html) in the Amazon SQS Developer Guide.)

For example, let's say you have a message and its default message visibility timeout is 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message would be extended by 10 minutes beyond the time of the ChangeMessageVisibility call. This results in a total visibility timeout of 13 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend beyond 12 hours, the request will be rejected.

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 SQS. 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation ChangeMessageVisibility for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.MessageNotInflight The message referred to is not in flight.

  • ReceiptHandleIsInvalid The receipt handle provided is not valid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.ChangeMessageVisibilityInput{
		QueueUrl:          aws.String("String"), // Required
		ReceiptHandle:     aws.String("String"), // Required
		VisibilityTimeout: aws.Int64(1),         // Required
	}
	resp, err := svc.ChangeMessageVisibility(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) ChangeMessageVisibilityBatch 

func (c *SQS) ChangeMessageVisibilityBatch(input *ChangeMessageVisibilityBatchInput) (*ChangeMessageVisibilityBatchOutput, error)

ChangeMessageVisibilityBatch 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 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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation ChangeMessageVisibilityBatch for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.TooManyEntriesInBatchRequest Batch request contains more number of entries than permissible.

  • AWS.SimpleQueueService.EmptyBatchRequest Batch request does not contain an entry.

  • AWS.SimpleQueueService.BatchEntryIdsNotDistinct Two or more batch entries have the same Id in the request.

  • AWS.SimpleQueueService.InvalidBatchEntryId The Id of a batch entry in a batch request does not abide by the specification.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.ChangeMessageVisibilityBatchInput{
		Entries: []*sqs.ChangeMessageVisibilityBatchRequestEntry{ // Required
			{ // Required
				Id:                aws.String("String"), // Required
				ReceiptHandle:     aws.String("String"), // Required
				VisibilityTimeout: aws.Int64(1),
			},
			// More values...
		},
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.ChangeMessageVisibilityBatch(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) ChangeMessageVisibilityBatchRequest 

func (c *SQS) ChangeMessageVisibilityBatchRequest(input *ChangeMessageVisibilityBatchInput) (req *request.Request, output *ChangeMessageVisibilityBatchOutput)

ChangeMessageVisibilityBatchRequest generates a "aws/request.Request" representing the client's request for the ChangeMessageVisibilityBatch operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ChangeMessageVisibilityBatch for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ChangeMessageVisibilityBatch method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ChangeMessageVisibilityBatchRequest method.
req, resp := client.ChangeMessageVisibilityBatchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) ChangeMessageVisibilityRequest 

func (c *SQS) ChangeMessageVisibilityRequest(input *ChangeMessageVisibilityInput) (req *request.Request, output *ChangeMessageVisibilityOutput)

ChangeMessageVisibilityRequest generates a "aws/request.Request" representing the client's request for the ChangeMessageVisibility operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ChangeMessageVisibility for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ChangeMessageVisibility method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ChangeMessageVisibilityRequest method.
req, resp := client.ChangeMessageVisibilityRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) CreateQueue 

func (c *SQS) CreateQueue(input *CreateQueueInput) (*CreateQueueOutput, error)

CreateQueue API operation for Amazon Simple Queue Service.

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.

Use GetQueueUrl to get a queue's URL. 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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation CreateQueue for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.QueueDeletedRecently You must wait 60 seconds after deleting a queue before you can create another with the same name.

  • QueueAlreadyExists A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.CreateQueueInput{
		QueueName: aws.String("String"), // Required
		Attributes: map[string]*string{
			"Key": aws.String("String"), // Required
			// More values...
		},
	}
	resp, err := svc.CreateQueue(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) CreateQueueRequest 

func (c *SQS) CreateQueueRequest(input *CreateQueueInput) (req *request.Request, output *CreateQueueOutput)

CreateQueueRequest generates a "aws/request.Request" representing the client's request for the CreateQueue operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateQueue for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateQueue method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the CreateQueueRequest method.
req, resp := client.CreateQueueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) DeleteMessage 

func (c *SQS) DeleteMessage(input *DeleteMessageInput) (*DeleteMessageOutput, error)

DeleteMessage API operation for Amazon Simple Queue Service.

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the message ID 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation DeleteMessage for usage and error information.

Returned Error Codes:

  • InvalidIdFormat The receipt handle is not valid for the current version.

  • ReceiptHandleIsInvalid The receipt handle provided is not valid.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.DeleteMessageInput{
		QueueUrl:      aws.String("String"), // Required
		ReceiptHandle: aws.String("String"), // Required
	}
	resp, err := svc.DeleteMessage(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) DeleteMessageBatch 

func (c *SQS) DeleteMessageBatch(input *DeleteMessageBatchInput) (*DeleteMessageBatchOutput, error)

DeleteMessageBatch 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 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 HTTP 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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation DeleteMessageBatch for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.TooManyEntriesInBatchRequest Batch request contains more number of entries than permissible.

  • AWS.SimpleQueueService.EmptyBatchRequest Batch request does not contain an entry.

  • AWS.SimpleQueueService.BatchEntryIdsNotDistinct Two or more batch entries have the same Id in the request.

  • AWS.SimpleQueueService.InvalidBatchEntryId The Id of a batch entry in a batch request does not abide by the specification.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.DeleteMessageBatchInput{
		Entries: []*sqs.DeleteMessageBatchRequestEntry{ // Required
			{ // Required
				Id:            aws.String("String"), // Required
				ReceiptHandle: aws.String("String"), // Required
			},
			// More values...
		},
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.DeleteMessageBatch(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) DeleteMessageBatchRequest 

func (c *SQS) DeleteMessageBatchRequest(input *DeleteMessageBatchInput) (req *request.Request, output *DeleteMessageBatchOutput)

DeleteMessageBatchRequest generates a "aws/request.Request" representing the client's request for the DeleteMessageBatch operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteMessageBatch for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMessageBatch method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteMessageBatchRequest method.
req, resp := client.DeleteMessageBatchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) DeleteMessageRequest 

func (c *SQS) DeleteMessageRequest(input *DeleteMessageInput) (req *request.Request, output *DeleteMessageOutput)

DeleteMessageRequest generates a "aws/request.Request" representing the client's request for the DeleteMessage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteMessage for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteMessage method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteMessageRequest method.
req, resp := client.DeleteMessageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) DeleteQueue 

func (c *SQS) DeleteQueue(input *DeleteQueueInput) (*DeleteQueueOutput, error)

DeleteQueue API operation for Amazon Simple Queue Service.

Deletes the queue specified by the queue URL, 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html) in the Amazon SQS Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation DeleteQueue for usage and error information.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.DeleteQueueInput{
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.DeleteQueue(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) DeleteQueueRequest 

func (c *SQS) DeleteQueueRequest(input *DeleteQueueInput) (req *request.Request, output *DeleteQueueOutput)

DeleteQueueRequest generates a "aws/request.Request" representing the client's request for the DeleteQueue operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteQueue for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteQueue method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the DeleteQueueRequest method.
req, resp := client.DeleteQueueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) GetQueueAttributes 

func (c *SQS) GetQueueAttributes(input *GetQueueAttributesInput) (*GetQueueAttributesOutput, error)

GetQueueAttributes API operation for Amazon Simple Queue Service.

Gets attributes for the specified queue.

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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation GetQueueAttributes for usage and error information.

Returned Error Codes:

  • InvalidAttributeName The attribute referred to does not exist.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.GetQueueAttributesInput{
		QueueUrl: aws.String("String"), // Required
		AttributeNames: []*string{
			aws.String("QueueAttributeName"), // Required
			// More values...
		},
	}
	resp, err := svc.GetQueueAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) GetQueueAttributesRequest 

func (c *SQS) GetQueueAttributesRequest(input *GetQueueAttributesInput) (req *request.Request, output *GetQueueAttributesOutput)

GetQueueAttributesRequest generates a "aws/request.Request" representing the client's request for the GetQueueAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetQueueAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetQueueAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the GetQueueAttributesRequest method.
req, resp := client.GetQueueAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) GetQueueUrl 

func (c *SQS) GetQueueUrl(input *GetQueueUrlInput) (*GetQueueUrlOutput, error)

GetQueueUrl API operation for Amazon Simple Queue Service.

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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html) in the Amazon SQS Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation GetQueueUrl for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.NonExistentQueue The queue referred to does not exist.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.GetQueueUrlInput{
		QueueName:              aws.String("String"), // Required
		QueueOwnerAWSAccountId: aws.String("String"),
	}
	resp, err := svc.GetQueueUrl(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) GetQueueUrlRequest 

func (c *SQS) GetQueueUrlRequest(input *GetQueueUrlInput) (req *request.Request, output *GetQueueUrlOutput)

GetQueueUrlRequest generates a "aws/request.Request" representing the client's request for the GetQueueUrl operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetQueueUrl for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetQueueUrl method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the GetQueueUrlRequest method.
req, resp := client.GetQueueUrlRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) ListDeadLetterSourceQueues 

func (c *SQS) ListDeadLetterSourceQueues(input *ListDeadLetterSourceQueuesInput) (*ListDeadLetterSourceQueuesOutput, error)

ListDeadLetterSourceQueues 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation ListDeadLetterSourceQueues for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.NonExistentQueue The queue referred to does not exist.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.ListDeadLetterSourceQueuesInput{
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.ListDeadLetterSourceQueues(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) ListDeadLetterSourceQueuesRequest 

func (c *SQS) ListDeadLetterSourceQueuesRequest(input *ListDeadLetterSourceQueuesInput) (req *request.Request, output *ListDeadLetterSourceQueuesOutput)

ListDeadLetterSourceQueuesRequest generates a "aws/request.Request" representing the client's request for the ListDeadLetterSourceQueues operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListDeadLetterSourceQueues for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListDeadLetterSourceQueues method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ListDeadLetterSourceQueuesRequest method.
req, resp := client.ListDeadLetterSourceQueuesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) ListQueues 

func (c *SQS) ListQueues(input *ListQueuesInput) (*ListQueuesOutput, error)

ListQueues API operation for Amazon Simple Queue Service.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation ListQueues for usage and error information.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.ListQueuesInput{
		QueueNamePrefix: aws.String("String"),
	}
	resp, err := svc.ListQueues(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) ListQueuesRequest 

func (c *SQS) ListQueuesRequest(input *ListQueuesInput) (req *request.Request, output *ListQueuesOutput)

ListQueuesRequest generates a "aws/request.Request" representing the client's request for the ListQueues operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ListQueues for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListQueues method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ListQueuesRequest method.
req, resp := client.ListQueuesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) PurgeQueue 

func (c *SQS) PurgeQueue(input *PurgeQueueInput) (*PurgeQueueOutput, error)

PurgeQueue API operation for Amazon Simple Queue Service.

Deletes the messages in a queue specified by the queue URL.

When you use the PurgeQueue API, 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation PurgeQueue for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.NonExistentQueue The queue referred to does not exist.

  • 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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.PurgeQueueInput{
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.PurgeQueue(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) PurgeQueueRequest 

func (c *SQS) PurgeQueueRequest(input *PurgeQueueInput) (req *request.Request, output *PurgeQueueOutput)

PurgeQueueRequest generates a "aws/request.Request" representing the client's request for the PurgeQueue operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See PurgeQueue for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PurgeQueue method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the PurgeQueueRequest method.
req, resp := client.PurgeQueueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) ReceiveMessage 

func (c *SQS) ReceiveMessage(input *ReceiveMessageInput) (*ReceiveMessageOutput, error)

ReceiveMessage API operation for Amazon Simple Queue Service.

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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html) 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:

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) 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 (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html) 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation ReceiveMessage for usage and error information.

Returned Error Codes:

  • OverLimit The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of messages inflight has already been reached. AddPermission returns this error if the maximum number of permissions for the queue has already been reached.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.ReceiveMessageInput{
		QueueUrl: aws.String("String"), // Required
		AttributeNames: []*string{
			aws.String("QueueAttributeName"), // Required
			// More values...
		},
		MaxNumberOfMessages: aws.Int64(1),
		MessageAttributeNames: []*string{
			aws.String("MessageAttributeName"), // Required
			// More values...
		},
		VisibilityTimeout: aws.Int64(1),
		WaitTimeSeconds:   aws.Int64(1),
	}
	resp, err := svc.ReceiveMessage(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) ReceiveMessageRequest 

func (c *SQS) ReceiveMessageRequest(input *ReceiveMessageInput) (req *request.Request, output *ReceiveMessageOutput)

ReceiveMessageRequest generates a "aws/request.Request" representing the client's request for the ReceiveMessage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ReceiveMessage for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ReceiveMessage method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the ReceiveMessageRequest method.
req, resp := client.ReceiveMessageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) RemovePermission 

func (c *SQS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)

RemovePermission API operation for Amazon Simple Queue Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation RemovePermission for usage and error information.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.RemovePermissionInput{
		Label:    aws.String("String"), // Required
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.RemovePermission(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) RemovePermissionRequest 

func (c *SQS) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)

RemovePermissionRequest generates a "aws/request.Request" representing the client's request for the RemovePermission operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See RemovePermission for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemovePermission method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the RemovePermissionRequest method.
req, resp := client.RemovePermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) SendMessage 

func (c *SQS) SendMessage(input *SendMessageInput) (*SendMessageOutput, error)

SendMessage API operation for Amazon Simple Queue Service.

Delivers a message to the specified queue. With Amazon SQS, 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 SDK, 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 (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]

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation SendMessage for usage and error information.

Returned Error Codes:

  • InvalidMessageContents The message contains characters outside the allowed set.

  • AWS.SimpleQueueService.UnsupportedOperation Error code 400. Unsupported operation.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.SendMessageInput{
		MessageBody:  aws.String("String"), // Required
		QueueUrl:     aws.String("String"), // Required
		DelaySeconds: aws.Int64(1),
		MessageAttributes: map[string]*sqs.MessageAttributeValue{
			"Key": { // Required
				DataType: aws.String("String"), // Required
				BinaryListValues: [][]byte{
					[]byte("PAYLOAD"), // Required
					// More values...
				},
				BinaryValue: []byte("PAYLOAD"),
				StringListValues: []*string{
					aws.String("String"), // Required
					// More values...
				},
				StringValue: aws.String("String"),
			},
			// More values...
		},
	}
	resp, err := svc.SendMessage(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) SendMessageBatch 

func (c *SQS) SendMessageBatch(input *SendMessageBatchInput) (*SendMessageBatchOutput, error)

SendMessageBatch API operation for Amazon Simple Queue Service.

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 (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 HTTP 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:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation SendMessageBatch for usage and error information.

Returned Error Codes:

  • AWS.SimpleQueueService.TooManyEntriesInBatchRequest Batch request contains more number of entries than permissible.

  • AWS.SimpleQueueService.EmptyBatchRequest Batch request does not contain an entry.

  • AWS.SimpleQueueService.BatchEntryIdsNotDistinct Two or more batch entries have the same Id in the request.

  • AWS.SimpleQueueService.BatchRequestTooLong The length of all the messages put together is more than the limit.

  • AWS.SimpleQueueService.InvalidBatchEntryId The Id of a batch entry in a batch request does not abide by the specification.

  • AWS.SimpleQueueService.UnsupportedOperation Error code 400. Unsupported operation.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.SendMessageBatchInput{
		Entries: []*sqs.SendMessageBatchRequestEntry{ // Required
			{ // Required
				Id:           aws.String("String"), // Required
				MessageBody:  aws.String("String"), // Required
				DelaySeconds: aws.Int64(1),
				MessageAttributes: map[string]*sqs.MessageAttributeValue{
					"Key": { // Required
						DataType: aws.String("String"), // Required
						BinaryListValues: [][]byte{
							[]byte("PAYLOAD"), // Required
							// More values...
						},
						BinaryValue: []byte("PAYLOAD"),
						StringListValues: []*string{
							aws.String("String"), // Required
							// More values...
						},
						StringValue: aws.String("String"),
					},
					// More values...
				},
			},
			// More values...
		},
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.SendMessageBatch(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) SendMessageBatchRequest 

func (c *SQS) SendMessageBatchRequest(input *SendMessageBatchInput) (req *request.Request, output *SendMessageBatchOutput)

SendMessageBatchRequest generates a "aws/request.Request" representing the client's request for the SendMessageBatch operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SendMessageBatch for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SendMessageBatch method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the SendMessageBatchRequest method.
req, resp := client.SendMessageBatchRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) SendMessageRequest 

func (c *SQS) SendMessageRequest(input *SendMessageInput) (req *request.Request, output *SendMessageOutput)

SendMessageRequest generates a "aws/request.Request" representing the client's request for the SendMessage operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SendMessage for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SendMessage method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the SendMessageRequest method.
req, resp := client.SendMessageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*SQS) SetQueueAttributes 

func (c *SQS) SetQueueAttributes(input *SetQueueAttributesInput) (*SetQueueAttributesOutput, error)

SetQueueAttributes 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 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Simple Queue Service's API operation SetQueueAttributes for usage and error information.

Returned Error Codes:

  • InvalidAttributeName The attribute referred to does not exist.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/sqs"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := sqs.New(sess)

	params := &sqs.SetQueueAttributesInput{
		Attributes: map[string]*string{ // Required
			"Key": aws.String("String"), // Required
			// More values...
		},
		QueueUrl: aws.String("String"), // Required
	}
	resp, err := svc.SetQueueAttributes(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*SQS) SetQueueAttributesRequest 

func (c *SQS) SetQueueAttributesRequest(input *SetQueueAttributesInput) (req *request.Request, output *SetQueueAttributesOutput)

SetQueueAttributesRequest generates a "aws/request.Request" representing the client's request for the SetQueueAttributes operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See SetQueueAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetQueueAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

// Example sending a request using the SetQueueAttributesRequest method.
req, resp := client.SetQueueAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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 take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessageBatchInput) GoString 

func (s SendMessageBatchInput) GoString() string

GoString returns the string representation

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 the error detail about each message
	// that could not 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) GoString 

func (s SendMessageBatchOutput) GoString() string

GoString returns the string representation

func (SendMessageBatchOutput) String 

func (s SendMessageBatchOutput) String() string

String returns the string representation

type SendMessageBatchRequestEntry 

type SendMessageBatchRequestEntry struct {

	// The number of seconds for which the message has to be delayed.
	DelaySeconds *int64 `type:"integer"`

	// An identifier for the message in this batch. This is used to communicate
	// the result. Note that the Ids of a batch request need to be unique within
	// the request.
	//
	// 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 Message Attribute Items (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV).
	MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// Body of the message.
	//
	// MessageBody is a required field
	MessageBody *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the details of a single Amazon SQS message along with a Id.

func (SendMessageBatchRequestEntry) GoString 

func (s SendMessageBatchRequestEntry) GoString() string

GoString returns the string representation

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 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. This can be
	// used to verify that Amazon SQS received the message batch correctly. Amazon
	// SQS first URL decodes the message before creating the MD5 digest. For information
	// about MD5, go to http://www.faqs.org/rfcs/rfc1321.html (http://www.faqs.org/rfcs/rfc1321.html).
	MD5OfMessageAttributes *string `type:"string"`

	// An MD5 digest of the non-URL-encoded message body string. This can be used
	// to verify that Amazon SQS received the message correctly. Amazon SQS first
	// URL decodes the message before creating the MD5 digest. For information about
	// MD5, go to http://www.faqs.org/rfcs/rfc1321.html (http://www.faqs.org/rfcs/rfc1321.html).
	//
	// MD5OfMessageBody is a required field
	MD5OfMessageBody *string `type:"string" required:"true"`

	// An identifier for the message.
	//
	// MessageId is a required field
	MessageId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Encloses a message ID for successfully enqueued message of a SendMessageBatch.

func (SendMessageBatchResultEntry) GoString 

func (s SendMessageBatchResultEntry) GoString() string

GoString returns the string representation

func (SendMessageBatchResultEntry) String 

func (s SendMessageBatchResultEntry) String() string

String returns the string representation

type SendMessageInput 

type SendMessageInput struct {

	// The number of seconds (0 to 900 - 15 minutes) to delay a specific message.
	// Messages with a positive DelaySeconds value become available for processing
	// after the delay time is finished. If you don't specify a value, the default
	// value for the queue applies.
	DelaySeconds *int64 `type:"integer"`

	// Each message attribute consists of a Name, Type, and Value. For more information,
	// see Message Attribute Items (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSMessageAttributes.html#SQSMessageAttributesNTV).
	MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// The message to send. String maximum 256 KB in size. For a list of allowed
	// characters, see the preceding important note.
	//
	// MessageBody is a required field
	MessageBody *string `type:"string" required:"true"`

	// The URL of the Amazon SQS queue to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SendMessageInput) GoString 

func (s SendMessageInput) GoString() string

GoString returns the string representation

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. This can be
	// used to verify that Amazon SQS received the message correctly. Amazon SQS
	// first URL decodes the message before creating the MD5 digest. For information
	// about MD5, go to http://www.faqs.org/rfcs/rfc1321.html (http://www.faqs.org/rfcs/rfc1321.html).
	MD5OfMessageAttributes *string `type:"string"`

	// An MD5 digest of the non-URL-encoded message body string. This can be used
	// to verify that Amazon SQS received the message correctly. Amazon SQS first
	// URL decodes the message before creating the MD5 digest. For information about
	// MD5, go to http://www.faqs.org/rfcs/rfc1321.html (http://www.faqs.org/rfcs/rfc1321.html).
	MD5OfMessageBody *string `type:"string"`

	// An element containing the message ID of the message sent to the queue. For
	// more information, see Queue and Message Identifiers (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html)
	// in the Amazon SQS Developer Guide.
	MessageId *string `type:"string"`
	// contains filtered or unexported fields
}

The MD5OfMessageBody and MessageId elements.

func (SendMessageOutput) GoString 

func (s SendMessageOutput) GoString() string

GoString returns the string representation

func (SendMessageOutput) String 

func (s SendMessageOutput) String() string

String returns the string representation

type SetQueueAttributesInput 

type SetQueueAttributesInput struct {

	// A map of attributes to set.
	//
	// The following lists the names, descriptions, and values of the special request
	// parameters the SetQueueAttributes action uses:
	//
	//    * DelaySeconds - The time in seconds that the delivery of all messages
	//    in the queue will be delayed. An integer from 0 to 900 (15 minutes). The
	//    default for this attribute is 0 (zero).
	//
	//    * MaximumMessageSize - The limit of how many bytes a message can contain
	//    before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to
	//    262144 bytes (256 KiB). The default for this attribute is 262144 (256
	//    KiB).
	//
	//    * MessageRetentionPeriod - The number of seconds Amazon SQS retains a
	//    message. Integer representing seconds, from 60 (1 minute) to 1209600 (14
	//    days). The default for this attribute is 345600 (4 days).
	//
	//    * Policy - The queue's policy. A valid AWS policy. For more information
	//    about policy structure, see Overview of AWS IAM Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html)
	//    in the Amazon IAM User Guide.
	//
	//    * ReceiveMessageWaitTimeSeconds - The time for which a ReceiveMessage
	//    call will wait for a message to arrive. An integer from 0 to 20 (seconds).
	//    The default for this attribute is 0.
	//
	//    * VisibilityTimeout - The visibility timeout for the queue. An integer
	//    from 0 to 43200 (12 hours). The default for this attribute is 30. For
	//    more information about visibility timeout, see Visibility Timeout in the
	//    Amazon SQS Developer Guide.
	//
	//    * RedrivePolicy - 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.
	//
	// Any other valid special request parameters that are specified (such as ApproximateNumberOfMessages,
	// ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible,
	// CreatedTimestamp, LastModifiedTimestamp, and QueueArn) will be ignored.
	//
	// 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 to take action on.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (SetQueueAttributesInput) GoString 

func (s SetQueueAttributesInput) GoString() string

GoString returns the string representation

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) GoString 

func (s SetQueueAttributesOutput) GoString() string

GoString returns the string representation

func (SetQueueAttributesOutput) String 

func (s SetQueueAttributesOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package sqsiface provides an interface to enable mocking the Amazon Simple Queue Service service client for testing your code.
 Package sqsiface provides an interface to enable mocking the Amazon Simple Queue Service service client for testing your code.

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.