Skip to content

Sqs Classes

AddPermissionRequest

QueueUrl

  • Type:
  • Required: Yes

Label

  • Type:
  • Required: Yes

AWSAccountIds

  • Type: typing.List[str]
  • Required: Yes

Actions

  • Type: typing.List[str]
  • Required: Yes

AddPermissionRequestQueueAddPermission

Label

  • Type:
  • Required: Yes

AWSAccountIds

  • Type: typing.List[str]
  • Required: Yes

Actions

  • Type: typing.List[str]
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchResultErrorEntry

Id

  • Type:
  • Required: Yes

SenderFault

  • Type:
  • Required: Yes

Code

  • Type:
  • Required: Yes

Message

  • Type: typing.Optional[str]

CancelMessageMoveTaskRequest

TaskHandle

  • Type:
  • Required: Yes

CancelMessageMoveTaskResult

ApproximateNumberOfMessagesMoved

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ChangeMessageVisibilityBatchRequest

QueueUrl

  • Type:
  • Required: Yes

Entries

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.ChangeMessageVisibilityBatchRequestEntry]
  • Required: Yes

ChangeMessageVisibilityBatchRequestEntry

Id

  • Type:
  • Required: Yes

ReceiptHandle

  • Type:
  • Required: Yes

VisibilityTimeout

  • Type: typing.Optional[int]

ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatch

Entries

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.ChangeMessageVisibilityBatchRequestEntry]
  • Required: Yes

ChangeMessageVisibilityBatchResult

Successful

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.ChangeMessageVisibilityBatchResultEntry]
  • Required: Yes

Failed

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.BatchResultErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ChangeMessageVisibilityBatchResultEntry

Id

  • Type:
  • Required: Yes

ChangeMessageVisibilityRequest

QueueUrl

  • Type:
  • Required: Yes

ReceiptHandle

  • Type:
  • Required: Yes

VisibilityTimeout

  • Type:
  • Required: Yes

ChangeMessageVisibilityRequestMessageChangeVisibility

VisibilityTimeout

  • Type:
  • Required: Yes

CreateQueueRequest

QueueName

  • Type:
  • Required: Yes

Attributes

  • Type: typing.Optional[typing.Dict[typing.Literal['All', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SqsManagedSseEnabled', 'VisibilityTimeout'], str]]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateQueueRequestServiceResourceCreateQueue

QueueName

  • Type:
  • Required: Yes

Attributes

  • Type: typing.Optional[typing.Dict[typing.Literal['All', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SqsManagedSseEnabled', 'VisibilityTimeout'], str]]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateQueueResult

QueueUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteMessageBatchRequest

QueueUrl

  • Type:
  • Required: Yes

Entries

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.DeleteMessageBatchRequestEntry]
  • Required: Yes

DeleteMessageBatchRequestEntry

Id

  • Type:
  • Required: Yes

ReceiptHandle

  • Type:
  • Required: Yes

DeleteMessageBatchRequestQueueDeleteMessages

Entries

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.DeleteMessageBatchRequestEntry]
  • Required: Yes

DeleteMessageBatchResult

Successful

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.DeleteMessageBatchResultEntry]
  • Required: Yes

Failed

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.BatchResultErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteMessageBatchResultEntry

Id

  • Type:
  • Required: Yes

DeleteMessageRequest

QueueUrl

  • Type:
  • Required: Yes

ReceiptHandle

  • Type:
  • Required: Yes

DeleteQueueRequest

QueueUrl

  • Type:
  • Required: Yes

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

GetQueueAttributesRequest

QueueUrl

  • Type:
  • Required: Yes

AttributeNames

  • Type: typing.Optional[typing.List[typing.Literal['AWSTraceHeader', 'All', 'ApproximateFirstReceiveTimestamp', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ApproximateReceiveCount', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageDeduplicationId', 'MessageGroupId', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SenderId', 'SentTimestamp', 'SequenceNumber', 'SqsManagedSseEnabled', 'VisibilityTimeout']]]

GetQueueAttributesResult

Attributes

  • Type: typing.Dict[typing.Literal['All', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SqsManagedSseEnabled', 'VisibilityTimeout'], str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetQueueUrlRequest

QueueName

  • Type:
  • Required: Yes

QueueOwnerAWSAccountId

  • Type: typing.Optional[str]

GetQueueUrlRequestServiceResourceGetQueueByName

QueueName

  • Type:
  • Required: Yes

QueueOwnerAWSAccountId

  • Type: typing.Optional[str]

GetQueueUrlResult

QueueUrl

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListDeadLetterSourceQueuesRequest

QueueUrl

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListDeadLetterSourceQueuesRequestPaginate

QueueUrl

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.sqs.sqs_classes.PaginatorConfig]

ListDeadLetterSourceQueuesResult

queueUrls

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListMessageMoveTasksRequest

SourceArn

  • Type:
  • Required: Yes

MaxResults

  • Type: typing.Optional[int]

ListMessageMoveTasksResult

Results

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.ListMessageMoveTasksResultEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListMessageMoveTasksResultEntry

TaskHandle

  • Type: typing.Optional[str]

Status

  • Type: typing.Optional[str]

SourceArn

  • Type: typing.Optional[str]

DestinationArn

  • Type: typing.Optional[str]

MaxNumberOfMessagesPerSecond

  • Type: typing.Optional[int]

ApproximateNumberOfMessagesMoved

  • Type: typing.Optional[int]

ApproximateNumberOfMessagesToMove

  • Type: typing.Optional[int]

FailureReason

  • Type: typing.Optional[str]

StartedTimestamp

  • Type: typing.Optional[int]

ListQueueTagsRequest

QueueUrl

  • Type:
  • Required: Yes

ListQueueTagsResult

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListQueuesRequest

QueueNamePrefix

  • Type: typing.Optional[str]

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListQueuesRequestPaginate

QueueNamePrefix

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.sqs.sqs_classes.PaginatorConfig]

ListQueuesResult

QueueUrls

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

Message

MessageId

  • Type: typing.Optional[str]

ReceiptHandle

  • Type: typing.Optional[str]

MD5OfBody

  • Type: typing.Optional[str]

Body

  • Type: typing.Optional[str]

Attributes

  • Type: typing.Optional[typing.Dict[typing.Literal['AWSTraceHeader', 'All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount', 'DeadLetterQueueSourceArn', 'MessageDeduplicationId', 'MessageGroupId', 'SenderId', 'SentTimestamp', 'SequenceNumber'], str]]

MD5OfMessageAttributes

  • Type: typing.Optional[str]

MessageAttributes

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageAttributeValueOutput]]

MessageAttributeValue

DataType

  • Type:
  • Required: Yes

StringValue

  • Type: typing.Optional[str]

BinaryValue

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

StringListValues

  • Type: typing.Optional[typing.List[str]]

BinaryListValues

  • Type: typing.Optional[typing.List[typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]]]

MessageAttributeValueOutput

DataType

  • Type:
  • Required: Yes

StringValue

  • Type: typing.Optional[str]

BinaryValue

  • Type: typing.Optional[bytes]

StringListValues

  • Type: typing.Optional[typing.List[str]]

BinaryListValues

  • Type: typing.Optional[typing.List[bytes]]

MessageSystemAttributeValue

DataType

  • Type:
  • Required: Yes

StringValue

  • Type: typing.Optional[str]

BinaryValue

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody, NoneType]

StringListValues

  • Type: typing.Optional[typing.List[str]]

BinaryListValues

  • Type: typing.Optional[typing.List[typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]]]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PurgeQueueRequest

QueueUrl

  • Type:
  • Required: Yes

ReceiveMessageRequest

QueueUrl

  • Type:
  • Required: Yes

AttributeNames

  • Type: typing.Optional[typing.List[typing.Literal['AWSTraceHeader', 'All', 'ApproximateFirstReceiveTimestamp', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ApproximateReceiveCount', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageDeduplicationId', 'MessageGroupId', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SenderId', 'SentTimestamp', 'SequenceNumber', 'SqsManagedSseEnabled', 'VisibilityTimeout']]]

MessageSystemAttributeNames

  • Type: typing.Optional[typing.List[typing.Literal['AWSTraceHeader', 'All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount', 'DeadLetterQueueSourceArn', 'MessageDeduplicationId', 'MessageGroupId', 'SenderId', 'SentTimestamp', 'SequenceNumber']]]

MessageAttributeNames

  • Type: typing.Optional[typing.List[str]]

MaxNumberOfMessages

  • Type: typing.Optional[int]

VisibilityTimeout

  • Type: typing.Optional[int]

WaitTimeSeconds

  • Type: typing.Optional[int]

ReceiveRequestAttemptId

  • Type: typing.Optional[str]

ReceiveMessageRequestQueueReceiveMessages

AttributeNames

  • Type: typing.Optional[typing.List[typing.Literal['AWSTraceHeader', 'All', 'ApproximateFirstReceiveTimestamp', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ApproximateReceiveCount', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageDeduplicationId', 'MessageGroupId', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SenderId', 'SentTimestamp', 'SequenceNumber', 'SqsManagedSseEnabled', 'VisibilityTimeout']]]

MessageSystemAttributeNames

  • Type: typing.Optional[typing.List[typing.Literal['AWSTraceHeader', 'All', 'ApproximateFirstReceiveTimestamp', 'ApproximateReceiveCount', 'DeadLetterQueueSourceArn', 'MessageDeduplicationId', 'MessageGroupId', 'SenderId', 'SentTimestamp', 'SequenceNumber']]]

MessageAttributeNames

  • Type: typing.Optional[typing.List[str]]

MaxNumberOfMessages

  • Type: typing.Optional[int]

VisibilityTimeout

  • Type: typing.Optional[int]

WaitTimeSeconds

  • Type: typing.Optional[int]

ReceiveRequestAttemptId

  • Type: typing.Optional[str]

ReceiveMessageResult

Messages

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.Message]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RemovePermissionRequest

QueueUrl

  • Type:
  • Required: Yes

Label

  • Type:
  • Required: Yes

RemovePermissionRequestQueueRemovePermission

Label

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

SendMessageBatchRequest

QueueUrl

  • Type:
  • Required: Yes

Entries

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.SendMessageBatchRequestEntry]
  • Required: Yes

SendMessageBatchRequestEntry

Id

  • Type:
  • Required: Yes

MessageBody

  • Type:
  • Required: Yes

DelaySeconds

  • Type: typing.Optional[int]

MessageAttributes

  • Type: typing.Optional[typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageAttributeValue, aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageAttributeValueOutput]]]

MessageSystemAttributes

  • Type: typing.Optional[typing.Dict[typing.Literal['AWSTraceHeader'], aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageSystemAttributeValue]]

MessageDeduplicationId

  • Type: typing.Optional[str]

MessageGroupId

  • Type: typing.Optional[str]

SendMessageBatchRequestQueueSendMessages

Entries

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.SendMessageBatchRequestEntry]
  • Required: Yes

SendMessageBatchResult

Successful

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.SendMessageBatchResultEntry]
  • Required: Yes

Failed

  • Type: typing.List[aws_resource_validator.pydantic_models.sqs.sqs_classes.BatchResultErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SendMessageBatchResultEntry

Id

  • Type:
  • Required: Yes

MessageId

  • Type:
  • Required: Yes

MD5OfMessageBody

  • Type:
  • Required: Yes

MD5OfMessageAttributes

  • Type: typing.Optional[str]

MD5OfMessageSystemAttributes

  • Type: typing.Optional[str]

SequenceNumber

  • Type: typing.Optional[str]

SendMessageRequest

QueueUrl

  • Type:
  • Required: Yes

MessageBody

  • Type:
  • Required: Yes

DelaySeconds

  • Type: typing.Optional[int]

MessageAttributes

  • Type: typing.Optional[typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageAttributeValue, aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageAttributeValueOutput]]]

