Skip to content

Typed dictionaries#

Index > SQS > Typed dictionaries

Auto-generated documentation for SQS type annotations stubs module mypy-boto3-sqs.

AddPermissionRequestQueueAddPermissionTypeDef#

# AddPermissionRequestQueueAddPermissionTypeDef usage example

from mypy_boto3_sqs.type_defs import AddPermissionRequestQueueAddPermissionTypeDef

def get_value() -> AddPermissionRequestQueueAddPermissionTypeDef:
    return {
        "Label": ...,
        "AWSAccountIds": ...,
        "Actions": ...,
    }
# AddPermissionRequestQueueAddPermissionTypeDef definition

class AddPermissionRequestQueueAddPermissionTypeDef(TypedDict):
    Label: str,
    AWSAccountIds: Sequence[str],
    Actions: Sequence[str],

AddPermissionRequestRequestTypeDef#

# AddPermissionRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import AddPermissionRequestRequestTypeDef

def get_value() -> AddPermissionRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Label": ...,
        "AWSAccountIds": ...,
        "Actions": ...,
    }
# AddPermissionRequestRequestTypeDef definition

class AddPermissionRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Label: str,
    AWSAccountIds: Sequence[str],
    Actions: Sequence[str],

BatchResultErrorEntryTypeDef#

# BatchResultErrorEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import BatchResultErrorEntryTypeDef

def get_value() -> BatchResultErrorEntryTypeDef:
    return {
        "Id": ...,
        "SenderFault": ...,
        "Code": ...,
    }
# BatchResultErrorEntryTypeDef definition

class BatchResultErrorEntryTypeDef(TypedDict):
    Id: str,
    SenderFault: bool,
    Code: str,
    Message: NotRequired[str],

CancelMessageMoveTaskRequestRequestTypeDef#

# CancelMessageMoveTaskRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import CancelMessageMoveTaskRequestRequestTypeDef

def get_value() -> CancelMessageMoveTaskRequestRequestTypeDef:
    return {
        "TaskHandle": ...,
    }
# CancelMessageMoveTaskRequestRequestTypeDef definition

class CancelMessageMoveTaskRequestRequestTypeDef(TypedDict):
    TaskHandle: str,

CancelMessageMoveTaskResultTypeDef#

# CancelMessageMoveTaskResultTypeDef usage example

from mypy_boto3_sqs.type_defs import CancelMessageMoveTaskResultTypeDef

def get_value() -> CancelMessageMoveTaskResultTypeDef:
    return {
        "ApproximateNumberOfMessagesMoved": ...,
        "ResponseMetadata": ...,
    }
# CancelMessageMoveTaskResultTypeDef definition

class CancelMessageMoveTaskResultTypeDef(TypedDict):
    ApproximateNumberOfMessagesMoved: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ChangeMessageVisibilityBatchRequestEntryTypeDef#

# ChangeMessageVisibilityBatchRequestEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import ChangeMessageVisibilityBatchRequestEntryTypeDef

def get_value() -> ChangeMessageVisibilityBatchRequestEntryTypeDef:
    return {
        "Id": ...,
        "ReceiptHandle": ...,
    }
# ChangeMessageVisibilityBatchRequestEntryTypeDef definition

class ChangeMessageVisibilityBatchRequestEntryTypeDef(TypedDict):
    Id: str,
    ReceiptHandle: str,
    VisibilityTimeout: NotRequired[int],

ChangeMessageVisibilityBatchResultEntryTypeDef#

# ChangeMessageVisibilityBatchResultEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import ChangeMessageVisibilityBatchResultEntryTypeDef

def get_value() -> ChangeMessageVisibilityBatchResultEntryTypeDef:
    return {
        "Id": ...,
    }
# ChangeMessageVisibilityBatchResultEntryTypeDef definition

class ChangeMessageVisibilityBatchResultEntryTypeDef(TypedDict):
    Id: str,

ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef#

# ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef usage example

from mypy_boto3_sqs.type_defs import ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef

def get_value() -> ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef:
    return {
        "VisibilityTimeout": ...,
    }
# ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef definition

class ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef(TypedDict):
    VisibilityTimeout: int,

ChangeMessageVisibilityRequestRequestTypeDef#

# ChangeMessageVisibilityRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import ChangeMessageVisibilityRequestRequestTypeDef

def get_value() -> ChangeMessageVisibilityRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "ReceiptHandle": ...,
        "VisibilityTimeout": ...,
    }
# ChangeMessageVisibilityRequestRequestTypeDef definition

class ChangeMessageVisibilityRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    ReceiptHandle: str,
    VisibilityTimeout: int,

CreateQueueRequestRequestTypeDef#

# CreateQueueRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import CreateQueueRequestRequestTypeDef

def get_value() -> CreateQueueRequestRequestTypeDef:
    return {
        "QueueName": ...,
    }
# CreateQueueRequestRequestTypeDef definition

class CreateQueueRequestRequestTypeDef(TypedDict):
    QueueName: str,
    Attributes: NotRequired[Mapping[QueueAttributeNameType, str]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See QueueAttributeNameType

CreateQueueRequestServiceResourceCreateQueueTypeDef#

# CreateQueueRequestServiceResourceCreateQueueTypeDef usage example

from mypy_boto3_sqs.type_defs import CreateQueueRequestServiceResourceCreateQueueTypeDef

def get_value() -> CreateQueueRequestServiceResourceCreateQueueTypeDef:
    return {
        "QueueName": ...,
    }
# CreateQueueRequestServiceResourceCreateQueueTypeDef definition

class CreateQueueRequestServiceResourceCreateQueueTypeDef(TypedDict):
    QueueName: str,
    Attributes: NotRequired[Mapping[QueueAttributeNameType, str]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See QueueAttributeNameType

CreateQueueResultTypeDef#

# CreateQueueResultTypeDef usage example

from mypy_boto3_sqs.type_defs import CreateQueueResultTypeDef

def get_value() -> CreateQueueResultTypeDef:
    return {
        "QueueUrl": ...,
        "ResponseMetadata": ...,
    }
# CreateQueueResultTypeDef definition

class CreateQueueResultTypeDef(TypedDict):
    QueueUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMessageBatchRequestEntryTypeDef#

# DeleteMessageBatchRequestEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import DeleteMessageBatchRequestEntryTypeDef

def get_value() -> DeleteMessageBatchRequestEntryTypeDef:
    return {
        "Id": ...,
        "ReceiptHandle": ...,
    }
# DeleteMessageBatchRequestEntryTypeDef definition

class DeleteMessageBatchRequestEntryTypeDef(TypedDict):
    Id: str,
    ReceiptHandle: str,

DeleteMessageBatchResultEntryTypeDef#

# DeleteMessageBatchResultEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import DeleteMessageBatchResultEntryTypeDef

def get_value() -> DeleteMessageBatchResultEntryTypeDef:
    return {
        "Id": ...,
    }
# DeleteMessageBatchResultEntryTypeDef definition

class DeleteMessageBatchResultEntryTypeDef(TypedDict):
    Id: str,

DeleteMessageRequestRequestTypeDef#

# DeleteMessageRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import DeleteMessageRequestRequestTypeDef

def get_value() -> DeleteMessageRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "ReceiptHandle": ...,
    }
# DeleteMessageRequestRequestTypeDef definition

class DeleteMessageRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    ReceiptHandle: str,

DeleteQueueRequestRequestTypeDef#

# DeleteQueueRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import DeleteQueueRequestRequestTypeDef

def get_value() -> DeleteQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
# DeleteQueueRequestRequestTypeDef definition

class DeleteQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_sqs.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetQueueAttributesRequestRequestTypeDef#

# GetQueueAttributesRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import GetQueueAttributesRequestRequestTypeDef

def get_value() -> GetQueueAttributesRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
# GetQueueAttributesRequestRequestTypeDef definition

class GetQueueAttributesRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    AttributeNames: NotRequired[Sequence[QueueAttributeFilterType]],  # (1)
  1. See QueueAttributeFilterType

GetQueueAttributesResultTypeDef#

# GetQueueAttributesResultTypeDef usage example

from mypy_boto3_sqs.type_defs import GetQueueAttributesResultTypeDef

def get_value() -> GetQueueAttributesResultTypeDef:
    return {
        "Attributes": ...,
        "ResponseMetadata": ...,
    }
# GetQueueAttributesResultTypeDef definition

class GetQueueAttributesResultTypeDef(TypedDict):
    Attributes: Dict[QueueAttributeNameType, str],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueueAttributeNameType
  2. See ResponseMetadataTypeDef

GetQueueUrlRequestRequestTypeDef#

# GetQueueUrlRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import GetQueueUrlRequestRequestTypeDef

def get_value() -> GetQueueUrlRequestRequestTypeDef:
    return {
        "QueueName": ...,
    }
# GetQueueUrlRequestRequestTypeDef definition

class GetQueueUrlRequestRequestTypeDef(TypedDict):
    QueueName: str,
    QueueOwnerAWSAccountId: NotRequired[str],

GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef#

# GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef usage example

from mypy_boto3_sqs.type_defs import GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef

def get_value() -> GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef:
    return {
        "QueueName": ...,
    }
# GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef definition

class GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef(TypedDict):
    QueueName: str,
    QueueOwnerAWSAccountId: NotRequired[str],

GetQueueUrlResultTypeDef#

# GetQueueUrlResultTypeDef usage example

from mypy_boto3_sqs.type_defs import GetQueueUrlResultTypeDef

def get_value() -> GetQueueUrlResultTypeDef:
    return {
        "QueueUrl": ...,
        "ResponseMetadata": ...,
    }
# GetQueueUrlResultTypeDef definition

class GetQueueUrlResultTypeDef(TypedDict):
    QueueUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef#

# ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef usage example

from mypy_boto3_sqs.type_defs import ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef

def get_value() -> ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef:
    return {
        "QueueUrl": ...,
    }
# ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef definition

class ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef(TypedDict):
    QueueUrl: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDeadLetterSourceQueuesRequestRequestTypeDef#

# ListDeadLetterSourceQueuesRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import ListDeadLetterSourceQueuesRequestRequestTypeDef

def get_value() -> ListDeadLetterSourceQueuesRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
# ListDeadLetterSourceQueuesRequestRequestTypeDef definition

class ListDeadLetterSourceQueuesRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDeadLetterSourceQueuesResultTypeDef#

# ListDeadLetterSourceQueuesResultTypeDef usage example

from mypy_boto3_sqs.type_defs import ListDeadLetterSourceQueuesResultTypeDef

def get_value() -> ListDeadLetterSourceQueuesResultTypeDef:
    return {
        "queueUrls": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListDeadLetterSourceQueuesResultTypeDef definition

class ListDeadLetterSourceQueuesResultTypeDef(TypedDict):
    queueUrls: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListMessageMoveTasksRequestRequestTypeDef#

# ListMessageMoveTasksRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import ListMessageMoveTasksRequestRequestTypeDef

def get_value() -> ListMessageMoveTasksRequestRequestTypeDef:
    return {
        "SourceArn": ...,
    }
# ListMessageMoveTasksRequestRequestTypeDef definition

class ListMessageMoveTasksRequestRequestTypeDef(TypedDict):
    SourceArn: str,
    MaxResults: NotRequired[int],

ListMessageMoveTasksResultEntryTypeDef#

# ListMessageMoveTasksResultEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import ListMessageMoveTasksResultEntryTypeDef

def get_value() -> ListMessageMoveTasksResultEntryTypeDef:
    return {
        "TaskHandle": ...,
    }
# ListMessageMoveTasksResultEntryTypeDef definition

class ListMessageMoveTasksResultEntryTypeDef(TypedDict):
    TaskHandle: NotRequired[str],
    Status: NotRequired[str],
    SourceArn: NotRequired[str],
    DestinationArn: NotRequired[str],
    MaxNumberOfMessagesPerSecond: NotRequired[int],
    ApproximateNumberOfMessagesMoved: NotRequired[int],
    ApproximateNumberOfMessagesToMove: NotRequired[int],
    FailureReason: NotRequired[str],
    StartedTimestamp: NotRequired[int],

ListQueueTagsRequestRequestTypeDef#

# ListQueueTagsRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import ListQueueTagsRequestRequestTypeDef

def get_value() -> ListQueueTagsRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
# ListQueueTagsRequestRequestTypeDef definition

class ListQueueTagsRequestRequestTypeDef(TypedDict):
    QueueUrl: str,

ListQueueTagsResultTypeDef#

# ListQueueTagsResultTypeDef usage example

from mypy_boto3_sqs.type_defs import ListQueueTagsResultTypeDef

def get_value() -> ListQueueTagsResultTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListQueueTagsResultTypeDef definition

class ListQueueTagsResultTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListQueuesRequestListQueuesPaginateTypeDef#

# ListQueuesRequestListQueuesPaginateTypeDef usage example

from mypy_boto3_sqs.type_defs import ListQueuesRequestListQueuesPaginateTypeDef

def get_value() -> ListQueuesRequestListQueuesPaginateTypeDef:
    return {
        "QueueNamePrefix": ...,
    }
# ListQueuesRequestListQueuesPaginateTypeDef definition

class ListQueuesRequestListQueuesPaginateTypeDef(TypedDict):
    QueueNamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueuesRequestRequestTypeDef#

# ListQueuesRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import ListQueuesRequestRequestTypeDef

def get_value() -> ListQueuesRequestRequestTypeDef:
    return {
        "QueueNamePrefix": ...,
    }
# ListQueuesRequestRequestTypeDef definition

class ListQueuesRequestRequestTypeDef(TypedDict):
    QueueNamePrefix: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListQueuesResultTypeDef#

# ListQueuesResultTypeDef usage example

from mypy_boto3_sqs.type_defs import ListQueuesResultTypeDef

def get_value() -> ListQueuesResultTypeDef:
    return {
        "QueueUrls": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListQueuesResultTypeDef definition

class ListQueuesResultTypeDef(TypedDict):
    QueueUrls: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

MessageAttributeValueTypeDef#

# MessageAttributeValueTypeDef usage example

from mypy_boto3_sqs.type_defs import MessageAttributeValueTypeDef

def get_value() -> MessageAttributeValueTypeDef:
    return {
        "DataType": ...,
    }
# MessageAttributeValueTypeDef definition

class MessageAttributeValueTypeDef(TypedDict):
    DataType: str,
    StringValue: NotRequired[str],
    BinaryValue: NotRequired[bytes],
    StringListValues: NotRequired[List[str]],
    BinaryListValues: NotRequired[List[bytes]],

MessageSystemAttributeValueTypeDef#

# MessageSystemAttributeValueTypeDef usage example

from mypy_boto3_sqs.type_defs import MessageSystemAttributeValueTypeDef

def get_value() -> MessageSystemAttributeValueTypeDef:
    return {
        "DataType": ...,
    }
# MessageSystemAttributeValueTypeDef definition

class MessageSystemAttributeValueTypeDef(TypedDict):
    DataType: str,
    StringValue: NotRequired[str],
    BinaryValue: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    StringListValues: NotRequired[Sequence[str]],
    BinaryListValues: NotRequired[Sequence[Union[str, bytes, IO[Any], StreamingBody]]],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_sqs.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

PurgeQueueRequestRequestTypeDef#

# PurgeQueueRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import PurgeQueueRequestRequestTypeDef

def get_value() -> PurgeQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
# PurgeQueueRequestRequestTypeDef definition

class PurgeQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,

ReceiveMessageRequestQueueReceiveMessagesTypeDef#

# ReceiveMessageRequestQueueReceiveMessagesTypeDef usage example

from mypy_boto3_sqs.type_defs import ReceiveMessageRequestQueueReceiveMessagesTypeDef

def get_value() -> ReceiveMessageRequestQueueReceiveMessagesTypeDef:
    return {
        "AttributeNames": ...,
    }
# ReceiveMessageRequestQueueReceiveMessagesTypeDef definition

class ReceiveMessageRequestQueueReceiveMessagesTypeDef(TypedDict):
    AttributeNames: NotRequired[Sequence[QueueAttributeFilterType]],  # (1)
    MessageAttributeNames: NotRequired[Sequence[str]],
    MaxNumberOfMessages: NotRequired[int],
    VisibilityTimeout: NotRequired[int],
    WaitTimeSeconds: NotRequired[int],
    ReceiveRequestAttemptId: NotRequired[str],
  1. See QueueAttributeFilterType

ReceiveMessageRequestRequestTypeDef#

# ReceiveMessageRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import ReceiveMessageRequestRequestTypeDef

def get_value() -> ReceiveMessageRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
# ReceiveMessageRequestRequestTypeDef definition

class ReceiveMessageRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    AttributeNames: NotRequired[Sequence[QueueAttributeFilterType]],  # (1)
    MessageAttributeNames: NotRequired[Sequence[str]],
    MaxNumberOfMessages: NotRequired[int],
    VisibilityTimeout: NotRequired[int],
    WaitTimeSeconds: NotRequired[int],
    ReceiveRequestAttemptId: NotRequired[str],
  1. See QueueAttributeFilterType

RemovePermissionRequestQueueRemovePermissionTypeDef#

# RemovePermissionRequestQueueRemovePermissionTypeDef usage example

from mypy_boto3_sqs.type_defs import RemovePermissionRequestQueueRemovePermissionTypeDef

def get_value() -> RemovePermissionRequestQueueRemovePermissionTypeDef:
    return {
        "Label": ...,
    }
# RemovePermissionRequestQueueRemovePermissionTypeDef definition

class RemovePermissionRequestQueueRemovePermissionTypeDef(TypedDict):
    Label: str,

RemovePermissionRequestRequestTypeDef#

# RemovePermissionRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import RemovePermissionRequestRequestTypeDef

def get_value() -> RemovePermissionRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Label": ...,
    }
# RemovePermissionRequestRequestTypeDef definition

class RemovePermissionRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Label: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_sqs.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SendMessageBatchResultEntryTypeDef#

# SendMessageBatchResultEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageBatchResultEntryTypeDef

def get_value() -> SendMessageBatchResultEntryTypeDef:
    return {
        "Id": ...,
        "MessageId": ...,
        "MD5OfMessageBody": ...,
    }
# SendMessageBatchResultEntryTypeDef definition

class SendMessageBatchResultEntryTypeDef(TypedDict):
    Id: str,
    MessageId: str,
    MD5OfMessageBody: str,
    MD5OfMessageAttributes: NotRequired[str],
    MD5OfMessageSystemAttributes: NotRequired[str],
    SequenceNumber: NotRequired[str],

SendMessageResultTypeDef#

# SendMessageResultTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageResultTypeDef

def get_value() -> SendMessageResultTypeDef:
    return {
        "MD5OfMessageBody": ...,
        "MD5OfMessageAttributes": ...,
        "MD5OfMessageSystemAttributes": ...,
        "MessageId": ...,
        "SequenceNumber": ...,
        "ResponseMetadata": ...,
    }
# SendMessageResultTypeDef definition

class SendMessageResultTypeDef(TypedDict):
    MD5OfMessageBody: str,
    MD5OfMessageAttributes: str,
    MD5OfMessageSystemAttributes: str,
    MessageId: str,
    SequenceNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetQueueAttributesRequestQueueSetAttributesTypeDef#

# SetQueueAttributesRequestQueueSetAttributesTypeDef usage example

from mypy_boto3_sqs.type_defs import SetQueueAttributesRequestQueueSetAttributesTypeDef

def get_value() -> SetQueueAttributesRequestQueueSetAttributesTypeDef:
    return {
        "Attributes": ...,
    }
# SetQueueAttributesRequestQueueSetAttributesTypeDef definition

class SetQueueAttributesRequestQueueSetAttributesTypeDef(TypedDict):
    Attributes: Mapping[QueueAttributeNameType, str],  # (1)
  1. See QueueAttributeNameType

SetQueueAttributesRequestRequestTypeDef#

# SetQueueAttributesRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import SetQueueAttributesRequestRequestTypeDef

def get_value() -> SetQueueAttributesRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Attributes": ...,
    }
# SetQueueAttributesRequestRequestTypeDef definition

class SetQueueAttributesRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Attributes: Mapping[QueueAttributeNameType, str],  # (1)
  1. See QueueAttributeNameType

StartMessageMoveTaskRequestRequestTypeDef#

# StartMessageMoveTaskRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import StartMessageMoveTaskRequestRequestTypeDef

def get_value() -> StartMessageMoveTaskRequestRequestTypeDef:
    return {
        "SourceArn": ...,
    }
# StartMessageMoveTaskRequestRequestTypeDef definition

class StartMessageMoveTaskRequestRequestTypeDef(TypedDict):
    SourceArn: str,
    DestinationArn: NotRequired[str],
    MaxNumberOfMessagesPerSecond: NotRequired[int],

StartMessageMoveTaskResultTypeDef#

# StartMessageMoveTaskResultTypeDef usage example

from mypy_boto3_sqs.type_defs import StartMessageMoveTaskResultTypeDef

def get_value() -> StartMessageMoveTaskResultTypeDef:
    return {
        "TaskHandle": ...,
        "ResponseMetadata": ...,
    }
# StartMessageMoveTaskResultTypeDef definition

class StartMessageMoveTaskResultTypeDef(TypedDict):
    TaskHandle: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagQueueRequestRequestTypeDef#

# TagQueueRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import TagQueueRequestRequestTypeDef

def get_value() -> TagQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Tags": ...,
    }
