get_queue_url¶
Operation¶
async
¶
get_queue_url(input: GetQueueUrlInput, plugins: list[Plugin] | None = None) -> GetQueueUrlOutput
The GetQueueUrl API returns the URL of an existing Amazon SQS queue.
This is useful when you know the queue's name but need to retrieve its
URL for further operations.
To access a queue owned by another Amazon Web Services account, use the
QueueOwnerAWSAccountId parameter to specify the account ID of the
queue's owner. Note that the queue owner must grant you the necessary
permissions to access the queue. For more information about accessing
shared queues, see the ``AddPermission`` API or Allow developers to
write messages to a shared
queue
in the Amazon SQS Developer Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetQueueUrlInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetQueueUrlOutput
|
An instance of |
Input¶
dataclass
¶
Retrieves the URL of an existing queue based on its name and, optionally, the Amazon Web Services account ID.
Attributes¶
class-attribute
instance-attribute
¶
queue_name: str | None = None
(Required) The name of the queue for which you want to fetch the URL. The name can be up to 80 characters long and can include alphanumeric characters, hyphens (-), and underscores (_). Queue URLs and names are case-sensitive.
class-attribute
instance-attribute
¶
queue_owner_aws_account_id: str | None = None
(Optional) The Amazon Web Services account ID of the account that created the queue. This is only required when you are attempting to access a queue owned by another Amazon Web Services account.
Output¶
dataclass
¶
For more information, see Interpreting Responses in the Amazon SQS Developer Guide.