View a markdown version of this page

UpdateQueue - Amazon Kinesis Data Streams Service

UpdateQueue

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.

UpdateQueue is an asynchronous operation. Upon receiving an UpdateQueue request, Amazon Kinesis Data Streams sets the QueueStatus to UPDATING, and sets it back to ACTIVE when the update is complete. You can continue to receive and acknowledge records while the queue is UPDATING.

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.

Request Syntax

{ "QueueARN": "string", "QueueAttributes": { "DeadLetterConfiguration": { "MaxReceiveCount": number, "TargetType": "string" }, "VisibilityTimeoutSeconds": number } }

Request Parameters

The request accepts the following data in JSON format.

QueueARN

The ARN of the queue to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws.*:kinesis:.*:\d{12}:queue/\S+

Required: Yes

QueueAttributes

The configuration attributes to apply to the queue. Attributes you do not specify are left unchanged.

Type: QueueAttributes object

Required: Yes

Response Syntax

{ "QueueDescription": { "QueueARN": "string", "QueueAttributes": { "DeadLetterConfiguration": { "MaxReceiveCount": number, "TargetType": "string" }, "VisibilityTimeoutSeconds": number }, "QueueCreationTimestamp": number, "QueueName": "string", "QueueStatus": "string", "StreamConfigurationList": [ { "StartingPosition": { "Timestamp": number, "Type": "string" }, "StreamARN": "string" } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

QueueDescription

A description of the queue, including the updated attributes.

Type: QueueDescription object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

Specifies that you do not have the permissions required to perform this operation.

HTTP Status Code: 400

InternalFailureException

The processing of the request failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

InvalidArgumentException

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

message

A message that provides information about the error.

HTTP Status Code: 400

LimitExceededException

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

message

A message that provides information about the error.

HTTP Status Code: 400

ResourceInUseException

The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

message

A message that provides information about the error.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource could not be found. The stream might not be specified correctly.

message

A message that provides information about the error.

HTTP Status Code: 400

ValidationException

The request failed validation. For example, a parameter value is not valid, a combination of parameters is not supported, or the operation is not supported for the stream's capacity mode. The error message describes the specific reason.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: