hot.dev/aws-sqs / ::aws::sqs::queues

Functions

create-queue

fn (queue_name: Str, attributes: Map): CreateQueueResponse | AwsError
fn (queue_name: Str): CreateQueueResponse | AwsError

Create a new SQS queue.

Example

// Standard queue
result ::aws::sqs::queues/create-queue("my-queue")
result.queue_url  // => "https://sqs.us-east-1.amazonaws.com/123456/my-queue"

// FIFO queue with attributes
result ::aws::sqs::queues/create-queue("my-queue.fifo", {
    FifoQueue: "true",
    ContentBasedDeduplication: "true"
})

delete-queue

fn (queue_url: Str): Map | AwsError

Delete an SQS queue by its URL.

Example

::aws::sqs::queues/delete-queue("https://sqs.us-east-1.amazonaws.com/123456/my-queue")

get-queue-attributes

fn (queue_url: Str, attribute_names: Vec): GetQueueAttributesResponse | AwsError

Get attributes of an SQS queue.

Example

result ::aws::sqs::queues/get-queue-attributes(queue-url, ["All"])
result.attributes.QueueArn                        // => "arn:aws:sqs:us-east-1:123456:my-queue"
result.attributes.ApproximateNumberOfMessages      // => "5"
result.attributes.VisibilityTimeout                // => "30"

get-queue-url

fn (queue_name: Str): GetQueueUrlResponse | AwsError

Get the URL of an SQS queue by its name.

Example

result ::aws::sqs::queues/get-queue-url("my-queue")
result.queue_url  // => "https://sqs.us-east-1.amazonaws.com/123456/my-queue"

list-queues

fn (queue_name_prefix: Str): ListQueuesResponse | AwsError
fn (): ListQueuesResponse | AwsError

List all SQS queues, optionally filtered by name prefix.

Example

// List all queues
result ::aws::sqs::queues/list-queues()
result.queue_urls
// => ["https://sqs.us-east-1.amazonaws.com/123456/queue-1", ...]

// Filter by prefix
result ::aws::sqs::queues/list-queues("my-app")

set-queue-attributes

fn (queue_url: Str, attributes: Map): Map | AwsError

Set attributes of an SQS queue.

Example

::aws::sqs::queues/set-queue-attributes(queue-url, {
    VisibilityTimeout: "60",
    MessageRetentionPeriod: "86400"
})

Types

CreateQueueResponse

CreateQueueResponse type {
    queue_url: Str?
}

GetQueueAttributesResponse

GetQueueAttributesResponse type {
    attributes: Map
}

GetQueueUrlResponse

GetQueueUrlResponse type {
    queue_url: Str?
}

ListQueuesResponse

ListQueuesResponse type {
    queue_urls: Vec
}

QueueAttributes

QueueAttributes type {
    visibility_timeout: Int?,
    message_retention_period: Int?,
    maximum_message_size: Int?,
    delay_seconds: Int?,
    receive_message_wait_time_seconds: Int?,
    policy: Str?,
    redrive_policy: Str?,
    fifo_queue: Bool?,
    content_based_deduplication: Bool?
}