SQS module#
Index > SQS
Auto-generated documentation for SQS type annotations stubs module mypy-boto3-sqs.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and SQS
.
From PyPI with pip#
Install boto3-stubs
for SQS
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[sqs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[sqs]'
# standalone installation
python -m pip install mypy-boto3-sqs
From conda-forge#
Installing mypy-boto3-sqs
from the conda-forge
channel
can be achieved by adding conda-forge
to your channels with:
conda config --add channels conda-forge
conda config --set channel_priority strict
Once the conda-forge
channel has been enabled, mypy-boto3-sqs
can be installed with:
conda install mypy-boto3-sqs
It is possible to list all of the versions of mypy-boto3-sqs
available on your platform with:
conda search mypy-boto3-sqs --channel conda-forge
How to uninstall#
python -m pip uninstall -y mypy-boto3-sqs
Usage#
Code samples can be found in Examples.
SQSClient#
Type annotations and code completion for boto3.client("sqs")
as SQSClient
boto3 documentation
# SQSClient usage example
from boto3.session import Session
from mypy_boto3_sqs.client import SQSClient
def get_client() -> SQSClient:
return Session().client("sqs")
Paginators#
Type annotations and code completion for paginators
from boto3.client("sqs").get_paginator("...")
.
# ListDeadLetterSourceQueuesPaginator usage example
from boto3.session import Session
from mypy_boto3_sqs.paginator import ListDeadLetterSourceQueuesPaginator
def get_list_dead_letter_source_queues_paginator() -> ListDeadLetterSourceQueuesPaginator:
return Session().client("sqs").get_paginator("list_dead_letter_source_queues"))
SQSServiceResource#
Type annotations and code completion for boto3.resource("sqs")
as
SQSServiceResource
boto3 documentation
# SQSServiceResource usage example
from boto3.session import Session
from mypy_boto3_sqs.service_resource import SQSServiceResource
def get_sqs_resource() -> SQSServiceResource:
return Session().resource("sqs")
Collections#
Type annotations and code completion for collections
from boto3.resource("sqs").*
.
# ServiceResourceQueuesCollection usage example
from boto3.session import Session
from mypy_boto3_sqs.service_resource import ServiceResourceQueuesCollection
def get_collection() -> ServiceResourceQueuesCollection:
return Session().resource("sqs").queues
Resources#
Type annotations and code completion for additional resources
from boto3.resource("sqs").*
.
# Message usage example
from boto3.session import Session
from mypy_boto3_sqs.service_resource import Message
def get_resource() -> Message:
return Session().resource("sqs").Message(...)
Literals#
Type annotations for literals used in methods and schemas.
# ListDeadLetterSourceQueuesPaginatorName usage example
from mypy_boto3_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.
# AddPermissionRequestQueueAddPermissionTypeDef usage example
from mypy_boto3_sqs.type_defs import AddPermissionRequestQueueAddPermissionTypeDef
def get_value() -> AddPermissionRequestQueueAddPermissionTypeDef:
return {
"Label": ...,
"AWSAccountIds": ...,
"Actions": ...,
}
- AddPermissionRequestQueueAddPermissionTypeDef
- AddPermissionRequestRequestTypeDef
- BatchResultErrorEntryTypeDef
- ChangeMessageVisibilityBatchRequestEntryTypeDef
- ChangeMessageVisibilityBatchResultEntryTypeDef
- ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef
- ChangeMessageVisibilityRequestRequestTypeDef
- CreateQueueRequestRequestTypeDef
- CreateQueueRequestServiceResourceCreateQueueTypeDef
- CreateQueueResultTypeDef
- DeleteMessageBatchRequestEntryTypeDef
- DeleteMessageBatchResultEntryTypeDef
- DeleteMessageRequestRequestTypeDef
- DeleteQueueRequestRequestTypeDef
- EmptyResponseMetadataTypeDef
- GetQueueAttributesRequestRequestTypeDef
- GetQueueAttributesResultTypeDef
- GetQueueUrlRequestRequestTypeDef
- GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef
- GetQueueUrlResultTypeDef
- ListDeadLetterSourceQueuesRequestListDeadLetterSourceQueuesPaginateTypeDef
- ListDeadLetterSourceQueuesRequestRequestTypeDef
- ListDeadLetterSourceQueuesResultTypeDef
- ListQueueTagsRequestRequestTypeDef
- ListQueueTagsResultTypeDef
- ListQueuesRequestListQueuesPaginateTypeDef
- ListQueuesRequestRequestTypeDef
- ListQueuesResultTypeDef
- MessageAttributeValueTypeDef
- MessageSystemAttributeValueTypeDef
- PaginatorConfigTypeDef
- PurgeQueueRequestRequestTypeDef
- ReceiveMessageRequestQueueReceiveMessagesTypeDef
- ReceiveMessageRequestRequestTypeDef
- RemovePermissionRequestQueueRemovePermissionTypeDef
- RemovePermissionRequestRequestTypeDef
- ResponseMetadataTypeDef
- SendMessageBatchResultEntryTypeDef
- SendMessageResultTypeDef
- SetQueueAttributesRequestQueueSetAttributesTypeDef
- SetQueueAttributesRequestRequestTypeDef
- TagQueueRequestRequestTypeDef
- UntagQueueRequestRequestTypeDef
- ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef
- ChangeMessageVisibilityBatchRequestRequestTypeDef
- ChangeMessageVisibilityBatchResultTypeDef
- DeleteMessageBatchRequestQueueDeleteMessagesTypeDef
- DeleteMessageBatchRequestRequestTypeDef
- DeleteMessageBatchResultTypeDef
- MessageTypeDef
- SendMessageBatchRequestEntryTypeDef
- SendMessageRequestQueueSendMessageTypeDef
- SendMessageRequestRequestTypeDef
- SendMessageBatchResultTypeDef
- ReceiveMessageResultTypeDef
- SendMessageBatchRequestQueueSendMessagesTypeDef
- SendMessageBatchRequestRequestTypeDef