Updates the configuration attributes of the specified queue. You can change the queue’s visibility timeout, its dead-letter handling configuration, or both.
A new visibility timeout applies to records received after the update completes. Records that are already in flight keep the visibility timeout they were received with. To change the visibility timeout of a record that is already in flight, use UpdateQueueRecordsVisibility .
UpdateQueueis an asynchronous operation. Upon receiving anUpdateQueuerequest, Amazon Kinesis Data Streams sets theQueueStatustoUPDATING, and sets it back toACTIVEwhen the update is complete. You can continue to receive and acknowledge records while the queue isUPDATING.
You can’t change the data stream or the starting position of a queue after you create it. To read from a different stream or position, create a new queue.
See also: AWS API Documentation
update-queue
--queue-arn <value>
--queue-attributes <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 to update.
Constraints:
- min:
1- max:
2048- pattern:
arn:aws.*:kinesis:.*:\d{12}:queue/\S+
--queue-attributes (structure) [required]
The configuration attributes to apply to the queue. Attributes you do not specify are left unchanged.
VisibilityTimeoutSeconds -> (integer)
The duration, in seconds, that a record is in flight and not visible to any consumer instance after it is received. A record that is not acknowledged before this duration elapses becomes visible in the queue again and can be received by any consumer instance. If you omit this attribute when you create a queue, the queue uses 30 seconds.
Constraints:
- min:
0- max:
43200DeadLetterConfiguration -> (structure)
The dead-letter handling configuration for the queue. If you omit this attribute, dead-letter handling is enabled with a
MaxReceiveCountof 6. If you specify it with aTargetTypeofBUILT_IN, you must also specifyMaxReceiveCount.TargetType -> (string) [required]
Whether dead-letter handling is enabled for the queue.
BUILT_INenables it: when a record has been receivedMaxReceiveCounttimes without being acknowledged, it becomes a dead-letter record and ReceiveQueueRecords no longer returns it.NONEdisables it, and an unacknowledged record continues to be redelivered until it is acknowledged or its retention period ends.Possible values:
BUILT_INNONEMaxReceiveCount -> (integer)
The number of times a record can be received without being acknowledged before it becomes a dead-letter record. Required when
TargetTypeisBUILT_IN. A queue that you create withoutDeadLetterConfigurationgets aMaxReceiveCountof 6.Constraints:
- min:
1- max:
1000
Shorthand Syntax:
VisibilityTimeoutSeconds=integer,DeadLetterConfiguration={TargetType=string,MaxReceiveCount=integer}
JSON Syntax:
{
"VisibilityTimeoutSeconds": integer,
"DeadLetterConfiguration": {
"TargetType": "BUILT_IN"|"NONE",
"MaxReceiveCount": 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.
QueueDescription -> (structure)
A description of the queue, including the updated attributes.
QueueName -> (string) [required]
The name of the queue.
Constraints:
- min:
1- max:
128- pattern:
[a-zA-Z0-9_.-]+QueueARN -> (string) [required]
The ARN of the queue. The resource identifier in the ARN is generated when the queue is created and is not derived from
QueueName. Use the returnedQueueARNto identify the queue in subsequent requests.Constraints:
- min:
1- max:
2048- pattern:
arn:aws.*:kinesis:.*:\d{12}:queue/\S+QueueStatus -> (string) [required]
The current status of the queue.
Possible values:
CREATINGACTIVEUPDATINGDELETINGQueueCreationTimestamp -> (timestamp) [required]
The time the queue was created.StreamConfigurationList -> (list) [required]
The data stream the queue delivers records from, and the position in that stream where delivery begins. The list contains exactly one entry, because a queue delivers records from a single data stream.
Constraints:
- min:
1- max:
10000(structure)
The data stream a queue delivers records from, and the position in that stream where delivery begins.
StreamARN -> (string) [required]
The ARN of the data stream.
Constraints:
- min:
1- max:
2048- pattern:
arn:aws.*:kinesis:.*:\d{12}:stream/\S+StartingPosition -> (structure)
The position in the stream from which the queue begins delivering records. The default is
LATEST.Type -> (string) [required]
You can set the starting position to one of the following values:
LATEST: Delivers records that arrive after you create the queue. This is the default.
TRIM_HORIZON: Start delivering at the last untrimmed record in the stream, which is the oldest record the stream still retains.
AT_TIMESTAMP: Delivers records that arrive at or after a time stamp that you provide.Possible values:
TRIM_HORIZONLATESTAT_TIMESTAMPTimestamp -> (timestamp)
The approximate time from which the queue begins delivering records. Records that arrive at approximately this time or later are delivered.
In a request, specify this value only when
TypeisAT_TIMESTAMP. It is required in that case, and specifying it for any other type returns aValidationException.In a response, this value is approximate and reflects the queue’s effective starting position. While the queue is
CREATING, the response echoes what you configured: forAT_TIMESTAMP, the timestamp you provided, and forTRIM_HORIZONandLATEST, this member is absent because the effective position is not yet determined. Once the queue isACTIVE, the response always includes this member. ForAT_TIMESTAMP, it is the timestamp you provided or the earliest time the stream can be read from, whichever is later.QueueAttributes -> (structure)
The configuration attributes of the queue.
VisibilityTimeoutSeconds -> (integer)
The duration, in seconds, that a record is in flight and not visible to any consumer instance after it is received. A record that is not acknowledged before this duration elapses becomes visible in the queue again and can be received by any consumer instance. If you omit this attribute when you create a queue, the queue uses 30 seconds.
Constraints:
- min:
0- max:
43200DeadLetterConfiguration -> (structure)
The dead-letter handling configuration for the queue. If you omit this attribute, dead-letter handling is enabled with a
MaxReceiveCountof 6. If you specify it with aTargetTypeofBUILT_IN, you must also specifyMaxReceiveCount.TargetType -> (string) [required]
Whether dead-letter handling is enabled for the queue.
BUILT_INenables it: when a record has been receivedMaxReceiveCounttimes without being acknowledged, it becomes a dead-letter record and ReceiveQueueRecords no longer returns it.NONEdisables it, and an unacknowledged record continues to be redelivered until it is acknowledged or its retention period ends.Possible values:
BUILT_INNONEMaxReceiveCount -> (integer)
The number of times a record can be received without being acknowledged before it becomes a dead-letter record. Required when
TargetTypeisBUILT_IN. A queue that you create withoutDeadLetterConfigurationgets aMaxReceiveCountof 6.Constraints:
- min:
1- max:
1000