Changes the visibility timeout of up to 10 records that you have received from the specified queue but not yet acknowledged. The result for each entry is reported individually in the response.
Extend the visibility timeout of a record when your queue consumer needs more time to finish processing it, so the record does not become visible and get redelivered while it is still being processed. Set the visibility timeout to 0 to make a record visible in the queue immediately, so that it can be received again without waiting for its current timeout to expire.
Because the request can result in a combination of successful and unsuccessful entries, check the Failed list even when the call returns an HTTP status code of 200 .
See also: AWS API Documentation
update-queue-records-visibility
--queue-arn <value>
--entries <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
--queue-arn (string) [required]
The ARN of the queue the records were received from.
Constraints:
- min:
1- max:
2048- pattern:
arn:aws.*:kinesis:.*:\d{12}:queue/\S+
--entries (list) [required]
The records whose visibility timeout is changed, identified by their receipt handles, and the new visibility timeout for each.
Constraints:
- min:
1- max:
10(structure)
A record whose visibility timeout is changed, and the new visibility timeout.
ReceiptHandle -> (string) [required]
The receipt handle of the record, as returned by ReceiveQueueRecords .
Constraints:
- min:
1- max:
1024VisibilityTimeoutSeconds -> (integer) [required]
The new duration, in seconds, that the record is in flight and not visible to any consumer instance, measured from when this request is processed. Specify
0to make the record visible in the queue immediately.Constraints:
- min:
0- max:
43200
Shorthand Syntax:
ReceiptHandle=string,VisibilityTimeoutSeconds=integer ...
JSON Syntax:
[
{
"ReceiptHandle": "string",
"VisibilityTimeoutSeconds": integer
}
...
]
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
--help (boolean)
Display help for the command/subcommand.
Successful -> (list)
The records whose visibility timeout was changed.
(structure)
A record whose visibility timeout was changed.
ReceiptHandle -> (string) [required]
The receipt handle of the record whose visibility timeout was changed.
Constraints:
- min:
1- max:
1024
Failed -> (list)
The records whose visibility timeout was not changed, each with the reason the entry failed.
(structure)
A record whose visibility timeout was not changed, and why.
ReceiptHandle -> (string) [required]
The receipt handle of the record whose visibility timeout was not changed.
Constraints:
- min:
1- max:
1024ErrorCode -> (string) [required]
A code identifying the type of failure. One ofResourceNotFoundException,InvalidArgumentException,ThrottlingException, orInternalFailureException.ErrorMessage -> (string)
A description of the cause of the failure.