Skip to content

Typed dictionaries

Index > SQS > Typed dictionaries

Auto-generated documentation for SQS type annotations stubs module types-aiobotocore-sqs.

AddPermissionRequestQueueAddPermissionTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import AddPermissionRequestQueueAddPermissionTypeDef

def get_value() -> AddPermissionRequestQueueAddPermissionTypeDef:
    return {
        "Label": ...,
        "AWSAccountIds": ...,
        "Actions": ...,
    }
Definition
class AddPermissionRequestQueueAddPermissionTypeDef(TypedDict):
    Label: str,
    AWSAccountIds: Sequence[str],
    Actions: Sequence[str],

AddPermissionRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import AddPermissionRequestRequestTypeDef

def get_value() -> AddPermissionRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Label": ...,
        "AWSAccountIds": ...,
        "Actions": ...,
    }
Definition
class AddPermissionRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Label: str,
    AWSAccountIds: Sequence[str],
    Actions: Sequence[str],

BatchResultErrorEntryTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import BatchResultErrorEntryTypeDef

def get_value() -> BatchResultErrorEntryTypeDef:
    return {
        "Id": ...,
        "SenderFault": ...,
        "Code": ...,
    }
Definition
class BatchResultErrorEntryTypeDef(TypedDict):
    Id: str,
    SenderFault: bool,
    Code: str,
    Message: NotRequired[str],

ChangeMessageVisibilityBatchRequestEntryTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ChangeMessageVisibilityBatchRequestEntryTypeDef

def get_value() -> ChangeMessageVisibilityBatchRequestEntryTypeDef:
    return {
        "Id": ...,
        "ReceiptHandle": ...,
    }
Definition
class ChangeMessageVisibilityBatchRequestEntryTypeDef(TypedDict):
    Id: str,
    ReceiptHandle: str,
    VisibilityTimeout: NotRequired[int],

ChangeMessageVisibilityBatchResultEntryTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ChangeMessageVisibilityBatchResultEntryTypeDef

def get_value() -> ChangeMessageVisibilityBatchResultEntryTypeDef:
    return {
        "Id": ...,
    }
Definition
class ChangeMessageVisibilityBatchResultEntryTypeDef(TypedDict):
    Id: str,

ResponseMetadataTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef

def get_value() -> ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef:
    return {
        "VisibilityTimeout": ...,
    }
Definition
class ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef(TypedDict):
    VisibilityTimeout: int,

ChangeMessageVisibilityRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ChangeMessageVisibilityRequestRequestTypeDef

def get_value() -> ChangeMessageVisibilityRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "ReceiptHandle": ...,
        "VisibilityTimeout": ...,
    }
Definition
class ChangeMessageVisibilityRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    ReceiptHandle: str,
    VisibilityTimeout: int,

CreateQueueRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import CreateQueueRequestRequestTypeDef

def get_value() -> CreateQueueRequestRequestTypeDef:
    return {
        "QueueName": ...,
    }