MessageSystemAttributes

  • Type: typing.Optional[typing.Dict[typing.Literal['AWSTraceHeader'], aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageSystemAttributeValue]]

MessageDeduplicationId

  • Type: typing.Optional[str]

MessageGroupId

  • Type: typing.Optional[str]

SendMessageRequestQueueSendMessage

MessageBody

  • Type:
  • Required: Yes

DelaySeconds

  • Type: typing.Optional[int]

MessageAttributes

  • Type: typing.Optional[typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageAttributeValue, aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageAttributeValueOutput]]]

MessageSystemAttributes

  • Type: typing.Optional[typing.Dict[typing.Literal['AWSTraceHeader'], aws_resource_validator.pydantic_models.sqs.sqs_classes.MessageSystemAttributeValue]]

MessageDeduplicationId

  • Type: typing.Optional[str]

MessageGroupId

  • Type: typing.Optional[str]

SendMessageResult

MD5OfMessageBody

  • Type:
  • Required: Yes

MD5OfMessageAttributes

  • Type:
  • Required: Yes

MD5OfMessageSystemAttributes

  • Type:
  • Required: Yes

MessageId

  • Type:
  • Required: Yes

SequenceNumber

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

SetQueueAttributesRequest

QueueUrl

  • Type:
  • Required: Yes

Attributes

  • Type: typing.Dict[typing.Literal['All', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SqsManagedSseEnabled', 'VisibilityTimeout'], str]
  • Required: Yes

SetQueueAttributesRequestQueueSetAttributes

Attributes

  • Type: typing.Dict[typing.Literal['All', 'ApproximateNumberOfMessages', 'ApproximateNumberOfMessagesDelayed', 'ApproximateNumberOfMessagesNotVisible', 'ContentBasedDeduplication', 'CreatedTimestamp', 'DeduplicationScope', 'DelaySeconds', 'FifoQueue', 'FifoThroughputLimit', 'KmsDataKeyReusePeriodSeconds', 'KmsMasterKeyId', 'LastModifiedTimestamp', 'MaximumMessageSize', 'MessageRetentionPeriod', 'Policy', 'QueueArn', 'ReceiveMessageWaitTimeSeconds', 'RedriveAllowPolicy', 'RedrivePolicy', 'SqsManagedSseEnabled', 'VisibilityTimeout'], str]
  • Required: Yes

StartMessageMoveTaskRequest

SourceArn

  • Type:
  • Required: Yes

DestinationArn

  • Type: typing.Optional[str]

MaxNumberOfMessagesPerSecond

  • Type: typing.Optional[int]

StartMessageMoveTaskResult

TaskHandle

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagQueueRequest

QueueUrl

  • Type:
  • Required: Yes

Tags

  • Type: typing.Dict[str, str]
  • Required: Yes

UntagQueueRequest

QueueUrl

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes