This API exposes
11 operations
across 6 paths,
and defines 22 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
11 operations6 paths22 schemas2 DELETE3 GET4 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Queue API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 11
Across 6 paths, the API surfaces 11 operations — 2 DELETE, 3 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are mq_queue (8 properties), mq_consumer_created (6 properties), mq_queue_message (6 properties), mq_consumer_updated (6 properties). Each schema is shown below with its type and property counts.
mq_queue_created
object
4 properties
mq_queue_updated
object
4 properties
mq_queue_message
object
6 properties
mq_visibility_timeout
number
The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.
mq_consumer_updated
object
6 properties
mq_api-response-common
object
4 properties4 required
mq_lease_id
string
mq_queue
object
8 properties
mq_name
string
mq_consumer
object
5 properties
mq_messages
array
mq_api-response-common-failure
object
4 properties4 required
mq_identifier
string
Identifier.
mq_max_retries
number
The maximum number of retries
mq_dlq_name
string
The name of the dead letter queue.
mq_batch_size
number
The maximum number of messages to include in a batch.
mq_result_info
object
4 properties
mq_renamed_name
string
mq_api-response-collection
object
mq_producer
object
2 properties
mq_max_wait_time_ms
number
mq_consumer_created
object
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