Definition
class CreateQueueRequestRequestTypeDef(TypedDict):
    QueueName: str,
    Attributes: NotRequired[Mapping[QueueAttributeNameType, str]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See QueueAttributeNameType

CreateQueueRequestServiceResourceCreateQueueTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import CreateQueueRequestServiceResourceCreateQueueTypeDef

def get_value() -> CreateQueueRequestServiceResourceCreateQueueTypeDef:
    return {
        "QueueName": ...,
    }
Definition
class CreateQueueRequestServiceResourceCreateQueueTypeDef(TypedDict):
    QueueName: str,
    Attributes: NotRequired[Mapping[QueueAttributeNameType, str]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See QueueAttributeNameType

DeleteMessageBatchRequestEntryTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import DeleteMessageBatchRequestEntryTypeDef

def get_value() -> DeleteMessageBatchRequestEntryTypeDef:
    return {
        "Id": ...,
        "ReceiptHandle": ...,
    }
Definition
class DeleteMessageBatchRequestEntryTypeDef(TypedDict):
    Id: str,
    ReceiptHandle: str,

DeleteMessageBatchResultEntryTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import DeleteMessageBatchResultEntryTypeDef

def get_value() -> DeleteMessageBatchResultEntryTypeDef:
    return {
        "Id": ...,
    }
Definition
class DeleteMessageBatchResultEntryTypeDef(TypedDict):
    Id: str,

DeleteMessageRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import DeleteMessageRequestRequestTypeDef

def get_value() -> DeleteMessageRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "ReceiptHandle": ...,
    }
Definition
class DeleteMessageRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    ReceiptHandle: str,

DeleteQueueRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import DeleteQueueRequestRequestTypeDef

def get_value() -> DeleteQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
Definition
class DeleteQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,

GetQueueAttributesRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import GetQueueAttributesRequestRequestTypeDef

def get_value() -> GetQueueAttributesRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
Definition
class GetQueueAttributesRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    AttributeNames: NotRequired[Sequence[QueueAttributeFilterType]],  # (1)
  1. See QueueAttributeFilterType

GetQueueUrlRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import GetQueueUrlRequestRequestTypeDef

def get_value() -> GetQueueUrlRequestRequestTypeDef:
    return {
        "QueueName": ...,
    }
Definition
class GetQueueUrlRequestRequestTypeDef(TypedDict):
    QueueName: str,
    QueueOwnerAWSAccountId: NotRequired[str],

GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef

def get_value() -> GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef:
    return {
        "QueueName": ...,
    }
Definition
class GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef(TypedDict):
    QueueName: str,
    QueueOwnerAWSAccountId: NotRequired[str],

PaginatorConfigTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListDeadLetterSourceQueuesRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListDeadLetterSourceQueuesRequestRequestTypeDef

def get_value() -> ListDeadLetterSourceQueuesRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
Definition
class ListDeadLetterSourceQueuesRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListQueueTagsRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListQueueTagsRequestRequestTypeDef

def get_value() -> ListQueueTagsRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
Definition
class ListQueueTagsRequestRequestTypeDef(TypedDict):
    QueueUrl: str,

ListQueuesRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListQueuesRequestRequestTypeDef

def get_value() -> ListQueuesRequestRequestTypeDef:
    return {
        "QueueNamePrefix": ...,
    }
Definition
class ListQueuesRequestRequestTypeDef(TypedDict):
    QueueNamePrefix: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MessageAttributeValueTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import MessageAttributeValueTypeDef

def get_value() -> MessageAttributeValueTypeDef:
    return {
        "DataType": ...,
    }
Definition
class MessageAttributeValueTypeDef(TypedDict):
    DataType: str,
    StringValue: NotRequired[str],
    BinaryValue: NotRequired[bytes],
    StringListValues: NotRequired[List[str]],
    BinaryListValues: NotRequired[List[bytes]],

MessageSystemAttributeValueTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import MessageSystemAttributeValueTypeDef

def get_value() -> MessageSystemAttributeValueTypeDef:
    return {
        "DataType": ...,
    }
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]]],

PurgeQueueRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import PurgeQueueRequestRequestTypeDef

def get_value() -> PurgeQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
Definition
class PurgeQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,

QueueMessageRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import QueueMessageRequestTypeDef

def get_value() -> QueueMessageRequestTypeDef:
    return {
        "receipt_handle": ...,
    }
Definition
class QueueMessageRequestTypeDef(TypedDict):
    receipt_handle: str,

ReceiveMessageRequestQueueReceiveMessagesTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ReceiveMessageRequestQueueReceiveMessagesTypeDef

def get_value() -> ReceiveMessageRequestQueueReceiveMessagesTypeDef:
    return {
        "AttributeNames": ...,
    }
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

Usage Example
from types_aiobotocore_sqs.type_defs import ReceiveMessageRequestRequestTypeDef

def get_value() -> ReceiveMessageRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
    }
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

Usage Example
from types_aiobotocore_sqs.type_defs import RemovePermissionRequestQueueRemovePermissionTypeDef

def get_value() -> RemovePermissionRequestQueueRemovePermissionTypeDef:
    return {
        "Label": ...,
    }
Definition
class RemovePermissionRequestQueueRemovePermissionTypeDef(TypedDict):
    Label: str,

RemovePermissionRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import RemovePermissionRequestRequestTypeDef

def get_value() -> RemovePermissionRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Label": ...,
    }
Definition
class RemovePermissionRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Label: str,

SendMessageBatchResultEntryTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageBatchResultEntryTypeDef

def get_value() -> SendMessageBatchResultEntryTypeDef:
    return {
        "Id": ...,
        "MessageId": ...,
        "MD5OfMessageBody": ...,
    }
Definition
class SendMessageBatchResultEntryTypeDef(TypedDict):
    Id: str,
    MessageId: str,
    MD5OfMessageBody: str,
    MD5OfMessageAttributes: NotRequired[str],
    MD5OfMessageSystemAttributes: NotRequired[str],
    SequenceNumber: NotRequired[str],

ServiceResourceMessageRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ServiceResourceMessageRequestTypeDef

def get_value() -> ServiceResourceMessageRequestTypeDef:
    return {
        "queue_url": ...,
        "receipt_handle": ...,
    }
