SQSClient#
Auto-generated documentation for SQS type annotations stubs module mypy-boto3-sqs.
SQSClient#
Type annotations and code completion for boto3.client("sqs")
.
boto3 documentation
# SQSClient usage example
from boto3.session import Session
from mypy_boto3_sqs.client import SQSClient
def get_sqs_client() -> SQSClient:
return Session().client("sqs")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("sqs").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("sqs")
try:
do_something(client)
except (
client.exceptions.BatchEntryIdsNotDistinct,
client.exceptions.BatchRequestTooLong,
client.exceptions.ClientError,
client.exceptions.EmptyBatchRequest,
client.exceptions.InvalidAttributeName,
client.exceptions.InvalidBatchEntryId,
client.exceptions.InvalidIdFormat,
client.exceptions.InvalidMessageContents,
client.exceptions.MessageNotInflight,
client.exceptions.OverLimit,
client.exceptions.PurgeQueueInProgress,
client.exceptions.QueueDeletedRecently,
client.exceptions.QueueDoesNotExist,
client.exceptions.QueueNameExists,
client.exceptions.ReceiptHandleIsInvalid,
client.exceptions.TooManyEntriesInBatchRequest,
client.exceptions.UnsupportedOperation,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_sqs.client import Exceptions
def handle_error(exc: Exceptions.BatchEntryIdsNotDistinct) -> None:
...
Methods#
add_permission#
Adds a permission to a queue for a specific principal_.
Type annotations and code completion for boto3.client("sqs").add_permission
method.
boto3 documentation
# add_permission method definition
def add_permission(
self,
*,
QueueUrl: str,
Label: str,
AWSAccountIds: Sequence[str],
Actions: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# add_permission method usage example with argument unpacking
kwargs: AddPermissionRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"Label": ...,
"AWSAccountIds": ...,
"Actions": ...,
}
parent.add_permission(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("sqs").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
change_message_visibility#
Changes the visibility timeout of a specified message in a queue to a new value.
Type annotations and code completion for boto3.client("sqs").change_message_visibility
method.
boto3 documentation
# change_message_visibility method definition
def change_message_visibility(
self,
*,
QueueUrl: str,
ReceiptHandle: str,
VisibilityTimeout: int,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# change_message_visibility method usage example with argument unpacking
kwargs: ChangeMessageVisibilityRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"ReceiptHandle": ...,
"VisibilityTimeout": ...,
}
parent.change_message_visibility(**kwargs)
change_message_visibility_batch#
Changes the visibility timeout of multiple messages.
Type annotations and code completion for boto3.client("sqs").change_message_visibility_batch
method.
boto3 documentation
# change_message_visibility_batch method definition
def change_message_visibility_batch(
self,
*,
QueueUrl: str,
Entries: Sequence[ChangeMessageVisibilityBatchRequestEntryTypeDef], # (1)
) -> ChangeMessageVisibilityBatchResultTypeDef: # (2)
...
# change_message_visibility_batch method usage example with argument unpacking
kwargs: ChangeMessageVisibilityBatchRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"Entries": ...,
}
parent.change_message_visibility_batch(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("sqs").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_queue#
Creates a new standard or FIFO queue.
Type annotations and code completion for boto3.client("sqs").create_queue
method.
boto3 documentation
# create_queue method definition
def create_queue(
self,
*,
QueueName: str,
Attributes: Mapping[QueueAttributeNameType, str] = ..., # (1)
tags: Mapping[str, str] = ...,
) -> CreateQueueResultTypeDef: # (2)
...
# create_queue method usage example with argument unpacking
kwargs: CreateQueueRequestRequestTypeDef = { # (1)
"QueueName": ...,
}
parent.create_queue(**kwargs)
delete_message#
Deletes the specified message from the specified queue.
Type annotations and code completion for boto3.client("sqs").delete_message
method.
boto3 documentation
# delete_message method definition
def delete_message(
self,
*,
QueueUrl: str,
ReceiptHandle: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_message method usage example with argument unpacking
kwargs: DeleteMessageRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"ReceiptHandle": ...,
}
parent.delete_message(**kwargs)
delete_message_batch#
Deletes up to ten messages from the specified queue.
Type annotations and code completion for boto3.client("sqs").delete_message_batch
method.
boto3 documentation
# delete_message_batch method definition
def delete_message_batch(
self,
*,
QueueUrl: str,
Entries: Sequence[DeleteMessageBatchRequestEntryTypeDef], # (1)
) -> DeleteMessageBatchResultTypeDef: # (2)
...
# delete_message_batch method usage example with argument unpacking
kwargs: DeleteMessageBatchRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"Entries": ...,
}
parent.delete_message_batch(**kwargs)
delete_queue#
Deletes the queue specified by the QueueUrl
, regardless of the queue's
contents.
Type annotations and code completion for boto3.client("sqs").delete_queue
method.
boto3 documentation
# delete_queue method definition
def delete_queue(
self,
*,
QueueUrl: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_queue method usage example with argument unpacking
kwargs: DeleteQueueRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
}
parent.delete_queue(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("sqs").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_queue_attributes#
Gets attributes for the specified queue.
Type annotations and code completion for boto3.client("sqs").get_queue_attributes
method.
boto3 documentation
# get_queue_attributes method definition
def get_queue_attributes(
self,
*,
QueueUrl: str,
AttributeNames: Sequence[QueueAttributeFilterType] = ..., # (1)
) -> GetQueueAttributesResultTypeDef: # (2)
...
# get_queue_attributes method usage example with argument unpacking
kwargs: GetQueueAttributesRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
}
parent.get_queue_attributes(**kwargs)
get_queue_url#
Returns the URL of an existing Amazon SQS queue.
Type annotations and code completion for boto3.client("sqs").get_queue_url
method.
boto3 documentation
# get_queue_url method definition
def get_queue_url(
self,
*,
QueueName: str,
QueueOwnerAWSAccountId: str = ...,
) -> GetQueueUrlResultTypeDef: # (1)
...
# get_queue_url method usage example with argument unpacking
kwargs: GetQueueUrlRequestRequestTypeDef = { # (1)
"QueueName": ...,
}
parent.get_queue_url(**kwargs)
list_dead_letter_source_queues#
Returns a list of your queues that have the RedrivePolicy
queue attribute
configured with a dead-letter queue.
Type annotations and code completion for boto3.client("sqs").list_dead_letter_source_queues
method.
boto3 documentation
# list_dead_letter_source_queues method definition
def list_dead_letter_source_queues(
self,
*,
QueueUrl: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDeadLetterSourceQueuesResultTypeDef: # (1)
...
# list_dead_letter_source_queues method usage example with argument unpacking
kwargs: ListDeadLetterSourceQueuesRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
}
parent.list_dead_letter_source_queues(**kwargs)
list_queue_tags#
List all cost allocation tags added to the specified Amazon SQS queue.
Type annotations and code completion for boto3.client("sqs").list_queue_tags
method.
boto3 documentation
# list_queue_tags method definition
def list_queue_tags(
self,
*,
QueueUrl: str,
) -> ListQueueTagsResultTypeDef: # (1)
...
# list_queue_tags method usage example with argument unpacking
kwargs: ListQueueTagsRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
}
parent.list_queue_tags(**kwargs)
list_queues#
Returns a list of your queues in the current region.
Type annotations and code completion for boto3.client("sqs").list_queues
method.
boto3 documentation
# list_queues method definition
def list_queues(
self,
*,
QueueNamePrefix: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListQueuesResultTypeDef: # (1)
...
# list_queues method usage example with argument unpacking
kwargs: ListQueuesRequestRequestTypeDef = { # (1)
"QueueNamePrefix": ...,
}
parent.list_queues(**kwargs)
purge_queue#
Deletes the messages in a queue specified by the QueueURL
parameter.
Type annotations and code completion for boto3.client("sqs").purge_queue
method.
boto3 documentation
# purge_queue method definition
def purge_queue(
self,
*,
QueueUrl: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# purge_queue method usage example with argument unpacking
kwargs: PurgeQueueRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
}
parent.purge_queue(**kwargs)
receive_message#
Retrieves one or more messages (up to 10), from the specified queue.
Type annotations and code completion for boto3.client("sqs").receive_message
method.
boto3 documentation
# receive_message method definition
def receive_message(
self,
*,
QueueUrl: str,
AttributeNames: Sequence[QueueAttributeFilterType] = ..., # (1)
MessageAttributeNames: Sequence[str] = ...,
MaxNumberOfMessages: int = ...,
VisibilityTimeout: int = ...,
WaitTimeSeconds: int = ...,
ReceiveRequestAttemptId: str = ...,
) -> ReceiveMessageResultTypeDef: # (2)
...
# receive_message method usage example with argument unpacking
kwargs: ReceiveMessageRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
}
parent.receive_message(**kwargs)
remove_permission#
Revokes any permissions in the queue policy that matches the specified Label
parameter.
Type annotations and code completion for boto3.client("sqs").remove_permission
method.
boto3 documentation
# remove_permission method definition
def remove_permission(
self,
*,
QueueUrl: str,
Label: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# remove_permission method usage example with argument unpacking
kwargs: RemovePermissionRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"Label": ...,
}
parent.remove_permission(**kwargs)
send_message#
Delivers a message to the specified queue.
Type annotations and code completion for boto3.client("sqs").send_message
method.
boto3 documentation
# send_message method definition
def send_message(
self,
*,
QueueUrl: str,
MessageBody: str,
DelaySeconds: int = ...,
MessageAttributes: Mapping[str, MessageAttributeValueTypeDef] = ..., # (1)
MessageSystemAttributes: Mapping[MessageSystemAttributeNameForSendsType, MessageSystemAttributeValueTypeDef] = ..., # (2)
MessageDeduplicationId: str = ...,
MessageGroupId: str = ...,
) -> SendMessageResultTypeDef: # (3)
...
- See MessageAttributeValueTypeDef
- See MessageSystemAttributeNameForSendsType MessageSystemAttributeValueTypeDef
- See SendMessageResultTypeDef
# send_message method usage example with argument unpacking
kwargs: SendMessageRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"MessageBody": ...,
}
parent.send_message(**kwargs)
send_message_batch#
Delivers up to ten messages to the specified queue.
Type annotations and code completion for boto3.client("sqs").send_message_batch
method.
boto3 documentation
# send_message_batch method definition
def send_message_batch(
self,
*,
QueueUrl: str,
Entries: Sequence[SendMessageBatchRequestEntryTypeDef], # (1)
) -> SendMessageBatchResultTypeDef: # (2)
...
# send_message_batch method usage example with argument unpacking
kwargs: SendMessageBatchRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"Entries": ...,
}
parent.send_message_batch(**kwargs)
set_queue_attributes#
Sets the value of one or more queue attributes.
Type annotations and code completion for boto3.client("sqs").set_queue_attributes
method.
boto3 documentation
# set_queue_attributes method definition
def set_queue_attributes(
self,
*,
QueueUrl: str,
Attributes: Mapping[QueueAttributeNameType, str], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# set_queue_attributes method usage example with argument unpacking
kwargs: SetQueueAttributesRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"Attributes": ...,
}
parent.set_queue_attributes(**kwargs)
tag_queue#
Add cost allocation tags to the specified Amazon SQS queue.
Type annotations and code completion for boto3.client("sqs").tag_queue
method.
boto3 documentation
# tag_queue method definition
def tag_queue(
self,
*,
QueueUrl: str,
Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# tag_queue method usage example with argument unpacking
kwargs: TagQueueRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"Tags": ...,
}
parent.tag_queue(**kwargs)
untag_queue#
Remove cost allocation tags from the specified Amazon SQS queue.
Type annotations and code completion for boto3.client("sqs").untag_queue
method.
boto3 documentation
# untag_queue method definition
def untag_queue(
self,
*,
QueueUrl: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# untag_queue method usage example with argument unpacking
kwargs: UntagQueueRequestRequestTypeDef = { # (1)
"QueueUrl": ...,
"TagKeys": ...,
}
parent.untag_queue(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("sqs").get_paginator
method with overloads.
client.get_paginator("list_dead_letter_source_queues")
-> ListDeadLetterSourceQueuesPaginatorclient.get_paginator("list_queues")
-> ListQueuesPaginator