# TagQueueRequestRequestTypeDef definition

class TagQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Tags: Mapping[str, str],

UntagQueueRequestRequestTypeDef#

# UntagQueueRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import UntagQueueRequestRequestTypeDef

def get_value() -> UntagQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "TagKeys": ...,
    }
# UntagQueueRequestRequestTypeDef definition

class UntagQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    TagKeys: Sequence[str],

ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef#

# ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef usage example

from mypy_boto3_sqs.type_defs import ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef

def get_value() -> ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef:
    return {
        "Entries": ...,
    }
# ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef definition

class ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef(TypedDict):
    Entries: Sequence[ChangeMessageVisibilityBatchRequestEntryTypeDef],  # (1)
  1. See ChangeMessageVisibilityBatchRequestEntryTypeDef

ChangeMessageVisibilityBatchRequestRequestTypeDef#

# ChangeMessageVisibilityBatchRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import ChangeMessageVisibilityBatchRequestRequestTypeDef

def get_value() -> ChangeMessageVisibilityBatchRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Entries": ...,
    }
# ChangeMessageVisibilityBatchRequestRequestTypeDef definition

class ChangeMessageVisibilityBatchRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Entries: Sequence[ChangeMessageVisibilityBatchRequestEntryTypeDef],  # (1)
  1. See ChangeMessageVisibilityBatchRequestEntryTypeDef

