sqs

package
v1.10.13 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2017 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package sqs provides the client and types for making API requests to Amazon Simple Queue Service.

Welcome to the Amazon Simple Queue Service API Reference.

Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

Standard queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/standard-queues.html) are available in all regions. FIFO queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) are available in US West (Oregon) and US East (Ohio).

You can use AWS SDKs (http://aws.amazon.com/tools/#sdk) to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

  • Cryptographically sign your service requests

  • Retry requests

  • Handle error responses

Additional Information

Making API Requests (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/MakingRequestsArticle.html)

Using Amazon SQS Message Attributes (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html)

Using Amazon SQS Dead Letter Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)

  • Amazon Web Services General Reference

Regions and Endpoints (http://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region)

See https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05 for more information on this service.

See sqs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/

Using the Client

To use the client for Amazon Simple Queue Service you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := sqs.New(sess)

See the SDK's documentation for more information on how to use service clients. https://docs.aws.amazon.com/sdk-for-go/api/

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Simple Queue Service client SQS for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/sqs/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.AddPermission(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("AddPermission result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.AddPermissionWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Constants

View Source 
const (
	// MessageSystemAttributeNameSenderId is a MessageSystemAttributeName enum value
	MessageSystemAttributeNameSenderId = "SenderId"

	// MessageSystemAttributeNameSentTimestamp is a MessageSystemAttributeName enum value
	MessageSystemAttributeNameSentTimestamp = "SentTimestamp"

	// MessageSystemAttributeNameApproximateReceiveCount is a MessageSystemAttributeName enum value
	MessageSystemAttributeNameApproximateReceiveCount = "ApproximateReceiveCount"

	// MessageSystemAttributeNameApproximateFirstReceiveTimestamp is a MessageSystemAttributeName enum value
	MessageSystemAttributeNameApproximateFirstReceiveTimestamp = "ApproximateFirstReceiveTimestamp"

	// MessageSystemAttributeNameSequenceNumber is a MessageSystemAttributeName enum value
	MessageSystemAttributeNameSequenceNumber = "SequenceNumber"

	// MessageSystemAttributeNameMessageDeduplicationId is a MessageSystemAttributeName enum value
	MessageSystemAttributeNameMessageDeduplicationId = "MessageDeduplicationId"

	// MessageSystemAttributeNameMessageGroupId is a MessageSystemAttributeName enum value
	MessageSystemAttributeNameMessageGroupId = "MessageGroupId"
)
View Source 
const (
	// QueueAttributeNameAll is a QueueAttributeName enum value
	QueueAttributeNameAll = "All"

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

	// QueueAttributeNameFifoQueue is a QueueAttributeName enum value
	QueueAttributeNameFifoQueue = "FifoQueue"

	// QueueAttributeNameContentBasedDeduplication is a QueueAttributeName enum value
	QueueAttributeNameContentBasedDeduplication = "ContentBasedDeduplication"

	// QueueAttributeNameKmsMasterKeyId is a QueueAttributeName enum value
	QueueAttributeNameKmsMasterKeyId = "KmsMasterKeyId"

	// QueueAttributeNameKmsDataKeyReusePeriodSeconds is a QueueAttributeName enum value
	QueueAttributeNameKmsDataKeyReusePeriodSeconds = "KmsDataKeyReusePeriodSeconds"
)
View Source 
const (

	// ErrCodeBatchEntryIdsNotDistinct for service response error code
	// "AWS.SimpleQueueService.BatchEntryIdsNotDistinct".
	//
	// Two or more batch entries in the request have the same Id.
	ErrCodeBatchEntryIdsNotDistinct = "AWS.SimpleQueueService.BatchEntryIdsNotDistinct"

	// ErrCodeBatchRequestTooLong for service response error code
	// "AWS.SimpleQueueService.BatchRequestTooLong".
	//
	// The length of all the messages put together is more than the limit.
	ErrCodeBatchRequestTooLong = "AWS.SimpleQueueService.BatchRequestTooLong"

	// ErrCodeEmptyBatchRequest for service response error code
	// "AWS.SimpleQueueService.EmptyBatchRequest".
	//
	// The batch request doesn't contain any entries.
	ErrCodeEmptyBatchRequest = "AWS.SimpleQueueService.EmptyBatchRequest"

	// ErrCodeInvalidAttributeName for service response error code
	// "InvalidAttributeName".
	//
	// The attribute referred to doesn't exist.
	ErrCodeInvalidAttributeName = "InvalidAttributeName"

	// ErrCodeInvalidBatchEntryId for service response error code
	// "AWS.SimpleQueueService.InvalidBatchEntryId".
	//
	// The Id of a batch entry in a batch request doesn't abide by the specification.
	ErrCodeInvalidBatchEntryId = "AWS.SimpleQueueService.InvalidBatchEntryId"

	// ErrCodeInvalidIdFormat for service response error code
	// "InvalidIdFormat".
	//
	// The receipt handle isn't valid for the current version.
	ErrCodeInvalidIdFormat = "InvalidIdFormat"

	// ErrCodeInvalidMessageContents for service response error code
	// "InvalidMessageContents".
	//
	// The message contains characters outside the allowed set.
	ErrCodeInvalidMessageContents = "InvalidMessageContents"

	// ErrCodeMessageNotInflight for service response error code
	// "AWS.SimpleQueueService.MessageNotInflight".
	//
	// The message referred to isn't in flight.
	ErrCodeMessageNotInflight = "AWS.SimpleQueueService.MessageNotInflight"

	// ErrCodeOverLimit for service response error code
	// "OverLimit".
	//
	// The action that you requested would violate a limit. For example, ReceiveMessage
	// returns this error if the maximum number of inflight messages is reached.
	// AddPermission returns this error if the maximum number of permissions for
	// the queue is reached.
	ErrCodeOverLimit = "OverLimit"

	// ErrCodePurgeQueueInProgress for service response error code
	// "AWS.SimpleQueueService.PurgeQueueInProgress".
	//
	// Indicates that the specified queue previously received a PurgeQueue request
	// within the last 60 seconds (the time it can take to delete the messages in
	// the queue).
	ErrCodePurgeQueueInProgress = "AWS.SimpleQueueService.PurgeQueueInProgress"

	// ErrCodeQueueDeletedRecently for service response error code
	// "AWS.SimpleQueueService.QueueDeletedRecently".
	//
	// You must wait 60 seconds after deleting a queue before you can create another
	// one with the same name.
	ErrCodeQueueDeletedRecently = "AWS.SimpleQueueService.QueueDeletedRecently"

	// ErrCodeQueueDoesNotExist for service response error code
	// "AWS.SimpleQueueService.NonExistentQueue".
	//
	// The queue referred to doesn't exist.
	ErrCodeQueueDoesNotExist = "AWS.SimpleQueueService.NonExistentQueue"

	// ErrCodeQueueNameExists for service response error code
	// "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.
	ErrCodeQueueNameExists = "QueueAlreadyExists"

	// ErrCodeReceiptHandleIsInvalid for service response error code
	// "ReceiptHandleIsInvalid".
	//
	// The receipt handle provided isn't valid.
	ErrCodeReceiptHandleIsInvalid = "ReceiptHandleIsInvalid"

	// ErrCodeTooManyEntriesInBatchRequest for service response error code
	// "AWS.SimpleQueueService.TooManyEntriesInBatchRequest".
	//
	// The batch request contains more entries than permissible.
	ErrCodeTooManyEntriesInBatchRequest = "AWS.SimpleQueueService.TooManyEntriesInBatchRequest"

	// ErrCodeUnsupportedOperation for service response error code
	// "AWS.SimpleQueueService.UnsupportedOperation".
	//
	// Error code 400. Unsupported operation.
	ErrCodeUnsupportedOperation = "AWS.SimpleQueueService.UnsupportedOperation"
)
View Source 
const (
	ServiceName = "sqs"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

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 is given permission. The principal must have an AWS account, but does
	// not need to be signed up for Amazon SQS. For information about locating the
	// AWS account identification, see Your AWS Identifiers (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
	// values are valid:
	//
	//    * *
	//
	//    * ChangeMessageVisibility
	//
	//    * DeleteMessage
	//
	//    * GetQueueAttributes
	//
	//    * GetQueueUrl
	//
	//    * ReceiveMessage
	//
	//    * SendMessage
	//
	// 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 ActionName.n
	// also grants permissions for the corresponding batch versions of those actions:
	// SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
	//
	// Actions is a required field
	Actions []*string `locationNameList:"ActionName" type:"list" flattened:"true" required:"true"`

	// The unique identification of the permission you're setting (for example,
	// AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric
	// characters, hyphens (-), and underscores (_).
	//
	// Label is a required field
	Label *string `type:"string" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermissionRequest

func (AddPermissionInput) GoString added in v0.6.5 

func (s AddPermissionInput) GoString() string

GoString returns the string representation

func (*AddPermissionInput) SetAWSAccountIds added in v1.5.0 

func (s *AddPermissionInput) SetAWSAccountIds(v []*string) *AddPermissionInput

SetAWSAccountIds sets the AWSAccountIds field's value.

func (*AddPermissionInput) SetActions added in v1.5.0 

func (s *AddPermissionInput) SetActions(v []*string) *AddPermissionInput

SetActions sets the Actions field's value.

func (*AddPermissionInput) SetLabel added in v1.5.0 

func (s *AddPermissionInput) SetLabel(v string) *AddPermissionInput

SetLabel sets the Label field's value.

func (*AddPermissionInput) SetQueueUrl added in v1.5.0 

func (s *AddPermissionInput) SetQueueUrl(v string) *AddPermissionInput

SetQueueUrl sets the QueueUrl field's value.

func (AddPermissionInput) String added in v0.6.5 

func (s AddPermissionInput) String() string

String returns the string representation

func (*AddPermissionInput) Validate added in v1.1.21 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermissionOutput

func (AddPermissionOutput) GoString added in v0.6.5 

func (s AddPermissionOutput) GoString() string

GoString returns the string representation

func (AddPermissionOutput) String added in v0.6.5 

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

	// Specifies 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchResultErrorEntry

func (BatchResultErrorEntry) GoString added in v0.6.5 

func (s BatchResultErrorEntry) GoString() string

GoString returns the string representation

func (*BatchResultErrorEntry) SetCode added in v1.5.0 

func (s *BatchResultErrorEntry) SetCode(v string) *BatchResultErrorEntry

SetCode sets the Code field's value.

func (*BatchResultErrorEntry) SetId added in v1.5.0 

func (s *BatchResultErrorEntry) SetId(v string) *BatchResultErrorEntry

SetId sets the Id field's value.

func (*BatchResultErrorEntry) SetMessage added in v1.5.0 

func (s *BatchResultErrorEntry) SetMessage(v string) *BatchResultErrorEntry

SetMessage sets the Message field's value.

func (*BatchResultErrorEntry) SetSenderFault added in v1.5.0 

func (s *BatchResultErrorEntry) SetSenderFault(v bool) *BatchResultErrorEntry

SetSenderFault sets the SenderFault field's value.

func (BatchResultErrorEntry) String added in v0.6.5 

func (s BatchResultErrorEntry) String() string

String returns the string representation

type ChangeMessageVisibilityBatchInput 

type ChangeMessageVisibilityBatchInput struct {

	// A list of receipt handles of the messages for which the visibility timeout
	// must be changed.
	//
	// Entries is a required field
	Entries []*ChangeMessageVisibilityBatchRequestEntry `locationNameList:"ChangeMessageVisibilityBatchRequestEntry" type:"list" flattened:"true" required:"true"`

	// The URL of the Amazon SQS queue whose messages' visibility is changed.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatchRequest

func (ChangeMessageVisibilityBatchInput) GoString added in v0.6.5 

func (s ChangeMessageVisibilityBatchInput) GoString() string

GoString returns the string representation

func (*ChangeMessageVisibilityBatchInput) SetEntries added in v1.5.0 

func (s *ChangeMessageVisibilityBatchInput) SetEntries(v []*ChangeMessageVisibilityBatchRequestEntry) *ChangeMessageVisibilityBatchInput

SetEntries sets the Entries field's value.

func (*ChangeMessageVisibilityBatchInput) SetQueueUrl added in v1.5.0 

func (s *ChangeMessageVisibilityBatchInput) SetQueueUrl(v string) *ChangeMessageVisibilityBatchInput

SetQueueUrl sets the QueueUrl field's value.

func (ChangeMessageVisibilityBatchInput) String added in v0.6.5 

func (s ChangeMessageVisibilityBatchInput) String() string

String returns the string representation

func (*ChangeMessageVisibilityBatchInput) Validate added in v1.1.21 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatchResult

func (ChangeMessageVisibilityBatchOutput) GoString added in v0.6.5 

func (s ChangeMessageVisibilityBatchOutput) GoString() string

GoString returns the string representation

func (*ChangeMessageVisibilityBatchOutput) SetFailed added in v1.5.0 

func (s *ChangeMessageVisibilityBatchOutput) SetFailed(v []*BatchResultErrorEntry) *ChangeMessageVisibilityBatchOutput

SetFailed sets the Failed field's value.

func (*ChangeMessageVisibilityBatchOutput) SetSuccessful added in v1.5.0 

func (s *ChangeMessageVisibilityBatchOutput) SetSuccessful(v []*ChangeMessageVisibilityBatchResultEntry) *ChangeMessageVisibilityBatchOutput

SetSuccessful sets the Successful field's value.

func (ChangeMessageVisibilityBatchOutput) String added in v0.6.5 

func (s ChangeMessageVisibilityBatchOutput) String() string

String returns the string representation

type ChangeMessageVisibilityBatchRequestEntry 

type ChangeMessageVisibilityBatchRequestEntry struct {

	// An identifier for this particular receipt handle used to communicate the
	// result.
	//
	// The Ids of a batch request need to be unique within a request
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// A receipt handle.
	//
	// ReceiptHandle is a required field
	ReceiptHandle *string `type:"string" required:"true"`

	// The new value (in seconds) for the message's visibility timeout.
	VisibilityTimeout *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.

All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:

&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=<replaceable>Your_Receipt_Handle</replaceable>

&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45 Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatchRequestEntry

func (ChangeMessageVisibilityBatchRequestEntry) GoString added in v0.6.5 

func (s ChangeMessageVisibilityBatchRequestEntry) GoString() string

GoString returns the string representation

func (*ChangeMessageVisibilityBatchRequestEntry) SetId added in v1.5.0 

func (s *ChangeMessageVisibilityBatchRequestEntry) SetId(v string) *ChangeMessageVisibilityBatchRequestEntry

SetId sets the Id field's value.

func (*ChangeMessageVisibilityBatchRequestEntry) SetReceiptHandle added in v1.5.0 

func (s *ChangeMessageVisibilityBatchRequestEntry) SetReceiptHandle(v string) *ChangeMessageVisibilityBatchRequestEntry

SetReceiptHandle sets the ReceiptHandle field's value.

func (*ChangeMessageVisibilityBatchRequestEntry) SetVisibilityTimeout added in v1.5.0 

func (s *ChangeMessageVisibilityBatchRequestEntry) SetVisibilityTimeout(v int64) *ChangeMessageVisibilityBatchRequestEntry

SetVisibilityTimeout sets the VisibilityTimeout field's value.

func (ChangeMessageVisibilityBatchRequestEntry) String added in v0.6.5 

func (s ChangeMessageVisibilityBatchRequestEntry) String() string

String returns the string representation

func (*ChangeMessageVisibilityBatchRequestEntry) Validate added in v1.1.21 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatchResultEntry

func (ChangeMessageVisibilityBatchResultEntry) GoString added in v0.6.5 

func (s ChangeMessageVisibilityBatchResultEntry) GoString() string

GoString returns the string representation

func (*ChangeMessageVisibilityBatchResultEntry) SetId added in v1.5.0 

func (s *ChangeMessageVisibilityBatchResultEntry) SetId(v string) *ChangeMessageVisibilityBatchResultEntry

SetId sets the Id field's value.

func (ChangeMessageVisibilityBatchResultEntry) String added in v0.6.5 

func (s ChangeMessageVisibilityBatchResultEntry) String() string

String returns the string representation

type ChangeMessageVisibilityInput 

type ChangeMessageVisibilityInput struct {

	// The URL of the Amazon SQS queue whose message's visibility is changed.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityRequest

func (ChangeMessageVisibilityInput) GoString added in v0.6.5 

func (s ChangeMessageVisibilityInput) GoString() string

GoString returns the string representation

func (*ChangeMessageVisibilityInput) SetQueueUrl added in v1.5.0 

func (s *ChangeMessageVisibilityInput) SetQueueUrl(v string) *ChangeMessageVisibilityInput

SetQueueUrl sets the QueueUrl field's value.

func (*ChangeMessageVisibilityInput) SetReceiptHandle added in v1.5.0 

func (s *ChangeMessageVisibilityInput) SetReceiptHandle(v string) *ChangeMessageVisibilityInput

SetReceiptHandle sets the ReceiptHandle field's value.

func (*ChangeMessageVisibilityInput) SetVisibilityTimeout added in v1.5.0 

func (s *ChangeMessageVisibilityInput) SetVisibilityTimeout(v int64) *ChangeMessageVisibilityInput

SetVisibilityTimeout sets the VisibilityTimeout field's value.

func (ChangeMessageVisibilityInput) String added in v0.6.5 

func (s ChangeMessageVisibilityInput) String() string

String returns the string representation

func (*ChangeMessageVisibilityInput) Validate added in v1.1.21 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityOutput

func (ChangeMessageVisibilityOutput) GoString added in v0.6.5 

func (s ChangeMessageVisibilityOutput) GoString() string

GoString returns the string representation

func (ChangeMessageVisibilityOutput) String added in v0.6.5 

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 that the CreateQueue action uses:
	//
	//    * DelaySeconds - The length of time, in seconds, for which the delivery
	//    of all messages in the queue is delayed. Valid values: An integer from
	//    0 to 900 seconds (15 minutes). The default is 0 (zero).
	//
	//    * MaximumMessageSize - The limit of how many bytes a message can contain
	//    before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
	//    (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).
	//
	//
	//    * MessageRetentionPeriod - The length of time, in seconds, for which Amazon
	//    SQS retains a message. Valid values: An integer from 60 seconds (1 minute)
	//    to 1,209,600 seconds (14 days). The default is 345,600 (4 days).
	//
	//    * Policy - The queue's policy. A valid AWS policy. For more information
	//    about policy structure, see Overview of AWS IAM Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html)
	//    in the Amazon IAM User Guide.
	//
	//    * ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for
	//    which a ReceiveMessage action waits for a message to arrive. Valid values:
	//    An integer from 0 to 20 (seconds). The default is 0 (zero).
	//
	//    * RedrivePolicy - The parameters for the dead letter queue functionality
	//    of the source queue. For more information about the redrive policy and
	//    dead letter queues, see Using Amazon SQS Dead Letter Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
	//    in the Amazon SQS Developer Guide.
	//
	// The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly,
	//    the dead letter queue of a standard queue must also be a standard queue.
	//
	//    * VisibilityTimeout - The visibility timeout for the queue. Valid values:
	//    An integer from 0 to 43,200 (12 hours). The default is 30. For more information
	//    about the visibility timeout, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
	//    in the Amazon SQS Developer Guide.
	//
	// The following attributes apply only to server-side-encryption (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
	//
	//    * KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK)
	//    for Amazon SQS or a custom CMK. For more information, see Key Terms (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
	//    While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs,
	//    the alias of a custom CMK can, for example, be alias/aws/sqs. For more
	//    examples, see KeyId (http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
	//    in the AWS Key Management Service API Reference.
	//
	//    * KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which
	//    Amazon SQS can reuse a data key (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)
	//    to encrypt or decrypt messages before calling AWS KMS again. An integer
	//    representing seconds, between 60 seconds (1 minute) and 86,400 seconds
	//    (24 hours). The default is 300 (5 minutes). A shorter time period provides
	//    better security but results in more calls to KMS which incur charges after
	//    Free Tier. For more information, see How Does the Data Key Reuse Period
	//    Work? (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work).
	//
	//
	// The following attributes apply only to FIFO (first-in-first-out) queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
	//
	//    * FifoQueue - Designates a queue as FIFO. Valid values: true, false. You
	//    can provide this attribute only during queue creation. You can't change
	//    it for an existing queue. When you set this attribute, you must also provide
	//    the MessageGroupId for your messages explicitly.
	//
	// For more information, see FIFO Queue Logic (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic)
	//    in the Amazon SQS Developer Guide.
	//
	//    * ContentBasedDeduplication - Enables content-based deduplication. Valid
	//    values: true, false. For more information, see Exactly-Once Processing
	//    (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
	//    in the Amazon SQS Developer Guide.
	//
	// Every message must have a unique MessageDeduplicationId,
	//
	// You may provide a MessageDeduplicationId explicitly.
	//
	// If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication
	//    for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId
	//    using the body of the message (but not the attributes of the message).
	//
	//
	// If you don't provide a MessageDeduplicationId and the queue doesn't have
	//    ContentBasedDeduplication set, the action fails with an error.
	//
	// If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
	//    overrides the generated one.
	//
	// When ContentBasedDeduplication is in effect, messages with identical content
	//    sent within the deduplication interval are treated as duplicates and only
	//    one copy of the message is delivered.
	//
	// If you send one message with ContentBasedDeduplication enabled and then another
	//    message with a MessageDeduplicationId that is the same as the one generated
	//    for the first MessageDeduplicationId, the two messages are treated as
	//    duplicates and only one copy of the message is delivered.
	//
	// Any other valid special request parameters (such as the following) are ignored:
	//
	//    * ApproximateNumberOfMessages
	//
	//    * ApproximateNumberOfMessagesDelayed
	//
	//    * ApproximateNumberOfMessagesNotVisible
	//
	//    * CreatedTimestamp
	//
	//    * LastModifiedTimestamp
	//
	//    * QueueArn
	Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// The name of the new queue. The following limits apply to this name:
	//
	//    * A queue name can have up to 80 characters.
	//
	//    * Valid values: alphanumeric characters, hyphens (-), and underscores
	//    (_).
	//
	//    * A FIFO queue name must end with the .fifo suffix.
	//
	// Queue names are case-sensitive.
	//
	// QueueName is a required field
	QueueName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueueRequest

func (CreateQueueInput) GoString added in v0.6.5 

func (s CreateQueueInput) GoString() string

GoString returns the string representation

func (*CreateQueueInput) SetAttributes added in v1.5.0 

func (s *CreateQueueInput) SetAttributes(v map[string]*string) *CreateQueueInput

SetAttributes sets the Attributes field's value.

func (*CreateQueueInput) SetQueueName added in v1.5.0 

func (s *CreateQueueInput) SetQueueName(v string) *CreateQueueInput

SetQueueName sets the QueueName field's value.

func (CreateQueueInput) String added in v0.6.5 

func (s CreateQueueInput) String() string

String returns the string representation

func (*CreateQueueInput) Validate added in v1.1.21 

func (s *CreateQueueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateQueueOutput 

type CreateQueueOutput struct {

	// The URL of the created Amazon SQS queue.
	QueueUrl *string `type:"string"`
	// contains filtered or unexported fields
}

Returns the QueueUrl attribute of the created queue. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueueResult

func (CreateQueueOutput) GoString added in v0.6.5 

func (s CreateQueueOutput) GoString() string

GoString returns the string representation

func (*CreateQueueOutput) SetQueueUrl added in v1.5.0 

func (s *CreateQueueOutput) SetQueueUrl(v string) *CreateQueueOutput

SetQueueUrl sets the QueueUrl field's value.

func (CreateQueueOutput) String added in v0.6.5 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatchRequest

func (DeleteMessageBatchInput) GoString added in v0.6.5 

func (s DeleteMessageBatchInput) GoString() string

GoString returns the string representation

func (*DeleteMessageBatchInput) SetEntries added in v1.5.0 

func (s *DeleteMessageBatchInput) SetEntries(v []*DeleteMessageBatchRequestEntry) *DeleteMessageBatchInput

SetEntries sets the Entries field's value.

func (*DeleteMessageBatchInput) SetQueueUrl added in v1.5.0 

func (s *DeleteMessageBatchInput) SetQueueUrl(v string) *DeleteMessageBatchInput

SetQueueUrl sets the QueueUrl field's value.

func (DeleteMessageBatchInput) String added in v0.6.5 

func (s DeleteMessageBatchInput) String() string

String returns the string representation

func (*DeleteMessageBatchInput) Validate added in v1.1.21 

func (s *DeleteMessageBatchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteMessageBatchOutput 

type DeleteMessageBatchOutput struct {

	// A list of BatchResultErrorEntry items.
	//
	// Failed is a required field
	Failed []*BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"`

	// A list of DeleteMessageBatchResultEntry items.
	//
	// Successful is a required field
	Successful []*DeleteMessageBatchResultEntry `locationNameList:"DeleteMessageBatchResultEntry" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatchResult

func (DeleteMessageBatchOutput) GoString added in v0.6.5 

func (s DeleteMessageBatchOutput) GoString() string

GoString returns the string representation

func (*DeleteMessageBatchOutput) SetFailed added in v1.5.0 

func (s *DeleteMessageBatchOutput) SetFailed(v []*BatchResultErrorEntry) *DeleteMessageBatchOutput

SetFailed sets the Failed field's value.

func (*DeleteMessageBatchOutput) SetSuccessful added in v1.5.0 

func (s *DeleteMessageBatchOutput) SetSuccessful(v []*DeleteMessageBatchResultEntry) *DeleteMessageBatchOutput

SetSuccessful sets the Successful field's value.

func (DeleteMessageBatchOutput) String added in v0.6.5 

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.
	//
	// The Ids of a batch request need to be unique within a 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatchRequestEntry

func (DeleteMessageBatchRequestEntry) GoString added in v0.6.5 

func (s DeleteMessageBatchRequestEntry) GoString() string

GoString returns the string representation

func (*DeleteMessageBatchRequestEntry) SetId added in v1.5.0 

func (s *DeleteMessageBatchRequestEntry) SetId(v string) *DeleteMessageBatchRequestEntry

SetId sets the Id field's value.

func (*DeleteMessageBatchRequestEntry) SetReceiptHandle added in v1.5.0 

func (s *DeleteMessageBatchRequestEntry) SetReceiptHandle(v string) *DeleteMessageBatchRequestEntry

SetReceiptHandle sets the ReceiptHandle field's value.

func (DeleteMessageBatchRequestEntry) String added in v0.6.5 

func (s DeleteMessageBatchRequestEntry) String() string

String returns the string representation

func (*DeleteMessageBatchRequestEntry) Validate added in v1.1.21 

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 of an entry in DeleteMessageBatch. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatchResultEntry

func (DeleteMessageBatchResultEntry) GoString added in v0.6.5 

func (s DeleteMessageBatchResultEntry) GoString() string

GoString returns the string representation

func (*DeleteMessageBatchResultEntry) SetId added in v1.5.0 

func (s *DeleteMessageBatchResultEntry) SetId(v string) *DeleteMessageBatchResultEntry

SetId sets the Id field's value.

func (DeleteMessageBatchResultEntry) String added in v0.6.5 

func (s DeleteMessageBatchResultEntry) String() string

String returns the string representation

type DeleteMessageInput 

type DeleteMessageInput struct {

	// The URL of the Amazon SQS queue from which messages are deleted.
	//
	// Queue URLs 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageRequest

func (DeleteMessageInput) GoString added in v0.6.5 

func (s DeleteMessageInput) GoString() string

GoString returns the string representation

func (*DeleteMessageInput) SetQueueUrl added in v1.5.0 

func (s *DeleteMessageInput) SetQueueUrl(v string) *DeleteMessageInput

SetQueueUrl sets the QueueUrl field's value.

func (*DeleteMessageInput) SetReceiptHandle added in v1.5.0 

func (s *DeleteMessageInput) SetReceiptHandle(v string) *DeleteMessageInput

SetReceiptHandle sets the ReceiptHandle field's value.

func (DeleteMessageInput) String added in v0.6.5 

func (s DeleteMessageInput) String() string

String returns the string representation

func (*DeleteMessageInput) Validate added in v1.1.21 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageOutput

func (DeleteMessageOutput) GoString added in v0.6.5 

func (s DeleteMessageOutput) GoString() string

GoString returns the string representation

func (DeleteMessageOutput) String added in v0.6.5 

func (s DeleteMessageOutput) String() string

String returns the string representation

type DeleteQueueInput 

type DeleteQueueInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteQueueRequest

func (DeleteQueueInput) GoString added in v0.6.5 

func (s DeleteQueueInput) GoString() string

GoString returns the string representation

func (*DeleteQueueInput) SetQueueUrl added in v1.5.0 

func (s *DeleteQueueInput) SetQueueUrl(v string) *DeleteQueueInput

SetQueueUrl sets the QueueUrl field's value.

func (DeleteQueueInput) String added in v0.6.5 

func (s DeleteQueueInput) String() string

String returns the string representation

func (*DeleteQueueInput) Validate added in v1.1.21 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteQueueOutput

func (DeleteQueueOutput) GoString added in v0.6.5 

func (s DeleteQueueOutput) GoString() string

GoString returns the string representation

func (DeleteQueueOutput) String added in v0.6.5 

func (s DeleteQueueOutput) String() string

String returns the string representation

type GetQueueAttributesInput 

type GetQueueAttributesInput struct {

	// A list of attributes for which to retrieve information.
	//
	// In the future, new attributes might be added. If you write code that calls
	// this action, we recommend that you structure your code so that it can handle
	// new attributes gracefully.
	//
	// The following attributes are supported:
	//
	//    * 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/sqs-resources-required-process-messages.html)
	//    in the Amazon SQS Developer Guide.
	//
	//    * ApproximateNumberOfMessagesDelayed - Returns the approximate number
	//    of messages that are waiting to be added to the queue.
	//
	//    * ApproximateNumberOfMessagesNotVisible - Returns the approximate number
	//    of messages that have not timed-out and aren't deleted. For more information,
	//    see Resources Required to Process Messages (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html)
	//    in the Amazon SQS Developer Guide.
	//
	//    * CreatedTimestamp - Returns the time when the queue was created in seconds
	//    (epoch time (http://en.wikipedia.org/wiki/Unix_time)).
	//
	//    * DelaySeconds - Returns the default delay on the queue in seconds.
	//
	//    * LastModifiedTimestamp - Returns the time when the queue was last changed
	//    in seconds (epoch time (http://en.wikipedia.org/wiki/Unix_time)).
	//
	//    * MaximumMessageSize - Returns the limit of how many bytes a message can
	//    contain before Amazon SQS rejects it.
	//
	//    * MessageRetentionPeriod - Returns the length of time, in seconds, for
	//    which Amazon SQS retains a message.
	//
	//    * Policy - Returns the policy of the queue.
	//
	//    * QueueArn - Returns the Amazon resource name (ARN) of the queue.
	//
	//    * ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds,
	//    for which the ReceiveMessage action waits for a message to arrive.
	//
	//    * RedrivePolicy - Returns the parameters for dead letter queue functionality
	//    of the source queue. For more information about the redrive policy and
	//    dead letter queues, see Using Amazon SQS Dead Letter Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
	//    in the Amazon SQS Developer Guide.
	//
	//    * VisibilityTimeout - Returns the visibility timeout for the queue. For
	//    more information about the visibility timeout, see Visibility Timeout
	//    (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
	//    in the Amazon SQS Developer Guide.
	//
	// The following attributes apply only to server-side-encryption (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
	//
	//    * KmsMasterKeyId - Returns the ID of an AWS-managed customer master key
	//    (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms
	//    (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
	//
	//
	//    * KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds,
	//    for which Amazon SQS can reuse a data key to encrypt or decrypt messages
	//    before calling AWS KMS again.
	//
	// The following attributes apply only to FIFO (first-in-first-out) queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
	//
	//    * FifoQueue - Returns whether the queue is FIFO. For more information,
	//    see FIFO Queue Logic (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic)
	//    in the Amazon SQS Developer Guide.
	//
	// To determine whether a queue is FIFO (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html),
	//    you can check whether QueueName ends with the .fifo suffix.
	//
	//    * ContentBasedDeduplication - Returns whether content-based deduplication
	//    is enabled for the queue. For more information, see Exactly-Once Processing
	//    (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
	//    in the Amazon SQS Developer Guide.
	AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest

func (GetQueueAttributesInput) GoString added in v0.6.5 

func (s GetQueueAttributesInput) GoString() string

GoString returns the string representation

func (*GetQueueAttributesInput) SetAttributeNames added in v1.5.0 

func (s *GetQueueAttributesInput) SetAttributeNames(v []*string) *GetQueueAttributesInput

SetAttributeNames sets the AttributeNames field's value.

func (*GetQueueAttributesInput) SetQueueUrl added in v1.5.0 

func (s *GetQueueAttributesInput) SetQueueUrl(v string) *GetQueueAttributesInput

SetQueueUrl sets the QueueUrl field's value.

func (GetQueueAttributesInput) String added in v0.6.5 

func (s GetQueueAttributesInput) String() string

String returns the string representation

func (*GetQueueAttributesInput) Validate added in v1.1.21 

func (s *GetQueueAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueueAttributesOutput 

type GetQueueAttributesOutput struct {

	// A map of attributes to their respective values.
	Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`
	// contains filtered or unexported fields
}

A list of returned queue attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesResult

func (GetQueueAttributesOutput) GoString added in v0.6.5 

func (s GetQueueAttributesOutput) GoString() string

GoString returns the string representation

func (*GetQueueAttributesOutput) SetAttributes added in v1.5.0 

func (s *GetQueueAttributesOutput) SetAttributes(v map[string]*string) *GetQueueAttributesOutput

SetAttributes sets the Attributes field's value.

func (GetQueueAttributesOutput) String added in v0.6.5 

func (s GetQueueAttributesOutput) String() string

String returns the string representation

type GetQueueUrlInput added in v0.9.5 

type GetQueueUrlInput struct {

	// The name of the queue whose URL must be fetched. Maximum 80 characters. Valid
	// values: alphanumeric characters, hyphens (-), and underscores (_).
	//
	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest

func (GetQueueUrlInput) GoString added in v0.9.5 

func (s GetQueueUrlInput) GoString() string

GoString returns the string representation

func (*GetQueueUrlInput) SetQueueName added in v1.5.0 

func (s *GetQueueUrlInput) SetQueueName(v string) *GetQueueUrlInput

SetQueueName sets the QueueName field's value.

func (*GetQueueUrlInput) SetQueueOwnerAWSAccountId added in v1.5.0 

func (s *GetQueueUrlInput) SetQueueOwnerAWSAccountId(v string) *GetQueueUrlInput

SetQueueOwnerAWSAccountId sets the QueueOwnerAWSAccountId field's value.

func (GetQueueUrlInput) String added in v0.9.5 

func (s GetQueueUrlInput) String() string

String returns the string representation

func (*GetQueueUrlInput) Validate added in v1.1.21 

func (s *GetQueueUrlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetQueueUrlOutput added in v0.9.5 

type GetQueueUrlOutput struct {

	// The URL of 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlResult

func (GetQueueUrlOutput) GoString added in v0.9.5 

func (s GetQueueUrlOutput) GoString() string

GoString returns the string representation

func (*GetQueueUrlOutput) SetQueueUrl added in v1.5.0 

func (s *GetQueueUrlOutput) SetQueueUrl(v string) *GetQueueUrlOutput

SetQueueUrl sets the QueueUrl field's value.

func (GetQueueUrlOutput) String added in v0.9.5 

func (s GetQueueUrlOutput) String() string

String returns the string representation

type ListDeadLetterSourceQueuesInput 

type ListDeadLetterSourceQueuesInput struct {

	// The 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest

func (ListDeadLetterSourceQueuesInput) GoString added in v0.6.5 

func (s ListDeadLetterSourceQueuesInput) GoString() string

GoString returns the string representation

func (*ListDeadLetterSourceQueuesInput) SetQueueUrl added in v1.5.0 

func (s *ListDeadLetterSourceQueuesInput) SetQueueUrl(v string) *ListDeadLetterSourceQueuesInput

SetQueueUrl sets the QueueUrl field's value.

func (ListDeadLetterSourceQueuesInput) String added in v0.6.5 

func (s ListDeadLetterSourceQueuesInput) String() string

String returns the string representation

func (*ListDeadLetterSourceQueuesInput) Validate added in v1.1.21 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult

func (ListDeadLetterSourceQueuesOutput) GoString added in v0.6.5 

func (s ListDeadLetterSourceQueuesOutput) GoString() string

GoString returns the string representation

func (*ListDeadLetterSourceQueuesOutput) SetQueueUrls added in v1.5.0 

func (s *ListDeadLetterSourceQueuesOutput) SetQueueUrls(v []*string) *ListDeadLetterSourceQueuesOutput

SetQueueUrls sets the QueueUrls field's value.

func (ListDeadLetterSourceQueuesOutput) String added in v0.6.5 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest

func (ListQueuesInput) GoString added in v0.6.5 

func (s ListQueuesInput) GoString() string

GoString returns the string representation

func (*ListQueuesInput) SetQueueNamePrefix added in v1.5.0 

func (s *ListQueuesInput) SetQueueNamePrefix(v string) *ListQueuesInput

SetQueueNamePrefix sets the QueueNamePrefix field's value.

func (ListQueuesInput) String added in v0.6.5 

func (s ListQueuesInput) String() string

String returns the string representation

type ListQueuesOutput 

type ListQueuesOutput struct {

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

A list of your queues. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesResult

func (ListQueuesOutput) GoString added in v0.6.5 

func (s ListQueuesOutput) GoString() string

GoString returns the string representation

func (*ListQueuesOutput) SetQueueUrls added in v1.5.0 

func (s *ListQueuesOutput) SetQueueUrls(v []*string) *ListQueuesOutput

SetQueueUrls sets the QueueUrls field's value.

func (ListQueuesOutput) String added in v0.6.5 

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. You can use
	// this attribute to verify that Amazon SQS received the message correctly.
	// Amazon SQS URL-decodes the message before creating the MD5 digest. For information
	// about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).
	MD5OfMessageAttributes *string `type:"string"`

	// Each message attribute consists of a Name, Type, and Value. For more information,
	// see Message Attribute Items and Validation (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation)
	// in the Amazon SQS Developer Guide.
	MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// A unique identifier for the message. A MessageIdis considered unique across
	// all AWS accounts for an extended period of time.
	MessageId *string `type:"string"`

	// An identifier associated with the act of receiving the message. A new receipt
	// handle is returned every time you receive a message. When deleting a message,
	// you provide the last received receipt handle to delete the message.
	ReceiptHandle *string `type:"string"`
	// contains filtered or unexported fields
}

An Amazon SQS message. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/Message

func (Message) GoString added in v0.6.5 

func (s Message) GoString() string

GoString returns the string representation

func (*Message) SetAttributes added in v1.5.0 

func (s *Message) SetAttributes(v map[string]*string) *Message

SetAttributes sets the Attributes field's value.

func (*Message) SetBody added in v1.5.0 

func (s *Message) SetBody(v string) *Message

SetBody sets the Body field's value.

func (*Message) SetMD5OfBody added in v1.5.0 

func (s *Message) SetMD5OfBody(v string) *Message

SetMD5OfBody sets the MD5OfBody field's value.

func (*Message) SetMD5OfMessageAttributes added in v1.5.0 

func (s *Message) SetMD5OfMessageAttributes(v string) *Message

SetMD5OfMessageAttributes sets the MD5OfMessageAttributes field's value.

func (*Message) SetMessageAttributes added in v1.5.0 

func (s *Message) SetMessageAttributes(v map[string]*MessageAttributeValue) *Message

SetMessageAttributes sets the MessageAttributes field's value.

func (*Message) SetMessageId added in v1.5.0 

func (s *Message) SetMessageId(v string) *Message

SetMessageId sets the MessageId field's value.

func (*Message) SetReceiptHandle added in v1.5.0 

func (s *Message) SetReceiptHandle(v string) *Message

SetReceiptHandle sets the ReceiptHandle field's value.

func (Message) String added in v0.6.5 

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, such as compressed data,
	// encrypted data, or images.
	//
	// BinaryValue is automatically base64 encoded/decoded by the SDK.
	BinaryValue []byte `type:"blob"`

	// Amazon SQS supports the following logical data types: String, Number, and
	// Binary. For the Number data type, you must use StringValue.
	//
	// You can also append custom labels. For more information, see Message Attribute
	// Data Types and Validation (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-data-types-validation)
	// in the Amazon SQS Developer Guide.
	//
	// DataType is a required field
	DataType *string `type:"string" required:"true"`

	// Not implemented. Reserved for future use.
	StringListValues []*string `locationName:"StringListValue" locationNameList:"StringListValue" type:"list" flattened:"true"`

	// Strings are Unicode with UTF-8 binary encoding. For a list of code values,
	// see ASCII Printable Characters (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters).
	StringValue *string `type:"string"`
	// contains filtered or unexported fields
}

The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes). Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageAttributeValue

func (MessageAttributeValue) GoString added in v0.6.5 

func (s MessageAttributeValue) GoString() string

GoString returns the string representation

func (*MessageAttributeValue) SetBinaryListValues added in v1.5.0 

func (s *MessageAttributeValue) SetBinaryListValues(v [][]byte) *MessageAttributeValue

SetBinaryListValues sets the BinaryListValues field's value.

func (*MessageAttributeValue) SetBinaryValue added in v1.5.0 

func (s *MessageAttributeValue) SetBinaryValue(v []byte) *MessageAttributeValue

SetBinaryValue sets the BinaryValue field's value.

func (*MessageAttributeValue) SetDataType added in v1.5.0 

func (s *MessageAttributeValue) SetDataType(v string) *MessageAttributeValue

SetDataType sets the DataType field's value.

func (*MessageAttributeValue) SetStringListValues added in v1.5.0 

func (s *MessageAttributeValue) SetStringListValues(v []*string) *MessageAttributeValue

SetStringListValues sets the StringListValues field's value.

func (*MessageAttributeValue) SetStringValue added in v1.5.0 

func (s *MessageAttributeValue) SetStringValue(v string) *MessageAttributeValue

SetStringValue sets the StringValue field's value.

func (MessageAttributeValue) String added in v0.6.5 

func (s MessageAttributeValue) String() string

String returns the string representation

func (*MessageAttributeValue) Validate added in v1.1.21 

func (s *MessageAttributeValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PurgeQueueInput 

type PurgeQueueInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueRequest

func (PurgeQueueInput) GoString added in v0.6.5 

func (s PurgeQueueInput) GoString() string

GoString returns the string representation

func (*PurgeQueueInput) SetQueueUrl added in v1.5.0 

func (s *PurgeQueueInput) SetQueueUrl(v string) *PurgeQueueInput

SetQueueUrl sets the QueueUrl field's value.

func (PurgeQueueInput) String added in v0.6.5 

func (s PurgeQueueInput) String() string

String returns the string representation

func (*PurgeQueueInput) Validate added in v1.1.21 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueOutput

func (PurgeQueueOutput) GoString added in v0.6.5 

func (s PurgeQueueOutput) GoString() string

GoString returns the string representation

func (PurgeQueueOutput) String added in v0.6.5 

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 the message was
	//    first received from the queue (epoch time (http://en.wikipedia.org/wiki/Unix_time)
	//    in milliseconds).
	//
	//    * ApproximateReceiveCount - Returns the number of times a message has
	//    been received from the queue but not deleted.
	//
	//    * SenderId
	//
	// For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
	//
	// For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
	//
	//    * SentTimestamp - Returns the time the message was sent to the queue (epoch
	//    time (http://en.wikipedia.org/wiki/Unix_time) in milliseconds).
	//
	//    * MessageDeduplicationId - Returns the value provided by the sender that
	//    calls the SendMessage action.
	//
	//    * MessageGroupId - Returns the value provided by the sender that calls
	//    the SendMessage action. Messages with the same MessageGroupId are returned
	//    in sequence.
	//
	//    * SequenceNumber - Returns the value provided by Amazon SQS.
	//
	// Any other valid special request parameters (such as the following) are ignored:
	//
	//    * ApproximateNumberOfMessages
	//
	//    * ApproximateNumberOfMessagesDelayed
	//
	//    * ApproximateNumberOfMessagesNotVisible
	//
	//    * CreatedTimestamp
	//
	//    * ContentBasedDeduplication
	//
	//    * DelaySeconds
	//
	//    * FifoQueue
	//
	//    * LastModifiedTimestamp
	//
	//    * MaximumMessageSize
	//
	//    * MessageRetentionPeriod
	//
	//    * Policy
	//
	//    * QueueArn,
	//
	//    * ReceiveMessageWaitTimeSeconds
	//
	//    * RedrivePolicy
	//
	//    * VisibilityTimeout
	AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true"`

	// The maximum number of messages to return. Amazon SQS never returns more messages
	// than this value (however, fewer messages might be returned). Valid values
	// are 1 to 10. Default is 1.
	MaxNumberOfMessages *int64 `type:"integer"`

	// The name of the message attribute, where N is the index.
	//
	//    * The name can contain alphanumeric characters and the underscore (_),
	//    hyphen (-), and period (.).
	//
	//    * The name is case-sensitive and must be unique among all attribute names
	//    for the message.
	//
	//    * The name must not start with AWS-reserved prefixes such as AWS. or Amazon.
	//    (or any casing variants).
	//
	//    * The name must not start or end with a period (.), and it should not
	//    have periods in succession (..).
	//
	//    * The name can be up to 256 characters long.
	//
	// When using ReceiveMessage, you can send a list of attribute names to receive,
	// or you can return all of the attributes by specifying All or .* in your request.
	// You can also use all message attributes starting with a prefix, for example
	// bar.*.
	MessageAttributeNames []*string `locationNameList:"MessageAttributeName" type:"list" flattened:"true"`

	// The URL of the Amazon SQS queue from which messages are received.
	//
	// Queue URLs are case-sensitive.
	//
	// QueueUrl is a required field
	QueueUrl *string `type:"string" required:"true"`

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The token used for deduplication of ReceiveMessage calls. If a networking
	// issue occurs after a ReceiveMessage action, and instead of a response you
	// receive a generic error, you can retry the same action with an identical
	// ReceiveRequestAttemptId to retrieve the same set of messages, even if their
	// visibility timeout has not yet expired.
	//
	//    * You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage
	//    action.
	//
	//    * When you set FifoQueue, a caller of the ReceiveMessage action can provide
	//    a ReceiveRequestAttemptId explicitly.
	//
	//    * If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId,
	//    Amazon SQS generates a ReceiveRequestAttemptId.
	//
	//    * You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId
	//    if none of the messages have been modified (deleted or had their visibility
	//    changes).
	//
	//    * During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId
	//    return the same messages and receipt handles. If a retry occurs within
	//    the deduplication interval, it resets the visibility timeout. For more
	//    information, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
	//    in the Amazon Simple Queue Service Developer Guide.
	//
	// If a caller of the ReceiveMessage action is still processing messages when
	//    the visibility timeout expires and messages become visible, another worker
	//    reading from the same queue can receive the same messages and therefore
	//    process duplicates. Also, if a reader whose message processing time is
	//    longer than the visibility timeout tries to delete the processed messages,
	//    the action fails with an error.
	//
	// To mitigate this effect, ensure that your application observes a safe threshold
	//    before the visibility timeout expires and extend the visibility timeout
	//    as necessary.
	//
	//    * While messages with a particular MessageGroupId are invisible, no more
	//    messages belonging to the same MessageGroupId are returned until the visibility
	//    timeout expires. You can still receive messages with another MessageGroupId
	//    as long as it is also visible.
	//
	//    * If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId,
	//    no retries work until the original visibility timeout expires. As a result,
	//    delays might occur but the messages in the queue remain in a strict order.
	//
	// The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId
	// can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
	//
	// For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId
	// Request Parameter (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-receiverequestattemptid-request-parameter)
	// in the Amazon Simple Queue Service Developer Guide.
	ReceiveRequestAttemptId *string `type:"string"`

	// The duration (in seconds) that the received messages are hidden from subsequent
	// retrieve requests after being retrieved by a ReceiveMessage request.
	VisibilityTimeout *int64 `type:"integer"`

	// The duration (in seconds) for which the call waits for a message to arrive
	// in the queue before returning. If a message is available, the call returns
	// sooner than WaitTimeSeconds.
	WaitTimeSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessageRequest

func (ReceiveMessageInput) GoString added in v0.6.5 

func (s ReceiveMessageInput) GoString() string

GoString returns the string representation

func (*ReceiveMessageInput) SetAttributeNames added in v1.5.0 

func (s *ReceiveMessageInput) SetAttributeNames(v []*string) *ReceiveMessageInput

SetAttributeNames sets the AttributeNames field's value.

func (*ReceiveMessageInput) SetMaxNumberOfMessages added in v1.5.0 

func (s *ReceiveMessageInput) SetMaxNumberOfMessages(v int64) *ReceiveMessageInput

SetMaxNumberOfMessages sets the MaxNumberOfMessages field's value.

func (*ReceiveMessageInput) SetMessageAttributeNames added in v1.5.0 

func (s *ReceiveMessageInput) SetMessageAttributeNames(v []*string) *ReceiveMessageInput

SetMessageAttributeNames sets the MessageAttributeNames field's value.

func (*ReceiveMessageInput) SetQueueUrl added in v1.5.0 

func (s *ReceiveMessageInput) SetQueueUrl(v string) *ReceiveMessageInput

SetQueueUrl sets the QueueUrl field's value.

func (*ReceiveMessageInput) SetReceiveRequestAttemptId added in v1.5.7 

func (s *ReceiveMessageInput) SetReceiveRequestAttemptId(v string) *ReceiveMessageInput

SetReceiveRequestAttemptId sets the ReceiveRequestAttemptId field's value.

func (*ReceiveMessageInput) SetVisibilityTimeout added in v1.5.0 

func (s *ReceiveMessageInput) SetVisibilityTimeout(v int64) *ReceiveMessageInput

SetVisibilityTimeout sets the VisibilityTimeout field's value.

func (*ReceiveMessageInput) SetWaitTimeSeconds added in v1.5.0 

func (s *ReceiveMessageInput) SetWaitTimeSeconds(v int64) *ReceiveMessageInput

SetWaitTimeSeconds sets the WaitTimeSeconds field's value.

func (ReceiveMessageInput) String added in v0.6.5 

func (s ReceiveMessageInput) String() string

String returns the string representation

func (*ReceiveMessageInput) Validate added in v1.1.21 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessageResult

func (ReceiveMessageOutput) GoString added in v0.6.5 

func (s ReceiveMessageOutput) GoString() string

GoString returns the string representation

func (*ReceiveMessageOutput) SetMessages added in v1.5.0 

func (s *ReceiveMessageOutput) SetMessages(v []*Message) *ReceiveMessageOutput

SetMessages sets the Messages field's value.

func (ReceiveMessageOutput) String added in v0.6.5 

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 using
	// the AddPermission action.
	//
	// Label is a required field
	Label *string `type:"string" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RemovePermissionRequest

func (RemovePermissionInput) GoString added in v0.6.5 

func (s RemovePermissionInput) GoString() string

GoString returns the string representation

func (*RemovePermissionInput) SetLabel added in v1.5.0 

func (s *RemovePermissionInput) SetLabel(v string) *RemovePermissionInput

SetLabel sets the Label field's value.

func (*RemovePermissionInput) SetQueueUrl added in v1.5.0 

func (s *RemovePermissionInput) SetQueueUrl(v string) *RemovePermissionInput

SetQueueUrl sets the QueueUrl field's value.

func (RemovePermissionInput) String added in v0.6.5 

func (s RemovePermissionInput) String() string

String returns the string representation

func (*RemovePermissionInput) Validate added in v1.1.21 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RemovePermissionOutput

func (RemovePermissionOutput) GoString added in v0.6.5 

func (s RemovePermissionOutput) GoString() string

GoString returns the string representation

func (RemovePermissionOutput) String added in v0.6.5 

func (s RemovePermissionOutput) String() string

String returns the string representation

type SQS 

type SQS struct {
	*client.Client
}

SQS provides the API operation methods for making requests to Amazon Simple Queue Service. See this package's package overview docs for details on the service.

SQS methods are safe to use concurrently. It is not safe to modify mutate any of the struct'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 sharing access to the queue.

When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see 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 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:

&Attribute.1=this

&Attribute.2=that

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:

  • ErrCodeOverLimit "OverLimit" The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermission

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermission

func (*SQS) AddPermissionWithContext added in v1.8.0 

func (c *SQS) AddPermissionWithContext(ctx aws.Context, input *AddPermissionInput, opts ...request.Option) (*AddPermissionOutput, error)

AddPermissionWithContext is the same as AddPermission with the addition of the ability to pass a context and additional request options.

See AddPermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 is 12 hours. Thus, 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, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon SQS Developer Guide.

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

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.

For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages.

If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.

Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

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:

  • ErrCodeMessageNotInflight "AWS.SimpleQueueService.MessageNotInflight" The message referred to isn't in flight.

  • ErrCodeReceiptHandleIsInvalid "ReceiptHandleIsInvalid" The receipt handle provided isn't valid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibility

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

&Attribute.1=this

&Attribute.2=that

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:

  • ErrCodeTooManyEntriesInBatchRequest "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" The batch request contains more entries than permissible.

  • ErrCodeEmptyBatchRequest "AWS.SimpleQueueService.EmptyBatchRequest" The batch request doesn't contain any entries.

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

  • ErrCodeInvalidBatchEntryId "AWS.SimpleQueueService.InvalidBatchEntryId" The Id of a batch entry in a batch request doesn't abide by the specification.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatch

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityBatch

func (*SQS) ChangeMessageVisibilityBatchWithContext added in v1.8.0 

func (c *SQS) ChangeMessageVisibilityBatchWithContext(ctx aws.Context, input *ChangeMessageVisibilityBatchInput, opts ...request.Option) (*ChangeMessageVisibilityBatchOutput, error)

ChangeMessageVisibilityBatchWithContext is the same as ChangeMessageVisibilityBatch with the addition of the ability to pass a context and additional request options.

See ChangeMessageVisibilityBatch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibility

func (*SQS) ChangeMessageVisibilityWithContext added in v1.8.0 

func (c *SQS) ChangeMessageVisibilityWithContext(ctx aws.Context, input *ChangeMessageVisibilityInput, opts ...request.Option) (*ChangeMessageVisibilityOutput, error)

ChangeMessageVisibilityWithContext is the same as ChangeMessageVisibility with the addition of the ability to pass a context and additional request options.

See ChangeMessageVisibility for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SQS) CreateQueue 

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

CreateQueue API operation for Amazon Simple Queue Service.

Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:

  • If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

    You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving) in the Amazon SQS Developer Guide.

  • If you don't provide a value for an attribute, the queue is created with the default value for the attribute.

  • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) and is unique within the scope of your queues.

To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:

  • If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.

  • If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

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:

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueue

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueue

func (*SQS) CreateQueueWithContext added in v1.8.0 

func (c *SQS) CreateQueueWithContext(ctx aws.Context, input *CreateQueueInput, opts ...request.Option) (*CreateQueueOutput, error)

CreateQueueWithContext is the same as CreateQueue with the addition of the ability to pass a context and additional request options.

See CreateQueue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 MessageId you receive when you send 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 the message.

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. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

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:

  • ErrCodeInvalidIdFormat "InvalidIdFormat" The receipt handle isn't valid for the current version.

  • ErrCodeReceiptHandleIsInvalid "ReceiptHandleIsInvalid" The receipt handle provided isn't valid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessage

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 action on each message is reported individually in the response.

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

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:

  • ErrCodeTooManyEntriesInBatchRequest "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" The batch request contains more entries than permissible.

  • ErrCodeEmptyBatchRequest "AWS.SimpleQueueService.EmptyBatchRequest" The batch request doesn't contain any entries.

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

  • ErrCodeInvalidBatchEntryId "AWS.SimpleQueueService.InvalidBatchEntryId" The Id of a batch entry in a batch request doesn't abide by the specification.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatch

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatch

func (*SQS) DeleteMessageBatchWithContext added in v1.8.0 

func (c *SQS) DeleteMessageBatchWithContext(ctx aws.Context, input *DeleteMessageBatchInput, opts ...request.Option) (*DeleteMessageBatchOutput, error)

DeleteMessageBatchWithContext is the same as DeleteMessageBatch with the addition of the ability to pass a context and additional request options.

See DeleteMessageBatch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessage

func (*SQS) DeleteMessageWithContext added in v1.8.0 

func (c *SQS) DeleteMessageWithContext(ctx aws.Context, input *DeleteMessageInput, opts ...request.Option) (*DeleteMessageOutput, error)

DeleteMessageWithContext is the same as DeleteMessage with the addition of the ability to pass a context and additional request options.

See DeleteMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 QueueUrl, even if the queue is empty. If the specified queue doesn't exist, Amazon SQS returns a successful response.

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteQueue

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteQueue

func (*SQS) DeleteQueueWithContext added in v1.8.0 

func (c *SQS) DeleteQueueWithContext(ctx aws.Context, input *DeleteQueueInput, opts ...request.Option) (*DeleteQueueOutput, error)

DeleteQueueWithContext is the same as DeleteQueue with the addition of the ability to pass a context and additional request options.

See DeleteQueue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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.

To determine whether a queue is FIFO (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), you can check whether QueueName ends with the .fifo suffix.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

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:

  • ErrCodeInvalidAttributeName "InvalidAttributeName" The attribute referred to doesn't exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributes

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributes

func (*SQS) GetQueueAttributesWithContext added in v1.8.0 

func (c *SQS) GetQueueAttributesWithContext(ctx aws.Context, input *GetQueueAttributesInput, opts ...request.Option) (*GetQueueAttributesOutput, error)

GetQueueAttributesWithContext is the same as GetQueueAttributes with the addition of the ability to pass a context and additional request options.

See GetQueueAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SQS) GetQueueUrl added in v0.9.5 

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

  • ErrCodeQueueDoesNotExist "AWS.SimpleQueueService.NonExistentQueue" The queue referred to doesn't exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrl

func (*SQS) GetQueueUrlRequest added in v0.9.5 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrl

func (*SQS) GetQueueUrlWithContext added in v1.8.0 

func (c *SQS) GetQueueUrlWithContext(ctx aws.Context, input *GetQueueUrlInput, opts ...request.Option) (*GetQueueUrlOutput, error)

GetQueueUrlWithContext is the same as GetQueueUrl with the addition of the ability to pass a context and additional request options.

See GetQueueUrl for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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/sqs-dead-letter-queues.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 ListDeadLetterSourceQueues for usage and error information.

Returned Error Codes:

  • ErrCodeQueueDoesNotExist "AWS.SimpleQueueService.NonExistentQueue" The queue referred to doesn't exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues

func (*SQS) ListDeadLetterSourceQueuesWithContext added in v1.8.0 

func (c *SQS) ListDeadLetterSourceQueuesWithContext(ctx aws.Context, input *ListDeadLetterSourceQueuesInput, opts ...request.Option) (*ListDeadLetterSourceQueuesOutput, error)

ListDeadLetterSourceQueuesWithContext is the same as ListDeadLetterSourceQueues with the addition of the ability to pass a context and additional request options.

See ListDeadLetterSourceQueues for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues

func (*SQS) ListQueuesWithContext added in v1.8.0 

func (c *SQS) ListQueuesWithContext(ctx aws.Context, input *ListQueuesInput, opts ...request.Option) (*ListQueuesOutput, error)

ListQueuesWithContext is the same as ListQueues with the addition of the ability to pass a context and additional request options.

See ListQueues for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are 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:

  • ErrCodeQueueDoesNotExist "AWS.SimpleQueueService.NonExistentQueue" The queue referred to doesn't exist.

  • ErrCodePurgeQueueInProgress "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).

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueue

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueue

func (*SQS) PurgeQueueWithContext added in v1.8.0 

func (c *SQS) PurgeQueueWithContext(ctx aws.Context, input *PurgeQueueInput, opts ...request.Option) (*PurgeQueueOutput, error)

PurgeQueueWithContext is the same as PurgeQueue with the addition of the ability to pass a context and additional request options.

See PurgeQueue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SQS) ReceiveMessage 

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

ReceiveMessage API operation for Amazon Simple Queue Service.

Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling (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. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.

For each message returned, the response includes the following:

  • The message body.

  • An MD5 digest of the message body. For information about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).

  • The MessageId you received when you sent the message to the queue.

  • The receipt handle.

  • The message attributes.

  • An MD5 digest of the message attributes.

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) in the Amazon SQS Developer Guide.

You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon SQS Developer Guide.

A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead letter queue.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

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:

  • ErrCodeOverLimit "OverLimit" The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessage

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessage

func (*SQS) ReceiveMessageWithContext added in v1.8.0 

func (c *SQS) ReceiveMessageWithContext(ctx aws.Context, input *ReceiveMessageInput, opts ...request.Option) (*ReceiveMessageOutput, error)

ReceiveMessageWithContext is the same as ReceiveMessage with the addition of the ability to pass a context and additional request options.

See ReceiveMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RemovePermission

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RemovePermission

func (*SQS) RemovePermissionWithContext added in v1.8.0 

func (c *SQS) RemovePermissionWithContext(ctx aws.Context, input *RemovePermissionInput, opts ...request.Option) (*RemovePermissionOutput, error)

RemovePermissionWithContext is the same as RemovePermission with the addition of the ability to pass a context and additional request options.

See RemovePermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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.

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).

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:

  • ErrCodeInvalidMessageContents "InvalidMessageContents" The message contains characters outside the allowed set.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessage

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. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

#x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

Any characters not included in this list will be rejected. For more information, see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

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:

  • ErrCodeTooManyEntriesInBatchRequest "AWS.SimpleQueueService.TooManyEntriesInBatchRequest" The batch request contains more entries than permissible.

  • ErrCodeEmptyBatchRequest "AWS.SimpleQueueService.EmptyBatchRequest" The batch request doesn't contain any entries.

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

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

  • ErrCodeInvalidBatchEntryId "AWS.SimpleQueueService.InvalidBatchEntryId" The Id of a batch entry in a batch request doesn't abide by the specification.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatch

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatch

func (*SQS) SendMessageBatchWithContext added in v1.8.0 

func (c *SQS) SendMessageBatchWithContext(ctx aws.Context, input *SendMessageBatchInput, opts ...request.Option) (*SendMessageBatchOutput, error)

SendMessageBatchWithContext is the same as SendMessageBatch with the addition of the ability to pass a context and additional request options.

See SendMessageBatch for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessage

func (*SQS) SendMessageWithContext added in v1.8.0 

func (c *SQS) SendMessageWithContext(ctx aws.Context, input *SendMessageInput, opts ...request.Option) (*SendMessageOutput, error)

SendMessageWithContext is the same as SendMessage with the addition of the ability to pass a context and additional request options.

See SendMessage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

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 Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

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:

  • ErrCodeInvalidAttributeName "InvalidAttributeName" The attribute referred to doesn't exist.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributes

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributes

func (*SQS) SetQueueAttributesWithContext added in v1.8.0 

func (c *SQS) SetQueueAttributesWithContext(ctx aws.Context, input *SetQueueAttributesInput, opts ...request.Option) (*SetQueueAttributesOutput, error)

SetQueueAttributesWithContext is the same as SetQueueAttributes with the addition of the ability to pass a context and additional request options.

See SetQueueAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type SendMessageBatchInput 

type SendMessageBatchInput struct {

	// A list of SendMessageBatchRequestEntry items.
	//
	// Entries is a required field
	Entries []*SendMessageBatchRequestEntry `locationNameList:"SendMessageBatchRequestEntry" type:"list" flattened:"true" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatchRequest

func (SendMessageBatchInput) GoString added in v0.6.5 

func (s SendMessageBatchInput) GoString() string

GoString returns the string representation

func (*SendMessageBatchInput) SetEntries added in v1.5.0 

func (s *SendMessageBatchInput) SetEntries(v []*SendMessageBatchRequestEntry) *SendMessageBatchInput

SetEntries sets the Entries field's value.

func (*SendMessageBatchInput) SetQueueUrl added in v1.5.0 

func (s *SendMessageBatchInput) SetQueueUrl(v string) *SendMessageBatchInput

SetQueueUrl sets the QueueUrl field's value.

func (SendMessageBatchInput) String added in v0.6.5 

func (s SendMessageBatchInput) String() string

String returns the string representation

func (*SendMessageBatchInput) Validate added in v1.1.21 

func (s *SendMessageBatchInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendMessageBatchOutput 

type SendMessageBatchOutput struct {

	// A list of BatchResultErrorEntry items with error details about each message
	// that can't be enqueued.
	//
	// Failed is a required field
	Failed []*BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"`

	// A list of SendMessageBatchResultEntry items.
	//
	// Successful is a required field
	Successful []*SendMessageBatchResultEntry `locationNameList:"SendMessageBatchResultEntry" type:"list" flattened:"true" required:"true"`
	// contains filtered or unexported fields
}

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatchResult

func (SendMessageBatchOutput) GoString added in v0.6.5 

func (s SendMessageBatchOutput) GoString() string

GoString returns the string representation

func (*SendMessageBatchOutput) SetFailed added in v1.5.0 

func (s *SendMessageBatchOutput) SetFailed(v []*BatchResultErrorEntry) *SendMessageBatchOutput

SetFailed sets the Failed field's value.

func (*SendMessageBatchOutput) SetSuccessful added in v1.5.0 

func (s *SendMessageBatchOutput) SetSuccessful(v []*SendMessageBatchResultEntry) *SendMessageBatchOutput

SetSuccessful sets the Successful field's value.

func (SendMessageBatchOutput) String added in v0.6.5 

func (s SendMessageBatchOutput) String() string

String returns the string representation

type SendMessageBatchRequestEntry 

type SendMessageBatchRequestEntry struct {

	// The length of time, in seconds, for which a specific message is delayed.
	// Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
	// value become available for processing after the delay period is finished.
	// If you don't specify a value, the default value for the queue is applied.
	//
	// When you set FifoQueue, you can't set DelaySeconds per message. You can set
	// this parameter only on a queue level.
	DelaySeconds *int64 `type:"integer"`

	// An identifier for a message in this batch used to communicate the result.
	//
	// The Ids of a batch request need to be unique within a request
	//
	// 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 and Validation (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation)
	// in the Amazon SQS Developer Guide.
	MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// The body of the message.
	//
	// MessageBody is a required field
	MessageBody *string `type:"string" required:"true"`

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The token used for deduplication of messages within a 5-minute minimum deduplication
	// interval. If a message with a particular MessageDeduplicationId is sent successfully,
	// subsequent messages with the same MessageDeduplicationId are accepted successfully
	// but aren't delivered. For more information, see  Exactly-Once Processing
	// (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
	// in the Amazon SQS Developer Guide.
	//
	//    * Every message must have a unique MessageDeduplicationId,
	//
	// You may provide a MessageDeduplicationId explicitly.
	//
	// If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication
	//    for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId
	//    using the body of the message (but not the attributes of the message).
	//
	//
	// If you don't provide a MessageDeduplicationId and the queue doesn't have
	//    ContentBasedDeduplication set, the action fails with an error.
	//
	// If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
	//    overrides the generated one.
	//
	//    * When ContentBasedDeduplication is in effect, messages with identical
	//    content sent within the deduplication interval are treated as duplicates
	//    and only one copy of the message is delivered.
	//
	//    * If you send one message with ContentBasedDeduplication enabled and then
	//    another message with a MessageDeduplicationId that is the same as the
	//    one generated for the first MessageDeduplicationId, the two messages are
	//    treated as duplicates and only one copy of the message is delivered.
	//
	// The MessageDeduplicationId is available to the recipient of the message (this
	// can be useful for troubleshooting delivery issues).
	//
	// If a message is sent successfully but the acknowledgement is lost and the
	// message is resent with the same MessageDeduplicationId after the deduplication
	// interval, Amazon SQS can't detect duplicate messages.
	//
	// The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId
	// can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
	//
	// For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId
	// Property (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagededuplicationid-property)
	// in the Amazon Simple Queue Service Developer Guide.
	MessageDeduplicationId *string `type:"string"`

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The tag that specifies that a message belongs to a specific message group.
	// Messages that belong to the same message group are processed in a FIFO manner
	// (however, messages in different message groups might be processed out of
	// order). To interleave multiple ordered streams within a single queue, use
	// MessageGroupId values (for example, session data for multiple users). In
	// this scenario, multiple readers can process the queue, but the session data
	// of each user is processed in a FIFO fashion.
	//
	//    * You must associate a non-empty MessageGroupId with a message. If you
	//    don't provide a MessageGroupId, the action fails.
	//
	//    * ReceiveMessage might return messages with multiple MessageGroupId values.
	//    For each MessageGroupId, the messages are sorted by time sent. The caller
	//    can't specify a MessageGroupId.
	//
	// The length of MessageGroupId is 128 characters. Valid values are alphanumeric
	// characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
	//
	// For best practices of using MessageGroupId, see Using the MessageGroupId
	// Property (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property)
	// in the Amazon Simple Queue Service Developer Guide.
	//
	// MessageGroupId is required for FIFO queues. You can't use it for Standard
	// queues.
	MessageGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the details of a single Amazon SQS message along with an Id. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatchRequestEntry

func (SendMessageBatchRequestEntry) GoString added in v0.6.5 

func (s SendMessageBatchRequestEntry) GoString() string

GoString returns the string representation

func (*SendMessageBatchRequestEntry) SetDelaySeconds added in v1.5.0 

func (s *SendMessageBatchRequestEntry) SetDelaySeconds(v int64) *SendMessageBatchRequestEntry

SetDelaySeconds sets the DelaySeconds field's value.

func (*SendMessageBatchRequestEntry) SetId added in v1.5.0 

func (s *SendMessageBatchRequestEntry) SetId(v string) *SendMessageBatchRequestEntry

SetId sets the Id field's value.

func (*SendMessageBatchRequestEntry) SetMessageAttributes added in v1.5.0 

func (s *SendMessageBatchRequestEntry) SetMessageAttributes(v map[string]*MessageAttributeValue) *SendMessageBatchRequestEntry

SetMessageAttributes sets the MessageAttributes field's value.

func (*SendMessageBatchRequestEntry) SetMessageBody added in v1.5.0 

func (s *SendMessageBatchRequestEntry) SetMessageBody(v string) *SendMessageBatchRequestEntry

SetMessageBody sets the MessageBody field's value.

func (*SendMessageBatchRequestEntry) SetMessageDeduplicationId added in v1.5.7 

func (s *SendMessageBatchRequestEntry) SetMessageDeduplicationId(v string) *SendMessageBatchRequestEntry

SetMessageDeduplicationId sets the MessageDeduplicationId field's value.

func (*SendMessageBatchRequestEntry) SetMessageGroupId added in v1.5.7 

func (s *SendMessageBatchRequestEntry) SetMessageGroupId(v string) *SendMessageBatchRequestEntry

SetMessageGroupId sets the MessageGroupId field's value.

func (SendMessageBatchRequestEntry) String added in v0.6.5 

func (s SendMessageBatchRequestEntry) String() string

String returns the string representation

func (*SendMessageBatchRequestEntry) Validate added in v1.1.21 

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. You can use
	// this attribute to verify that Amazon SQS received the message correctly.
	// Amazon SQS URL-decodes the message before creating the MD5 digest. For information
	// about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).
	MD5OfMessageAttributes *string `type:"string"`

	// An MD5 digest of the non-URL-encoded message attribute string. You can use
	// this attribute to verify that Amazon SQS received the message correctly.
	// Amazon SQS URL-decodes the message before creating the MD5 digest. For information
	// about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).
	//
	// MD5OfMessageBody is a required field
	MD5OfMessageBody *string `type:"string" required:"true"`

	// An identifier for the message.
	//
	// MessageId is a required field
	MessageId *string `type:"string" required:"true"`

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The large, non-consecutive number that Amazon SQS assigns to each message.
	//
	// The length of SequenceNumber is 128 bits. As SequenceNumber continues to
	// increase for a particular MessageGroupId.
	SequenceNumber *string `type:"string"`
	// contains filtered or unexported fields
}

Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatchResultEntry

func (SendMessageBatchResultEntry) GoString added in v0.6.5 

func (s SendMessageBatchResultEntry) GoString() string

GoString returns the string representation

func (*SendMessageBatchResultEntry) SetId added in v1.5.0 

func (s *SendMessageBatchResultEntry) SetId(v string) *SendMessageBatchResultEntry

SetId sets the Id field's value.

func (*SendMessageBatchResultEntry) SetMD5OfMessageAttributes added in v1.5.0 

func (s *SendMessageBatchResultEntry) SetMD5OfMessageAttributes(v string) *SendMessageBatchResultEntry

SetMD5OfMessageAttributes sets the MD5OfMessageAttributes field's value.

func (*SendMessageBatchResultEntry) SetMD5OfMessageBody added in v1.5.0 

func (s *SendMessageBatchResultEntry) SetMD5OfMessageBody(v string) *SendMessageBatchResultEntry

SetMD5OfMessageBody sets the MD5OfMessageBody field's value.

func (*SendMessageBatchResultEntry) SetMessageId added in v1.5.0 

func (s *SendMessageBatchResultEntry) SetMessageId(v string) *SendMessageBatchResultEntry

SetMessageId sets the MessageId field's value.

func (*SendMessageBatchResultEntry) SetSequenceNumber added in v1.5.7 

func (s *SendMessageBatchResultEntry) SetSequenceNumber(v string) *SendMessageBatchResultEntry

SetSequenceNumber sets the SequenceNumber field's value.

func (SendMessageBatchResultEntry) String added in v0.6.5 

func (s SendMessageBatchResultEntry) String() string

String returns the string representation

type SendMessageInput 

type SendMessageInput struct {

	// The length of time, in seconds, for which to delay a specific message. Valid
	// values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
	// value become available for processing after the delay period is finished.
	// If you don't specify a value, the default value for the queue applies.
	//
	// When you set FifoQueue, you can't set DelaySeconds per message. You can set
	// this parameter only on a queue level.
	DelaySeconds *int64 `type:"integer"`

	// Each message attribute consists of a Name, Type, and Value. For more information,
	// see Message Attribute Items and Validation (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation)
	// in the Amazon SQS Developer Guide.
	MessageAttributes map[string]*MessageAttributeValue `locationName:"MessageAttribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true"`

	// The message to send. The maximum string size is 256 KB.
	//
	// A message can include only XML, JSON, and unformatted text. The following
	// Unicode characters are allowed:
	//
	// #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF
	//
	// Any characters not included in this list will be rejected. For more information,
	// see the W3C specification for characters (http://www.w3.org/TR/REC-xml/#charsets).
	//
	// MessageBody is a required field
	MessageBody *string `type:"string" required:"true"`

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The token used for deduplication of sent messages. If a message with a particular
	// MessageDeduplicationId is sent successfully, any messages sent with the same
	// MessageDeduplicationId are accepted successfully but aren't delivered during
	// the 5-minute deduplication interval. For more information, see  Exactly-Once
	// Processing (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
	// in the Amazon SQS Developer Guide.
	//
	//    * Every message must have a unique MessageDeduplicationId,
	//
	// You may provide a MessageDeduplicationId explicitly.
	//
	// If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication
	//    for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId
	//    using the body of the message (but not the attributes of the message).
	//
	//
	// If you don't provide a MessageDeduplicationId and the queue doesn't have
	//    ContentBasedDeduplication set, the action fails with an error.
	//
	// If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
	//    overrides the generated one.
	//
	//    * When ContentBasedDeduplication is in effect, messages with identical
	//    content sent within the deduplication interval are treated as duplicates
	//    and only one copy of the message is delivered.
	//
	//    * If you send one message with ContentBasedDeduplication enabled and then
	//    another message with a MessageDeduplicationId that is the same as the
	//    one generated for the first MessageDeduplicationId, the two messages are
	//    treated as duplicates and only one copy of the message is delivered.
	//
	// The MessageDeduplicationId is available to the recipient of the message (this
	// can be useful for troubleshooting delivery issues).
	//
	// If a message is sent successfully but the acknowledgement is lost and the
	// message is resent with the same MessageDeduplicationId after the deduplication
	// interval, Amazon SQS can't detect duplicate messages.
	//
	// The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId
	// can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
	//
	// For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId
	// Property (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagededuplicationid-property)
	// in the Amazon Simple Queue Service Developer Guide.
	MessageDeduplicationId *string `type:"string"`

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The tag that specifies that a message belongs to a specific message group.
	// Messages that belong to the same message group are processed in a FIFO manner
	// (however, messages in different message groups might be processed out of
	// order). To interleave multiple ordered streams within a single queue, use
	// MessageGroupId values (for example, session data for multiple users). In
	// this scenario, multiple readers can process the queue, but the session data
	// of each user is processed in a FIFO fashion.
	//
	//    * You must associate a non-empty MessageGroupId with a message. If you
	//    don't provide a MessageGroupId, the action fails.
	//
	//    * ReceiveMessage might return messages with multiple MessageGroupId values.
	//    For each MessageGroupId, the messages are sorted by time sent. The caller
	//    can't specify a MessageGroupId.
	//
	// The length of MessageGroupId is 128 characters. Valid values are alphanumeric
	// characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).
	//
	// For best practices of using MessageGroupId, see Using the MessageGroupId
	// Property (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property)
	// in the Amazon Simple Queue Service Developer Guide.
	//
	// MessageGroupId is required for FIFO queues. You can't use it for Standard
	// queues.
	MessageGroupId *string `type:"string"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageRequest

func (SendMessageInput) GoString added in v0.6.5 

func (s SendMessageInput) GoString() string

GoString returns the string representation

func (*SendMessageInput) SetDelaySeconds added in v1.5.0 

func (s *SendMessageInput) SetDelaySeconds(v int64) *SendMessageInput

SetDelaySeconds sets the DelaySeconds field's value.

func (*SendMessageInput) SetMessageAttributes added in v1.5.0 

func (s *SendMessageInput) SetMessageAttributes(v map[string]*MessageAttributeValue) *SendMessageInput

SetMessageAttributes sets the MessageAttributes field's value.

func (*SendMessageInput) SetMessageBody added in v1.5.0 

func (s *SendMessageInput) SetMessageBody(v string) *SendMessageInput

SetMessageBody sets the MessageBody field's value.

func (*SendMessageInput) SetMessageDeduplicationId added in v1.5.7 

func (s *SendMessageInput) SetMessageDeduplicationId(v string) *SendMessageInput

SetMessageDeduplicationId sets the MessageDeduplicationId field's value.

func (*SendMessageInput) SetMessageGroupId added in v1.5.7 

func (s *SendMessageInput) SetMessageGroupId(v string) *SendMessageInput

SetMessageGroupId sets the MessageGroupId field's value.

func (*SendMessageInput) SetQueueUrl added in v1.5.0 

func (s *SendMessageInput) SetQueueUrl(v string) *SendMessageInput

SetQueueUrl sets the QueueUrl field's value.

func (SendMessageInput) String added in v0.6.5 

func (s SendMessageInput) String() string

String returns the string representation

func (*SendMessageInput) Validate added in v1.1.21 

func (s *SendMessageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SendMessageOutput 

type SendMessageOutput struct {

	// An MD5 digest of the non-URL-encoded message attribute string. You can use
	// this attribute to verify that Amazon SQS received the message correctly.
	// Amazon SQS URL-decodes the message before creating the MD5 digest. For information
	// about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).
	MD5OfMessageAttributes *string `type:"string"`

	// An MD5 digest of the non-URL-encoded message attribute string. You can use
	// this attribute to verify that Amazon SQS received the message correctly.
	// Amazon SQS URL-decodes the message before creating the MD5 digest. For information
	// about MD5, see RFC1321 (https://www.ietf.org/rfc/rfc1321.txt).
	MD5OfMessageBody *string `type:"string"`

	// An attribute containing the MessageId of the message sent to the queue. For
	// more information, see Queue and Message Identifiers (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html)
	// in the Amazon SQS Developer Guide.
	MessageId *string `type:"string"`

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The large, non-consecutive number that Amazon SQS assigns to each message.
	//
	// The length of SequenceNumber is 128 bits. SequenceNumber continues to increase
	// for a particular MessageGroupId.
	SequenceNumber *string `type:"string"`
	// contains filtered or unexported fields
}

The MD5OfMessageBody and MessageId elements. Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageResult

func (SendMessageOutput) GoString added in v0.6.5 

func (s SendMessageOutput) GoString() string

GoString returns the string representation

func (*SendMessageOutput) SetMD5OfMessageAttributes added in v1.5.0 

func (s *SendMessageOutput) SetMD5OfMessageAttributes(v string) *SendMessageOutput

SetMD5OfMessageAttributes sets the MD5OfMessageAttributes field's value.

func (*SendMessageOutput) SetMD5OfMessageBody added in v1.5.0 

func (s *SendMessageOutput) SetMD5OfMessageBody(v string) *SendMessageOutput

SetMD5OfMessageBody sets the MD5OfMessageBody field's value.

func (*SendMessageOutput) SetMessageId added in v1.5.0 

func (s *SendMessageOutput) SetMessageId(v string) *SendMessageOutput

SetMessageId sets the MessageId field's value.

func (*SendMessageOutput) SetSequenceNumber added in v1.5.7 

func (s *SendMessageOutput) SetSequenceNumber(v string) *SendMessageOutput

SetSequenceNumber sets the SequenceNumber field's value.

func (SendMessageOutput) String added in v0.6.5 

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 that the SetQueueAttributes action uses:
	//
	//    * DelaySeconds - The length of time, in seconds, for which the delivery
	//    of all messages in the queue is delayed. Valid values: An integer from
	//    0 to 900 (15 minutes). The default is 0 (zero).
	//
	//    * MaximumMessageSize - The limit of how many bytes a message can contain
	//    before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
	//    (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).
	//
	//
	//    * MessageRetentionPeriod - The length of time, in seconds, for which Amazon
	//    SQS retains a message. Valid values: An integer representing seconds,
	//    from 60 (1 minute) to 1,209,600 (14 days). The default is 345,600 (4 days).
	//
	//
	//    * Policy - The queue's policy. A valid AWS policy. For more information
	//    about policy structure, see Overview of AWS IAM Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html)
	//    in the Amazon IAM User Guide.
	//
	//    * ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for
	//    which a ReceiveMessage action waits for a message to arrive. Valid values:
	//    an integer from 0 to 20 (seconds). The default is 0.
	//
	//    * RedrivePolicy - The parameters for the dead letter queue functionality
	//    of the source queue. For more information about the redrive policy and
	//    dead letter queues, see Using Amazon SQS Dead Letter Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
	//    in the Amazon SQS Developer Guide.
	//
	// The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly,
	//    the dead letter queue of a standard queue must also be a standard queue.
	//
	//    * VisibilityTimeout - The visibility timeout for the queue. Valid values:
	//    an integer from 0 to 43,200 (12 hours). The default is 30. For more information
	//    about the visibility timeout, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
	//    in the Amazon SQS Developer Guide.
	//
	// The following attributes apply only to server-side-encryption (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
	//
	//    * KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK)
	//    for Amazon SQS or a custom CMK. For more information, see Key Terms (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
	//    While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs,
	//    the alias of a custom CMK can, for example, be alias/aws/sqs. For more
	//    examples, see KeyId (http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
	//    in the AWS Key Management Service API Reference.
	//
	//    * KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which
	//    Amazon SQS can reuse a data key (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)
	//    to encrypt or decrypt messages before calling AWS KMS again. An integer
	//    representing seconds, between 60 seconds (1 minute) and 86,400 seconds
	//    (24 hours). The default is 300 (5 minutes). A shorter time period provides
	//    better security but results in more calls to KMS which incur charges after
	//    Free Tier. For more information, see How Does the Data Key Reuse Period
	//    Work? (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work).
	//
	//
	// The following attribute applies only to FIFO (first-in-first-out) queues
	// (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):
	//
	//    * ContentBasedDeduplication - Enables content-based deduplication. For
	//    more information, see Exactly-Once Processing (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
	//    in the Amazon SQS Developer Guide.
	//
	// Every message must have a unique MessageDeduplicationId,
	//
	// You may provide a MessageDeduplicationId explicitly.
	//
	// If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication
	//    for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId
	//    using the body of the message (but not the attributes of the message).
	//
	//
	// If you don't provide a MessageDeduplicationId and the queue doesn't have
	//    ContentBasedDeduplication set, the action fails with an error.
	//
	// If the queue has ContentBasedDeduplication set, your MessageDeduplicationId
	//    overrides the generated one.
	//
	// When ContentBasedDeduplication is in effect, messages with identical content
	//    sent within the deduplication interval are treated as duplicates and only
	//    one copy of the message is delivered.
	//
	// If you send one message with ContentBasedDeduplication enabled and then another
	//    message with a MessageDeduplicationId that is the same as the one generated
	//    for the first MessageDeduplicationId, the two messages are treated as
	//    duplicates and only one copy of the message is delivered.
	//
	// Any other valid special request parameters (such as the following) are ignored:
	//
	//    * ApproximateNumberOfMessages
	//
	//    * ApproximateNumberOfMessagesDelayed
	//
	//    * ApproximateNumberOfMessagesNotVisible
	//
	//    * CreatedTimestamp
	//
	//    * LastModifiedTimestamp
	//
	//    * QueueArn
	//
	// Attributes is a required field
	Attributes map[string]*string `locationName:"Attribute" locationNameKey:"Name" locationNameValue:"Value" type:"map" flattened:"true" required:"true"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest

func (SetQueueAttributesInput) GoString added in v0.6.5 

func (s SetQueueAttributesInput) GoString() string

GoString returns the string representation

func (*SetQueueAttributesInput) SetAttributes added in v1.5.0 

func (s *SetQueueAttributesInput) SetAttributes(v map[string]*string) *SetQueueAttributesInput

SetAttributes sets the Attributes field's value.

func (*SetQueueAttributesInput) SetQueueUrl added in v1.5.0 

func (s *SetQueueAttributesInput) SetQueueUrl(v string) *SetQueueAttributesInput

SetQueueUrl sets the QueueUrl field's value.

func (SetQueueAttributesInput) String added in v0.6.5 

func (s SetQueueAttributesInput) String() string

String returns the string representation

func (*SetQueueAttributesInput) Validate added in v1.1.21 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesOutput

func (SetQueueAttributesOutput) GoString added in v0.6.5 

func (s SetQueueAttributesOutput) GoString() string

GoString returns the string representation

func (SetQueueAttributesOutput) String added in v0.6.5 

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.