SQSServiceResource#
Auto-generated documentation for SQS type annotations stubs module mypy-boto3-sqs.
SQSServiceResource#
Type annotations and code completion for boto3.resource("sqs")
, included resources and collections.
boto3 documentation
# SQSServiceResource usage example
from mypy_boto3_sqs.service_resource import SQSServiceResource
def get_sqs_resource() -> SQSServiceResource:
return boto3.resource("sqs")
Attributes#
-
meta
: SQSResourceMeta -
queues
: ServiceResourceQueuesCollection
Collections#
ServiceResourceQueuesCollection#
Provides access to Queue resource.
Type annotations and code completion for boto3.resource("sqs").queues
collection.
boto3 documentation
# ServiceResourceQueuesCollection usage example
from mypy_boto3_sqs.service_resource import ServiceResourceQueuesCollection
def get_collection() -> ServiceResourceQueuesCollection:
return boto3.resource("sqs").queues
Methods#
SQSServiceResource.Message method#
Creates a Message resource.
Type annotations and code completion for boto3.resource("sqs").Message
method.
boto3 documentation
# Message method definition
def Message(
self,
queue_url: str,
receipt_handle: str,
) -> Message:
...
SQSServiceResource.Queue method#
Creates a Queue resource.
Type annotations and code completion for boto3.resource("sqs").Queue
method.
boto3 documentation
# Queue method definition
def Queue(
self,
url: str,
) -> Queue:
...
SQSServiceResource.create_queue method#
Creates a new standard or FIFO queue.
Type annotations and code completion for boto3.resource("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] = ...,
) -> Queue:
...
# create_queue method usage example with argument unpacking
kwargs: CreateQueueRequestServiceResourceCreateQueueTypeDef = { # (1)
"QueueName": ...,
}
parent.create_queue(**kwargs)
SQSServiceResource.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("sqs").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
def get_available_subresources(
self,
) -> Sequence[str]:
...
SQSServiceResource.get_queue_by_name method#
Returns the URL of an existing Amazon SQS queue.
Type annotations and code completion for boto3.resource("sqs").get_queue_by_name
method.
boto3 documentation
# get_queue_by_name method definition
def get_queue_by_name(
self,
*,
QueueName: str,
QueueOwnerAWSAccountId: str = ...,
) -> Queue:
...
# get_queue_by_name method usage example with argument unpacking
kwargs: GetQueueUrlRequestServiceResourceGetQueueByNameTypeDef = { # (1)
"QueueName": ...,
}
parent.get_queue_by_name(**kwargs)
Message#
Type annotations and code completion for boto3.resource("sqs").Message
class.
boto3 documentation
# Message usage example
from mypy_boto3_sqs.service_resource import Message
def get_resource() -> Message:
return boto3.resource("sqs").Message(...)
Message attributes#
message_id
:str
md5_of_body
:str
body
:str
attributes
:Dict
[MessageSystemAttributeNameType,str
]md5_of_message_attributes
:str
message_attributes
:Dict
[str
, MessageAttributeValueTypeDef]queue_url
:str
receipt_handle
:str
Message methods#
Message.Queue method#
Creates a Queue resource.
Type annotations and code completion for boto3.resource("sqs").Queue
method.
boto3 documentation
# Queue method definition
def Queue(
self,
) -> Queue:
...
Message.change_visibility method#
Changes the visibility timeout of a specified message in a queue to a new value.
Type annotations and code completion for boto3.resource("sqs").change_visibility
method.
boto3 documentation
# change_visibility method definition
def change_visibility(
self,
*,
VisibilityTimeout: int,
) -> None:
...
# change_visibility method usage example with argument unpacking
kwargs: ChangeMessageVisibilityRequestMessageChangeVisibilityTypeDef = { # (1)
"VisibilityTimeout": ...,
}
parent.change_visibility(**kwargs)
Message.delete method#
Deletes the specified message from the specified queue.
Type annotations and code completion for boto3.resource("sqs").delete
method.
boto3 documentation
# delete method definition
def delete(
self,
) -> None:
...
Message.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("sqs").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
def get_available_subresources(
self,
) -> Sequence[str]:
...
Queue#
Type annotations and code completion for boto3.resource("sqs").Queue
class.
boto3 documentation
# Queue usage example
from mypy_boto3_sqs.service_resource import Queue
def get_resource() -> Queue:
return boto3.resource("sqs").Queue(...)
Queue attributes#
attributes
:Dict
[QueueAttributeNameType,str
]url
:str
dead_letter_source_queues
: QueueDeadLetterSourceQueuesCollection
Queue collections#
Queue.dead_letter_source_queues#
Provides access to Queue resource.
Type annotations and code completion for boto3.resource("sqs").Queue(...).dead_letter_source_queues
collection.
boto3 documentation
# QueueDeadLetterSourceQueuesCollection usage example
from mypy_boto3_sqs.service_resource import QueueDeadLetterSourceQueuesCollection
def get_collection() -> QueueDeadLetterSourceQueuesCollection:
resource = boto3.resource("sqs").Queue(...)
return resource.dead_letter_source_queues
Queue methods#
Queue.Message method#
Creates a Message resource.
Type annotations and code completion for boto3.resource("sqs").Message
method.
boto3 documentation
# Message method definition
def Message(
self,
receipt_handle: str,
) -> Message:
...
Queue.add_permission method#
Adds a permission to a queue for a specific principal_.
Type annotations and code completion for boto3.resource("sqs").add_permission
method.
boto3 documentation
# add_permission method definition
def add_permission(
self,
*,
Label: str,
AWSAccountIds: Sequence[str],
Actions: Sequence[str],
) -> None:
...
# add_permission method usage example with argument unpacking
kwargs: AddPermissionRequestQueueAddPermissionTypeDef = { # (1)
"Label": ...,
"AWSAccountIds": ...,
"Actions": ...,
}
parent.add_permission(**kwargs)
Queue.change_message_visibility_batch method#
Changes the visibility timeout of multiple messages.
Type annotations and code completion for boto3.resource("sqs").change_message_visibility_batch
method.
boto3 documentation
# change_message_visibility_batch method definition
def change_message_visibility_batch(
self,
*,
Entries: Sequence[ChangeMessageVisibilityBatchRequestEntryTypeDef], # (1)
) -> ChangeMessageVisibilityBatchResultTypeDef: # (2)
...
# change_message_visibility_batch method usage example with argument unpacking
kwargs: ChangeMessageVisibilityBatchRequestQueueChangeMessageVisibilityBatchTypeDef = { # (1)
"Entries": ...,
}
parent.change_message_visibility_batch(**kwargs)
Queue.delete method#
Deletes the queue specified by the QueueUrl
, regardless of the queue's
contents.
Type annotations and code completion for boto3.resource("sqs").delete
method.
boto3 documentation
# delete method definition
def delete(
self,
) -> None:
...
Queue.delete_messages method#
Deletes up to ten messages from the specified queue.
Type annotations and code completion for boto3.resource("sqs").delete_messages
method.
boto3 documentation
# delete_messages method definition
def delete_messages(
self,
*,
Entries: Sequence[DeleteMessageBatchRequestEntryTypeDef], # (1)
) -> DeleteMessageBatchResultTypeDef: # (2)
...
# delete_messages method usage example with argument unpacking
kwargs: DeleteMessageBatchRequestQueueDeleteMessagesTypeDef = { # (1)
"Entries": ...,
}
parent.delete_messages(**kwargs)
Queue.get_available_subresources method#
Returns a list of all the available sub-resources for this Resource.
Type annotations and code completion for boto3.resource("sqs").get_available_subresources
method.
boto3 documentation
# get_available_subresources method definition
def get_available_subresources(
self,
) -> Sequence[str]:
...
Queue.load method#
Calls meth:
SQS.Client.get_queue_attributes
to update the attributes of the
Queue resource.
Type annotations and code completion for boto3.resource("sqs").load
method.
boto3 documentation
# load method definition
def load(
self,
) -> None:
...
Queue.purge method#
Deletes the messages in a queue specified by the QueueURL
parameter.
Type annotations and code completion for boto3.resource("sqs").purge
method.
boto3 documentation
# purge method definition
def purge(
self,
) -> None:
...
Queue.receive_messages method#
Retrieves one or more messages (up to 10), from the specified queue.
Type annotations and code completion for boto3.resource("sqs").receive_messages
method.
boto3 documentation
# receive_messages method definition
def receive_messages(
self,
*,
AttributeNames: Sequence[QueueAttributeFilterType] = ..., # (1)
MessageAttributeNames: Sequence[str] = ...,
MaxNumberOfMessages: int = ...,
VisibilityTimeout: int = ...,
WaitTimeSeconds: int = ...,
ReceiveRequestAttemptId: str = ...,
) -> List[Message]:
...
# receive_messages method usage example with argument unpacking
kwargs: ReceiveMessageRequestQueueReceiveMessagesTypeDef = { # (1)
"AttributeNames": ...,
}
parent.receive_messages(**kwargs)
Queue.reload method#
Calls meth:
SQS.Client.get_queue_attributes
to update the attributes of the
Queue resource.
Type annotations and code completion for boto3.resource("sqs").reload
method.
boto3 documentation
# reload method definition
def reload(
self,
) -> None:
...
Queue.remove_permission method#
Revokes any permissions in the queue policy that matches the specified Label
parameter.
Type annotations and code completion for boto3.resource("sqs").remove_permission
method.
boto3 documentation
# remove_permission method definition
def remove_permission(
self,
*,
Label: str,
) -> None:
...
# remove_permission method usage example with argument unpacking
kwargs: RemovePermissionRequestQueueRemovePermissionTypeDef = { # (1)
"Label": ...,
}
parent.remove_permission(**kwargs)
Queue.send_message method#
Delivers a message to the specified queue.
Type annotations and code completion for boto3.resource("sqs").send_message
method.
boto3 documentation
# send_message method definition
def send_message(
self,
*,
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: SendMessageRequestQueueSendMessageTypeDef = { # (1)
"MessageBody": ...,
}
parent.send_message(**kwargs)
Queue.send_messages method#
Delivers up to ten messages to the specified queue.
Type annotations and code completion for boto3.resource("sqs").send_messages
method.
boto3 documentation
# send_messages method definition
def send_messages(
self,
*,
Entries: Sequence[SendMessageBatchRequestEntryTypeDef], # (1)
) -> SendMessageBatchResultTypeDef: # (2)
...
# send_messages method usage example with argument unpacking
kwargs: SendMessageBatchRequestQueueSendMessagesTypeDef = { # (1)
"Entries": ...,
}
parent.send_messages(**kwargs)
Queue.set_attributes method#
Sets the value of one or more queue attributes.
Type annotations and code completion for boto3.resource("sqs").set_attributes
method.
boto3 documentation
# set_attributes method definition
def set_attributes(
self,
*,
Attributes: Mapping[QueueAttributeNameType, str], # (1)
) -> None:
...
# set_attributes method usage example with argument unpacking
kwargs: SetQueueAttributesRequestQueueSetAttributesTypeDef = { # (1)
"Attributes": ...,
}
parent.set_attributes(**kwargs)