ChangeMessageVisibilityBatchResultTypeDef#

# ChangeMessageVisibilityBatchResultTypeDef usage example

from mypy_boto3_sqs.type_defs import ChangeMessageVisibilityBatchResultTypeDef

def get_value() -> ChangeMessageVisibilityBatchResultTypeDef:
    return {
        "Successful": ...,
        "Failed": ...,
        "ResponseMetadata": ...,
    }
# ChangeMessageVisibilityBatchResultTypeDef definition

class ChangeMessageVisibilityBatchResultTypeDef(TypedDict):
    Successful: List[ChangeMessageVisibilityBatchResultEntryTypeDef],  # (1)
    Failed: List[BatchResultErrorEntryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ChangeMessageVisibilityBatchResultEntryTypeDef
  2. See BatchResultErrorEntryTypeDef
  3. See ResponseMetadataTypeDef

DeleteMessageBatchRequestQueueDeleteMessagesTypeDef#

# DeleteMessageBatchRequestQueueDeleteMessagesTypeDef usage example

from mypy_boto3_sqs.type_defs import DeleteMessageBatchRequestQueueDeleteMessagesTypeDef

def get_value() -> DeleteMessageBatchRequestQueueDeleteMessagesTypeDef:
    return {
        "Entries": ...,
    }
# DeleteMessageBatchRequestQueueDeleteMessagesTypeDef definition

class DeleteMessageBatchRequestQueueDeleteMessagesTypeDef(TypedDict):
    Entries: Sequence[DeleteMessageBatchRequestEntryTypeDef],  # (1)
  1. See DeleteMessageBatchRequestEntryTypeDef

DeleteMessageBatchRequestRequestTypeDef#

# DeleteMessageBatchRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import DeleteMessageBatchRequestRequestTypeDef

def get_value() -> DeleteMessageBatchRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Entries": ...,
    }