Definition
class ServiceResourceMessageRequestTypeDef(TypedDict):
    queue_url: str,
    receipt_handle: str,

ServiceResourceQueueRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ServiceResourceQueueRequestTypeDef

def get_value() -> ServiceResourceQueueRequestTypeDef:
    return {
        "url": ...,
    }
Definition
class ServiceResourceQueueRequestTypeDef(TypedDict):
    url: str,

SetQueueAttributesRequestQueueSetAttributesTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import SetQueueAttributesRequestQueueSetAttributesTypeDef

def get_value() -> SetQueueAttributesRequestQueueSetAttributesTypeDef:
    return {
        "Attributes": ...,
    }
Definition
class SetQueueAttributesRequestQueueSetAttributesTypeDef(TypedDict):
    Attributes: Mapping[QueueAttributeNameType, str],  # (1)
  1. See QueueAttributeNameType

SetQueueAttributesRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import SetQueueAttributesRequestRequestTypeDef

def get_value() -> SetQueueAttributesRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Attributes": ...,
    }
Definition
class SetQueueAttributesRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Attributes: Mapping[QueueAttributeNameType, str],  # (1)
  1. See QueueAttributeNameType

TagQueueRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import TagQueueRequestRequestTypeDef

def get_value() -> TagQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Tags": ...,
    }
Definition
class TagQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Tags: Mapping[str, str],

UntagQueueRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import UntagQueueRequestRequestTypeDef

def get_value() -> UntagQueueRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "TagKeys": ...,
    }
Definition
class UntagQueueRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    TagKeys: Sequence[str],

ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef

def get_value() -> ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef:
    return {
        "Entries": ...,
    }
Definition
class ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef(TypedDict):
    Entries: Sequence[ChangeMessageVisibilityBatchRequestEntryTypeDef],  # (1)
  1. See ChangeMessageVisibilityBatchRequestEntryTypeDef

ChangeMessageVisibilityBatchRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ChangeMessageVisibilityBatchRequestRequestTypeDef

def get_value() -> ChangeMessageVisibilityBatchRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Entries": ...,
    }
Definition
class ChangeMessageVisibilityBatchRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Entries: Sequence[ChangeMessageVisibilityBatchRequestEntryTypeDef],  # (1)
  1. See ChangeMessageVisibilityBatchRequestEntryTypeDef

ChangeMessageVisibilityBatchResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ChangeMessageVisibilityBatchResultTypeDef

def get_value() -> ChangeMessageVisibilityBatchResultTypeDef:
    return {
        "Successful": ...,
        "Failed": ...,
        "ResponseMetadata": ...,
    }
