queue.messages.change-visibility

Extend or shorten how long a received message stays hidden

POST /queue/api/queues/{name}/messages/visibilityIAM queue:ChangeMessageVisibilityChanges state

0 makes the message visible again at once.

Request syntax

POST /queue/api/queues/{name}/messages/visibility
{
  "receiptHandle": "string",
  "visibilityTimeoutSeconds": "number"
}

Path parameters

  • nameRequired

    string

    Constraints: max 80 chars, /^[A-Za-z0-9_-]+(\.fifo)?$/

Request body

  • receiptHandleRequired

    string

    The receipt handle the message was last received with

    Constraints: 1-200 chars

  • visibilityTimeoutSecondsRequired

    number

    Seconds from now the message stays hidden; 0 makes it receivable again at once

    Constraints: integer, 0-43200

Response

200; data is { changed: true }.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow queue:ChangeMessageVisibility on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud queue messages change-visibility name --receipt-handle example --visibility-timeout-seconds 1

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_queue_messages_change-visibility.