# DeleteMessageBatchRequestRequestTypeDef definition

class DeleteMessageBatchRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Entries: Sequence[DeleteMessageBatchRequestEntryTypeDef],  # (1)
  1. See DeleteMessageBatchRequestEntryTypeDef

DeleteMessageBatchResultTypeDef#

# DeleteMessageBatchResultTypeDef usage example

from mypy_boto3_sqs.type_defs import DeleteMessageBatchResultTypeDef

def get_value() -> DeleteMessageBatchResultTypeDef:
    return {
        "Successful": ...,
        "Failed": ...,
        "ResponseMetadata": ...,
    }
# DeleteMessageBatchResultTypeDef definition

class DeleteMessageBatchResultTypeDef(TypedDict):
    Successful: List[DeleteMessageBatchResultEntryTypeDef],  # (1)
    Failed: List[BatchResultErrorEntryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DeleteMessageBatchResultEntryTypeDef
  2. See BatchResultErrorEntryTypeDef
  3. See ResponseMetadataTypeDef

ListMessageMoveTasksResultTypeDef#

# ListMessageMoveTasksResultTypeDef usage example

from mypy_boto3_sqs.type_defs import ListMessageMoveTasksResultTypeDef

def get_value() -> ListMessageMoveTasksResultTypeDef:
    return {
        "Results": ...,
        "ResponseMetadata": ...,
    }
# ListMessageMoveTasksResultTypeDef definition

class ListMessageMoveTasksResultTypeDef(TypedDict):
    Results: List[ListMessageMoveTasksResultEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ListMessageMoveTasksResultEntryTypeDef
  2. See ResponseMetadataTypeDef

MessageTypeDef#

# MessageTypeDef usage example

from mypy_boto3_sqs.type_defs import MessageTypeDef

def get_value() -> MessageTypeDef:
    return {
        "MessageId": ...,
    }
# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    MessageId: NotRequired[str],
    ReceiptHandle: NotRequired[str],
    MD5OfBody: NotRequired[str],
    Body: NotRequired[str],
    Attributes: NotRequired[Dict[MessageSystemAttributeNameType, str]],  # (1)
    MD5OfMessageAttributes: NotRequired[str],
    MessageAttributes: NotRequired[Dict[str, MessageAttributeValueTypeDef]],  # (2)
  1. See MessageSystemAttributeNameType
  2. See MessageAttributeValueTypeDef

SendMessageBatchRequestEntryTypeDef#

# SendMessageBatchRequestEntryTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageBatchRequestEntryTypeDef

def get_value() -> SendMessageBatchRequestEntryTypeDef:
    return {
        "Id": ...,
        "MessageBody": ...,
    }
# SendMessageBatchRequestEntryTypeDef definition

class SendMessageBatchRequestEntryTypeDef(TypedDict):
    Id: str,
    MessageBody: str,
    DelaySeconds: NotRequired[int],
    MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]],  # (1)
    MessageSystemAttributes: NotRequired[Mapping[MessageSystemAttributeNameForSendsType, MessageSystemAttributeValueTypeDef]],  # (2)
    MessageDeduplicationId: NotRequired[str],
    MessageGroupId: NotRequired[str],
  1. See MessageAttributeValueTypeDef
  2. See MessageSystemAttributeNameForSendsType MessageSystemAttributeValueTypeDef

