Hierarchy

Properties

attributeNames?: string[]

A list of attributes that need to be returned along with each message.

maxNumberOfMessages?: number

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

queueUrl: undefined | string

The URL of the queue.

visibilityTimeout?: number

Visibility timeout, specified in seconds. Valid values: An integer from 0 to 43,200 (12 hours).

waitTimeSeconds?: number

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.