Definition
class ChangeMessageVisibilityBatchResultTypeDef(TypedDict):
    Successful: List[ChangeMessageVisibilityBatchResultEntryTypeDef],  # (1)
    Failed: List[BatchResultErrorEntryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ChangeMessageVisibilityBatchResultEntryTypeDef
  2. See BatchResultErrorEntryTypeDef
  3. See ResponseMetadataTypeDef

CreateQueueResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import CreateQueueResultTypeDef

def get_value() -> CreateQueueResultTypeDef:
    return {
        "QueueUrl": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateQueueResultTypeDef(TypedDict):
    QueueUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetQueueAttributesResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import GetQueueAttributesResultTypeDef

def get_value() -> GetQueueAttributesResultTypeDef:
    return {
        "Attributes": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetQueueAttributesResultTypeDef(TypedDict):
    Attributes: Dict[QueueAttributeNameType, str],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueueAttributeNameType
  2. See ResponseMetadataTypeDef

GetQueueUrlResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import GetQueueUrlResultTypeDef

def get_value() -> GetQueueUrlResultTypeDef:
    return {
        "QueueUrl": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetQueueUrlResultTypeDef(TypedDict):
    QueueUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDeadLetterSourceQueuesResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListDeadLetterSourceQueuesResultTypeDef

def get_value() -> ListDeadLetterSourceQueuesResultTypeDef:
    return {
        "queueUrls": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListDeadLetterSourceQueuesResultTypeDef(TypedDict):
    queueUrls: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListQueueTagsResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListQueueTagsResultTypeDef

def get_value() -> ListQueueTagsResultTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListQueueTagsResultTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListQueuesResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListQueuesResultTypeDef

def get_value() -> ListQueuesResultTypeDef:
    return {
        "QueueUrls": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListQueuesResultTypeDef(TypedDict):
    QueueUrls: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendMessageResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageResultTypeDef

def get_value() -> SendMessageResultTypeDef:
    return {
        "MD5OfMessageBody": ...,
        "MD5OfMessageAttributes": ...,
        "MD5OfMessageSystemAttributes": ...,
        "MessageId": ...,
        "SequenceNumber": ...,
        "ResponseMetadata": ...,
    }
Definition
class SendMessageResultTypeDef(TypedDict):
    MD5OfMessageBody: str,
    MD5OfMessageAttributes: str,
    MD5OfMessageSystemAttributes: str,
    MessageId: str,
    SequenceNumber: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMessageBatchRequestQueueDeleteMessagesTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import DeleteMessageBatchRequestQueueDeleteMessagesTypeDef

def get_value() -> DeleteMessageBatchRequestQueueDeleteMessagesTypeDef:
    return {
        "Entries": ...,
    }
Definition
class DeleteMessageBatchRequestQueueDeleteMessagesTypeDef(TypedDict):
    Entries: Sequence[DeleteMessageBatchRequestEntryTypeDef],  # (1)
  1. See DeleteMessageBatchRequestEntryTypeDef

DeleteMessageBatchRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import DeleteMessageBatchRequestRequestTypeDef

def get_value() -> DeleteMessageBatchRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Entries": ...,
    }
Definition
class DeleteMessageBatchRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Entries: Sequence[DeleteMessageBatchRequestEntryTypeDef],  # (1)
  1. See DeleteMessageBatchRequestEntryTypeDef

DeleteMessageBatchResultTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import DeleteMessageBatchResultTypeDef

def get_value() -> DeleteMessageBatchResultTypeDef:
    return {
        "Successful": ...,
        "Failed": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteMessageBatchResultTypeDef(TypedDict):
    Successful: List[DeleteMessageBatchResultEntryTypeDef],  # (1)
    Failed: List[BatchResultErrorEntryTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DeleteMessageBatchResultEntryTypeDef
  2. See BatchResultErrorEntryTypeDef
  3. See ResponseMetadataTypeDef

ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef

def get_value() -> ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef:
    return {
        "QueueUrl": ...,
    }
Definition
class ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef(TypedDict):
    QueueUrl: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQueuesRequestListQueuesPaginateTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import ListQueuesRequestListQueuesPaginateTypeDef

def get_value() -> ListQueuesRequestListQueuesPaginateTypeDef:
    return {
        "QueueNamePrefix": ...,
    }
Definition
class ListQueuesRequestListQueuesPaginateTypeDef(TypedDict):
    QueueNamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

MessageTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import MessageTypeDef

def get_value() -> MessageTypeDef:
    return {
        "MessageId": ...,
    }
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

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageBatchRequestEntryTypeDef

def get_value() -> SendMessageBatchRequestEntryTypeDef:
    return {
        "Id": ...,
        "MessageBody": ...,
    }
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

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageRequestQueueSendMessageTypeDef

def get_value() -> SendMessageRequestQueueSendMessageTypeDef:
    return {
        "MessageBody": ...,
    }
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

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageRequestRequestTypeDef

def get_value() -> SendMessageRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "MessageBody": ...,
    }
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

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageBatchResultTypeDef

def get_value() -> SendMessageBatchResultTypeDef:
    return {
        "Successful": ...,
        "Failed": ...,
        "ResponseMetadata": ...,
    }
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

Usage Example
from types_aiobotocore_sqs.type_defs import ReceiveMessageResultTypeDef

def get_value() -> ReceiveMessageResultTypeDef:
    return {
        "Messages": ...,
        "ResponseMetadata": ...,
    }
Definition
class ReceiveMessageResultTypeDef(TypedDict):
    Messages: List[MessageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageTypeDef
  2. See ResponseMetadataTypeDef

SendMessageBatchRequestQueueSendMessagesTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageBatchRequestQueueSendMessagesTypeDef

def get_value() -> SendMessageBatchRequestQueueSendMessagesTypeDef:
    return {
        "Entries": ...,
    }
Definition
class SendMessageBatchRequestQueueSendMessagesTypeDef(TypedDict):
    Entries: Sequence[SendMessageBatchRequestEntryTypeDef],  # (1)
  1. See SendMessageBatchRequestEntryTypeDef

SendMessageBatchRequestRequestTypeDef

Usage Example
from types_aiobotocore_sqs.type_defs import SendMessageBatchRequestRequestTypeDef

def get_value() -> SendMessageBatchRequestRequestTypeDef:
    return {
        "QueueUrl": ...,
        "Entries": ...,
    }
Definition
class SendMessageBatchRequestRequestTypeDef(TypedDict):
    QueueUrl: str,
    Entries: Sequence[SendMessageBatchRequestEntryTypeDef],  # (1)
  1. See SendMessageBatchRequestEntryTypeDef