SQS module#
Index > SQS
Auto-generated documentation for SQS type annotations stubs module types-aiobotocore-sqs.
How to install#
From PyPI with pip#
Install types-aiobotocore
for SQS
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[sqs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[sqs]'
# standalone installation
python -m pip install types-aiobotocore-sqs
How to uninstall#
python -m pip uninstall -y types-aiobotocore-sqs
Usage#
Code samples can be found in Examples.
SQSClient#
Type annotations and code completion for session.create_client("sqs")
as SQSClient
boto3 documentation
# SQSClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_sqs.client import SQSClient
session = get_session()
async with session.create_client("sqs") as client:
client: SQSClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("sqs").get_paginator("...")
.
# ListDeadLetterSourceQueuesPaginator usage example
from types_aiobotocore_sqs.paginator import ListDeadLetterSourceQueuesPaginator
def get_list_dead_letter_source_queues_paginator() -> ListDeadLetterSourceQueuesPaginator:
return client.get_paginator("list_dead_letter_source_queues"))
SQSServiceResource#
Type annotations and code completion for session.resource("sqs")
as
SQSServiceResource
boto3 documentation
# SQSServiceResource usage example
from types_aiobotocore_sqs.service_resource import SQSServiceResource
Collections#
Type annotations and code completion for collections
from session.resource("sqs").*
.
# ServiceResourceQueuesCollection usage example
from types_aiobotocore_sqs.service_resource import ServiceResourceQueuesCollection
def get_collection() -> ServiceResourceQueuesCollection:
return resource.queues
Resources#
Type annotations and code completion for additional resources
from session.resource("sqs").*
.
# Message usage example
from types_aiobotocore_sqs.service_resource import Message
def get_resource() -> Message:
return resource.Message(...)
Literals#
Type annotations for literals used in methods and schema.
# ListDeadLetterSourceQueuesPaginatorName usage example
from types_aiobotocore_sqs.literals import ListDeadLetterSourceQueuesPaginatorName
def get_value() -> ListDeadLetterSourceQueuesPaginatorName:
return "list_dead_letter_source_queues"
- ListDeadLetterSourceQueuesPaginatorName
- ListQueuesPaginatorName
- MessageSystemAttributeNameForSendsType
- MessageSystemAttributeNameType
- QueueAttributeFilterType
- QueueAttributeNameType
- SQSServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AddPermissionRequestQueueAddPermissionTypeDef
- AddPermissionRequestRequestTypeDef
- BatchResultErrorEntryTypeDef
- BlobTypeDef
- CancelMessageMoveTaskRequestRequestTypeDef
- ResponseMetadataTypeDef
- ChangeMessageVisibilityBatchRequestEntryTypeDef
- ChangeMessageVisibilityBatchResultEntryTypeDef
- ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef
- ChangeMessageVisibilityRequestRequestTypeDef
- CreateQueueRequestRequestTypeDef
- CreateQueueRequestServiceResourceCreateQueueTypeDef
- DeleteMessageBatchRequestEntryTypeDef
- DeleteMessageBatchResultEntryTypeDef
- DeleteMessageRequestRequestTypeDef
- DeleteQueueRequestRequestTypeDef
- GetQueueAttributesRequestRequestTypeDef
- GetQueueUrlRequestRequestTypeDef
- GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef
- PaginatorConfigTypeDef
- ListDeadLetterSourceQueuesRequestRequestTypeDef
- ListMessageMoveTasksRequestRequestTypeDef
- ListMessageMoveTasksResultEntryTypeDef
- ListQueueTagsRequestRequestTypeDef
- ListQueuesRequestRequestTypeDef
- MessageAttributeValueTypeDef
- PurgeQueueRequestRequestTypeDef
- ReceiveMessageRequestQueueReceiveMessagesTypeDef
- ReceiveMessageRequestRequestTypeDef
- RemovePermissionRequestQueueRemovePermissionTypeDef
- RemovePermissionRequestRequestTypeDef
- SendMessageBatchResultEntryTypeDef
- SetQueueAttributesRequestQueueSetAttributesTypeDef
- SetQueueAttributesRequestRequestTypeDef
- StartMessageMoveTaskRequestRequestTypeDef
- TagQueueRequestRequestTypeDef
- UntagQueueRequestRequestTypeDef
- MessageAttributeValueQueueTypeDef
- MessageSystemAttributeValueTypeDef
- CancelMessageMoveTaskResultTypeDef
- CreateQueueResultTypeDef
- EmptyResponseMetadataTypeDef
- GetQueueAttributesResultTypeDef
- GetQueueUrlResultTypeDef
- ListDeadLetterSourceQueuesResultTypeDef
- ListQueueTagsResultTypeDef
- ListQueuesResultTypeDef
- SendMessageResultTypeDef
- StartMessageMoveTaskResultTypeDef
- ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef
- ChangeMessageVisibilityBatchRequestRequestTypeDef
- ChangeMessageVisibilityBatchResultTypeDef
- DeleteMessageBatchRequestQueueDeleteMessagesTypeDef
- DeleteMessageBatchRequestRequestTypeDef
- DeleteMessageBatchResultTypeDef
- ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef
- ListQueuesRequestListQueuesPaginateTypeDef
- ListMessageMoveTasksResultTypeDef
- MessageTypeDef
- SendMessageBatchResultTypeDef
- SendMessageBatchRequestEntryQueueTypeDef
- SendMessageBatchRequestEntryTypeDef
- SendMessageRequestQueueSendMessageTypeDef
- SendMessageRequestRequestTypeDef
- ReceiveMessageResultTypeDef
- SendMessageBatchRequestQueueSendMessagesTypeDef
- SendMessageBatchRequestRequestTypeDef