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-aioboto3
for SQS
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[sqs]'
# standalone installation
python -m pip install types-aiobotocore-sqs
How to uninstall
Usage
Code samples can be found in Examples.
SQSClient
Type annotations and code completion for session.client("sqs")
as SQSClient
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_sqs.client import SQSClient
session = Session()
async with session.client("sqs") as client:
client: SQSClient
Paginators
Type annotations and code completion for
paginators
from session.client("sqs").get_paginator("...")
.
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
Collections
Type annotations and code completion for collections
from session.resource("sqs").*
.
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").*
.
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.
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
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
from types_aiobotocore_sqs.type_defs import AddPermissionRequestQueueAddPermissionTypeDef
def get_value() -> AddPermissionRequestQueueAddPermissionTypeDef:
return {
"Label": ...,
"AWSAccountIds": ...,
"Actions": ...,
}
- AddPermissionRequestQueueAddPermissionTypeDef
- AddPermissionRequestRequestTypeDef
- BatchResultErrorEntryTypeDef
- ChangeMessageVisibilityBatchRequestEntryTypeDef
- ChangeMessageVisibilityBatchResultEntryTypeDef
- ResponseMetadataTypeDef
- ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef
- ChangeMessageVisibilityRequestRequestTypeDef
- CreateQueueRequestRequestTypeDef
- CreateQueueRequestServiceResourceCreateQueueTypeDef
- DeleteMessageBatchRequestEntryTypeDef
- DeleteMessageBatchResultEntryTypeDef
- DeleteMessageRequestRequestTypeDef
- DeleteQueueRequestRequestTypeDef
- GetQueueAttributesRequestRequestTypeDef
- GetQueueUrlRequestRequestTypeDef
- GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef
- PaginatorConfigTypeDef
- ListDeadLetterSourceQueuesRequestRequestTypeDef
- ListQueueTagsRequestRequestTypeDef
- ListQueuesRequestRequestTypeDef
- MessageAttributeValueTypeDef
- MessageSystemAttributeValueTypeDef
- PurgeQueueRequestRequestTypeDef
- QueueMessageRequestTypeDef
- ReceiveMessageRequestQueueReceiveMessagesTypeDef
- ReceiveMessageRequestRequestTypeDef
- RemovePermissionRequestQueueRemovePermissionTypeDef
- RemovePermissionRequestRequestTypeDef
- SendMessageBatchResultEntryTypeDef
- ServiceResourceMessageRequestTypeDef
- ServiceResourceQueueRequestTypeDef
- SetQueueAttributesRequestQueueSetAttributesTypeDef
- SetQueueAttributesRequestRequestTypeDef
- TagQueueRequestRequestTypeDef
- UntagQueueRequestRequestTypeDef
- ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef
- ChangeMessageVisibilityBatchRequestRequestTypeDef
- ChangeMessageVisibilityBatchResultTypeDef
- CreateQueueResultTypeDef
- EmptyResponseMetadataTypeDef
- GetQueueAttributesResultTypeDef
- GetQueueUrlResultTypeDef
- ListDeadLetterSourceQueuesResultTypeDef
- ListQueueTagsResultTypeDef
- ListQueuesResultTypeDef
- SendMessageResultTypeDef
- DeleteMessageBatchRequestQueueDeleteMessagesTypeDef
- DeleteMessageBatchRequestRequestTypeDef
- DeleteMessageBatchResultTypeDef
- ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef
- ListQueuesRequestListQueuesPaginateTypeDef
- MessageTypeDef
- SendMessageBatchRequestEntryTypeDef
- SendMessageRequestQueueSendMessageTypeDef
- SendMessageRequestRequestTypeDef
- SendMessageBatchResultTypeDef
- ReceiveMessageResultTypeDef
- SendMessageBatchRequestQueueSendMessagesTypeDef
- SendMessageBatchRequestRequestTypeDef