SendMessageRequestQueueSendMessageTypeDef#

# SendMessageRequestQueueSendMessageTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageRequestQueueSendMessageTypeDef

def get_value() -> SendMessageRequestQueueSendMessageTypeDef:
    return {
        "MessageBody": ...,
    }
# SendMessageRequestQueueSendMessageTypeDef definition

class SendMessageRequestQueueSendMessageTypeDef(TypedDict):
    MessageBody: str,
    DelaySeconds: NotRequired[int],
    MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]],  # (1)
    MessageSystemAttributes: NotRequired[Mapping[MessageSystemAttributeNameForSendsType, MessageSystemAttributeValueTypeDef]],  # (2)
    MessageDeduplicationId: NotRequired[str],
    MessageGroupId: NotRequired[str],
  1. See MessageAttributeValueTypeDef
  2. See MessageSystemAttributeNameForSendsType MessageSystemAttributeValueTypeDef

SendMessageRequestRequestTypeDef#

# SendMessageRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageRequestRequestTypeDef

def get_value() -> SendMessageRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "MessageBody": ...,
    }
# SendMessageRequestRequestTypeDef definition

class SendMessageRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    MessageBody: str,
    DelaySeconds: NotRequired[int],
    MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]],  # (1)
    MessageSystemAttributes: NotRequired[Mapping[MessageSystemAttributeNameForSendsType, MessageSystemAttributeValueTypeDef]],  # (2)
    MessageDeduplicationId: NotRequired[str],
    MessageGroupId: NotRequired[str],
  1. See MessageAttributeValueTypeDef
  2. See MessageSystemAttributeNameForSendsType MessageSystemAttributeValueTypeDef

