AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ReceiveMessageInput

import "github.com/aws/aws-sdk-go/service/sqs"

type ReceiveMessageInput struct { AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true"` MaxNumberOfMessages *int64 `type:"integer"` MessageAttributeNames []*string `locationNameList:"MessageAttributeName" type:"list" flattened:"true"` QueueUrl *string `type:"string" required:"true"` ReceiveRequestAttemptId *string `type:"string"` VisibilityTimeout *int64 `type:"integer"` WaitTimeSeconds *int64 `type:"integer"` }

AttributeNames

Type: []*string

A list of s that need to be returned along with each message. These attributes include:

  • All - Returns all values.

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

  • MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.

  • MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

  • SequenceNumber - Returns the value provided by Amazon SQS.

MaxNumberOfMessages

Type: *int64

The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

MessageAttributeNames

Type: []*string

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

QueueUrl

Type: *string

The URL of the Amazon SQS queue from which messages are received.

Queue URLs and names are case-sensitive.

QueueUrl is a required field

ReceiveRequestAttemptId

Type: *string

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

If a caller of the ReceiveMessage action still processes messages when the

visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

To mitigate this effect, ensure that your application observes a safe threshold

before the visibility timeout expires and extend the visibility timeout as necessary.
  • While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.

  • If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~).

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html) in the Amazon Simple Queue Service Developer Guide.

VisibilityTimeout

Type: *int64

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

WaitTimeSeconds

Type: *int64

The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

Method

GoString

func (s ReceiveMessageInput) GoString() string

GoString returns the string representation

SetAttributeNames

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

SetAttributeNames sets the AttributeNames field's value.

SetMaxNumberOfMessages

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

SetMaxNumberOfMessages sets the MaxNumberOfMessages field's value.

SetMessageAttributeNames

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

SetMessageAttributeNames sets the MessageAttributeNames field's value.

SetQueueUrl

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

SetQueueUrl sets the QueueUrl field's value.

SetReceiveRequestAttemptId

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

SetReceiveRequestAttemptId sets the ReceiveRequestAttemptId field's value.

SetVisibilityTimeout

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

SetVisibilityTimeout sets the VisibilityTimeout field's value.

SetWaitTimeSeconds

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

SetWaitTimeSeconds sets the WaitTimeSeconds field's value.

String

func (s ReceiveMessageInput) String() string

String returns the string representation

Validate

func (s *ReceiveMessageInput) Validate() error

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

On this page: