Skip to content

Receive message

async_boto.validation.sqs.receive_message

ReceiveMessageRequest

Bases: BaseModel

The request accepts the following data in JSON format.

ATTRIBUTE DESCRIPTION
AttributeNames

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

TYPE: Optional[List[str]]

MaxNumberOfMessages

The maximum number of messages to return.

TYPE: Optional[int]

MessageAttributeNames

The name of the message attribute.

TYPE: Optional[List[str]]

MessageSystemAttributeNames

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

TYPE: Optional[List[str]]

QueueUrl

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

TYPE: str

ReceiveRequestAttemptId

The token used for deduplication of ReceiveMessage calls.

TYPE: Optional[str]

VisibilityTimeout

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests.

TYPE: Optional[int]

WaitTimeSeconds

The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.

TYPE: Optional[int]

AttributeNames class-attribute instance-attribute

AttributeNames = None

MaxNumberOfMessages class-attribute instance-attribute

MaxNumberOfMessages = None

MessageAttributeNames class-attribute instance-attribute

MessageAttributeNames = None

MessageSystemAttributeNames class-attribute instance-attribute

MessageSystemAttributeNames = None

QueueUrl instance-attribute

QueueUrl

ReceiveRequestAttemptId class-attribute instance-attribute

ReceiveRequestAttemptId = None

VisibilityTimeout class-attribute instance-attribute

VisibilityTimeout = None

WaitTimeSeconds class-attribute instance-attribute

WaitTimeSeconds = None

ReceiveMessageResponse

Bases: BaseModel

The response returned in JSON format by the service.

ATTRIBUTE DESCRIPTION
Messages

A list of messages received from the queue.

TYPE: List[Message]

Messages instance-attribute

Messages