SendMessageBatchResultTypeDef#

# SendMessageBatchResultTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageBatchResultTypeDef

def get_value() -> SendMessageBatchResultTypeDef:
    return {
        "Successful": ...,
        "Failed": ...,
        "ResponseMetadata": ...,
    }
# SendMessageBatchResultTypeDef definition

class SendMessageBatchResultTypeDef(TypedDict):
    Successful: List[SendMessageBatchResultEntryTypeDef],  # (1)
    Failed: List[BatchResultErrorEntryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SendMessageBatchResultEntryTypeDef
  2. See BatchResultErrorEntryTypeDef
  3. See ResponseMetadataTypeDef

ReceiveMessageResultTypeDef#

# ReceiveMessageResultTypeDef usage example

from mypy_boto3_sqs.type_defs import ReceiveMessageResultTypeDef

def get_value() -> ReceiveMessageResultTypeDef:
    return {
        "Messages": ...,
        "ResponseMetadata": ...,
    }
# ReceiveMessageResultTypeDef definition

class ReceiveMessageResultTypeDef(TypedDict):
    Messages: List[MessageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageTypeDef
  2. See ResponseMetadataTypeDef

SendMessageBatchRequestQueueSendMessagesTypeDef#

# SendMessageBatchRequestQueueSendMessagesTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageBatchRequestQueueSendMessagesTypeDef

def get_value() -> SendMessageBatchRequestQueueSendMessagesTypeDef:
    return {
        "Entries": ...,
    }
# SendMessageBatchRequestQueueSendMessagesTypeDef definition

class SendMessageBatchRequestQueueSendMessagesTypeDef(TypedDict):
    Entries: Sequence[SendMessageBatchRequestEntryTypeDef],  # (1)
  1. See SendMessageBatchRequestEntryTypeDef

SendMessageBatchRequestRequestTypeDef#

# SendMessageBatchRequestRequestTypeDef usage example

from mypy_boto3_sqs.type_defs import SendMessageBatchRequestRequestTypeDef

def get_value() -> SendMessageBatchRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Entries": ...,
    }
# SendMessageBatchRequestRequestTypeDef definition

class SendMessageBatchRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Entries: Sequence[SendMessageBatchRequestEntryTypeDef],  # (1)
  1. See SendMessageBatchRequestEntryTypeDef