{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" }, { "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountIdEndpointMode", "namespace": "*" }, { "id": "RuleSetAwsBuiltIn.AWS::Auth::AccountId", "namespace": "*" } ] }, "shapes": { "com.amazonaws.kinesis#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecords": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsInput" }, "output": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Acknowledges up to 10 dead-letter records in the specified queue, so the\n queue doesn't return them again. The result for each entry is reported individually\n in the response.

\n

Acknowledging a record does not affect the record in the data stream. That record remains available to stream consumers and to other queues on the same stream for the rest of its retention period.

\n

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.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsErrorEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record that was not acknowledged.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.kinesis#ErrorCode", "traits": { "smithy.api#documentation": "

A code identifying the type of failure. One of\n ResourceNotFoundException, InvalidArgumentException,\n ThrottlingException, or InternalFailureException.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the cause of the failure.

" } } }, "traits": { "smithy.api#documentation": "

A dead-letter record that was not acknowledged, and why.

" } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsErrorEntry" } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue whose dead-letter records are acknowledged.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "Entries": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsRequestEntryList", "traits": { "smithy.api#documentation": "

The dead-letter records to acknowledge, identified by their receipt handles.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsOutput": { "type": "structure", "members": { "Successful": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsResultEntryList", "traits": { "smithy.api#documentation": "

The records that were acknowledged.

", "smithy.api#required": {} } }, "Failed": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsErrorEntryList", "traits": { "smithy.api#documentation": "

The records that were not acknowledged, each with the reason the entry failed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsRequestEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record to acknowledge, as returned by\n ReceiveDeadLetterQueueRecords.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A dead-letter record to acknowledge, identified by its receipt handle.

" } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsRequestEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsResultEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record that was acknowledged.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A dead-letter record that was acknowledged.

" } }, "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsResultEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecordsResultEntry" } }, "com.amazonaws.kinesis#AcknowledgeQueueRecords": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsInput" }, "output": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Acknowledges up to 10 records from the specified queue. After a record is acknowledged,\n the queue does not deliver it again. The result for each entry is reported individually in\n the response.

\n

Acknowledging a record does not affect the record in the data stream. That record remains available to stream consumers and to other queues on the same stream for the rest of its retention period.

\n

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.

\n

On rare occasions, you can receive a record again after you acknowledge it. Design your\n queue consumer to be idempotent, so that processing the same record more than once is\n safe.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsErrorEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record that was not acknowledged.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.kinesis#ErrorCode", "traits": { "smithy.api#documentation": "

A code identifying the type of failure. One of\n ResourceNotFoundException, InvalidArgumentException,\n ThrottlingException, or InternalFailureException.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the cause of the failure.

" } } }, "traits": { "smithy.api#documentation": "

A record that was not acknowledged, and why.

" } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsErrorEntry" } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue the records were received from.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "Entries": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsRequestEntryList", "traits": { "smithy.api#documentation": "

The records to acknowledge, identified by their receipt handles.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsOutput": { "type": "structure", "members": { "Successful": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsResultEntryList", "traits": { "smithy.api#documentation": "

The records that were acknowledged.

", "smithy.api#required": {} } }, "Failed": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsErrorEntryList", "traits": { "smithy.api#documentation": "

The records that were not acknowledged, each with the reason the entry failed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsRequestEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record to acknowledge, as returned by\n ReceiveQueueRecords.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A record to acknowledge, identified by its receipt handle.

" } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsRequestEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsResultEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record that was acknowledged.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A record that was acknowledged.

" } }, "com.amazonaws.kinesis#AcknowledgeQueueRecordsResultEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecordsResultEntry" } }, "com.amazonaws.kinesis#AddTagsToStream": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#AddTagsToStreamInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Adds or updates tags for the specified Kinesis data stream. You can assign up to 50\n tags to a data stream.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

If tags have already been assigned to the stream, AddTagsToStream\n overwrites any existing tags that correspond to the specified tag keys.

\n

\n AddTagsToStream has a limit of five transactions per second per\n account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#AddTagsToStreamInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream.

" } }, "Tags": { "target": "com.amazonaws.kinesis#TagMap", "traits": { "smithy.api#documentation": "

A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for AddTagsToStream.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#ApproximateArrivalTimestamp": { "type": "timestamp" }, "com.amazonaws.kinesis#BooleanObject": { "type": "boolean" }, "com.amazonaws.kinesis#BucketARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws[-a-z0-9]*:s3:::[a-z0-9._-]{3,63}$" } }, "com.amazonaws.kinesis#ChannelARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws.*:kinesis:.*:\\d{12}:channel/\\S+$" } }, "com.amazonaws.kinesis#ChannelCountObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.kinesis#ChannelDescription": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.kinesis#ChannelName", "traits": { "smithy.api#documentation": "

The name of the channel.

", "smithy.api#required": {} } }, "ChannelARN": { "target": "com.amazonaws.kinesis#ChannelARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel.

", "smithy.api#required": {} } }, "ChannelId": { "target": "com.amazonaws.kinesis#ChannelId", "traits": { "smithy.api#documentation": "

The unique identifier of the channel.

", "smithy.api#required": {} } }, "ChannelStatus": { "target": "com.amazonaws.kinesis#ChannelStatus", "traits": { "smithy.api#documentation": "

The current status of the channel. Valid values:

\n ", "smithy.api#required": {} } }, "ChannelStatusReason": { "target": "com.amazonaws.kinesis#ChannelStatusReason", "traits": { "smithy.api#documentation": "

A message describing the reason for a FAILED status.

" } }, "ChannelCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the channel was created.

", "smithy.api#required": {} } }, "ServiceExecutionRoleARN": { "target": "com.amazonaws.kinesis#RoleARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

", "smithy.api#required": {} } }, "StreamConfigurationList": { "target": "com.amazonaws.kinesis#ChannelStreamDescriptionList", "traits": { "smithy.api#documentation": "

The source stream configuration for the channel.

", "smithy.api#required": {} } }, "S3DestinationConfiguration": { "target": "com.amazonaws.kinesis#S3DestinationDescription", "traits": { "smithy.api#documentation": "

The configuration for delivery to a general purpose Amazon S3 bucket. Present only when the channel destination is a general purpose Amazon S3 bucket.

" } }, "S3TablesDestinationConfiguration": { "target": "com.amazonaws.kinesis#S3TablesDestinationDescription", "traits": { "smithy.api#documentation": "

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Present only when the channel destination is a streaming table.

" } }, "EncryptionConfiguration": { "target": "com.amazonaws.kinesis#ChannelEncryptionConfiguration", "traits": { "smithy.api#documentation": "

The Amazon Web Services KMS key configuration that Amazon Kinesis Data Streams uses to encrypt data delivered to the channel's destination.

" } }, "LoggingConfiguration": { "target": "com.amazonaws.kinesis#ChannelLoggingConfiguration", "traits": { "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration for the channel.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes the configuration and current status of a channel.

" } }, "com.amazonaws.kinesis#ChannelDestinationType": { "type": "enum", "members": { "S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3" } }, "S3_TABLES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3_TABLES" } } } }, "com.amazonaws.kinesis#ChannelEncryptionConfiguration": { "type": "structure", "members": { "EncryptionType": { "target": "com.amazonaws.kinesis#ChannelEncryptionType", "traits": { "smithy.api#documentation": "

The encryption type. The only valid value is KMS.

", "smithy.api#required": {} } }, "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { "smithy.api#documentation": "

The identifier of the customer managed Amazon Web Services KMS key. You cannot use the Amazon Kinesis Data Streams service key (aws/kinesis).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the Amazon Web Services KMS key that Amazon Kinesis Data Streams uses to encrypt data delivered to the channel's destination.

" } }, "com.amazonaws.kinesis#ChannelEncryptionType": { "type": "enum", "members": { "KMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS" } } } }, "com.amazonaws.kinesis#ChannelId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.kinesis#ChannelLoggingConfiguration": { "type": "structure", "members": { "CloudWatchLogs": { "target": "com.amazonaws.kinesis#CloudWatchLogs", "traits": { "smithy.api#documentation": "

The Amazon CloudWatch Logs settings for the channel.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration for a channel.

" } }, "com.amazonaws.kinesis#ChannelLoggingUpdateInput": { "type": "structure", "members": { "CloudWatchLogs": { "target": "com.amazonaws.kinesis#CloudWatchLogsUpdateInput", "traits": { "smithy.api#documentation": "

The updated Amazon CloudWatch Logs settings, including whether logging is enabled and the target log group and log stream.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The updated Amazon CloudWatch Logs configuration for a channel. Used in UpdateChannel.

" } }, "com.amazonaws.kinesis#ChannelName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesis#ChannelStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.kinesis#ChannelStatusReason": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.kinesis#ChannelStreamConfiguration": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source Kinesis data stream.

", "smithy.api#required": {} } }, "RecordConfiguration": { "target": "com.amazonaws.kinesis#RecordConfiguration", "traits": { "smithy.api#documentation": "

The record format configuration for the source stream.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the source stream and record configuration when creating a channel.

" } }, "com.amazonaws.kinesis#ChannelStreamConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#ChannelStreamConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ChannelStreamDescription": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source Kinesis data stream.

", "smithy.api#required": {} } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the source stream was created.

", "smithy.api#required": {} } }, "RecordConfiguration": { "target": "com.amazonaws.kinesis#RecordConfiguration", "traits": { "smithy.api#documentation": "

The record format configuration for the source stream.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes the source stream of a channel.

" } }, "com.amazonaws.kinesis#ChannelStreamDescriptionList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#ChannelStreamDescription" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ChannelStreamIdentifier": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source Kinesis data stream.

", "smithy.api#required": {} } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the source stream was created.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifies a source stream associated with a channel.

" } }, "com.amazonaws.kinesis#ChannelStreamIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#ChannelStreamIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ChannelSummary": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.kinesis#ChannelName", "traits": { "smithy.api#documentation": "

The name of the channel.

", "smithy.api#required": {} } }, "ChannelARN": { "target": "com.amazonaws.kinesis#ChannelARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel.

", "smithy.api#required": {} } }, "ChannelId": { "target": "com.amazonaws.kinesis#ChannelId", "traits": { "smithy.api#documentation": "

The unique identifier of the channel.

", "smithy.api#required": {} } }, "ChannelStatus": { "target": "com.amazonaws.kinesis#ChannelStatus", "traits": { "smithy.api#documentation": "

The current status of the channel. Valid values:

\n ", "smithy.api#required": {} } }, "ChannelStatusReason": { "target": "com.amazonaws.kinesis#ChannelStatusReason", "traits": { "smithy.api#documentation": "

A message describing the reason for a FAILED status.

" } }, "ChannelCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the channel was created.

", "smithy.api#required": {} } }, "ChannelDestinationType": { "target": "com.amazonaws.kinesis#ChannelDestinationType", "traits": { "smithy.api#documentation": "

The destination type of the channel. Valid values:

\n ", "smithy.api#required": {} } }, "Streams": { "target": "com.amazonaws.kinesis#ChannelStreamIdentifierList", "traits": { "smithy.api#documentation": "

The source streams associated with the channel.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A summary of a channel, returned by ListChannels.

" } }, "com.amazonaws.kinesis#ChannelSummaryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#ChannelSummary" } }, "com.amazonaws.kinesis#ChildShard": { "type": "structure", "members": { "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the existing child shard of the current shard.

", "smithy.api#required": {} } }, "ParentShards": { "target": "com.amazonaws.kinesis#ShardIdList", "traits": { "smithy.api#documentation": "

The current shard that is the parent of the existing child shard.

", "smithy.api#required": {} } }, "HashKeyRange": { "target": "com.amazonaws.kinesis#HashKeyRange", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Output parameter of the GetRecords API. The existing child shard of the current\n shard.

" } }, "com.amazonaws.kinesis#ChildShardList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#ChildShard" } }, "com.amazonaws.kinesis#CloudWatchLogGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" } }, "com.amazonaws.kinesis#CloudWatchLogStreamName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[^:*]*$" } }, "com.amazonaws.kinesis#CloudWatchLogs": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

Specifies whether logging to Amazon CloudWatch Logs is enabled.

", "smithy.api#required": {} } }, "LogGroupName": { "target": "com.amazonaws.kinesis#CloudWatchLogGroupName", "traits": { "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log group. Defaults to /aws/kinesis/{channelName}/{channelId}.

" } }, "LogStreamName": { "target": "com.amazonaws.kinesis#CloudWatchLogStreamName", "traits": { "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log stream. Defaults to DestinationDelivery.

" } } }, "traits": { "smithy.api#documentation": "

The Amazon CloudWatch Logs settings for channel logging.

" } }, "com.amazonaws.kinesis#CloudWatchLogsUpdateInput": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

Specifies whether logging to Amazon CloudWatch Logs is enabled.

", "smithy.api#required": {} } }, "LogGroupName": { "target": "com.amazonaws.kinesis#CloudWatchLogGroupName", "traits": { "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log group.

" } }, "LogStreamName": { "target": "com.amazonaws.kinesis#CloudWatchLogStreamName", "traits": { "smithy.api#documentation": "

The name of the Amazon CloudWatch Logs log stream.

" } } }, "traits": { "smithy.api#documentation": "

The updated Amazon CloudWatch Logs settings for a channel.

" } }, "com.amazonaws.kinesis#Consumer": { "type": "structure", "members": { "ConsumerName": { "target": "com.amazonaws.kinesis#ConsumerName", "traits": { "smithy.api#documentation": "

The name of the consumer is something you choose when you register the\n consumer.

", "smithy.api#required": {} } }, "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", "smithy.api#required": {} } }, "ConsumerStatus": { "target": "com.amazonaws.kinesis#ConsumerStatus", "traits": { "smithy.api#documentation": "

A consumer can't read data while in the CREATING or DELETING\n states.

", "smithy.api#required": {} } }, "ConsumerCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An object that represents the details of the consumer you registered. This type of\n object is returned by RegisterStreamConsumer.

" } }, "com.amazonaws.kinesis#ConsumerARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+$" } }, "com.amazonaws.kinesis#ConsumerCountObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.kinesis#ConsumerDescription": { "type": "structure", "members": { "ConsumerName": { "target": "com.amazonaws.kinesis#ConsumerName", "traits": { "smithy.api#documentation": "

The name of the consumer is something you choose when you register the\n consumer.

", "smithy.api#required": {} } }, "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { "smithy.api#documentation": "

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need\n this ARN to be able to call SubscribeToShard.

\n

If you delete a consumer and then create a new one with the same name, it won't have\n the same ARN. That's because consumer ARNs contain the creation timestamp. This is\n important to keep in mind if you have IAM policies that reference consumer ARNs.

", "smithy.api#required": {} } }, "ConsumerStatus": { "target": "com.amazonaws.kinesis#ConsumerStatus", "traits": { "smithy.api#documentation": "

A consumer can't read data while in the CREATING or DELETING\n states.

", "smithy.api#required": {} } }, "ConsumerCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream with which you registered the consumer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An object that represents the details of a registered consumer. This type of object is\n returned by DescribeStreamConsumer.

" } }, "com.amazonaws.kinesis#ConsumerList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#Consumer" } }, "com.amazonaws.kinesis#ConsumerName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesis#ConsumerStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } } } }, "com.amazonaws.kinesis#CreateChannel": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#CreateChannelInput" }, "output": { "target": "com.amazonaws.kinesis#CreateChannelOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, { "target": "com.amazonaws.kinesis#KMSDisabledException" }, { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a channel that delivers records from a Kinesis data stream to a destination. A channel reads records from the specified stream and writes them to streaming tables on Apache Iceberg (Amazon S3 Tables) or to a general purpose Amazon S3 bucket.

\n

You must specify either S3DestinationConfiguration or S3TablesDestinationConfiguration, but not both.

\n

To use this operation, you must have permission to pass the specified service execution IAM role to Amazon Kinesis Data Streams (the iam:PassRole permission on that role).

\n

Creating a channel is an asynchronous operation. Upon receiving the request, Amazon Kinesis Data Streams returns immediately with the channel in the CREATING state. After provisioning is complete, Amazon Kinesis Data Streams sets the state to ACTIVE. You can use DescribeChannel to check the current state.

\n

This operation is only supported for data streams with the on-demand capacity mode.

\n

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#CreateChannelInput": { "type": "structure", "members": { "ChannelName": { "target": "com.amazonaws.kinesis#ChannelName", "traits": { "smithy.api#documentation": "

The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.

", "smithy.api#required": {} } }, "ServiceExecutionRoleARN": { "target": "com.amazonaws.kinesis#RoleARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

", "smithy.api#required": {} } }, "StreamConfigurationList": { "target": "com.amazonaws.kinesis#ChannelStreamConfigurationList", "traits": { "smithy.api#documentation": "

The source stream configuration for the channel. Currently, one stream is supported per channel.

", "smithy.api#required": {} } }, "S3DestinationConfiguration": { "target": "com.amazonaws.kinesis#S3DestinationConfiguration", "traits": { "smithy.api#documentation": "

The configuration for delivery to a general purpose Amazon S3 bucket. Specify this parameter when S3TablesDestinationConfiguration is not specified.

" } }, "S3TablesDestinationConfiguration": { "target": "com.amazonaws.kinesis#S3TablesDestinationConfiguration", "traits": { "smithy.api#documentation": "

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Specify this parameter when S3DestinationConfiguration is not specified.

" } }, "EncryptionConfiguration": { "target": "com.amazonaws.kinesis#ChannelEncryptionConfiguration", "traits": { "smithy.api#documentation": "

The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.

" } }, "Tags": { "target": "com.amazonaws.kinesis#TagMap", "traits": { "smithy.api#documentation": "

A set of key-value pairs to assign to the channel. A tag consists of a required key and an optional value.

" } }, "LoggingConfiguration": { "target": "com.amazonaws.kinesis#ChannelLoggingConfiguration", "traits": { "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration for the channel.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#CreateChannelOutput": { "type": "structure", "members": { "ChannelDescription": { "target": "com.amazonaws.kinesis#ChannelDescription", "traits": { "smithy.api#documentation": "

The configuration and current status of the channel, including its ARN, destination configuration, and lifecycle state. Immediately after creation, the state is CREATING.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#CreateQueue": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#CreateQueueInput" }, "output": { "target": "com.amazonaws.kinesis#CreateQueueOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a queue on the specified data stream. A queue delivers records from the stream to\n a queue consumer, tracks the delivery state of each record, and redelivers any record that\n is not acknowledged before its visibility timeout expires.

\n

A queue does not extend how long the stream keeps a record. When a record reaches the\n end of the data stream's retention period, the queue stops delivering it.

\n

Your queue consumer calls ReceiveQueueRecords to receive up to 10\n records at a time. After it processes records, it calls\n AcknowledgeQueueRecords so the queue does not deliver them\n again.

\n

Queues are supported only on data streams in on-demand capacity mode.

\n

Creating a queue does not change how producers write to the stream, and it does not change\n how existing stream consumers read from it. A queue counts as a registered consumer on the\n stream and shares the stream's registered consumer limit with enhanced fan-out\n consumers: 20 on On-demand Standard and 50 on On-demand Advantage.

\n

Use StartingPosition to set the position in the stream where delivery\n begins. The default is LATEST.

\n

\n CreateQueue is an asynchronous operation. Upon receiving a\n CreateQueue request, Amazon Kinesis Data Streams immediately returns a queue\n description with a QueueStatus of CREATING. After the queue is\n created, Kinesis Data Streams sets the QueueStatus to ACTIVE.\n You can begin receiving records after the queue is ACTIVE. Use\n DescribeQueue to check the status of the queue.

\n

Each queue has built-in dead-letter handling. When a record has been received\n MaxReceiveCount times without being acknowledged, it becomes a dead-letter\n record, and ReceiveQueueRecords no longer returns it. You work with\n dead-letter records through a separate set of operations that use the same queue ARN: ReceiveDeadLetterQueueRecords,\n AcknowledgeDeadLetterQueueRecords,\n UpdateDeadLetterQueueRecordsVisibility, and\n RestoreDeadLetterQueueRecords.

\n

Dead-letter handling is enabled by default, with a MaxReceiveCount of 6. To\n use a different value, or to turn dead-letter handling off, specify\n DeadLetterConfiguration in QueueAttributes.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#CreateQueueInput": { "type": "structure", "members": { "QueueName": { "target": "com.amazonaws.kinesis#QueueName", "traits": { "smithy.api#documentation": "

A name for the queue. The name is scoped to the Amazon Web Services account and Region\n used by the request, so two queues in different accounts, or in the same account and\n different Regions, can have the same name.

", "smithy.api#required": {} } }, "StreamConfigurationList": { "target": "com.amazonaws.kinesis#QueueStreamConfigurationList", "traits": { "smithy.api#documentation": "

The data stream the queue delivers records from, and the position in that stream\n where delivery begins. The list must contain exactly one entry, because a queue\n delivers records from a single data stream.

", "smithy.api#required": {} } }, "QueueAttributes": { "target": "com.amazonaws.kinesis#QueueAttributes", "traits": { "smithy.api#documentation": "

The configuration attributes for the queue, including its visibility timeout and its\n dead-letter handling configuration.

" } }, "Tags": { "target": "com.amazonaws.kinesis#TagMap", "traits": { "smithy.api#documentation": "

A set of up to 50 key-value pairs to apply to the queue. You can also add, change, and\n remove tags after the queue is created with TagResource and\n UntagResource.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#CreateQueueOutput": { "type": "structure", "members": { "QueueDescription": { "target": "com.amazonaws.kinesis#QueueDescription", "traits": { "smithy.api#documentation": "

A description of the queue that was created.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#CreateStream": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#CreateStreamInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput.

\n

If you'd still like to proactively scale your on-demand data stream\u2019s capacity, you can unlock the warm throughput feature for on-demand data streams by enabling MinimumThroughputBillingCommitment for your account. Once your account has MinimumThroughputBillingCommitment enabled, you can specify the warm throughput in MiB per second that your stream can support in writes.

\n

For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard or on-demand throughput limits for an Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

\n

You can add tags to the stream when making a CreateStream request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:CreateStream permission, you must also have the kinesis:AddTagsToStream permission for the stream that will be created. The kinesis:TagResource permission won\u2019t work to tag streams on creation. Tags will take effect from the CREATING status of the stream, but you can't make any updates to the tags until the stream is in ACTIVE state.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#CreateStreamInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

A name to identify the stream. The stream name is scoped to the Amazon Web Services\n account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts\n can have the same name. Two streams in the same Amazon Web Services account but in two\n different Regions can also have the same name.

", "smithy.api#required": {} } }, "ShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { "smithy.api#documentation": "

The number of shards that the stream will use. The throughput of the stream is a\n function of the number of shards; more shards are required for greater provisioned\n throughput.

" } }, "StreamModeDetails": { "target": "com.amazonaws.kinesis#StreamModeDetails", "traits": { "smithy.api#documentation": "

Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,\n you can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data\n streams.

" } }, "Tags": { "target": "com.amazonaws.kinesis#TagMap", "traits": { "smithy.api#documentation": "

A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.

" } }, "WarmThroughputMiBps": { "target": "com.amazonaws.kinesis#NaturalIntegerObject", "traits": { "smithy.api#documentation": "

The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.

" } }, "MaxRecordSizeInKiB": { "target": "com.amazonaws.kinesis#MaxRecordSizeInKiB", "traits": { "smithy.api#documentation": "

The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

" } }, "RecordDistributionStrategy": { "target": "com.amazonaws.kinesis#RecordDistributionStrategy", "traits": { "smithy.api#documentation": "

The record distribution strategy for the stream, which determines how Amazon Kinesis\n Data Streams distributes records across shards. Specify one of the following\n values:

\n \n

The record distribution strategy is only supported for streams that use the on-demand\n capacity mode. If you do not specify this parameter, the stream uses\n USER_PARTITION_KEY.

" } } }, "traits": { "smithy.api#documentation": "

Represents the input for CreateStream.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#Data": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 10485760 } } }, "com.amazonaws.kinesis#DataFreshnessInSeconds": { "type": "integer" }, "com.amazonaws.kinesis#DeadLetterConfiguration": { "type": "structure", "members": { "TargetType": { "target": "com.amazonaws.kinesis#TargetType", "traits": { "smithy.api#documentation": "

Whether dead-letter handling is enabled for the queue. BUILT_IN enables it:\n when a record has been received MaxReceiveCount times without being\n acknowledged, it becomes a dead-letter record and ReceiveQueueRecords no\n longer returns it. NONE disables it, and an unacknowledged record continues to\n be redelivered until it is acknowledged or its retention period ends.

", "smithy.api#required": {} } }, "MaxReceiveCount": { "target": "com.amazonaws.kinesis#MaxReceiveCount", "traits": { "smithy.api#documentation": "

The number of times a record can be received without being acknowledged before it\n becomes a dead-letter record. Required when TargetType is\n BUILT_IN. A queue that you create without\n DeadLetterConfiguration gets a MaxReceiveCount of 6.

" } } }, "traits": { "smithy.api#documentation": "

The dead-letter handling configuration for a queue. Each queue has built-in dead-letter\n handling. When a record has been received MaxReceiveCount times without being\n acknowledged, it becomes a dead-letter record, and ReceiveQueueRecords no\n longer returns it. The dead-letter record stays in the same queue, and you work with it\n through ReceiveDeadLetterQueueRecords,\n AcknowledgeDeadLetterQueueRecords,\n UpdateDeadLetterQueueRecordsVisibility, and\n RestoreDeadLetterQueueRecords, which use the same queue ARN.

\n

Dead-letter handling is enabled by default, with a MaxReceiveCount of 6. To\n use a different value, or to turn dead-letter handling off, specify this configuration in\n QueueAttributes.

" } }, "com.amazonaws.kinesis#DeadLetterQueueS3Configuration": { "type": "structure", "members": { "BucketARN": { "target": "com.amazonaws.kinesis#BucketARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dead-letter queue Amazon S3 bucket.

", "smithy.api#required": {} } }, "ExpectedBucketOwner": { "target": "com.amazonaws.kinesis#ExpectedBucketOwner", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID of the expected owner of the dead-letter queue bucket.

", "smithy.api#required": {} } }, "ErrorOutputPrefix": { "target": "com.amazonaws.kinesis#S3ErrorOutputPrefix", "traits": { "smithy.api#documentation": "

The Amazon S3 key prefix for error records.

" } } }, "traits": { "smithy.api#documentation": "

The Amazon S3 dead-letter queue configuration for records that cannot be delivered.

" } }, "com.amazonaws.kinesis#DecreaseStreamRetentionPeriod": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DecreaseStreamRetentionPeriodInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Decreases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The minimum value of a\n stream's retention period is 24 hours.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

This operation may result in lost data. For example, if the stream's retention period\n is 48 hours and is decreased to 24 hours, any data already in the stream that is older\n than 24 hours is inaccessible.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DecreaseStreamRetentionPeriodInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to modify.

" } }, "RetentionPeriodHours": { "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be less than the current\n retention period.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for DecreaseStreamRetentionPeriod.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#DeleteChannel": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DeleteChannelInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified channel. Deleting a channel stops delivery from the source stream to the destination. Data already delivered to the destination is not deleted.

\n

A stream cannot be deleted while it has active channels. Use ListChannels with a stream filter to find the channels attached to a stream before deleting it.

\n

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DeleteChannelInput": { "type": "structure", "members": { "ChannelARN": { "target": "com.amazonaws.kinesis#ChannelARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel to delete.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ChannelARN" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DeleteQueue": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DeleteQueueInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified queue. Records that are in flight when you delete the queue are not\n delivered again, and receipt handles issued by the queue stop being valid.

\n

Deleting a queue does not delete the data stream the queue was created on, and does not\n delete any records in that stream. Those records remain available to stream consumers and\n to other queues on the same stream for the rest of their retention period.

\n

\n DeleteQueue is an asynchronous operation. Upon receiving a\n DeleteQueue request, Amazon Kinesis Data Streams sets the\n QueueStatus to DELETING. The queue is deleted when the operation\n completes. A queue in the DELETING state does not deliver records.

\n

You must delete every queue on a data stream before you can delete the stream, or switch\n it from on-demand to provisioned capacity mode.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DeleteQueueInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue to delete.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DeleteResourcePolicyInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a policy for the specified data stream, consumer, or queue. Request patterns can be one of the following:

\n ", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DeleteResourcePolicyInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.kinesis#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data stream, a queue, or an enhanced fan-out\n consumer.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DeleteStream": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DeleteStreamInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes a Kinesis data stream and all its shards and data. You must shut down any\n applications that are operating on the stream before you delete the stream. If an\n application attempts to operate on a deleted stream, it receives the exception\n ResourceNotFoundException.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

If the stream is in the ACTIVE state, you can delete it. After a\n DeleteStream request, the specified stream is in the\n DELETING state until Kinesis Data Streams completes the\n deletion.

\n

\n Note: Kinesis Data Streams might continue to accept\n data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the\n DELETING state until the stream deletion is complete.

\n

When you delete a stream, any shards in that stream are also deleted, and any tags are\n dissociated from the stream.

\n

Before you can delete a data stream that has queues, you must delete every queue on the stream with DeleteQueue.

\n

You can use the DescribeStreamSummary operation to check the state\n of the stream, which is returned in StreamStatus.

\n

\n DeleteStream has a limit of five transactions per second per\n account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DeleteStreamInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to delete.

" } }, "EnforceConsumerDeletion": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

If this parameter is unset (null) or if you set it to false,\n and the stream has registered enhanced fan-out consumers, the call to\n DeleteStream fails\n with a ResourceInUseException.

\n

If you set it to true, DeleteStream deletes the stream and\n every consumer registered with it.

\n

This parameter does not apply to queues. A stream that has queues cannot be deleted\n until every queue on it is deleted with DeleteQueue, whatever this\n parameter is set to.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for DeleteStream.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#DeregisterStreamConsumer": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DeregisterStreamConsumerInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of\n the data stream and the name you gave the consumer when you registered it. You may also\n provide all three parameters, as long as they don't conflict with each other. If you\n don't know the name or ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of\n all the consumers that are currently registered with a given data stream. The\n description of a consumer contains its name and ARN.

\n

This operation has a limit of five transactions per second per stream.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DeregisterStreamConsumerInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "ConsumerName": { "target": "com.amazonaws.kinesis#ConsumerName", "traits": { "smithy.api#documentation": "

The name that you gave to the consumer.

" } }, "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer. If you\n don't know the ARN of the consumer that you want to deregister, you can use the\n ListStreamConsumers operation to get a list of the descriptions of all the consumers\n that are currently registered with a given data stream. The description of a consumer\n contains its ARN.

", "smithy.rules#contextParam": { "name": "ConsumerARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DescribeAccountSettingsInput" }, "output": { "target": "com.amazonaws.kinesis#DescribeAccountSettingsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#LimitExceededException" } ], "traits": { "smithy.api#documentation": "

Describes the account-level settings for Amazon Kinesis Data Streams. This operation returns information about the minimum throughput billing commitments and other account-level configurations.

\n

This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DescribeAccountSettingsInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeAccountSettingsOutput": { "type": "structure", "members": { "MinimumThroughputBillingCommitment": { "target": "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentOutput", "traits": { "smithy.api#documentation": "

The current configuration of the minimum throughput billing commitment for your Amazon Web Services account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#DescribeChannel": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DescribeChannelInput" }, "output": { "target": "com.amazonaws.kinesis#DescribeChannelOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes the specified channel, including its configuration and current status.

\n

Use this operation to verify that a channel reached the ACTIVE state after creation, or to diagnose a channel in the FAILED state by reading the ChannelStatusReason.

\n

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

", "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } }, "smithy.waiters#waitable": { "ChannelActive": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "ChannelDescription.ChannelStatus", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "ChannelDescription.ChannelStatus", "expected": "CREATING", "comparator": "stringEquals" } } }, { "state": "retry", "matcher": { "output": { "path": "ChannelDescription.ChannelStatus", "expected": "UPDATING", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ChannelDescription.ChannelStatus", "expected": "DELETING", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "ChannelDescription.ChannelStatus", "expected": "FAILED", "comparator": "stringEquals" } } } ], "minDelay": 10 } } } }, "com.amazonaws.kinesis#DescribeChannelInput": { "type": "structure", "members": { "ChannelARN": { "target": "com.amazonaws.kinesis#ChannelARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel to describe.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ChannelARN" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeChannelOutput": { "type": "structure", "members": { "ChannelDescription": { "target": "com.amazonaws.kinesis#ChannelDescription", "traits": { "smithy.api#documentation": "

The configuration and current status of the channel, including its ARN, source stream, destination configuration, and lifecycle state.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#DescribeLimits": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DescribeLimitsInput" }, "output": { "target": "com.amazonaws.kinesis#DescribeLimitsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#LimitExceededException" } ], "traits": { "smithy.api#documentation": "

Describes the shard limits and usage for the account.

\n

If you update your account limits, the old limits might be returned for a few\n minutes.

\n

This operation has a limit of one transaction per second per account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DescribeLimitsInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeLimitsOutput": { "type": "structure", "members": { "ShardLimit": { "target": "com.amazonaws.kinesis#ShardCountObject", "traits": { "smithy.api#documentation": "

The maximum number of shards.

", "smithy.api#required": {} } }, "OpenShardCount": { "target": "com.amazonaws.kinesis#ShardCountObject", "traits": { "smithy.api#documentation": "

The number of open shards.

", "smithy.api#required": {} } }, "OnDemandStreamCount": { "target": "com.amazonaws.kinesis#OnDemandStreamCountObject", "traits": { "smithy.api#documentation": "

Indicates the number of data streams with the on-demand capacity mode.

", "smithy.api#required": {} } }, "OnDemandStreamCountLimit": { "target": "com.amazonaws.kinesis#OnDemandStreamCountLimitObject", "traits": { "smithy.api#documentation": "

The maximum number of data streams with the on-demand capacity mode.

", "smithy.api#required": {} } }, "ChannelCount": { "target": "com.amazonaws.kinesis#ChannelCountObject", "traits": { "smithy.api#documentation": "

The number of channels in the account.

" } }, "ChannelCountLimit": { "target": "com.amazonaws.kinesis#ChannelCountObject", "traits": { "smithy.api#documentation": "

The maximum number of channels allowed in the account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#DescribeQueue": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DescribeQueueInput" }, "output": { "target": "com.amazonaws.kinesis#DescribeQueueOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a description of the specified queue, including its status, the data stream it\n delivers records from, and its configuration attributes.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DescribeQueueInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue to describe.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeQueueOutput": { "type": "structure", "members": { "QueueDescription": { "target": "com.amazonaws.kinesis#QueueDescription", "traits": { "smithy.api#documentation": "

A description of the queue.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#DescribeStream": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DescribeStreamInput" }, "output": { "target": "com.amazonaws.kinesis#DescribeStreamOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Describes the specified Kinesis data stream.

\n \n

This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the\n specified Kinesis data stream and the ListShards API to list the\n shards in a specified data stream and obtain information about each shard.

\n
\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

The information returned includes the stream name, Amazon Resource Name (ARN),\n creation time, enhanced metric configuration, and shard map. The shard map is an array\n of shard objects. For each shard object, there is the hash key and sequence number\n ranges that the shard spans, and the IDs of any earlier shards that played in a role in\n creating the shard. Every record ingested in the stream is identified by a sequence\n number, which is assigned when the record is put into the stream.

\n

You can limit the number of shards returned by each call. For more information, see\n Retrieving\n Shards from a Stream in the Amazon Kinesis Data Streams Developer\n Guide.

\n

There are no guarantees about the chronological order shards returned. To process\n shards in chronological order, use the ID of the parent shard to track the lineage to\n the oldest shard.

\n

This operation has a limit of 10 transactions per second per account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } }, "smithy.test#smokeTests": [ { "id": "DescribeStreamFailure", "params": { "StreamName": "bogus-stream-name" }, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "failure": {} } } ], "smithy.waiters#waitable": { "StreamExists": { "acceptors": [ { "state": "success", "matcher": { "output": { "path": "StreamDescription.StreamStatus", "expected": "ACTIVE", "comparator": "stringEquals" } } } ], "minDelay": 10 }, "StreamNotExists": { "acceptors": [ { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } } ], "minDelay": 10 } } } }, "com.amazonaws.kinesis#DescribeStreamConsumer": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DescribeStreamConsumerInput" }, "output": { "target": "com.amazonaws.kinesis#DescribeStreamConsumerOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

To get the description of a registered consumer, provide the ARN of the consumer.\n Alternatively, you can provide the ARN of the data stream and the name you gave the\n consumer when you registered it. You may also provide all three parameters, as long as\n they don't conflict with each other. If you don't know the name or ARN of the consumer\n that you want to describe, you can use the ListStreamConsumers\n operation to get a list of the descriptions of all the consumers that are currently\n registered with a given data stream.

\n

This operation has a limit of 20 transactions per second per stream.

\n \n

When making a cross-account call with DescribeStreamConsumer, make sure to provide the ARN of the consumer.

\n
", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DescribeStreamConsumerInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis data stream that the consumer is registered with. For more\n information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "ConsumerName": { "target": "com.amazonaws.kinesis#ConsumerName", "traits": { "smithy.api#documentation": "

The name that you gave to the consumer.

" } }, "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { "smithy.api#documentation": "

The ARN returned by Kinesis Data Streams when you registered the consumer.

", "smithy.rules#contextParam": { "name": "ConsumerARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeStreamConsumerOutput": { "type": "structure", "members": { "ConsumerDescription": { "target": "com.amazonaws.kinesis#ConsumerDescription", "traits": { "smithy.api#documentation": "

An object that represents the details of the consumer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#DescribeStreamInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to describe.

" } }, "Limit": { "target": "com.amazonaws.kinesis#DescribeStreamInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of shards to return in a single call. The default value is 100. If\n you specify a value greater than 100, at most 100 results are returned.

" } }, "ExclusiveStartShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the shard to start with.

\n

Specify this parameter to indicate that you want to describe the stream starting with\n the shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior for\n DescribeStream is to describe the stream starting with the first shard\n in the stream.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for DescribeStream.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeStreamInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#DescribeStreamOutput": { "type": "structure", "members": { "StreamDescription": { "target": "com.amazonaws.kinesis#StreamDescription", "traits": { "smithy.api#documentation": "

The current status of the stream, the stream Amazon Resource Name (ARN), an array of\n shard objects that comprise the stream, and whether there are more shards\n available.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Represents the output for DescribeStream.

", "smithy.api#output": {} } }, "com.amazonaws.kinesis#DescribeStreamSummary": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DescribeStreamSummaryInput" }, "output": { "target": "com.amazonaws.kinesis#DescribeStreamSummaryOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Provides a summarized description of the specified Kinesis data stream without the\n shard list.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

The information returned includes the stream name, Amazon Resource Name (ARN), status,\n record retention period, approximate creation time, monitoring, encryption details, and\n open shard count.

\n

\n DescribeStreamSummary has a limit of 20 transactions per second per\n account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DescribeStreamSummaryInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to describe.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#DescribeStreamSummaryOutput": { "type": "structure", "members": { "StreamDescriptionSummary": { "target": "com.amazonaws.kinesis#StreamDescriptionSummary", "traits": { "smithy.api#documentation": "

A StreamDescriptionSummary containing information about the\n stream.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#DisableEnhancedMonitoring": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#DisableEnhancedMonitoringInput" }, "output": { "target": "com.amazonaws.kinesis#EnhancedMonitoringOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Disables enhanced monitoring.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#DisableEnhancedMonitoringInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the Kinesis data stream for which to disable enhanced monitoring.

" } }, "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { "smithy.api#documentation": "

List of shard-level metrics to disable.

\n

The following are the valid shard-level metrics. The value \"ALL\" disables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for DisableEnhancedMonitoring.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#DryRunOperationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The request was rejected because the DryRun parameter was specified.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#EnableEnhancedMonitoring": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#EnableEnhancedMonitoringInput" }, "output": { "target": "com.amazonaws.kinesis#EnhancedMonitoringOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#EnableEnhancedMonitoringInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream for which to enable enhanced monitoring.

" } }, "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { "smithy.api#documentation": "

List of shard-level metrics to enable.

\n

The following are the valid shard-level metrics. The value \"ALL\" enables\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for EnableEnhancedMonitoring.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#EncryptionType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "KMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS" } } } }, "com.amazonaws.kinesis#EnhancedMetrics": { "type": "structure", "members": { "ShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { "smithy.api#documentation": "

List of shard-level metrics.

\n

The following are the valid shard-level metrics. The value \"ALL\" enhances\n every metric.

\n \n

For more information, see Monitoring the Amazon\n Kinesis Data Streams Service with Amazon CloudWatch in the Amazon\n Kinesis Data Streams Developer Guide.

" } } }, "traits": { "smithy.api#documentation": "

Represents enhanced metrics types.

" } }, "com.amazonaws.kinesis#EnhancedMonitoringList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#EnhancedMetrics" } }, "com.amazonaws.kinesis#EnhancedMonitoringOutput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the Kinesis data stream.

" } }, "CurrentShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { "smithy.api#documentation": "

Represents the current state of the metrics that are in the enhanced state before the\n operation.

" } }, "DesiredShardLevelMetrics": { "target": "com.amazonaws.kinesis#MetricsNameList", "traits": { "smithy.api#documentation": "

Represents the list of all the metrics that would be in the enhanced state after the\n operation.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

" } }, "com.amazonaws.kinesis#ErrorCode": { "type": "string" }, "com.amazonaws.kinesis#ErrorMessage": { "type": "string" }, "com.amazonaws.kinesis#ExpectedBucketOwner": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.kinesis#ExpiredIteratorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The provided iterator exceeds the maximum age allowed.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#ExpiredNextTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

The pagination token passed to the operation is expired.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#FirstReceiveTimestamp": { "type": "timestamp" }, "com.amazonaws.kinesis#GSRSchemaARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^arn:aws[-a-z0-9]*:glue:[-a-z0-9]+:\\d{12}:schema/[-a-zA-Z0-9_$#.]+/[-a-zA-Z0-9_$#.]+$" } }, "com.amazonaws.kinesis#GetRecords": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#GetRecordsInput" }, "output": { "target": "com.amazonaws.kinesis#GetRecordsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#DryRunOperationException" }, { "target": "com.amazonaws.kinesis#ExpiredIteratorException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, { "target": "com.amazonaws.kinesis#KMSDisabledException" }, { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, { "target": "com.amazonaws.kinesis#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Gets data records from a Kinesis data stream's shard.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

Specify a shard iterator using the ShardIterator parameter. The shard\n iterator specifies the position in the shard from which you want to start reading data\n records sequentially. If there are no records available in the portion of the shard that\n the iterator points to, GetRecords returns an empty list. It might\n take multiple calls to get to a portion of the shard that contains records.

\n

You can scale by provisioning multiple shards per stream while considering service\n limits (for more information, see Amazon Kinesis Data Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide). Your application should have one thread per shard, each reading\n continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the\n shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in\n NextShardIterator. Specify the shard iterator returned in\n NextShardIterator in subsequent calls to GetRecords.\n If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator.\n You can terminate the loop when the shard is closed, or when the shard iterator reaches\n the record with the sequence number or other attribute that marks it as the last record\n to process.

\n

Each data record can be up to 1 MiB in size by default. Amazon Kinesis Data Streams supports \n large records up to 10 MiB in size, but the average throughput for your stream cannot exceed \n 1 MiB per second. For more information about how large records are handled, see \n Large records. \n Each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed \n the maximum supported size or throughput by using the Limit parameter to \n specify the maximum number of records that GetRecords can return. \n Consider your average record size when determining this limit. The maximum number of records \n that can be returned per call is 10,000.

\n

The size of the data returned by GetRecords varies depending on the\n utilization of the shard. It is recommended that consumer applications retrieve records\n via the GetRecords command using the 5 TPS limit to remain caught up.\n Retrieving records less frequently can lead to consumer applications falling behind. The\n maximum size of data that GetRecords can return is 10 MiB. If a call\n returns this amount of data, subsequent calls made within the next 5 seconds throw\n ProvisionedThroughputExceededException. If there is insufficient\n provisioned throughput on the stream, subsequent calls made within the next 1 second\n throw ProvisionedThroughputExceededException. GetRecords\n doesn't return any data when it throws an exception. For this reason, we recommend that\n you wait 1 second between calls to GetRecords. However, it's possible\n that the application will get exceptions for longer than 1 second.

\n

To detect whether the application is falling behind in processing, you can use the\n MillisBehindLatest response attribute. You can also monitor the stream\n using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon\n Kinesis Data Streams Developer Guide).

\n

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp,\n that is set when a stream successfully receives and stores a record. This is commonly\n referred to as a server-side time stamp, whereas a client-side time stamp is set when a\n data producer creates or sends the record to a stream (a data producer is any data\n source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time\n stamp accuracy, or that the time stamp is always increasing. For example, records in a\n shard or across a stream might have time stamps that are out of order.

\n

This operation has a limit of five transactions per second per shard.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#GetRecordsInput": { "type": "structure", "members": { "ShardIterator": { "target": "com.amazonaws.kinesis#ShardIterator", "traits": { "smithy.api#documentation": "

The position in the shard from which you want to start sequentially reading data\n records. A shard iterator specifies this position using the sequence number of a data\n record in the shard.

", "smithy.api#required": {} } }, "Limit": { "target": "com.amazonaws.kinesis#GetRecordsInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of records to return. Specify a value of up to 10,000. If you\n specify a value that is greater than 10,000, GetRecords throws\n InvalidArgumentException. The default value is 10,000.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "DryRun": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

Checks if your request will succeed. DryRun is an optional\n parameter.

" } } }, "traits": { "smithy.api#documentation": "

Represents the input for GetRecords.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#GetRecordsInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#GetRecordsOutput": { "type": "structure", "members": { "Records": { "target": "com.amazonaws.kinesis#RecordList", "traits": { "smithy.api#documentation": "

The data records retrieved from the shard.

", "smithy.api#required": {} } }, "NextShardIterator": { "target": "com.amazonaws.kinesis#ShardIterator", "traits": { "smithy.api#documentation": "

The next position in the shard from which to start sequentially reading data records.\n If set to null, the shard has been closed and the requested iterator does\n not return any more data.

" } }, "MillisBehindLatest": { "target": "com.amazonaws.kinesis#MillisBehindLatest", "traits": { "smithy.api#documentation": "

The number of milliseconds the GetRecords response is from the tip\n of the stream, indicating how far behind current time the consumer is. A value of zero\n indicates that record processing is caught up, and there are no new records to process\n at this moment.

" } }, "ChildShards": { "target": "com.amazonaws.kinesis#ChildShardList", "traits": { "smithy.api#documentation": "

The list of the current shard's child shards, returned in the GetRecords\n API's response only when the end of the current shard is reached.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output for GetRecords.

", "smithy.api#output": {} } }, "com.amazonaws.kinesis#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#GetResourcePolicyInput" }, "output": { "target": "com.amazonaws.kinesis#GetResourcePolicyOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a policy attached to the specified data stream, consumer, or queue. Request patterns can be one of the following:

\n ", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#GetResourcePolicyInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.kinesis#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data stream, a queue, or an enhanced fan-out\n consumer.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#GetResourcePolicyOutput": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.kinesis#Policy", "traits": { "smithy.api#documentation": "

Details of the resource policy. This is formatted as a JSON string.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#GetShardIterator": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#GetShardIteratorInput" }, "output": { "target": "com.amazonaws.kinesis#GetShardIteratorOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#DryRunOperationException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is\n returned to the requester.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

A shard iterator specifies the shard position from which to start reading data records\n sequentially. The position is specified using the sequence number of a data record in a\n shard. A sequence number is the identifier associated with every record ingested in the\n stream, and is assigned when a record is put into the stream. Each stream has one or\n more shards.

\n

You must specify the shard iterator type. For example, you can set the\n ShardIteratorType parameter to read exactly from the position denoted\n by a specific sequence number by using the AT_SEQUENCE_NUMBER shard\n iterator type. Alternatively, the parameter can read right after the sequence number by\n using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers\n returned by earlier calls to PutRecord, PutRecords,\n GetRecords, or DescribeStream. In the request,\n you can specify the shard iterator type AT_TIMESTAMP to read records from\n an arbitrary point in time, TRIM_HORIZON to cause\n ShardIterator to point to the last untrimmed record in the shard in the\n system (the oldest data record in the shard), or LATEST so that you always\n read the most recent data in the shard.

\n

When you read repeatedly from a stream, use a GetShardIterator\n request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard\n iterator is returned by every GetRecords request in\n NextShardIterator, which you use in the ShardIterator\n parameter of the next GetRecords request.

\n

If a GetShardIterator request is made too often, you receive a\n ProvisionedThroughputExceededException. For more information about\n throughput limits, see GetRecords, and Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide.

\n

If the shard is closed, GetShardIterator returns a valid iterator\n for the last sequence number of the shard. A shard can be closed as a result of using\n SplitShard or MergeShards.

\n

\n GetShardIterator has a limit of five transactions per second per\n account per open shard.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#GetShardIteratorInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the Amazon Kinesis data stream.

" } }, "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the Kinesis Data Streams shard to get the iterator for.

", "smithy.api#required": {} } }, "ShardIteratorType": { "target": "com.amazonaws.kinesis#ShardIteratorType", "traits": { "smithy.api#documentation": "

Determines how the shard iterator is used to start reading data records from the\n shard.

\n

The following are the valid Amazon Kinesis shard iterator types:

\n ", "smithy.api#required": {} } }, "StartingSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

The sequence number of the data record in the shard from which to start reading. Used\n with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

" } }, "Timestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time stamp of the data record from which to start reading. Used with shard\n iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in\n milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or\n 1459799926.480. If a record with this exact time stamp does not exist,\n the iterator returned is for the next (later) record. If the time stamp is older than\n the current trim horizon, the iterator returned is for the oldest untrimmed data record\n (TRIM_HORIZON).

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "DryRun": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

Checks if your request will succeed. DryRun is an optional\n parameter.

" } } }, "traits": { "smithy.api#documentation": "

Represents the input for GetShardIterator.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#GetShardIteratorOutput": { "type": "structure", "members": { "ShardIterator": { "target": "com.amazonaws.kinesis#ShardIterator", "traits": { "smithy.api#documentation": "

The position in the shard from which to start reading data records sequentially. A\n shard iterator specifies this position using the sequence number of a data record in a\n shard.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output for GetShardIterator.

", "smithy.api#output": {} } }, "com.amazonaws.kinesis#HashKey": { "type": "string", "traits": { "smithy.api#pattern": "^(0|([1-9]\\d{0,38}))$" } }, "com.amazonaws.kinesis#HashKeyRange": { "type": "structure", "members": { "StartingHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { "smithy.api#documentation": "

The starting hash key of the hash key range.

", "smithy.api#required": {} } }, "EndingHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { "smithy.api#documentation": "

The ending hash key of the hash key range.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The range of possible hash key values for the shard, which is a set of ordered\n contiguous positive integers.

" } }, "com.amazonaws.kinesis#IncreaseStreamRetentionPeriod": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#IncreaseStreamRetentionPeriodInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Increases the Kinesis data stream's retention period, which is the length of time data\n records are accessible after they are added to the stream. The maximum value of a\n stream's retention period is 8760 hours (365 days).

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

If you choose a longer stream retention period, this operation increases the time\n period during which records that have not yet expired are accessible. However, it does\n not make previous, expired data (older than the stream's previous retention period)\n accessible after the operation has been called. For example, if a stream's retention\n period is set to 24 hours and is increased to 168 hours, any data that is older than 24\n hours remains inaccessible to consumer applications.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#IncreaseStreamRetentionPeriodInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to modify.

" } }, "RetentionPeriodHours": { "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { "smithy.api#documentation": "

The new retention period of the stream, in hours. Must be more than the current\n retention period.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for IncreaseStreamRetentionPeriod.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#InternalFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server" } }, "com.amazonaws.kinesis#InvalidArgumentException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#KMSAccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The ciphertext references a key that doesn't exist or that you don't have access\n to.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#KMSDisabledException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The request was rejected because the specified KMS key isn't\n enabled.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#KMSInvalidStateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The request was rejected because the state of the specified resource isn't valid for\n this request. For more information, see How Key State Affects Use of a\n Customer Master Key in the Amazon Web Services Key Management\n Service Developer Guide.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#KMSNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The request was rejected because the specified entity or resource can't be\n found.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#KMSOptInRequired": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The Amazon Web Services access key ID needs a subscription for the service.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#KMSThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The request was denied due to request throttling. For more information about\n throttling, see Limits in\n the Amazon Web Services Key Management Service Developer\n Guide.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#KeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.kinesis#Kinesis_20131202": { "type": "service", "version": "2013-12-02", "operations": [ { "target": "com.amazonaws.kinesis#AcknowledgeDeadLetterQueueRecords" }, { "target": "com.amazonaws.kinesis#AcknowledgeQueueRecords" }, { "target": "com.amazonaws.kinesis#AddTagsToStream" }, { "target": "com.amazonaws.kinesis#CreateChannel" }, { "target": "com.amazonaws.kinesis#CreateQueue" }, { "target": "com.amazonaws.kinesis#CreateStream" }, { "target": "com.amazonaws.kinesis#DecreaseStreamRetentionPeriod" }, { "target": "com.amazonaws.kinesis#DeleteChannel" }, { "target": "com.amazonaws.kinesis#DeleteQueue" }, { "target": "com.amazonaws.kinesis#DeleteResourcePolicy" }, { "target": "com.amazonaws.kinesis#DeleteStream" }, { "target": "com.amazonaws.kinesis#DeregisterStreamConsumer" }, { "target": "com.amazonaws.kinesis#DescribeAccountSettings" }, { "target": "com.amazonaws.kinesis#DescribeChannel" }, { "target": "com.amazonaws.kinesis#DescribeLimits" }, { "target": "com.amazonaws.kinesis#DescribeQueue" }, { "target": "com.amazonaws.kinesis#DescribeStream" }, { "target": "com.amazonaws.kinesis#DescribeStreamConsumer" }, { "target": "com.amazonaws.kinesis#DescribeStreamSummary" }, { "target": "com.amazonaws.kinesis#DisableEnhancedMonitoring" }, { "target": "com.amazonaws.kinesis#EnableEnhancedMonitoring" }, { "target": "com.amazonaws.kinesis#GetRecords" }, { "target": "com.amazonaws.kinesis#GetResourcePolicy" }, { "target": "com.amazonaws.kinesis#GetShardIterator" }, { "target": "com.amazonaws.kinesis#IncreaseStreamRetentionPeriod" }, { "target": "com.amazonaws.kinesis#ListChannels" }, { "target": "com.amazonaws.kinesis#ListQueues" }, { "target": "com.amazonaws.kinesis#ListShards" }, { "target": "com.amazonaws.kinesis#ListStreamConsumers" }, { "target": "com.amazonaws.kinesis#ListStreams" }, { "target": "com.amazonaws.kinesis#ListTagsForResource" }, { "target": "com.amazonaws.kinesis#ListTagsForStream" }, { "target": "com.amazonaws.kinesis#MergeShards" }, { "target": "com.amazonaws.kinesis#PutRecord" }, { "target": "com.amazonaws.kinesis#PutRecords" }, { "target": "com.amazonaws.kinesis#PutResourcePolicy" }, { "target": "com.amazonaws.kinesis#ReceiveDeadLetterQueueRecords" }, { "target": "com.amazonaws.kinesis#ReceiveQueueRecords" }, { "target": "com.amazonaws.kinesis#RegisterStreamConsumer" }, { "target": "com.amazonaws.kinesis#RemoveTagsFromStream" }, { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecords" }, { "target": "com.amazonaws.kinesis#SplitShard" }, { "target": "com.amazonaws.kinesis#StartStreamEncryption" }, { "target": "com.amazonaws.kinesis#StopStreamEncryption" }, { "target": "com.amazonaws.kinesis#SubscribeToShard" }, { "target": "com.amazonaws.kinesis#TagResource" }, { "target": "com.amazonaws.kinesis#UntagResource" }, { "target": "com.amazonaws.kinesis#UpdateAccountSettings" }, { "target": "com.amazonaws.kinesis#UpdateChannel" }, { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibility" }, { "target": "com.amazonaws.kinesis#UpdateMaxRecordSize" }, { "target": "com.amazonaws.kinesis#UpdateQueue" }, { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibility" }, { "target": "com.amazonaws.kinesis#UpdateShardCount" }, { "target": "com.amazonaws.kinesis#UpdateStreamMode" }, { "target": "com.amazonaws.kinesis#UpdateStreamRecordDistributionStrategy" }, { "target": "com.amazonaws.kinesis#UpdateStreamWarmThroughput" } ], "traits": { "aws.api#service": { "sdkId": "Kinesis", "arnNamespace": "kinesis", "cloudFormationName": "Kinesis", "cloudTrailEventSource": "kinesis.amazonaws.com", "endpointPrefix": "kinesis" }, "aws.auth#sigv4": { "name": "kinesis" }, "aws.protocols#awsJson1_1": { "http": [ "http/1.1", "h2" ], "eventStreamHttp": [ "h2" ] }, "smithy.api#documentation": "Amazon Kinesis Data Streams Service API Reference\n

Amazon Kinesis Data Streams is a serverless data streaming service that ingests data\n once and fans it out to multiple consumer applications for real-time processing.

", "smithy.api#title": "Amazon Kinesis", "smithy.api#xmlNamespace": { "uri": "http://kinesis.amazonaws.com/doc/2013-12-02" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "OperationType": { "required": false, "documentation": "Internal parameter to distinguish between Control/Data plane API and accordingly generate control/data plane endpoint", "type": "string" }, "StreamId": { "required": false, "documentation": "The unique identifier of the Kinesis stream", "type": "string" }, "StreamARN": { "required": false, "documentation": "The ARN of the Kinesis stream", "type": "string" }, "ConsumerARN": { "required": false, "documentation": "The ARN of the Kinesis consumer", "type": "string" }, "ResourceARN": { "required": false, "documentation": "The ARN of the Kinesis resource", "type": "string" }, "ChannelARN": { "required": false, "documentation": "The ARN of the Kinesis data channel", "type": "string" }, "QueueARN": { "required": false, "documentation": "The ARN of the Kinesis queue", "type": "string" }, "ResourceType": { "required": true, "default": "", "documentation": "The type of Kinesis resource targeted by the operation (e.g., queue). Used for endpoint routing.", "type": "string" }, "AccountId": { "builtIn": "AWS::Auth::AccountId", "required": false, "documentation": "The AWS AccountId used for the request.", "type": "string" }, "AccountIdEndpointMode": { "builtIn": "AWS::Auth::AccountIdEndpointMode", "required": false, "documentation": "The AccountId Endpoint Mode.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "isSet", "argv": [ { "ref": "StreamId" } ] }, { "fn": "substring", "argv": [ { "ref": "StreamId" }, 21, 24, false ], "assign": "StreamIdSuffixValue" }, { "fn": "substring", "argv": [ { "ref": "StreamId" }, 0, 20, false ], "assign": "StreamIdPrefixValue" }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "StreamId" }, 20, 21, false ] }, "" ] }, "-" ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "StreamId" }, 3, 4, true ] }, "" ] }, "-" ] }, { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "StreamARN" } ] }, { "fn": "isSet", "argv": [ { "ref": "ConsumerARN" } ] }, { "fn": "isSet", "argv": [ { "ref": "ResourceARN" } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "ConsumerARN" } ], "assign": "arn_ssa_2" }, { "fn": "aws.parseArn", "argv": [ { "ref": "ResourceARN" } ], "assign": "arn_ssa_4" }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "resourceId[0]" ], "assign": "isoArnType" }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_2" }, "accountId" ] }, false ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_2" }, "region" ] }, false ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_2" }, "service" ] }, "kinesis" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_2" }, "resourceId[0]" ], "assign": "arnType_ssa_2" }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_2" }, "" ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 15, 20, false ], "assign": "HttpsCustomEndpointSuffixValue" }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 20, 21, false ] }, "" ] }, "." ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 15, 16, false ] }, "" ] }, "-" ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 7, 12, false ], "assign": "PlainCustomEndpointSuffixValue" }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_2" }, "stream" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_2" }, "partition" ] } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "StreamARN" } ], "assign": "arn_ssa_5" }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_5" }, "accountId" ] }, false ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_5" }, "region" ] }, false ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_5" }, "service" ] }, "kinesis" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_5" }, "resourceId[0]" ], "assign": "arnType_ssa_1" }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_1" }, "" ] }, { "fn": "stringEquals", "argv": [ { "ref": "isoArnType" }, "queue" ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "accountId" ] }, false ] }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_1" }, "stream" ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "region" ] }, false ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_5" }, "partition" ] } ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "service" ] }, "kinesis" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "resourceId[0]" ], "assign": "arnType_ssa_3" }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_3" }, "" ] }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_3" }, "stream" ] }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_3" }, "channel" ] }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_3" }, "queue" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "partition" ] } ] }, { "fn": "isSet", "argv": [ { "ref": "ChannelARN" } ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "resourceId[1]" ], "assign": "resourceId_ssa_1" }, { "fn": "isSet", "argv": [ { "ref": "QueueARN" } ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "ChannelARN" } ], "assign": "arn_ssa_1" }, { "fn": "isSet", "argv": [ { "ref": "AccountIdEndpointMode" } ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_1" }, "accountId" ] }, false ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_1" }, "region" ] }, false ] }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] }, { "fn": "stringEquals", "argv": [ { "ref": "AccountIdEndpointMode" }, "disabled" ] }, { "fn": "stringEquals", "argv": [ { "ref": "AccountIdEndpointMode" }, "required" ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "AccountId" }, false ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_1" }, "service" ] }, "kinesis" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_1" }, "resourceId[0]" ], "assign": "arnType_ssa_4" }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_4" }, "" ] }, { "fn": "stringEquals", "argv": [ { "ref": "ResourceType" }, "queue" ] }, { "fn": "aws.parseArn", "argv": [ { "ref": "QueueARN" } ], "assign": "arn_ssa_3" }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_3" }, "accountId" ] }, false ] }, { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_3" }, "region" ] }, false ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_3" }, "service" ] }, "kinesis" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_3" }, "resourceId[0]" ], "assign": "arnType_ssa_5" }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_5" }, "" ] }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_5" }, "queue" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_3" }, "partition" ] } ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "resourceId_ssa_1" }, false ] }, { "fn": "stringEquals", "argv": [ { "ref": "arnType_ssa_4" }, "channel" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_1" }, "partition" ] } ] }, { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_1" }, "resourceId[1]" ], "assign": "resourceId_ssa_2" }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_3" }, "resourceId[1]" ], "assign": "resourceId_ssa_3" }, { "fn": "isValidHostLabel", "argv": [ { "ref": "resourceId_ssa_3" }, false ] }, { "fn": "isValidHostLabel", "argv": [ { "ref": "resourceId_ssa_2" }, false ] }, { "fn": "getAttr", "argv": [ { "ref": "arn_ssa_4" }, "resourceId[1]" ], "assign": "isoResourceId" }, { "fn": "isValidHostLabel", "argv": [ { "ref": "isoResourceId" }, false ] }, { "fn": "stringEquals", "argv": [ { "ref": "OperationType" }, "data" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 12, 13, false ] }, "" ] }, "." ] }, { "fn": "stringEquals", "argv": [ { "fn": "coalesce", "argv": [ { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 7, 8, false ] }, "" ] }, "-" ] } ], "results": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_5#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_5#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_5#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_5#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Partition: {arn_ssa_5#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Kinesis ARNs don't support `{arnType_ssa_1}` arn types.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn_ssa_5#service}.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Invalid region.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Invalid account id.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Failed to parse ARN.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_2#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_2#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_2#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_2#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Partition: {arn_ssa_2#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Kinesis ARNs don't support `{arnType_ssa_2}` arn types.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn_ssa_2#service}.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Unsupported resource type `{arnType_ssa_3}`. Expected: stream, channel, or queue.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_4#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_4#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_4#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{arn_ssa_4#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid ARN: Invalid channel id.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Missing channel id.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_1}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid ARN: Invalid queue id.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: Missing queue id.", "type": "error" }, { "conditions": [], "error": "Partition: {arn_ssa_4#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn_ssa_4#service}.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_2}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_2}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_2}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_2}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "ChannelARN does not support the `data` operation type.", "type": "error" }, { "conditions": [], "error": "Partition: {arn_ssa_1#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: ChannelARN only supports `channel` arn types, found: `{arnType_ssa_4}`.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn_ssa_1#service}.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_3}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_3}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_3}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{resourceId_ssa_3}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Partition: {arn_ssa_3#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: QueueARN only supports `queue` ARN types, found: `{arnType_ssa_5}`.", "type": "error" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn_ssa_3#service}.", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: ResourceType must be \"queue\" when QueueARN is set.", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid account id.", "type": "error" }, { "conditions": [], "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://kinesis.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 237, "nodes": "/////wAAAAH/////AAAAAAAAAAMAAAAEAAAAAQAAAAcAAAAEAAAACQAAAOwAAAAFAAAALwAAAAYF9eFfAAAAOwX14V8F9eFKAAAAAgAAAMEAAAAIAAAAAwAAAMEAAAAJAAAABAAAAAoAAAAOAAAABQAAAAsAAAAOAAAABgAAAAwAAAAOAAAABwAAAA0AAAAOAAAACAAAAJwAAAAOAAAACQAAAOwAAAAPAAAACgAAAIwAAAAQAAAACwAAAHwAAAARAAAADAAAAFAAAAASAAAALQAAAD0AAAATAAAALwAAACoAAAAUAAAAMQAAABUAAADJAAAANAAAABYAAAApAAAANQAAACkAAAAXAAAANwAAABgF9eFTAAAAOwAAACEAAAAZAAAARwAAABoF9eERAAAATwAAAB0AAAAbAAAAUAAAABwF9eFSAAAAUgX14VEF9eEHAAAAUAAAAB8AAAAeAAAAUQX14VAF9eEFAAAAUQAAACAF9eEDAAAAUgX14U8F9eECAAAARwAAACIF9eERAAAATwAAACUAAAAjAAAAUAAAACQF9eFOAAAAUgX14U0F9eEHAAAAUAAAACcAAAAmAAAAUQX14UwF9eEFAAAAUQAAACgF9eEDAAAAUgX14UsF9eECAAAANgX14VQAAADJAAAAOwAAACsF9eFKAAAAPAAAACwF9eEcAAAAPQAAAC0F9eEbAAAAPgAAAC4F9eEaAAAAPwAAAC8F9eFJAAAAQAAAADAF9eEYAAAAQQX14RgAAAAxAAAAQgAAADIF9eFIAAAAQwAAADMF9eFHAAAARwAAADQF9eERAAAASQAAADUF9eE0AAAASgAAADYF9eEzAAAATwAAADkAAAA3AAAAUAAAADgF9eFGAAAAUgX14UUF9eEHAAAAUAAAADsAAAA6AAAAUQX14UQF9eEFAAAAUQAAADwF9eEDAAAAUgX14UMF9eECAAAAMAAAAD4F9eEcAAAAMgAAAD8F9eEbAAAAMwAAAEAF9eEaAAAAOAAAAEEF9eFCAAAAOQAAAEIF9eEYAAAAOgX14RgAAABDAAAARQAAAEQF9eFBAAAARgAAAEUF9eFAAAAARwAAAEYF9eERAAAASAAAAEcF9eEuAAAASwAAAEgF9eEtAAAATgX14T8AAABJAAAATwAAAEwAAABKAAAAUAAAAEsF9eE+AAAAUgX14T0F9eEHAAAAUAAAAE4AAABNAAAAUQX14TwF9eEFAAAAUQAAAE8F9eEDAAAAUgX14TsF9eECAAAADgAAAFEF9eEcAAAAIgAAAFIF9eEbAAAAJAAAAFMF9eEaAAAAJgAAAFQF9eE2AAAAJwAAAFUF9eEYAAAAKAX14RgAAABWAAAAKQAAAHMAAABXAAAAKgAAAGYAAABYAAAAKwAAAFkF9eEkAAAALAAAAFoF9eE1AAAALgAAAFwAAABbAAAARwX14TQF9eERAAAARAAAAF4AAABdAAAARwX14TMF9eERAAAARwAAAF8F9eERAAAATwAAAGIAAABgAAAAUAAAAGEF9eEyAAAAUgX14TEF9eEHAAAAUAAAAGQAAABjAAAAUQX14TAF9eEFAAAAUQAAAGUF9eEDAAAAUgX14S8F9eECAAAALAAAAGcF9eE1AAAALgAAAGkAAABoAAAARwX14S4F9eERAAAARAAAAGsAAABqAAAARwX14S0F9eERAAAARwAAAGwF9eERAAAATwAAAG8AAABtAAAAUAAAAG4F9eEsAAAAUgX14SsF9eEHAAAAUAAAAHEAAABwAAAAUQX14SoF9eEFAAAAUQAAAHIF9eEDAAAAUgX14SkF9eECAAAALAAAAHQF9eE1AAAARwAAAHUF9eERAAAATwAAAHgAAAB2AAAAUAAAAHcF9eEoAAAAUgX14ScF9eEHAAAAUAAAAHoAAAB5AAAAUQX14SYF9eEFAAAAUQAAAHsF9eEDAAAAUgX14SUF9eECAAAADQAAAH0F9eEcAAAAEAAAAH4F9eEbAAAAEQAAAH8F9eEaAAAAEgAAAIAF9eEjAAAAEwAAAIEF9eEYAAAAFAX14RgAAACCAAAAGQAAAIMF9eEiAAAAGgAAAIQF9eEhAAAARwAAAIUF9eERAAAATwAAAIgAAACGAAAAUAAAAIcF9eEgAAAAUgX14R8F9eEHAAAAUAAAAIoAAACJAAAAUQX14R4F9eEFAAAAUQAAAIsF9eEDAAAAUgX14R0F9eECAAAAGwAAAI0F9eEcAAAAHAAAAI4F9eEbAAAAHQAAAI8F9eEaAAAAHgAAAJAF9eEZAAAAHwAAAJEF9eEYAAAAIAX14RgAAACSAAAAIwAAAJMF9eEXAAAAJQAAAJQF9eEWAAAARwAAAJUF9eERAAAATwAAAJgAAACWAAAAUAAAAJcF9eEVAAAAUgX14RQF9eEHAAAAUAAAAJoAAACZAAAAUQX14RMF9eEFAAAAUQAAAJsF9eEDAAAAUgX14RIF9eECAAAACQAAAJ0AAAChAAAAFQAAAJ4AAACgAAAAFgAAAJ8AAACgAAAAFwAAALkAAACgAAAAGAAAAKkAAAChAAAARwAAAKIF9eERAAAATwAAAKUAAACjAAAAUAAAAKQF9eEQAAAAUgX14Q8F9eEHAAAAUAAAAKcAAACmAAAAUQX14Q4F9eEFAAAAUQAAAKgF9eEDAAAAUgX14Q0F9eECAAAARwAAAKoF9eERAAAATwAAALEAAACrAAAAUAAAAK4AAACsAAAAVAAAAK0F9eEQAAAAVQX14QwF9eEQAAAAUgAAAK8F9eEHAAAAVAAAALAF9eEPAAAAVQX14QsF9eEPAAAAUAAAALUAAACyAAAAUQAAALMF9eEFAAAAVAAAALQF9eEOAAAAVQX14QoF9eEOAAAAUQAAALYF9eEDAAAAUgAAALcF9eECAAAAVAAAALgF9eENAAAAVQX14QkF9eENAAAARwAAALoF9eERAAAATwAAAL0AAAC7AAAAUAAAALwF9eEIAAAAUgX14QYF9eEHAAAAUAAAAL8AAAC+AAAAUQX14QQF9eEFAAAAUQAAAMAF9eEDAAAAUgX14QEF9eECAAAACQAAAOwAAADCAAAADAAAAMMAAADGAAAADgAAAMQAAADGAAAADwAAAMUAAADGAAAAIQAAAN4AAADGAAAALwAAANIAAADHAAAAMQAAAMgAAADJAAAANgX14VUAAADJAAAAOwAAAOUAAADKAAAATwAAAM0AAADLAAAAUAAAAMwF9eFeAAAAUgX14V0F9eEHAAAAUAAAANAAAADOAAAAUQAAAM8F9eEFAAAAUwX14VsF9eFcAAAAUQAAANEF9eFaAAAAUgX14VkF9eFaAAAAOwAAANMF9eFKAAAAPAAAANQF9eEcAAAAPQAAANUF9eEbAAAAPgAAANYF9eEaAAAAPwAAANcF9eFJAAAAQAAAANgF9eEYAAAAQQX14RgAAADZAAAAQgAAANoF9eFIAAAAQwAAANsF9eFHAAAARwAAANwF9eERAAAASQAAAN0F9eE0AAAASgAAAOUF9eEzAAAAIgAAAN8F9eEbAAAAJAAAAOAF9eEaAAAAJgAAAOEF9eE2AAAALAAAAOIF9eE1AAAARwAAAOMF9eERAAAATAAAAOQF9eE0AAAATQAAAOUF9eEzAAAATwAAAOgAAADmAAAAUAAAAOcF9eE6AAAAUgX14TkF9eEHAAAAUAAAAOoAAADpAAAAUQX14TgF9eEFAAAAUQAAAOsF9eEDAAAAUgX14TcF9eECAAAATwX14VYAAADtAAAAUAX14VcF9eFY" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "OperationType": { "required": false, "documentation": "Internal parameter to distinguish between Control/Data plane API and accordingly generate control/data plane endpoint", "type": "string" }, "StreamId": { "required": false, "documentation": "The unique identifier of the Kinesis stream", "type": "string" }, "StreamARN": { "required": false, "documentation": "The ARN of the Kinesis stream", "type": "string" }, "ConsumerARN": { "required": false, "documentation": "The ARN of the Kinesis consumer", "type": "string" }, "ResourceARN": { "required": false, "documentation": "The ARN of the Kinesis resource", "type": "string" }, "ChannelARN": { "required": false, "documentation": "The ARN of the Kinesis data channel", "type": "string" }, "QueueARN": { "required": false, "documentation": "The ARN of the Kinesis queue", "type": "string" }, "ResourceType": { "required": true, "default": "", "documentation": "The type of Kinesis resource targeted by the operation (e.g., queue). Used for endpoint routing.", "type": "string" }, "AccountId": { "builtIn": "AWS::Auth::AccountId", "required": false, "documentation": "The AWS AccountId used for the request.", "type": "string" }, "AccountIdEndpointMode": { "builtIn": "AWS::Auth::AccountIdEndpointMode", "required": false, "documentation": "The AccountId Endpoint Mode.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "StreamId" } ] }, { "fn": "substring", "argv": [ { "ref": "StreamId" }, 20, 21, false ], "assign": "StreamIdDelimiterValue" }, { "fn": "stringEquals", "argv": [ { "ref": "StreamIdDelimiterValue" }, "-" ] }, { "fn": "substring", "argv": [ { "ref": "StreamId" }, 3, 4, true ], "assign": "StreamIdDelimiterReversedValue" }, { "fn": "stringEquals", "argv": [ { "ref": "StreamIdDelimiterReversedValue" }, "-" ] }, { "fn": "substring", "argv": [ { "ref": "StreamId" }, 0, 20, false ], "assign": "StreamIdPrefixValue" }, { "fn": "substring", "argv": [ { "ref": "StreamId" }, 21, 24, false ], "assign": "StreamIdSuffixValue" }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 15, 16, false ], "assign": "HttpsCustomEndpointDelimiterValue" }, { "fn": "stringEquals", "argv": [ { "ref": "HttpsCustomEndpointDelimiterValue" }, "-" ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 20, 21, false ], "assign": "HttpsEndpointDelimiterValue" }, { "fn": "stringEquals", "argv": [ { "ref": "HttpsEndpointDelimiterValue" }, "." ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 15, 20, false ], "assign": "HttpsCustomEndpointSuffixValue" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{HttpsCustomEndpointSuffixValue}.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 7, 8, false ], "assign": "PlainCustomEndpointDelimiterValue" }, { "fn": "stringEquals", "argv": [ { "ref": "PlainCustomEndpointDelimiterValue" }, "-" ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 12, 13, false ], "assign": "PlainEndpointDelimiterValue" }, { "fn": "stringEquals", "argv": [ { "ref": "PlainEndpointDelimiterValue" }, "." ] }, { "fn": "substring", "argv": [ { "ref": "Endpoint" }, 7, 12, false ], "assign": "PlainCustomEndpointSuffixValue" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis{PlainCustomEndpointSuffixValue}.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{StreamIdPrefixValue}.{StreamIdSuffixValue}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "StreamARN" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] } ], "rules": [ { "conditions": [ { "fn": "aws.parseArn", "argv": [ { "ref": "StreamARN" } ], "assign": "arn" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "region" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "service" ] }, "kinesis" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[0]" ], "assign": "arnType" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "stream" ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "{arn#partition}" ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Partition: {arn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Kinesis ARNs don't support `{arnType}` arn types.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn#service}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid region.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid account id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Failed to parse ARN.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "ConsumerARN" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] } ], "rules": [ { "conditions": [ { "fn": "aws.parseArn", "argv": [ { "ref": "ConsumerARN" } ], "assign": "arn" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "region" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "service" ] }, "kinesis" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[0]" ], "assign": "arnType" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "stream" ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "{arn#partition}" ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Partition: {arn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Kinesis ARNs don't support `{arnType}` arn types.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn#service}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid region.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid account id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Failed to parse ARN.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "ResourceARN" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] } ], "rules": [ { "conditions": [ { "fn": "aws.parseArn", "argv": [ { "ref": "ResourceARN" } ], "assign": "arn" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "region" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "service" ] }, "kinesis" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[0]" ], "assign": "arnType" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "stream" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "channel" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "queue" ] } ] } ], "error": "Invalid ARN: Unsupported resource type `{arnType}`. Expected: stream, channel, or queue.", "type": "error" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "{arn#partition}" ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "stream" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{arn#accountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "channel" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[1]" ], "assign": "resourceId" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "resourceId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid channel id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Missing channel id.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "queue" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[1]" ], "assign": "resourceId" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "resourceId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{resourceId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid queue id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Missing queue id.", "type": "error" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Partition: {arn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn#service}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid region.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid account id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Failed to parse ARN.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "ResourceARN" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "aws.parseArn", "argv": [ { "ref": "ResourceARN" } ], "assign": "isoArn" }, { "fn": "getAttr", "argv": [ { "ref": "isoArn" }, "resourceId[0]" ], "assign": "isoArnType" }, { "fn": "stringEquals", "argv": [ { "ref": "isoArnType" }, "queue" ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "isoArn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "isoArn" }, "region" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "isoArn" }, "service" ] }, "kinesis" ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "{isoArn#partition}" ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "isoArn" }, "resourceId[1]" ], "assign": "isoResourceId" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "isoResourceId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid queue id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Missing queue id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Partition: {isoArn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {isoArn#service}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid region.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid account id.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "ChannelARN" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] } ], "rules": [ { "conditions": [ { "fn": "aws.parseArn", "argv": [ { "ref": "ChannelARN" } ], "assign": "arn" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "region" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "service" ] }, "kinesis" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[0]" ], "assign": "arnType" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "channel" ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "{arn#partition}" ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[1]" ], "assign": "channelId" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "channelId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "OperationType" }, "data" ] } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{channelId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{channelId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{channelId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{channelId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "ChannelARN does not support the `data` operation type.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid channel id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Missing channel id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Partition: {arn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: ChannelARN only supports `channel` arn types, found: `{arnType}`.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn#service}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid region.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid account id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Failed to parse ARN.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "QueueARN" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "ref": "ResourceType" }, "queue" ] } ], "rules": [ { "conditions": [ { "fn": "aws.parseArn", "argv": [ { "ref": "QueueARN" } ], "assign": "arn" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "accountId" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "region" ] }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "service" ] }, "kinesis" ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[0]" ], "assign": "arnType" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "" ] } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "arnType" }, "queue" ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "{arn#partition}" ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "getAttr", "argv": [ { "ref": "arn" }, "resourceId[1]" ], "assign": "queueId" } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "queueId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{queueId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{queueId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{queueId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{queueId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid queue id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Missing queue id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Partition: {arn#partition} from ARN doesn't match with partition name: {PartitionResult#name}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: QueueARN only supports `queue` ARN types, found: `{arnType}`.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: No ARN type specified", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: The ARN was not for the Kinesis service, found: {arn#service}.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid region.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Invalid account id.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid ARN: Failed to parse ARN.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "QueueARN" } ] }, { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "ResourceType" }, "queue" ] } ] } ], "error": "Invalid Configuration: ResourceType must be \"queue\" when QueueARN is set.", "type": "error" }, { "conditions": [ { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "AccountIdEndpointMode" } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "AccountIdEndpointMode" }, "disabled" ] } ] }, { "fn": "isSet", "argv": [ { "ref": "AccountId" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] } ], "rules": [ { "conditions": [ { "fn": "isValidHostLabel", "argv": [ { "ref": "AccountId" }, false ] } ], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "OperationType" } ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "ResourceType" }, "queue" ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "ref": "ResourceType" }, "queue" ] } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://{AccountId}.{OperationType}-kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": { "metricValues": [ "O" ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Operation Type is not set. Please contact service team for resolution.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid account id.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "isSet", "argv": [ { "ref": "AccountIdEndpointMode" } ] }, { "fn": "stringEquals", "argv": [ { "ref": "AccountIdEndpointMode" }, "required" ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] } ], "rules": [ { "conditions": [], "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "stringEquals", "argv": [ { "ref": "ResourceType" }, "queue" ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled, but this partition does not support DualStack.", "type": "error" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled, but this partition does not support FIPS.", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://kinesis-queues.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://kinesis.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://kinesis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://kinesis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://kinesis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kinesis-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kinesis.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://kinesis.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } }, { "documentation": "Invalid ARN: Failed to parse ARN.", "expect": { "error": "Invalid ARN: Failed to parse ARN." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn" } }, { "documentation": "Invalid ARN: partition missing from ARN.", "expect": { "error": "Invalid ARN: Failed to parse ARN." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn::kinesis:us-west-2:123456789012:stream/testStream" } }, { "documentation": "Invalid ARN: partitions mismatch.", "expect": { "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/testStream" } }, { "documentation": "Invalid ARN: Not Kinesis", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:s3:us-west-2:123456789012:stream/testStream" } }, { "documentation": "Invalid ARN: Region is missing in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:kinesis::123456789012:stream/testStream" } }, { "documentation": "Invalid ARN: Region is empty string in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:kinesis: :123456789012:stream/testStream" } }, { "documentation": "Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:kinesis:us-east-1::stream/testStream", "OperationType": "control" } }, { "documentation": "Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:kinesis:us-east-1: :stream/testStream", "OperationType": "control" } }, { "documentation": "Invalid ARN: Kinesis ARNs only support stream arn types", "expect": { "error": "Invalid ARN: Kinesis ARNs don't support `accesspoint` arn types." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream" } }, { "documentation": "OperationType not set", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/testStream" } }, { "documentation": "Custom Endpoint is specified", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream", "Endpoint": "https://example.com" } }, { "documentation": "Account endpoint targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with fips targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with fips targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with Dual Stack and FIPS enabled", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with Dual Stack enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-west-1.api.aws" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with FIPS and DualStack disabled", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" } }, { "documentation": "RegionMismatch: client region should be used for endpoint region", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/testStream" } }, { "documentation": "Account endpoint with FIPS enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "StreamARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with FIPS and DualStack enabled for cn regions.", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "data", "StreamARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream" } }, { "documentation": "Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws-iso:kinesis:us-iso-west-1:123:stream/test-stream" } }, { "documentation": "Account endpoint targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with fips targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" } }, { "documentation": "Account endpoint with fips targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "StreamARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream" } }, { "documentation": "Invalid ConsumerARN: Failed to parse ARN.", "expect": { "error": "Invalid ARN: Failed to parse ARN." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn" } }, { "documentation": "Invalid ConsumerARN: partition missing from ARN.", "expect": { "error": "Invalid ARN: Failed to parse ARN." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn::kinesis:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "Invalid ARN: partitions mismatch.", "expect": { "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:kinesis:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "Invalid ARN: Not Kinesis", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:s3:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "Invalid ARN: Region is missing in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:kinesis::123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "Invalid ARN: Region is empty string in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:kinesis: :123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:kinesis:us-east-1::stream/testStream/consumer/test-consumer:1525898737", "OperationType": "control" } }, { "documentation": "Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:kinesis:us-east-1: :stream/testStream/consumer/test-consumer:1525898737", "OperationType": "control" } }, { "documentation": "Invalid ARN: Kinesis ARNs only support stream arn/consumer arn types", "expect": { "error": "Invalid ARN: Kinesis ARNs don't support `accesspoint` arn types." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "OperationType not set", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ConsumerARN": "arn:aws:kinesis:us-east-1:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "Custom Endpoint is specified", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737", "Endpoint": "https://example.com" } }, { "documentation": "Account endpoint targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with fips targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with fips targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with Dual Stack and FIPS enabled", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with Dual Stack enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-west-1.api.aws" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "ConsumerARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with FIPS and DualStack disabled", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "RegionMismatch: client region should be used for endpoint region", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ConsumerARN": "arn:aws:kinesis:us-west-1:123:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with FIPS enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ConsumerARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with FIPS and DualStack enabled for cn regions.", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "data", "ConsumerARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws-iso:kinesis:us-iso-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ConsumerARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with fips targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "Account endpoint with fips targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ConsumerARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ConsumerARN targeting US-EAST-1", "expect": { "endpoint": { "url": "https://123456789123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ConsumerARN": "arn:aws:kinesis:us-east-1:123456789123:stream/foobar/consumer/test-consumer:1525898737" } }, { "documentation": "Both StreamARN and ConsumerARN specified. StreamARN should take precedence", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/foobar", "ConsumerARN": "arn:aws:kinesis:us-east-1:123456789123:stream/foobar/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN test: Invalid ARN: Failed to parse ARN.", "expect": { "error": "Invalid ARN: Failed to parse ARN." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: partition missing from ARN.", "expect": { "error": "Invalid ARN: Failed to parse ARN." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn::kinesis:us-west-2:123456789012:stream/testStream" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: partitions mismatch.", "expect": { "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-west-2:123456789012:stream/testStream" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: Not Kinesis", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:s3:us-west-2:123456789012:stream/testStream" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: Region is missing in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis::123456789012:stream/testStream" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: Region is empty string in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis: :123456789012:stream/testStream" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1::stream/testStream", "OperationType": "control" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1: :stream/testStream", "OperationType": "control" } }, { "documentation": "ResourceARN as StreamARN test: Invalid ARN: Kinesis ARNs only support stream arn types", "expect": { "error": "Invalid ARN: Unsupported resource type `accesspoint`. Expected: stream, channel, or queue." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream" } }, { "documentation": "ResourceARN as StreamARN test: OperationType not set", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:stream/testStream" } }, { "documentation": "ResourceARN as StreamARN test: Custom Endpoint is specified", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream", "Endpoint": "https://example.com" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with fips targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with fips targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with Dual Stack and FIPS enabled", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with Dual Stack enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-west-1.api.aws" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with FIPS and DualStack disabled", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: RegionMismatch: client region should be used for endpoint region", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-west-1:123:stream/testStream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with FIPS enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with FIPS and DualStack enabled for cn regions.", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "data", "ResourceARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-west-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with fips targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as StreamARN test: Account endpoint with fips targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: partition missing from ARN.", "expect": { "error": "Invalid ARN: Failed to parse ARN." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn::kinesis:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: partitions mismatch.", "expect": { "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: Not Kinesis", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:s3:us-west-2:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: Region is missing in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis::123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: Region is empty string in ARN", "expect": { "error": "Invalid ARN: Invalid region." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis: :123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1::stream/testStream/consumer/test-consumer:1525898737", "OperationType": "control" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: Invalid account id", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1: :stream/testStream/consumer/test-consumer:1525898737", "OperationType": "control" } }, { "documentation": "ResourceARN as ConsumerARN test: Invalid ARN: Kinesis ARNs only support stream arn/consumer arn types", "expect": { "error": "Invalid ARN: Unsupported resource type `accesspoint`. Expected: stream, channel, or queue." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1:123:accesspoint/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: OperationType not set", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Custom Endpoint is specified", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737", "Endpoint": "https://example.com" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with fips targeting data operation type", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with fips targeting control operation type", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with Dual Stack and FIPS enabled", "expect": { "endpoint": { "url": "https://123.control-kinesis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with Dual Stack enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-west-1.api.aws" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with FIPS and DualStack disabled", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: RegionMismatch: client region should be used for endpoint region", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-west-1:123:stream/testStream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with FIPS enabled", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with FIPS and DualStack enabled for cn regions.", "expect": { "endpoint": { "url": "https://123.data-kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "data", "ResourceARN": "arn:aws-cn:kinesis:cn-northwest-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-west-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-west-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with fips targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ConsumerARN test: Account endpoint with fips targeting data operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "ResourceARN as ChannelARN test: Invalid ARN: unsupported resource type", "expect": { "error": "Invalid ARN: Unsupported resource type `accesspoint`. Expected: stream, channel, or queue." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:accesspoint/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Invalid ARN: Not Kinesis", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:s3:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Invalid ARN: partitions mismatch", "expect": { "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-2:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: OperationType not set", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Missing channel id", "expect": { "error": "Invalid ARN: Missing channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel" } }, { "documentation": "ResourceARN as ChannelARN test: Invalid channel id (subdomains not allowed)", "expect": { "error": "Invalid ARN: Invalid channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8.ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Custom Endpoint is specified", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe", "Endpoint": "https://example.com" } }, { "documentation": "ResourceARN as ChannelARN test: endpoint targeting control operation type", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: endpoint with fips targeting control operation type", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: endpoint with Dual Stack enabled", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: endpoint with Dual Stack and FIPS enabled", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: RegionMismatch: client region should be used for endpoint region", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Account endpoint with FIPS enabled for cn regions", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-cn:kinesis:cn-northwest-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Account endpoint with FIPS and DualStack enabled for cn regions", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws-cn:kinesis:cn-northwest-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Account endpoint targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ResourceARN as ChannelARN test: Account endpoint with fips targeting control operation type in ADC regions", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "StreamId test: OperationType not set with StreamId", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "StreamId": "af4lwng4k01746835071-xyz" } }, { "documentation": "StreamId test: Stream endpoint targeting control operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint targeting data operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "GetShardIterator", "operationParams": { "ShardId": "shardId-000000000001", "ShardIteratorType": "LATEST", "StreamId": "af4lwng4k01746835071-xyz" } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint with fips targeting data operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint with fips targeting control operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint with Dual Stack and FIPS enabled", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint with Dual Stack enabled", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis.us-west-1.api.aws" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint with FIPS and DualStack disabled", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis.us-west-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-1" }, "operationName": "ListShards", "operationParams": { "StreamId": "af4lwng4k01746835071-xyz" } } ], "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "StreamARN": "arn:aws:kinesis:us-west-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint FIPS and DualStack disabled with endpoint", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-pod1.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: Stream endpoint targeting data operation type with endpoint", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod1.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: Stream endpoint with fips targeting data operation type with endpoint", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod1-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: Stream endpoint with fips targeting control operation type with endpoint", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-pod1-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: Stream endpoint with Dual Stack and FIPS enabled with endpoint", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-pod1-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: Stream endpoint with Dual Stack enabled with endpoint", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod1.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: Stream endpoint targeting data operation type with https endpoint", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod1.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with FIPS enabled targeting control operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-pod1-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with FIPS enabled targeting data operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod1-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with DualStack enabled targeting control operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-pod1.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with DualStack enabled targeting data operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod1.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with FIPS and DualStack enabled targeting control operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-pod1-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with FIPS and DualStack enabled targeting data operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod1-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod1.us-east-1.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with FIPS enabled in different region", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis-pod2-fips.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod2.us-west-2.amazonaws.com" } }, { "documentation": "StreamId test: HTTPS endpoint with DualStack enabled in different region", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis-pod2.us-west-2.api.aws" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "Endpoint": "https://kinesis-pod2.us-west-2.amazonaws.com" } }, { "documentation": "StreamId test: Stream endpoint with ConsumerARN targeting control operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "StreamId test: Stream endpoint with ConsumerARN targeting data operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "ConsumerARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream/consumer/test-consumer:1525898737" } }, { "documentation": "StreamId test: Stream endpoint with ResourceARN targeting control operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Stream endpoint with ResourceARN targeting data operation type", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071-xyz", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Invalid StreamId with ARN", "expect": { "endpoint": { "url": "https://123.data-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "StreamId": "af4lwng4k01746835071=xyz", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Invalid streamId with custom endpoint", "expect": { "endpoint": { "url": "https://kinesis-pod2.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071=xyz", "Endpoint": "https://kinesis-pod2.us-west-2.amazonaws.com" } }, { "documentation": "StreamId test: Invalid streamId", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071=xyz" } }, { "documentation": "StreamId test: Invalid streamId with custom endpoint and ARN", "expect": { "endpoint": { "url": "https://kinesis-pod2.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071=xyz", "Endpoint": "https://kinesis-pod2.us-west-2.amazonaws.com", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Invalid streamId with longer prefix", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k0174683507123-xyz", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Invalid streamId with shorter prefix", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835-xyz", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Invalid streamId with longer suffix", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-wxyz", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "StreamId test: Invalid streamId with shorter suffix", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-yz", "ResourceARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream" } }, { "documentation": "ChannelARN: endpoint targeting control operation type", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DescribeChannel", "operationParams": { "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ChannelARN: endpoint with FIPS targeting control operation type", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "DeleteChannel", "operationParams": { "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ChannelARN: endpoint with DualStack targeting control operation type", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "UpdateChannel", "operationParams": { "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "ChannelARN: endpoint with FIPS and DualStack targeting control operation type", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis-fips.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "DescribeChannel", "operationParams": { "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "Invalid ChannelARN: ChannelARN only supports channel arn types", "expect": { "error": "Invalid ARN: ChannelARN only supports `channel` arn types, found: `stream`." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:stream/test-stream" } }, { "documentation": "Invalid ChannelARN: ARN was not for the Kinesis service", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: s3." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ChannelARN": "arn:aws:s3:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "Invalid ChannelARN: OperationType not set", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "Invalid ChannelARN: partitions mismatch", "expect": { "error": "Partition: aws from ARN doesn't match with partition name: aws-us-gov." }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ChannelARN": "arn:aws:kinesis:us-west-2:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "Invalid ChannelARN: missing channel id", "expect": { "error": "Invalid ARN: Missing channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel" } }, { "documentation": "Invalid ChannelARN: channel id contains a period (subdomains not allowed)", "expect": { "error": "Invalid ARN: Invalid channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8.ge6utbndxe" } }, { "documentation": "Invalid ChannelARN: channel id exceeds 63 character host label limit", "expect": { "error": "Invalid ARN: Invalid channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, { "documentation": "Invalid ChannelARN: channel id starts with a hyphen", "expect": { "error": "Invalid ARN: Invalid channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/-pu0zt8ge6utbndxe" } }, { "documentation": "Invalid ChannelARN: channel id contains an invalid character", "expect": { "error": "Invalid ARN: Invalid channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8_ge6utbndxe" } }, { "documentation": "Invalid ChannelARN: data operation type is not supported for channel", "expect": { "error": "ChannelARN does not support the `data` operation type." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ChannelARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "AccountId test: Account Id present", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://012345678901.data-kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "012345678901", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "GetShardIterator", "operationParams": { "ShardId": "shardId-000000000001", "ShardIteratorType": "LATEST", "StreamName": "test-stream" } } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "AccountId": "012345678901", "AccountIdEndpointMode": "preferred" } }, { "documentation": "AccountId test: Account Id present with fips", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123.control-kinesis-fips.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123", "AWS::Auth::AccountIdEndpointMode": "required", "AWS::UseFIPS": true }, "operationName": "ListShards", "operationParams": { "StreamName": "testStream" } } ], "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123", "AccountIdEndpointMode": "required" } }, { "documentation": "AccountId test: Account Id present with dual stack", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123.control-kinesis.us-west-2.api.aws" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "AccountId test: Account Id present with fips and dual stack", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123.control-kinesis-fips.us-west-2.api.aws" } }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id present with streamId", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id present with stream ARN", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id present with consumer ARN", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ConsumerARN": "arn:aws:kinesis:us-west-2:123:stream/testStream/consumer/test-consumer:1525898737", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id present with resource ARN", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-2:123:stream/testStream/consumer/test-consumer:1525898737", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id present and stream ARN with different accountId", "expect": { "endpoint": { "url": "https://456.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-2:456:stream/testStream", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id present and consumer ARN with different accountId", "expect": { "endpoint": { "url": "https://456.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-2:456:stream/testStream/consumer/test-consumer:1525898737", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id, streamId and resource ARN with different accountId", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "ResourceARN": "arn:aws:kinesis:us-west-2:456:stream/testStream/consumer/test-consumer:1525898737", "AccountId": "123", "AccountIdEndpointMode": "preferred" } }, { "documentation": "ResourceARN with queue type: basic control endpoint", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "PutResourcePolicy", "operationParams": { "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId", "Policy": "{}" } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type: FIPS", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type: DualStack", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseDualStack": true }, "operationName": "TagResource", "operationParams": { "ResourceARN": "arn:aws:kinesis:us-west-2:123456789012:queue/myQueueId", "Tags": { "key1": "value1" } } } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-west-2:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with channel type: basic control endpoint", "expect": { "endpoint": { "url": "https://apu0zt8ge6utbndxe.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:298091445058:channel/apu0zt8ge6utbndxe" } }, { "documentation": "Account Id with account id endpoint mode disabled", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "ListShards", "operationParams": { "StreamName": "testStream" } } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123", "AccountIdEndpointMode": "disabled" } }, { "documentation": "Account Id and StreamArn with account id endpoint mode disabled", "expect": { "endpoint": { "url": "https://456.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-west-2:456:stream/testStream", "AccountId": "123", "AccountIdEndpointMode": "disabled" } }, { "documentation": "Account Id missing with account id endpoint mode required", "expect": { "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountIdEndpointMode": "required" }, "operationName": "ListShards", "operationParams": { "StreamName": "testStream" } } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountIdEndpointMode": "required" } }, { "documentation": "Account Id missing with account id endpoint mode required, fips and dual stack enabled", "expect": { "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" }, "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountIdEndpointMode": "required" } }, { "documentation": "Account Id missing with account id endpoint mode required in ADC region", "expect": { "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountIdEndpointMode": "required" } }, { "documentation": "Account Id present with account id endpoint mode required in ADC region", "expect": { "error": "Invalid Configuration: AccountIdEndpointMode is required but account endpoints are not supported in this partition" }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "required" } }, { "documentation": "Account Id present with account id endpoint mode preferred in ADC region", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id missing with account id endpoint mode required and endpoint override", "expect": { "endpoint": { "url": "https://kinesis-pod1.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "Endpoint": "https://kinesis-pod1.us-west-2.amazonaws.com", "AccountIdEndpointMode": "required" } }, { "documentation": "Account Id missing with StreamArn and account id endpoint mode required", "expect": { "endpoint": { "url": "https://456.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-west-2:456:stream/testStream", "AccountIdEndpointMode": "required" } }, { "documentation": "Account Id missing with StreamId and account id endpoint mode required", "expect": { "endpoint": { "url": "https://af4lwng4k01746835071.xyz.control-kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamId": "af4lwng4k01746835071-xyz", "AccountIdEndpointMode": "required" } }, { "documentation": "Account Id missing with account id endpoint mode preferred", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Account Id missing with account id endpoint mode disabled", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateStream: control operation type with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "CreateStream", "operationParams": { "StreamName": "test-stream", "ShardCount": 1 } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "CreateStream: control operation type with FIPS and AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true }, "operationName": "CreateStream", "operationParams": { "StreamName": "test-stream", "ShardCount": 1 } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "ListStreams: control operation type with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "ListStreams" } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "ListStreams: control operation type with FIPS and DualStack", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "ListStreams" } ], "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "DescribeLimits: control operation type with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "DescribeLimits" } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "DescribeLimits: control operation type with FIPS", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true }, "operationName": "DescribeLimits" } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "DescribeAccountSettings: control operation type with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "DescribeAccountSettings" } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "DescribeAccountSettings: control operation type with FIPS and DualStack", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "DescribeAccountSettings" } ], "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "UpdateAccountSettings: control operation type with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "UpdateAccountSettings", "operationParams": { "MinimumThroughputBillingCommitment": { "Status": "ENABLED" } } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "UpdateAccountSettings: control operation type with FIPS", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true }, "operationName": "UpdateAccountSettings", "operationParams": { "MinimumThroughputBillingCommitment": { "Status": "ENABLED" } } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "CreateStream: account id endpoint mode disabled falls back to regional endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "CreateStream", "operationParams": { "StreamName": "test-stream", "ShardCount": 1 } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "ListStreams: account id endpoint mode disabled falls back to regional endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "ListStreams" } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "DescribeLimits: account id endpoint mode disabled falls back to regional endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "DescribeLimits" } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "DescribeAccountSettings: account id endpoint mode disabled falls back to regional endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "DescribeAccountSettings" } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "UpdateAccountSettings: account id endpoint mode disabled falls back to regional endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "UpdateAccountSettings", "operationParams": { "MinimumThroughputBillingCommitment": { "Status": "ENABLED" } } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateStream: account id endpoint mode disabled with FIPS falls back to regional FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseFIPS": true }, "operationName": "CreateStream", "operationParams": { "StreamName": "test-stream", "ShardCount": 1 } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateStream: account id endpoint mode disabled with DualStack falls back to regional DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseDualStack": true }, "operationName": "CreateStream", "operationParams": { "StreamName": "test-stream", "ShardCount": 1 } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateStream: account id endpoint mode disabled with FIPS and DualStack falls back to regional FIPS DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-fips.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "CreateStream", "operationParams": { "StreamName": "test-stream", "ShardCount": 1 } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateChannel: control operation type with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "CreateChannel: control operation type with FIPS and AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "CreateChannel: control operation type with DualStack and AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseDualStack": true }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "CreateChannel: control operation type with FIPS and DualStack and AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "CreateChannel: account id endpoint mode disabled falls back to regional endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateChannel: account id endpoint mode disabled with FIPS falls back to regional FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseFIPS": true }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateChannel: account id endpoint mode disabled with DualStack falls back to regional DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseDualStack": true }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "CreateChannel: account id endpoint mode disabled with FIPS and DualStack falls back to regional FIPS DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-fips.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "CreateChannel", "operationParams": { "ChannelName": "test-channel", "ServiceExecutionRoleARN": "arn:aws:iam::123456789012:role/test-role", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream", "RecordConfiguration": { "RecordFormatType": "JSON" } } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "ListChannels: control operation type with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "ListChannels" } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "ListChannels: control operation type with FIPS and DualStack", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-fips.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "ListChannels" } ], "params": { "Region": "us-west-2", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "ListChannels: account id endpoint mode disabled falls back to regional endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "ListChannels" } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled" } }, { "documentation": "QueueARN: basic endpoint resolution with control operation type", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1" }, "operationName": "DescribeQueue", "operationParams": { "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: endpoint with FIPS", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "UpdateQueue", "operationParams": { "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId", "QueueAttributes": { "VisibilityTimeoutSeconds": 30 } } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: endpoint with DualStack", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseDualStack": true }, "operationName": "DeleteQueue", "operationParams": { "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: endpoint with FIPS and DualStack", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: data operation type", "expect": { "endpoint": { "url": "https://abc123def456.data-kinesis-queues.us-west-2.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2" }, "operationName": "ReceiveQueueRecords", "operationParams": { "QueueARN": "arn:aws:kinesis:us-west-2:123456789012:queue/abc123def456" } } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-west-2:123456789012:queue/abc123def456" } }, { "documentation": "QueueARN: data operation type with FIPS", "expect": { "endpoint": { "url": "https://abc123def456.data-kinesis-queues-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::UseFIPS": true }, "operationName": "AcknowledgeQueueRecords", "operationParams": { "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/abc123def456", "Entries": [ { "ReceiptHandle": "handle1" } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "data", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/abc123def456" } }, { "documentation": "QueueARN: data operation type with DualStack", "expect": { "endpoint": { "url": "https://abc123def456.data-kinesis-queues.us-west-2.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-west-2", "AWS::UseDualStack": true }, "operationName": "UpdateQueueRecordsVisibility", "operationParams": { "QueueARN": "arn:aws:kinesis:us-west-2:123456789012:queue/abc123def456", "Entries": [ { "ReceiptHandle": "handle1", "VisibilityTimeoutSeconds": 30 } ] } } ], "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true, "OperationType": "data", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-west-2:123456789012:queue/abc123def456" } }, { "documentation": "QueueARN: VPCE endpoint override is respected as-is", "expect": { "endpoint": { "url": "https://my-vpce-xyz.vpce.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId", "Endpoint": "https://my-vpce-xyz.vpce.amazonaws.com" } }, { "documentation": "Invalid QueueARN: wrong arn type", "expect": { "error": "Invalid ARN: QueueARN only supports `queue` ARN types, found: `stream`." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream" } }, { "documentation": "Invalid QueueARN: missing queue id", "expect": { "error": "Invalid ARN: Missing queue id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue" } }, { "documentation": "Invalid QueueARN: non-kinesis service", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: sqs." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:sqs:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "Queue AccountId: basic endpoint with AccountId", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-queues.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred" }, "operationName": "CreateQueue", "operationParams": { "QueueName": "test-queue", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream" } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred", "ResourceType": "queue" } }, { "documentation": "Queue AccountId: endpoint with FIPS", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-queues-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "preferred", "AWS::UseFIPS": true }, "operationName": "ListQueues" } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred", "ResourceType": "queue" } }, { "documentation": "Queue AccountId: endpoint with DualStack", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-queues.us-west-2.api.aws" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred", "ResourceType": "queue" } }, { "documentation": "Queue AccountId: endpoint with FIPS and DualStack", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis-queues-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred", "ResourceType": "queue" } }, { "documentation": "QueueARN: regular endpoint override is respected as-is", "expect": { "endpoint": { "url": "https://kinesis-queues.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId", "Endpoint": "https://kinesis-queues.us-east-1.amazonaws.com" } }, { "documentation": "Queue AccountId: disabled mode falls back to regional queue endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled" }, "operationName": "CreateQueue", "operationParams": { "QueueName": "test-queue", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream" } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled", "ResourceType": "queue" } }, { "documentation": "Queue AccountId: disabled mode with FIPS falls back to regional queue FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-east-1.amazonaws.com" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseFIPS": true }, "operationName": "ListQueues" } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled", "ResourceType": "queue" } }, { "documentation": "Queue AccountId: disabled mode with DualStack falls back to regional queue DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseDualStack": true }, "operationName": "CreateQueue", "operationParams": { "QueueName": "test-queue", "StreamConfigurationList": [ { "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test-stream" } ] } } ], "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled", "ResourceType": "queue" } }, { "documentation": "Queue AccountId: disabled mode with FIPS and DualStack falls back to regional queue FIPS DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-east-1.api.aws" } }, "operationInputs": [ { "builtInParams": { "AWS::Region": "us-east-1", "AWS::Auth::AccountId": "123456789012", "AWS::Auth::AccountIdEndpointMode": "disabled", "AWS::UseFIPS": true, "AWS::UseDualStack": true }, "operationName": "ListQueues" } ], "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled", "ResourceType": "queue" } }, { "documentation": "ResourceARN with queue type: missing queue id errors", "expect": { "error": "Invalid ARN: Missing queue id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:queue" } }, { "documentation": "ResourceARN with channel type: missing channel id errors", "expect": { "error": "Invalid ARN: Missing channel id." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:channel" } }, { "documentation": "ResourceARN with unsupported type: consumer type is rejected", "expect": { "error": "Invalid ARN: Unsupported resource type `consumer`. Expected: stream, channel, or queue." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:consumer/test-consumer" } }, { "documentation": "QueueARN and StreamARN both set: StreamARN wins by rule ordering today (ResourceType is not yet authoritative on the stream path; revisit if a both-ARN API is introduced)", "expect": { "endpoint": { "url": "https://123.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws:kinesis:us-east-1:123:stream/test-stream", "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN set but ResourceType absent: errors instead of misrouting to the default kinesis endpoint", "expect": { "error": "Invalid Configuration: ResourceType must be \"queue\" when QueueARN is set." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN set but ResourceType is not queue: errors instead of misrouting to the default kinesis endpoint", "expect": { "error": "Invalid Configuration: ResourceType must be \"queue\" when QueueARN is set." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "stream", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "AccountId without ResourceType: non-queue account endpoint is unchanged (no -queues suffix)", "expect": { "endpoint": { "properties": { "metricValues": [ "O" ] }, "url": "https://123456789012.control-kinesis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred" } }, { "documentation": "Queue AccountId: required mode with no AccountId errors", "expect": { "error": "AccountIdEndpointMode is required but no AccountID was provided or able to be loaded" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountIdEndpointMode": "required", "ResourceType": "queue" } }, { "documentation": "QueueARN: OperationType not set errors", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceType": "queue", "QueueARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: aws-iso region falls back to regional queue endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: aws-iso-b region falls back to regional queue endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123456789012:queue/myQueueId" } }, { "documentation": "Queue AccountId in aws-iso: disabled mode falls back to regional queue endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled", "ResourceType": "queue" } }, { "documentation": "ResourceARN with queue type in aws-iso: falls back to regional queue endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type in aws-iso-b: falls back to regional queue endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso-b:kinesis:us-isob-east-1:123456789012:queue/myQueueId" } }, { "documentation": "Queue AccountId in aws-iso: preferred mode falls back to regional queue endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred", "ResourceType": "queue" } }, { "documentation": "QueueARN: aws-iso region with FIPS falls back to regional queue FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type in aws-iso with FIPS: falls back to regional queue FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: aws-iso region with DualStack falls back to regional queue DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "QueueARN: aws-iso region with FIPS and DualStack falls back to regional queue FIPS DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type in aws-iso with DualStack: falls back to regional queue DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type in aws-iso with FIPS and DualStack: falls back to regional queue FIPS DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "Queue AccountId in aws-iso: preferred mode with FIPS falls back to regional queue FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "preferred", "ResourceType": "queue" } }, { "documentation": "Queue AccountId in aws-iso: disabled mode with FIPS falls back to regional queue FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-queues-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "AccountId": "123456789012", "AccountIdEndpointMode": "disabled", "ResourceType": "queue" } }, { "documentation": "ResourceARN with channel type in aws-iso: falls back to default kinesis endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:channel/myChannelId" } }, { "documentation": "ResourceARN with channel type in aws-iso with FIPS: falls back to default kinesis FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:channel/myChannelId" } }, { "documentation": "ChannelARN in aws-iso: falls back to default kinesis endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:channel/myChannelId" } }, { "documentation": "ChannelARN in aws-iso with FIPS: falls back to default kinesis FIPS endpoint", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false, "OperationType": "control", "ChannelARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:channel/myChannelId" } }, { "documentation": "ResourceARN queue in aws-iso: non-kinesis service should error", "expect": { "error": "Invalid ARN: The ARN was not for the Kinesis service, found: sqs." }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:sqs:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN queue in aws-iso: partition mismatch should error", "expect": { "error": "Partition: aws from ARN doesn't match with partition name: aws-iso." }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN queue in aws-iso: missing queue id should error", "expect": { "error": "Invalid ARN: Missing queue id." }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue" } }, { "documentation": "ResourceARN queue in aws-iso: invalid account id should error", "expect": { "error": "Invalid ARN: Invalid account id." }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:invalid..account:queue/myQueueId" } }, { "documentation": "ResourceARN queue in aws-iso: OperationType not set should error", "expect": { "error": "Operation Type is not set. Please contact service team for resolution." }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN queue in aws-iso: invalid queue id should error", "expect": { "error": "Invalid ARN: Invalid queue id." }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:queue/invalid.queue.id" } }, { "documentation": "StreamARN in aws-iso with DualStack: falls back to default kinesis DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true, "OperationType": "control", "StreamARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" } }, { "documentation": "StreamARN in aws-iso with FIPS and DualStack: falls back to default kinesis FIPS DualStack endpoint", "expect": { "endpoint": { "url": "https://kinesis-fips.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "StreamARN": "arn:aws-iso:kinesis:us-iso-east-1:123:stream/test-stream" } }, { "documentation": "StreamARN in aws-iso: missing ARN type falls back to default kinesis endpoint", "expect": { "endpoint": { "url": "https://kinesis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "StreamARN": "arn:aws-iso:kinesis:us-iso-east-1:123456789012:" } }, { "documentation": "QueueARN: partition mismatch errors", "expect": { "error": "Partition: aws-cn from ARN doesn't match with partition name: aws." }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "OperationType": "control", "ResourceType": "queue", "QueueARN": "arn:aws-cn:kinesis:cn-north-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type: FIPS and DualStack", "expect": { "endpoint": { "url": "https://myQueueId.control-kinesis-queues-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "OperationType": "control", "ResourceARN": "arn:aws:kinesis:us-east-1:123456789012:queue/myQueueId" } }, { "documentation": "ResourceARN with queue type: data operation type", "expect": { "endpoint": { "url": "https://myQueueId.data-kinesis-queues.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "OperationType": "data", "ResourceARN": "arn:aws:kinesis:us-west-2:123456789012:queue/myQueueId" } } ], "version": "1.0" } } }, "com.amazonaws.kinesis#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#ListChannels": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ListChannelsInput" }, "output": { "target": "com.amazonaws.kinesis#ListChannelsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#ExpiredNextTokenException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the channels in your account. You can filter the results by source stream. The results are paginated. Use the NextToken value returned in the response to retrieve additional results.

\n

Use this operation to find channels before deleting a stream, or to audit the channels configured in an Amazon Web Services Region.

\n

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "ChannelSummaries", "pageSize": "MaxResults" }, "smithy.api#readonly": {}, "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#ListChannelsInput": { "type": "structure", "members": { "StreamFilter": { "target": "com.amazonaws.kinesis#StreamFilterList", "traits": { "smithy.api#documentation": "

Filters the results to channels associated with the specified streams.

" } }, "MaxResults": { "target": "com.amazonaws.kinesis#ListChannelsInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

" } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

The pagination token returned by a previous call. Specify this token to retrieve the next page of results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#ListChannelsInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ListChannelsOutput": { "type": "structure", "members": { "ChannelSummaries": { "target": "com.amazonaws.kinesis#ChannelSummaryList", "traits": { "smithy.api#documentation": "

A list of channel summaries.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

The pagination token to use in a subsequent call to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ListQueues": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ListQueuesInput" }, "output": { "target": "com.amazonaws.kinesis#ListQueuesOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#ExpiredNextTokenException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a summary of each queue in the Amazon Web Services account and Region used by the\n request. Use StreamFilter to list only the queues on a particular data\n stream.

\n

If the response contains a NextToken, more queues are available. Call\n ListQueues again with that value to retrieve the next page.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "QueueSummaries", "pageSize": "MaxResults" }, "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#ListQueuesInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.kinesis#ListQueuesInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of queue summaries to return in one response. The response might\n contain fewer summaries than this value, and might contain a NextToken even\n when it contains fewer.

" } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

The NextToken returned by a previous ListQueues request. Use it\n to retrieve the next page of queue summaries.

" } }, "StreamFilter": { "target": "com.amazonaws.kinesis#QueueStreamFilterList", "traits": { "smithy.api#documentation": "

Lists only the queues created on the specified data stream.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#ListQueuesInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ListQueuesOutput": { "type": "structure", "members": { "QueueSummaries": { "target": "com.amazonaws.kinesis#QueueSummaryList", "traits": { "smithy.api#documentation": "

A summary of each queue that matched the request.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

The token to pass to the next ListQueues request to retrieve the next page\n of queue summaries. This member is absent when no more queues are available.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ListShards": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ListShardsInput" }, "output": { "target": "com.amazonaws.kinesis#ListShardsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#ExpiredNextTokenException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Lists the shards in a stream and provides information about each shard. This operation\n has a limit of 1000 transactions per second per data stream.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

This action does not list expired shards. For information about expired shards, see\n Data Routing, Data Persistence, and Shard State after a Reshard.

\n \n

This API is a new operation that is used by the Amazon Kinesis Client Library\n (KCL). If you have a fine-grained IAM policy that only allows specific operations,\n you must update your policy to allow calls to this API. For more information, see\n Controlling Access to Amazon Kinesis Data Streams Resources Using\n IAM.

\n
", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#ListShardsInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the data stream whose shards you want to list.

\n

You cannot specify this parameter if you specify the NextToken\n parameter.

" } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards.

\n

Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of shards that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListShards operation.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.

\n
" } }, "ExclusiveStartShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

Specify this parameter to indicate that you want to list the shards starting with the\n shard whose ID immediately follows ExclusiveStartShardId.

\n

If you don't specify this parameter, the default behavior is for\n ListShards to list the shards starting with the first one in the\n stream.

\n

You cannot specify this parameter if you specify NextToken.

" } }, "MaxResults": { "target": "com.amazonaws.kinesis#ListShardsInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of shards to return in a single call to ListShards.\n The maximum number of shards to return in a single call. The default value is 1000. If\n you specify a value greater than 1000, at most 1000 results are returned.

\n

When the number of shards to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListShards to list the next set of\n shards.

" } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the shards for.

\n

You cannot specify this parameter if you specify the NextToken\n parameter.

" } }, "ShardFilter": { "target": "com.amazonaws.kinesis#ShardFilter", "traits": { "smithy.api#documentation": "

Enables you to filter out the response of the ListShards API. You can\n only specify one filter at a time.

\n

If you use the ShardFilter parameter when invoking the ListShards API,\n the Type is the required property and must be specified. If you specify the\n AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or\n AT_LATEST types, you do not need to specify either the\n ShardId or the Timestamp optional properties.

\n

If you specify the AFTER_SHARD_ID type, you must also provide the value\n for the optional ShardId property. The ShardId property is\n identical in fuctionality to the ExclusiveStartShardId parameter of the\n ListShards API. When ShardId property is specified, the\n response includes the shards starting with the shard whose ID immediately follows the\n ShardId that you provided.

\n

If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type,\n you must also provide the value for the optional Timestamp property. If you\n specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp\n are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the\n provided timestamp to TIP are returned.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#ListShardsInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ListShardsOutput": { "type": "structure", "members": { "Shards": { "target": "com.amazonaws.kinesis#ShardList", "traits": { "smithy.api#documentation": "

An array of JSON objects. Each object represents one shard and specifies the IDs of\n the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each\n object also contains the starting and ending hash keys and the starting and ending\n sequence numbers for the shard.

" } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

When the number of shards in the data stream is greater than the default value for the\n MaxResults parameter, or if you explicitly specify a value for\n MaxResults that is less than the number of shards in the data stream,\n the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListShards to\n list the next set of shards. For more information about the use of this pagination token\n when calling the ListShards operation, see ListShardsInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to ListShards, you\n have 300 seconds to use that value. If you specify an expired token in a call to\n ListShards, you get ExpiredNextTokenException.

\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ListStreamConsumers": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ListStreamConsumersInput" }, "output": { "target": "com.amazonaws.kinesis#ListStreamConsumersOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#ExpiredNextTokenException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Lists the consumers registered to receive data from a stream using enhanced fan-out,\n and provides information about each consumer.

\n

This operation has a limit of 5 transactions per second per stream.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#ListStreamConsumersInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis data stream for which you want to list the registered\n consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "StreamARN" } } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of consumers\n that are registered with the data stream, the response includes a pagination token named\n NextToken. You can specify this NextToken value in a\n subsequent call to ListStreamConsumers to list the next set of registered\n consumers.

\n

Don't specify StreamName or StreamCreationTimestamp if you\n specify NextToken because the latter unambiguously identifies the\n stream.

\n

You can optionally specify a value for the MaxResults parameter when you\n specify NextToken. If you specify a MaxResults value that is\n less than the number of consumers that the operation returns if you don't specify\n MaxResults, the response will contain a new NextToken\n value. You can use the new NextToken value in a subsequent call to the\n ListStreamConsumers operation to list the next set of consumers.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n
" } }, "MaxResults": { "target": "com.amazonaws.kinesis#ListStreamConsumersInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of consumers that you want a single call of\n ListStreamConsumers to return. The default value is 100. If you specify\n a value greater than 100, at most 100 results are returned.

" } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

Specify this input parameter to distinguish data streams that have the same name. For\n example, if you create a data stream and then delete it, and you later create another\n data stream with the same name, you can use this input parameter to specify which of the\n two streams you want to list the consumers for.

\n

You can't specify this parameter if you specify the NextToken parameter.

" } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#ListStreamConsumersInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ListStreamConsumersOutput": { "type": "structure", "members": { "Consumers": { "target": "com.amazonaws.kinesis#ConsumerList", "traits": { "smithy.api#documentation": "

An array of JSON objects. Each object represents one registered consumer.

" } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

When the number of consumers that are registered with the data stream is greater than\n the default value for the MaxResults parameter, or if you explicitly\n specify a value for MaxResults that is less than the number of registered\n consumers, the response includes a pagination token named NextToken. You\n can specify this NextToken value in a subsequent call to\n ListStreamConsumers to list the next set of registered consumers. For\n more information about the use of this pagination token when calling the\n ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

\n \n

Tokens expire after 300 seconds. When you obtain a value for\n NextToken in the response to a call to\n ListStreamConsumers, you have 300 seconds to use that value. If you\n specify an expired token in a call to ListStreamConsumers, you get\n ExpiredNextTokenException.

\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ListStreams": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ListStreamsInput" }, "output": { "target": "com.amazonaws.kinesis#ListStreamsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#ExpiredNextTokenException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" } ], "traits": { "smithy.api#documentation": "

Lists your Kinesis data streams.

\n

The number of streams may be too large to return from a single call to\n ListStreams. You can limit the number of returned streams using the\n Limit parameter. If you do not specify a value for the\n Limit parameter, Kinesis Data Streams uses the default limit, which is\n currently 100.

\n

You can detect if there are more streams available to list by using the\n HasMoreStreams flag from the returned output. If there are more streams\n available, you can request more streams by using the name of the last stream returned by\n the ListStreams request in the ExclusiveStartStreamName\n parameter in a subsequent request to ListStreams. The group of stream names\n returned by the subsequent request is then added to the list. You can continue this\n process until all the stream names have been collected in the list.

\n

\n ListStreams has a limit of five transactions per second per\n account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "Limit" }, "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } }, "smithy.test#smokeTests": [ { "id": "ListStreamsSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.kinesis#ListStreamsInput": { "type": "structure", "members": { "Limit": { "target": "com.amazonaws.kinesis#ListStreamsInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of streams to list. The default value is 100. If you specify a\n value greater than 100, at most 100 results are returned.

" } }, "ExclusiveStartStreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to start the list with.

" } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Represents the input for ListStreams.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#ListStreamsInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#ListStreamsOutput": { "type": "structure", "members": { "StreamNames": { "target": "com.amazonaws.kinesis#StreamNameList", "traits": { "smithy.api#documentation": "

The names of the streams that are associated with the Amazon Web Services account\n making the ListStreams request.

", "smithy.api#required": {} } }, "HasMoreStreams": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

If set to true, there are more streams available to list.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.kinesis#NextToken", "traits": { "smithy.api#documentation": "

" } }, "StreamSummaries": { "target": "com.amazonaws.kinesis#StreamSummaryList", "traits": { "smithy.api#documentation": "

" } } }, "traits": { "smithy.api#documentation": "

Represents the output for ListStreams.

", "smithy.api#output": {} } }, "com.amazonaws.kinesis#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.kinesis#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

List all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

\n

The Kinesis resource can be a data stream, a queue, or an enhanced fan-out\n consumer.

\n

For more information about tagging Kinesis resources, see Tag your Amazon Kinesis Data Streams resources.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#ListTagsForResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.kinesis#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis resource for which to list tags.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.kinesis#TagList", "traits": { "smithy.api#documentation": "

An array of tags associated with the specified Kinesis resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ListTagsForStream": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ListTagsForStreamInput" }, "output": { "target": "com.amazonaws.kinesis#ListTagsForStreamOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Lists the tags for the specified Kinesis data stream. This operation has a limit of\n five transactions per second per account.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#ListTagsForStreamInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream.

" } }, "ExclusiveStartTagKey": { "target": "com.amazonaws.kinesis#TagKey", "traits": { "smithy.api#documentation": "

The key to use as the starting point for the list of tags. If this parameter is set,\n ListTagsForStream gets all tags that occur after\n ExclusiveStartTagKey.

" } }, "Limit": { "target": "com.amazonaws.kinesis#ListTagsForStreamInputLimit", "traits": { "smithy.api#documentation": "

The number of tags to return. If this number is less than the total number of tags\n associated with the stream, HasMoreTags is set to true. To\n list additional tags, set ExclusiveStartTagKey to the last key in the\n response.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for ListTagsForStream.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#ListTagsForStreamInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.kinesis#ListTagsForStreamOutput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.kinesis#TagList", "traits": { "smithy.api#documentation": "

A list of tags associated with StreamName, starting with the first tag\n after ExclusiveStartTagKey and up to the specified Limit.\n

", "smithy.api#required": {} } }, "HasMoreTags": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

If set to true, more tags are available. To request additional tags, set\n ExclusiveStartTagKey to the key of the last tag returned.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Represents the output for ListTagsForStream.

", "smithy.api#output": {} } }, "com.amazonaws.kinesis#MaxReceiveCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.kinesis#MaxRecordSizeInKiB": { "type": "integer", "traits": { "smithy.api#range": { "min": 1024, "max": 10240 } } }, "com.amazonaws.kinesis#MergeShards": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#MergeShardsInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Merges two adjacent shards in a Kinesis data stream and combines them into a single\n shard to reduce the stream's capacity to ingest and transport data. This API is only\n supported for the data streams with the provisioned capacity mode. Two shards are\n considered adjacent if the union of the hash key ranges for the two shards form a\n contiguous set with no gaps. For example, if you have two shards, one with a hash key\n range of 276...381 and the other with a hash key range of 382...454, then you could\n merge these two shards into a single shard that would have a hash key range of\n 276...454. After the merge, the single child shard receives data for all hash key values\n covered by the two parent shards.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

\n MergeShards is called when there is a need to reduce the overall capacity\n of a stream because of excess capacity that is not being used. You must specify the\n shard to be merged and the adjacent shard for a stream. For more information about\n merging shards, see Merge Two\n Shards in the Amazon Kinesis Data Streams Developer\n Guide.

\n

If the stream is in the ACTIVE state, you can call\n MergeShards. If a stream is in the CREATING,\n UPDATING, or DELETING state, MergeShards\n returns a ResourceInUseException. If the specified stream does not exist,\n MergeShards returns a ResourceNotFoundException.

\n

You can use DescribeStreamSummary to check the state of the stream,\n which is returned in StreamStatus.

\n

\n MergeShards is an asynchronous operation. Upon receiving a\n MergeShards request, Amazon Kinesis Data Streams immediately returns a\n response and sets the StreamStatus to UPDATING. After the\n operation is completed, Kinesis Data Streams sets the StreamStatus to\n ACTIVE. Read and write operations continue to work while the stream is\n in the UPDATING state.

\n

You use DescribeStreamSummary and the ListShards\n APIs to determine the shard IDs that are specified in the MergeShards\n request.

\n

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards,\n or SplitShard, you receive a LimitExceededException.

\n

\n MergeShards has a limit of five transactions per second per account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#MergeShardsInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream for the merge.

" } }, "ShardToMerge": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the shard to combine with the adjacent shard for the merge.

", "smithy.api#required": {} } }, "AdjacentShardToMerge": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the adjacent shard for the merge.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for MergeShards.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#MetricsName": { "type": "enum", "members": { "INCOMING_BYTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IncomingBytes" } }, "INCOMING_RECORDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IncomingRecords" } }, "OUTGOING_BYTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OutgoingBytes" } }, "OUTGOING_RECORDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OutgoingRecords" } }, "WRITE_PROVISIONED_THROUGHPUT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WriteProvisionedThroughputExceeded" } }, "READ_PROVISIONED_THROUGHPUT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReadProvisionedThroughputExceeded" } }, "ITERATOR_AGE_MILLISECONDS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IteratorAgeMilliseconds" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } } } }, "com.amazonaws.kinesis#MetricsNameList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#MetricsName" }, "traits": { "smithy.api#length": { "min": 1, "max": 7 } } }, "com.amazonaws.kinesis#MillisBehindLatest": { "type": "long", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentInput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentInputStatus", "traits": { "smithy.api#documentation": "

The desired status of the minimum throughput billing commitment.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Represents the request parameters for configuring minimum throughput billing commitment.

\n \n \n " } }, "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentInputStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentOutput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentOutputStatus", "traits": { "smithy.api#documentation": "

The current status of the minimum throughput billing commitment.

", "smithy.api#required": {} } }, "StartedAt": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the commitment was started.

" } }, "EndedAt": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the commitment was ended.

" } }, "EarliestAllowedEndAt": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The earliest timestamp when the commitment can be ended.

" } } }, "traits": { "smithy.api#documentation": "

Represents the current status of minimum throughput billing commitment for an account.

" } }, "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentOutputStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "ENABLED_UNTIL_EARLIEST_ALLOWED_END": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED_UNTIL_EARLIEST_ALLOWED_END" } } } }, "com.amazonaws.kinesis#NaturalIntegerObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.kinesis#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1048576 } } }, "com.amazonaws.kinesis#OnDemandStreamCountLimitObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.kinesis#OnDemandStreamCountObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.kinesis#PartitionField": { "type": "structure", "members": { "Transform": { "target": "com.amazonaws.kinesis#PartitionTransform", "traits": { "smithy.api#documentation": "

The partition transform to apply. The only valid value is TIME_HOUR.

", "smithy.api#required": {} } }, "SourceName": { "target": "com.amazonaws.kinesis#PartitionSourceName", "traits": { "smithy.api#documentation": "

The name of the source column used for partitioning. This column must be of the timestamptz type.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies a single partition field.

" } }, "com.amazonaws.kinesis#PartitionFieldList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#PartitionField" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.kinesis#PartitionKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.kinesis#PartitionSourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9\\.\\_]+$" } }, "com.amazonaws.kinesis#PartitionSpec": { "type": "structure", "members": { "PartitionFields": { "target": "com.amazonaws.kinesis#PartitionFieldList", "traits": { "smithy.api#documentation": "

The list of partition fields.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies how the destination table is partitioned.

" } }, "com.amazonaws.kinesis#PartitionTransform": { "type": "enum", "members": { "TIME_HOUR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIME_HOUR" } } } }, "com.amazonaws.kinesis#Policy": { "type": "string" }, "com.amazonaws.kinesis#PositiveIntegerObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.kinesis#ProvisionedThroughputExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The request rate for the stream is too high, or the requested data is too large for\n the available throughput. Reduce the frequency or size of your requests. For more\n information, see Streams Limits in the\n Amazon Kinesis Data Streams Developer Guide, and Error Retries and\n Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#PutRecord": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#PutRecordInput" }, "output": { "target": "com.amazonaws.kinesis#PutRecordOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#DryRunOperationException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, { "target": "com.amazonaws.kinesis#KMSDisabledException" }, { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, { "target": "com.amazonaws.kinesis#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Writes a single data record into an Amazon Kinesis data stream. Call\n PutRecord to send data into the stream for real-time ingestion and\n subsequent processing, one record at a time. Each shard can support writes up to 1,000\n records per second, up to a maximum data write total of 10 MiB per second.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

You must specify the name of the stream that captures, stores, and transports the\n data; a partition key; and the data blob itself.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams to distribute data across shards.\n Kinesis Data Streams segregates the data records that belong to a stream into multiple\n shards, using the partition key associated with each data record to determine the shard\n to which a given data record belongs.

\n

Partition keys are Unicode strings, with a maximum length limit of 256 characters for\n each key. An MD5 hash function is used to map partition keys to 128-bit integer values\n and to map associated data records to shards using the hash key ranges of the shards.\n You can override hashing the partition key to determine the shard by explicitly\n specifying a hash value using the ExplicitHashKey parameter. For more\n information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

\n PutRecord returns the shard ID of where the data record was placed and the\n sequence number that was assigned to the data record.

\n

Sequence numbers increase over time and are specific to a shard within a stream, not\n across all shards within a stream. To guarantee strictly increasing ordering, write\n serially to a shard and use the SequenceNumberForOrdering parameter. For\n more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n
\n

If a PutRecord request cannot be processed because of insufficient\n provisioned throughput on the shard involved in the request, PutRecord\n throws ProvisionedThroughputExceededException.

\n

By default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#PutRecordInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to put the data record into.

" } }, "Data": { "target": "com.amazonaws.kinesis#Data", "traits": { "smithy.api#documentation": "

The data blob to put into the record, which is base64-encoded when the blob is\n serialized. When the data blob (the payload before base64-encoding) is added to the\n partition key size, the total size must not exceed the maximum record size (10\n MiB).

", "smithy.api#required": {} } }, "PartitionKey": { "target": "com.amazonaws.kinesis#PartitionKey", "traits": { "smithy.api#documentation": "

Determines which shard in the stream the data record is assigned to. Partition keys\n are Unicode strings with a maximum length limit of 256 characters for each key. Amazon\n Kinesis Data Streams uses the partition key as input to a hash function that maps the\n partition key and associated data to a specific shard. Specifically, an MD5 hash\n function is used to map partition keys to 128-bit integer values and to map associated\n data records to shards. As a result of this hashing mechanism, all data records with the\n same partition key map to the same shard within the stream.

\n

If the stream uses the USER_PARTITION_KEY record distribution strategy\n (the default), a partition key is required. If the stream uses the AUTO\n record distribution strategy, the partition key is optional and any value you provide is\n ignored, along with any ExplicitHashKey you provide. In that case, Amazon\n Kinesis Data Streams distributes the record across shards using service-managed\n algorithms. For more information, see\n UpdateStreamRecordDistributionStrategy.

" } }, "ExplicitHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { "smithy.api#documentation": "

The hash value used to explicitly determine the shard the data record is assigned to\n by overriding the partition key hash.

" } }, "SequenceNumberForOrdering": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

Guarantees strictly increasing sequence numbers, for puts from the same client and to\n the same partition key. Usage: set the SequenceNumberForOrdering of record\n n to the sequence number of record n-1 (as\n returned in the result when putting record n-1). If this parameter\n is not set, records are coarsely ordered based on arrival time.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "DryRun": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

Checks if your request will succeed. DryRun is an optional\n parameter.

" } } }, "traits": { "smithy.api#documentation": "

Represents the input for PutRecord.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#PutRecordOutput": { "type": "structure", "members": { "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the shard where the data record was placed.

", "smithy.api#required": {} } }, "SequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

The sequence number identifier that was assigned to the put data record. The sequence\n number for the record is unique across all records in the stream. A sequence number is\n the identifier associated with every record put into the stream.

", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { "smithy.api#documentation": "

The encryption type to use on the record. This parameter can be one of the following\n values:

\n " } } }, "traits": { "smithy.api#documentation": "

Represents the output for PutRecord.

", "smithy.api#output": {} } }, "com.amazonaws.kinesis#PutRecords": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#PutRecordsInput" }, "output": { "target": "com.amazonaws.kinesis#PutRecordsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#DryRunOperationException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, { "target": "com.amazonaws.kinesis#KMSDisabledException" }, { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, { "target": "com.amazonaws.kinesis#ProvisionedThroughputExceededException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Writes multiple data records into a Kinesis data stream in a single call (also\n referred to as a PutRecords request). Use this operation to send data into\n the stream for data ingestion and processing.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

Each PutRecords request can support up to 500 records. Each record in the\n request can be as large as 10 MiB, up to a limit of 10 MiB for the entire request,\n including partition keys. Each shard can support writes up to 1,000 records per second,\n up to a maximum data write total of 1 MB per second.

\n

You must specify the name of the stream that captures, stores, and transports the\n data; and an array of request Records, with each record in the array\n requiring a partition key and data blob. The record size limit applies to the total size\n of the partition key and data blob.

\n

The data blob can be any type of data; for example, a segment from a log file,\n geographic/location data, website clickstream data, and so on.

\n

The partition key is used by Kinesis Data Streams as input to a hash function that\n maps the partition key and associated data to a specific shard. An MD5 hash function is\n used to map partition keys to 128-bit integer values and to map associated data records\n to shards. As a result of this hashing mechanism, all data records with the same\n partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams\n Developer Guide.

\n

Each record in the Records array may include an optional parameter,\n ExplicitHashKey, which overrides the partition key to shard mapping.\n This parameter allows a data producer to determine explicitly the shard where the record\n is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n

The PutRecords response includes an array of response\n Records. Each record in the response array directly correlates with a\n record in the request array using natural ordering, from the top to the bottom of the\n request and response. The response Records array always includes the same\n number of records as the request array.

\n

The response Records array includes both successfully and unsuccessfully\n processed records. Kinesis Data Streams attempts to process all records in each\n PutRecords request. A single record failure does not stop the\n processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering\n of records. If you need to read records in the same order they are written to the\n stream, use PutRecord instead of PutRecords, and write to\n the same shard.

\n

A successfully processed record includes ShardId and\n SequenceNumber values. The ShardId parameter identifies\n the shard in the stream where the record is stored. The SequenceNumber\n parameter is an identifier assigned to the put record, unique to all records in the\n stream.

\n

An unsuccessfully processed record includes ErrorCode and\n ErrorMessage values. ErrorCode reflects the type of error\n and can be one of the following values:\n ProvisionedThroughputExceededException or InternalFailure.\n ErrorMessage provides more detailed information about the\n ProvisionedThroughputExceededException exception including the account\n ID, stream name, and shard ID of the record that was throttled. For more information\n about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis\n Data Streams Developer Guide.

\n \n

After you write a record to a stream, you cannot modify that record or its order\n within the stream.

\n
\n

By default, data records are accessible for 24 hours from the time that they are added\n to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#PutRecordsInput": { "type": "structure", "members": { "Records": { "target": "com.amazonaws.kinesis#PutRecordsRequestEntryList", "traits": { "smithy.api#documentation": "

The records associated with the request.

", "smithy.api#required": {} } }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The stream name associated with the request.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "DryRun": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

Checks if your request will succeed. DryRun is an optional\n parameter.

" } } }, "traits": { "smithy.api#documentation": "

A PutRecords request.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#PutRecordsOutput": { "type": "structure", "members": { "FailedRecordCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { "smithy.api#documentation": "

The number of unsuccessfully processed records in a PutRecords\n request.

" } }, "Records": { "target": "com.amazonaws.kinesis#PutRecordsResultEntryList", "traits": { "smithy.api#documentation": "

An array of successfully and unsuccessfully processed record results. A record that is\n successfully added to a stream includes SequenceNumber and\n ShardId in the result. A record that fails to be added to a stream\n includes ErrorCode and ErrorMessage in the result.

", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { "smithy.api#documentation": "

The encryption type used on the records. This parameter can be one of the following\n values:

\n " } } }, "traits": { "smithy.api#documentation": "

\n PutRecords results.

", "smithy.api#output": {} } }, "com.amazonaws.kinesis#PutRecordsRequestEntry": { "type": "structure", "members": { "Data": { "target": "com.amazonaws.kinesis#Data", "traits": { "smithy.api#documentation": "

The data blob to put into the record, which is base64-encoded when the blob is\n serialized. When the data blob (the payload before base64-encoding) is added to the\n partition key size, the total size must not exceed the maximum record size (10\n MiB).

", "smithy.api#required": {} } }, "ExplicitHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { "smithy.api#documentation": "

The hash value used to determine explicitly the shard that the data record is assigned\n to by overriding the partition key hash.

" } }, "PartitionKey": { "target": "com.amazonaws.kinesis#PartitionKey", "traits": { "smithy.api#documentation": "

Determines which shard in the stream the data record is assigned to. Partition keys\n are Unicode strings with a maximum length limit of 256 characters for each key. Amazon\n Kinesis Data Streams uses the partition key as input to a hash function that maps the\n partition key and associated data to a specific shard. Specifically, an MD5 hash\n function is used to map partition keys to 128-bit integer values and to map associated\n data records to shards. As a result of this hashing mechanism, all data records with the\n same partition key map to the same shard within the stream.

\n

If the stream uses the USER_PARTITION_KEY record distribution strategy\n (the default), a partition key is required for each record. If the stream uses the\n AUTO record distribution strategy, the partition key is optional and any\n value you provide is ignored, along with any ExplicitHashKey you provide.\n In that case, Amazon Kinesis Data Streams distributes records across shards using\n service-managed algorithms. For more information, see\n UpdateStreamRecordDistributionStrategy.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output for PutRecords.

" } }, "com.amazonaws.kinesis#PutRecordsRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#PutRecordsRequestEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.kinesis#PutRecordsResultEntry": { "type": "structure", "members": { "SequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

The sequence number for an individual record result.

" } }, "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID for an individual record result.

" } }, "ErrorCode": { "target": "com.amazonaws.kinesis#ErrorCode", "traits": { "smithy.api#documentation": "

The error code for an individual record result. ErrorCodes can be either\n ProvisionedThroughputExceededException or\n InternalFailure.

" } }, "ErrorMessage": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

The error message for an individual record result. An ErrorCode value of\n ProvisionedThroughputExceededException has an error message that\n includes the account ID, stream name, and shard ID. An ErrorCode value of\n InternalFailure has the error message \"Internal Service\n Failure\".

" } } }, "traits": { "smithy.api#documentation": "

Represents the result of an individual record from a PutRecords request.\n A record that is successfully added to a stream includes SequenceNumber and\n ShardId in the result. A record that fails to be added to the stream\n includes ErrorCode and ErrorMessage in the result.

" } }, "com.amazonaws.kinesis#PutRecordsResultEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#PutRecordsResultEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.kinesis#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#PutResourcePolicyInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Attaches a resource-based policy to a data stream, a queue, or an enhanced fan-out consumer. If you are using an identity other than the root user of \n the Amazon Web Services account that owns the resource, the calling identity must have the PutResourcePolicy permissions on the \n specified Kinesis Data Streams resource and belong to the owner's account in order to use this operation.\n If you don't have PutResourcePolicy permissions, Amazon Kinesis Data Streams returns a 403 Access Denied error. \n If you receive a ResourceNotFoundException, check to see if you passed a valid stream or consumer resource.\n

\n

Request patterns can be one of the following:

\n \n

For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#PutResourcePolicyInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.kinesis#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data stream, a queue, or an enhanced fan-out\n consumer.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "Policy": { "target": "com.amazonaws.kinesis#Policy", "traits": { "smithy.api#documentation": "

Details of the resource policy. It must include the identity of the principal and the actions allowed on this resource. This is formatted as a JSON string.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#QueueARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws.*:kinesis:.*:\\d{12}:queue/\\S+$" } }, "com.amazonaws.kinesis#QueueAttributes": { "type": "structure", "members": { "VisibilityTimeoutSeconds": { "target": "com.amazonaws.kinesis#VisibilityTimeoutSeconds", "traits": { "smithy.api#documentation": "

The duration, in seconds, that a record is in flight and not visible to any consumer\n instance after it is received. A record that is not acknowledged before this duration elapses becomes\n visible in the queue again and can be received by any consumer instance. If you omit this\n attribute when you create a queue, the queue uses 30 seconds.

" } }, "DeadLetterConfiguration": { "target": "com.amazonaws.kinesis#DeadLetterConfiguration", "traits": { "smithy.api#documentation": "

The dead-letter handling configuration for the queue. If you omit this attribute,\n dead-letter handling is enabled with a MaxReceiveCount of 6. If you specify\n it with a TargetType of BUILT_IN, you must also specify\n MaxReceiveCount.

" } } }, "traits": { "smithy.api#documentation": "

The configuration attributes for a queue.

" } }, "com.amazonaws.kinesis#QueueCountObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.kinesis#QueueDescription": { "type": "structure", "members": { "QueueName": { "target": "com.amazonaws.kinesis#QueueName", "traits": { "smithy.api#documentation": "

The name of the queue.

", "smithy.api#required": {} } }, "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue. The resource identifier in the ARN is generated when the queue is\n created and is not derived from QueueName. Use the returned\n QueueARN to identify the queue in subsequent requests.

", "smithy.api#required": {} } }, "QueueStatus": { "target": "com.amazonaws.kinesis#QueueStatus", "traits": { "smithy.api#documentation": "

The current status of the queue.

", "smithy.api#required": {} } }, "QueueCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time the queue was created.

", "smithy.api#required": {} } }, "StreamConfigurationList": { "target": "com.amazonaws.kinesis#QueueStreamConfigurationList", "traits": { "smithy.api#documentation": "

The data stream the queue delivers records from, and the position in that stream\n where delivery begins. The list contains exactly one entry, because a queue delivers\n records from a single data stream.

", "smithy.api#required": {} } }, "QueueAttributes": { "target": "com.amazonaws.kinesis#QueueAttributes", "traits": { "smithy.api#documentation": "

The configuration attributes of the queue.

" } } }, "traits": { "smithy.api#documentation": "

A description of a queue. Returned by CreateQueue,\n UpdateQueue, and DescribeQueue.

" } }, "com.amazonaws.kinesis#QueueName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesis#QueueRecord": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The identifier you use to acknowledge this record, change its visibility, or restore it\n after it becomes a dead-letter record. A new receipt handle is issued each time the\n record is received.

", "smithy.api#required": {} } }, "RecordId": { "target": "com.amazonaws.kinesis#RecordId", "traits": { "smithy.api#documentation": "

The unique identifier of the record. This value stays the same across every delivery of\n the record, and it is the same in every queue on the stream that delivers the record. To\n identify a single delivery, use ReceiptHandle instead.

", "smithy.api#required": {} } }, "PartitionKey": { "target": "com.amazonaws.kinesis#PartitionKey", "traits": { "smithy.api#documentation": "

The partition key the record was written to the data stream with.

" } }, "Data": { "target": "com.amazonaws.kinesis#Data", "traits": { "smithy.api#documentation": "

The data blob of the record. Amazon Kinesis Data Streams does not inspect, interpret, or\n change the data.

", "smithy.api#required": {} } }, "ApproximateArrivalTimestamp": { "target": "com.amazonaws.kinesis#ApproximateArrivalTimestamp", "traits": { "smithy.api#documentation": "

The approximate time the record arrived in the data stream. The difference between this\n value and the current time is how long the record took to reach your queue consumer.

", "smithy.api#required": {} } }, "FirstReceiveTimestamp": { "target": "com.amazonaws.kinesis#FirstReceiveTimestamp", "traits": { "smithy.api#documentation": "

The approximate time the record was first received from the queue.

", "smithy.api#required": {} } }, "ReceiveCount": { "target": "com.amazonaws.kinesis#ReceiveCount", "traits": { "smithy.api#documentation": "

The number of times this record has been received without being\n acknowledged.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A data stream record, as delivered through a queue.

" } }, "com.amazonaws.kinesis#QueueRecordList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#QueueRecord" } }, "com.amazonaws.kinesis#QueueStartingPosition": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.kinesis#QueueStartingPositionType", "traits": { "smithy.api#documentation": "

You can set the starting position to one of the following values:

\n

\n LATEST: Delivers records that arrive after you create the queue. This is\n the default.

\n

\n TRIM_HORIZON: Start delivering at the last untrimmed record in the\n stream, which is the oldest record the stream still retains.

\n

\n AT_TIMESTAMP: Delivers records that arrive at or after a time stamp that\n you provide.

", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The approximate time from which the queue begins delivering records. Records that arrive\n at approximately this time or later are delivered.

\n

In a request, specify this value only when Type is\n AT_TIMESTAMP. It is required in that case, and specifying it for any\n other type returns a ValidationException.

\n

In a response, this value is approximate and reflects the queue's effective starting\n position. While the queue is CREATING, the response echoes what you\n configured: for AT_TIMESTAMP, the timestamp you provided, and for\n TRIM_HORIZON and LATEST, this member is absent because the\n effective position is not yet determined. Once the queue is ACTIVE, the\n response always includes this member. For AT_TIMESTAMP, it is the timestamp you\n provided or the earliest time the stream can be read from, whichever is later.

" } } }, "traits": { "smithy.api#documentation": "

The position in a data stream from which a queue begins delivering records.

" } }, "com.amazonaws.kinesis#QueueStartingPositionType": { "type": "enum", "members": { "TRIM_HORIZON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRIM_HORIZON" } }, "LATEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LATEST" } }, "AT_TIMESTAMP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AT_TIMESTAMP" } } } }, "com.amazonaws.kinesis#QueueStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.kinesis#QueueStreamConfiguration": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the data stream.

", "smithy.api#required": {} } }, "StartingPosition": { "target": "com.amazonaws.kinesis#QueueStartingPosition", "traits": { "smithy.api#documentation": "

The position in the stream from which the queue begins delivering records. The default\n is LATEST.

" } } }, "traits": { "smithy.api#documentation": "

The data stream a queue delivers records from, and the position in that stream where\n delivery begins.

" } }, "com.amazonaws.kinesis#QueueStreamConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#QueueStreamConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#QueueStreamFilter": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the data stream to filter on.

", "smithy.api#required": {} } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time the data stream was created. Specify this value to distinguish between a deleted\n stream and a stream that was recreated with the same name.

" } } }, "traits": { "smithy.api#documentation": "

Filters the queues returned by ListQueues to those created on a\n particular data stream.

" } }, "com.amazonaws.kinesis#QueueStreamFilterList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#QueueStreamFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#QueueStreamIdentifier": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the data stream.

", "smithy.api#required": {} } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time the data stream was created.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifies a data stream associated with a queue.

" } }, "com.amazonaws.kinesis#QueueStreamIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#QueueStreamIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#QueueSummary": { "type": "structure", "members": { "QueueName": { "target": "com.amazonaws.kinesis#QueueName", "traits": { "smithy.api#documentation": "

The name of the queue.

", "smithy.api#required": {} } }, "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue.

", "smithy.api#required": {} } }, "QueueStatus": { "target": "com.amazonaws.kinesis#QueueStatus", "traits": { "smithy.api#documentation": "

The current status of the queue.

", "smithy.api#required": {} } }, "QueueCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time the queue was created.

", "smithy.api#required": {} } }, "Streams": { "target": "com.amazonaws.kinesis#QueueStreamIdentifierList", "traits": { "smithy.api#documentation": "

The data stream the queue delivers records from.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A summary of a queue. Returned by ListQueues. To retrieve a queue's\n configuration attributes, use DescribeQueue.

" } }, "com.amazonaws.kinesis#QueueSummaryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#QueueSummary" } }, "com.amazonaws.kinesis#ReceiptHandle": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.kinesis#ReceiveCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.kinesis#ReceiveDeadLetterQueueRecords": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ReceiveDeadLetterQueueRecordsInput" }, "output": { "target": "com.amazonaws.kinesis#ReceiveDeadLetterQueueRecordsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, { "target": "com.amazonaws.kinesis#KMSDisabledException" }, { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Receives up to 10 dead-letter records from the specified queue. Each queue has built-in\n dead-letter handling: when a record has been received MaxReceiveCount times\n without being acknowledged, it becomes a dead-letter record, which usually means your queue\n consumer could not process it. The dead-letter record stays in the same queue, and\n ReceiveQueueRecords no longer returns it.

\n

Dead-letter records carry the same data and partition key as when\n they were first delivered, and are returned with a receipt handle. Use the receipt\n handle to acknowledge the record with\n AcknowledgeDeadLetterQueueRecords, which discards it, to change its\n visibility with UpdateDeadLetterQueueRecordsVisibility, or to restore\n it with RestoreDeadLetterQueueRecords, which returns it to the normal\n receive path so that ReceiveQueueRecords can return it again.

\n

Use this operation to inspect the records your queue consumer could not process, so you\n can correct the cause and then either acknowledge or restore them.

\n

A queue delivers dead-letter records while it is in the ACTIVE\n state.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#ReceiveDeadLetterQueueRecordsInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue whose dead-letter records are received.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "Limit": { "target": "com.amazonaws.kinesis#ReceiveQueueRecordsInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of records to return. The queue never returns more dead-letter records\n than this value, and might return fewer. The default is 10.

" } }, "WaitTimeSeconds": { "target": "com.amazonaws.kinesis#ReceiveQueueRecordsWaitTimeSeconds", "traits": { "smithy.api#documentation": "

The duration, in seconds, that the call waits for a record to become visible before\n returning. The default is 9.

" } }, "VisibilityTimeoutSeconds": { "target": "com.amazonaws.kinesis#VisibilityTimeoutSeconds", "traits": { "smithy.api#documentation": "

The duration, in seconds, that the records returned by this request are in flight and not\n visible to any consumer instance. If you do not specify this value, the queue's visibility\n timeout is used.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#ReceiveDeadLetterQueueRecordsOutput": { "type": "structure", "members": { "QueueRecords": { "target": "com.amazonaws.kinesis#QueueRecordList", "traits": { "smithy.api#documentation": "

The dead-letter records received from the queue. This list is empty when no\n dead-letter records are visible.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ReceiveQueueRecords": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#ReceiveQueueRecordsInput" }, "output": { "target": "com.amazonaws.kinesis#ReceiveQueueRecordsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, { "target": "com.amazonaws.kinesis#KMSDisabledException" }, { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Receives up to 10 records from the specified queue. Each record is returned with a\n receipt handle, which is the identifier you use to acknowledge the record or change its\n visibility.

\n

A record returned by ReceiveQueueRecords becomes in flight: it is not visible\n to any consumer instance for the duration of its visibility timeout, so subsequent\n receive requests do not return it while your queue consumer processes it. Acknowledge the record with\n AcknowledgeQueueRecords when you finish processing it. A record that is\n not acknowledged before its visibility timeout expires becomes visible in the queue again\n and can be received by any consumer instance.

\n

Use WaitTimeSeconds to control how long the call waits for a record to\n become visible before returning. If a record becomes visible sooner, the call returns\n sooner. If the wait time expires and no records are visible, the call returns an empty\n list of records.

\n

Records are not necessarily received in the order they were written to the data\n stream.

\n

A queue delivers records while it is in the ACTIVE state.

\n

On rare occasions, a queue can deliver a record more than once. Design your queue consumer to be idempotent, so that processing the same record more than once is safe.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#ReceiveQueueRecordsInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue to receive records from.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "Limit": { "target": "com.amazonaws.kinesis#ReceiveQueueRecordsInputLimit", "traits": { "smithy.api#documentation": "

The maximum number of records to return. The queue never returns more records than this\n value, and might return fewer. The default is 10.

" } }, "WaitTimeSeconds": { "target": "com.amazonaws.kinesis#ReceiveQueueRecordsWaitTimeSeconds", "traits": { "smithy.api#documentation": "

The duration, in seconds, that the call waits for a record to become visible before\n returning. The default is 9.

" } }, "VisibilityTimeoutSeconds": { "target": "com.amazonaws.kinesis#VisibilityTimeoutSeconds", "traits": { "smithy.api#documentation": "

The duration, in seconds, that the records returned by this request are in flight and not\n visible to any consumer instance. If you do not specify this value, the queue's visibility\n timeout is used.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#ReceiveQueueRecordsInputLimit": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.kinesis#ReceiveQueueRecordsOutput": { "type": "structure", "members": { "QueueRecords": { "target": "com.amazonaws.kinesis#QueueRecordList", "traits": { "smithy.api#documentation": "

The records received from the queue. This list is empty when no records are\n visible.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ReceiveQueueRecordsWaitTimeSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 20 } } }, "com.amazonaws.kinesis#Record": { "type": "structure", "members": { "SequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

The unique identifier of the record within its shard.

", "smithy.api#required": {} } }, "ApproximateArrivalTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The approximate time that the record was inserted into the stream.

" } }, "Data": { "target": "com.amazonaws.kinesis#Data", "traits": { "smithy.api#documentation": "

The data blob. The data in the blob is both opaque and immutable to Kinesis Data\n Streams, which does not inspect, interpret, or change the data in the blob in any way.\n When the data blob (the payload before base64-encoding) is added to the partition key\n size, the total size must not exceed the maximum record size (10 MiB).

", "smithy.api#required": {} } }, "PartitionKey": { "target": "com.amazonaws.kinesis#PartitionKey", "traits": { "smithy.api#documentation": "

Identifies which shard in the stream the data record is assigned to.

\n

For a stream that uses the AUTO record distribution strategy, this value\n is not returned if the producer did not provide a partition key when writing the record.\n If the producer provided a partition key, the original value is returned even though it\n was not used to determine shard placement.

" } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { "smithy.api#documentation": "

The encryption type used on the record. This parameter can be one of the following\n values:

\n " } } }, "traits": { "smithy.api#documentation": "

The unit of data of the Kinesis data stream, which is composed of a sequence number, a\n partition key, and a data blob.

" } }, "com.amazonaws.kinesis#RecordConfiguration": { "type": "structure", "members": { "RecordFormatType": { "target": "com.amazonaws.kinesis#RecordFormatType", "traits": { "smithy.api#documentation": "

The format of records on the source stream. Valid values:

\n ", "smithy.api#required": {} } }, "GSRSchemaARN": { "target": "com.amazonaws.kinesis#GSRSchemaARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Glue Schema Registry schema used to validate records. Required when the channel destination is a streaming table.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the format of records read from the source stream.

" } }, "com.amazonaws.kinesis#RecordDistributionStrategy": { "type": "enum", "members": { "AUTO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO" } }, "USER_PARTITION_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_PARTITION_KEY" } } } }, "com.amazonaws.kinesis#RecordFormatType": { "type": "enum", "members": { "GSR_JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GSR_JSON" } }, "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } }, "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRING" } }, "BYTE_ARRAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BYTE_ARRAY" } } } }, "com.amazonaws.kinesis#RecordId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$" } }, "com.amazonaws.kinesis#RecordList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#Record" } }, "com.amazonaws.kinesis#RegisterStreamConsumer": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#RegisterStreamConsumerInput" }, "output": { "target": "com.amazonaws.kinesis#RegisterStreamConsumerOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can add tags to the registered consumer when making a RegisterStreamConsumer request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:RegisterStreamConsumer permission, you must also have the kinesis:TagResource permission for the consumer that will be registered. Tags will take effect from the CREATING status of the consumer.

\n

With On-demand Advantage streams, you can register up to 50 consumers per stream to use\n enhanced fan-out. With On-demand Standard and Provisioned streams, you can register up\n to 20 consumers per stream to use enhanced fan-out. Queues share this limit with\n enhanced fan-out consumers: both count as registered consumers on the stream. A given\n consumer can only be registered with one stream at a time.

\n

For an example of how to use this operation, see Develop enhanced fan-out consumers\n with the Amazon Web Services SDK for Java.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#RegisterStreamConsumerInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis data stream that you want to register the consumer with. For\n more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service\n Namespaces.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "StreamARN" } } }, "ConsumerName": { "target": "com.amazonaws.kinesis#ConsumerName", "traits": { "smithy.api#documentation": "

For a given Kinesis data stream, each consumer must have a unique name. However,\n consumer names don't have to be unique across data streams.

", "smithy.api#required": {} } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "Tags": { "target": "com.amazonaws.kinesis#TagMap", "traits": { "smithy.api#documentation": "

A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#RegisterStreamConsumerOutput": { "type": "structure", "members": { "Consumer": { "target": "com.amazonaws.kinesis#Consumer", "traits": { "smithy.api#documentation": "

An object that represents the details of the consumer you registered. When you\n register a consumer, it gets an ARN that is generated by Kinesis Data Streams.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#RemoveTagsFromStream": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#RemoveTagsFromStreamInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Removes tags from the specified Kinesis data stream. Removed tags are deleted and\n cannot be recovered after this operation successfully completes.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

If you specify a tag that does not exist, it is ignored.

\n

\n RemoveTagsFromStream has a limit of five transactions per second per\n account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#RemoveTagsFromStreamInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream.

" } }, "TagKeys": { "target": "com.amazonaws.kinesis#TagKeyList", "traits": { "smithy.api#documentation": "

A list of tag keys. Each corresponding tag is removed from the stream.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for RemoveTagsFromStream.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#ResourceARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws.*:kinesis:.*:\\d{12}:.*(stream|channel|queue)/\\S+$" } }, "com.amazonaws.kinesis#ResourceInUseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecords": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsInput" }, "output": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Restores up to 10 dead-letter records in the specified queue. Restoring a record clears\n its dead-letter state and resets its receive count, so\n ReceiveQueueRecords can return it again, up to MaxReceiveCount times before it becomes a dead-letter record\n again. The result for each entry is reported individually in the response.

\n

Restore records after you have corrected the condition that prevented your queue consumer\n from processing them.

\n

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.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsErrorEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record that was not restored.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.kinesis#ErrorCode", "traits": { "smithy.api#documentation": "

A code identifying the type of failure. One of\n ResourceNotFoundException, InvalidArgumentException,\n ThrottlingException, or InternalFailureException.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the cause of the failure.

" } } }, "traits": { "smithy.api#documentation": "

A dead-letter record that was not restored, and why.

" } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsErrorEntry" } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue whose dead-letter records are restored.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "Entries": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsRequestEntryList", "traits": { "smithy.api#documentation": "

The dead-letter records to restore, identified by their receipt handles.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsOutput": { "type": "structure", "members": { "Successful": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsResultEntryList", "traits": { "smithy.api#documentation": "

The records that were restored.

", "smithy.api#required": {} } }, "Failed": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsErrorEntryList", "traits": { "smithy.api#documentation": "

The records that were not restored, each with the reason the entry failed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsRequestEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record to restore, as returned by\n ReceiveDeadLetterQueueRecords.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A dead-letter record to restore, identified by its receipt handle.

" } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsRequestEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsResultEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record that was restored.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A dead-letter record that was restored.

" } }, "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsResultEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#RestoreDeadLetterQueueRecordsResultEntry" } }, "com.amazonaws.kinesis#RetentionPeriodHours": { "type": "integer" }, "com.amazonaws.kinesis#RoleARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^arn:aws[-a-z0-9]*:iam::\\d{12}:role/[a-zA-Z_0-9+=,.@\\-_/]+$" } }, "com.amazonaws.kinesis#S3CompressionType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "GZIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GZIP" } }, "ZSTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZSTD" } } } }, "com.amazonaws.kinesis#S3DestinationConfiguration": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kinesis#DataFreshnessInSeconds", "traits": { "smithy.api#documentation": "

The maximum age, in seconds, of undelivered data before the channel delivers it to the destination. The default value is 300 seconds.

" } }, "DeadLetterQueueS3Configuration": { "target": "com.amazonaws.kinesis#DeadLetterQueueS3Configuration", "traits": { "smithy.api#documentation": "

The dead-letter queue configuration for records that cannot be delivered. Optional for general purpose Amazon S3 destinations. If not specified, it defaults to the destination bucket with an error prefix.

" } }, "StorageConfiguration": { "target": "com.amazonaws.kinesis#S3StorageConfiguration", "traits": { "smithy.api#documentation": "

The Amazon S3 storage configuration for the channel.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration for delivery to a general purpose Amazon S3 bucket. Used in CreateChannel.

" } }, "com.amazonaws.kinesis#S3DestinationDescription": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kinesis#DataFreshnessInSeconds", "traits": { "smithy.api#documentation": "

The maximum age, in seconds, of undelivered data.

", "smithy.api#required": {} } }, "DeadLetterQueueS3Configuration": { "target": "com.amazonaws.kinesis#DeadLetterQueueS3Configuration", "traits": { "smithy.api#documentation": "

The dead-letter queue configuration for records that cannot be delivered.

", "smithy.api#required": {} } }, "StorageConfiguration": { "target": "com.amazonaws.kinesis#S3StorageConfiguration", "traits": { "smithy.api#documentation": "

The Amazon S3 storage configuration for the channel.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration for delivery to a general purpose Amazon S3 bucket. Returned in ChannelDescription.

" } }, "com.amazonaws.kinesis#S3DestinationUpdateInput": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kinesis#DataFreshnessInSeconds", "traits": { "smithy.api#documentation": "

The maximum age, in seconds, of undelivered data before the channel delivers it to the destination.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The updated configuration for a general purpose Amazon S3 destination. Used in UpdateChannel. Only DataFreshnessInSeconds can be updated.

" } }, "com.amazonaws.kinesis#S3ErrorOutputPrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[0-9A-Za-z!\\-_'.*()\\/]+$" } }, "com.amazonaws.kinesis#S3OutputKeyTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[0-9A-Za-z!\\-_'.*()\\/=:{}]+$" } }, "com.amazonaws.kinesis#S3StorageClass": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } }, "INTELLIGENT_TIERING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTELLIGENT_TIERING" } }, "GLACIER_IR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GLACIER_IR" } } } }, "com.amazonaws.kinesis#S3StorageConfiguration": { "type": "structure", "members": { "BucketARN": { "target": "com.amazonaws.kinesis#BucketARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

", "smithy.api#required": {} } }, "ExpectedBucketOwner": { "target": "com.amazonaws.kinesis#ExpectedBucketOwner", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID of the expected owner of the destination bucket. This value helps prevent delivery to an unintended bucket if ownership changes.

", "smithy.api#required": {} } }, "OutputKeyTemplate": { "target": "com.amazonaws.kinesis#S3OutputKeyTemplate", "traits": { "smithy.api#documentation": "

The template used to construct the Amazon S3 object key for delivered objects. If not specified, a default template is used.

" } }, "StorageClass": { "target": "com.amazonaws.kinesis#S3StorageClass", "traits": { "smithy.api#documentation": "

The Amazon S3 storage class for delivered objects. Valid values:

\n " } }, "CompressionType": { "target": "com.amazonaws.kinesis#S3CompressionType", "traits": { "smithy.api#documentation": "

The compression applied to delivered objects. Valid values:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The Amazon S3 storage settings for a general purpose Amazon S3 destination.

" } }, "com.amazonaws.kinesis#S3TablesCompressionType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "ZSTD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ZSTD" } }, "SNAPPY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNAPPY" } } } }, "com.amazonaws.kinesis#S3TablesConfiguration": { "type": "structure", "members": { "TableBucketARN": { "target": "com.amazonaws.kinesis#TableBucketARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon S3 table bucket.

", "smithy.api#required": {} } }, "Namespace": { "target": "com.amazonaws.kinesis#S3TablesNamespace", "traits": { "smithy.api#documentation": "

The namespace (database) of the destination table.

", "smithy.api#required": {} } }, "TableName": { "target": "com.amazonaws.kinesis#S3TablesTableName", "traits": { "smithy.api#documentation": "

The name of the destination table. Amazon Kinesis Data Streams creates this table in the specified table bucket.

", "smithy.api#required": {} } }, "CompressionType": { "target": "com.amazonaws.kinesis#S3TablesCompressionType", "traits": { "smithy.api#documentation": "

The compression applied to Parquet data files. Valid values:

\n ", "smithy.api#required": {} } }, "PartitionSpec": { "target": "com.amazonaws.kinesis#PartitionSpec", "traits": { "smithy.api#documentation": "

The partitioning specification for the destination table.

" } } }, "traits": { "smithy.api#documentation": "

Specifies a destination streaming table on Apache Iceberg.

" } }, "com.amazonaws.kinesis#S3TablesConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#S3TablesConfiguration" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#S3TablesDestinationConfiguration": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kinesis#DataFreshnessInSeconds", "traits": { "smithy.api#documentation": "

The maximum age, in seconds, of undelivered data before the channel delivers it to the destination. The default value is 300 seconds.

" } }, "DeadLetterQueueS3Configuration": { "target": "com.amazonaws.kinesis#DeadLetterQueueS3Configuration", "traits": { "smithy.api#documentation": "

The dead-letter queue configuration for records that cannot be delivered. Required for streaming table destinations.

", "smithy.api#required": {} } }, "S3TablesConfigurationList": { "target": "com.amazonaws.kinesis#S3TablesConfigurationList", "traits": { "smithy.api#documentation": "

The list of streaming table configurations. Currently, one table is supported per channel.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration for delivery to streaming tables on Apache Iceberg. Used in CreateChannel.

" } }, "com.amazonaws.kinesis#S3TablesDestinationDescription": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kinesis#DataFreshnessInSeconds", "traits": { "smithy.api#documentation": "

The maximum age, in seconds, of undelivered data.

", "smithy.api#required": {} } }, "DeadLetterQueueS3Configuration": { "target": "com.amazonaws.kinesis#DeadLetterQueueS3Configuration", "traits": { "smithy.api#documentation": "

The dead-letter queue configuration for records that cannot be delivered.

", "smithy.api#required": {} } }, "S3TablesConfigurationList": { "target": "com.amazonaws.kinesis#S3TablesConfigurationList", "traits": { "smithy.api#documentation": "

The list of streaming table configurations.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration for delivery to streaming tables on Apache Iceberg. Returned in ChannelDescription.

" } }, "com.amazonaws.kinesis#S3TablesDestinationUpdateInput": { "type": "structure", "members": { "DataFreshnessInSeconds": { "target": "com.amazonaws.kinesis#DataFreshnessInSeconds", "traits": { "smithy.api#documentation": "

The maximum age, in seconds, of undelivered data before the channel delivers it to the destination.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The updated configuration for a streaming table destination. Used in UpdateChannel. Only DataFreshnessInSeconds can be updated.

" } }, "com.amazonaws.kinesis#S3TablesNamespace": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[0-9a-z_]+$" } }, "com.amazonaws.kinesis#S3TablesTableName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[0-9a-z_]+$" } }, "com.amazonaws.kinesis#ScalingType": { "type": "enum", "members": { "UNIFORM_SCALING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNIFORM_SCALING" } } } }, "com.amazonaws.kinesis#SequenceNumber": { "type": "string", "traits": { "smithy.api#pattern": "^(0|([1-9]\\d{0,128}))$" } }, "com.amazonaws.kinesis#SequenceNumberRange": { "type": "structure", "members": { "StartingSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

The starting sequence number for the range.

", "smithy.api#required": {} } }, "EndingSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

The ending sequence number for the range. Shards that are in the OPEN state have an\n ending sequence number of null.

" } } }, "traits": { "smithy.api#documentation": "

The range of possible sequence numbers for the shard.

" } }, "com.amazonaws.kinesis#Shard": { "type": "structure", "members": { "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The unique identifier of the shard within the stream.

", "smithy.api#required": {} } }, "ParentShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the shard's parent.

" } }, "AdjacentParentShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the shard adjacent to the shard's parent.

" } }, "HashKeyRange": { "target": "com.amazonaws.kinesis#HashKeyRange", "traits": { "smithy.api#documentation": "

The range of possible hash key values for the shard, which is a set of ordered\n contiguous positive integers.

", "smithy.api#required": {} } }, "SequenceNumberRange": { "target": "com.amazonaws.kinesis#SequenceNumberRange", "traits": { "smithy.api#documentation": "

The range of possible sequence numbers for the shard.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A uniquely identified group of data records in a Kinesis data stream.

" } }, "com.amazonaws.kinesis#ShardCountObject": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1000000 } } }, "com.amazonaws.kinesis#ShardFilter": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.kinesis#ShardFilterType", "traits": { "smithy.api#documentation": "

The shard type specified in the ShardFilter parameter. This is a required\n property of the ShardFilter parameter.

\n

You can specify the following valid values:

\n ", "smithy.api#required": {} } }, "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The exclusive start shardID speified in the ShardFilter\n parameter. This property can only be used if the AFTER_SHARD_ID shard type\n is specified.

" } }, "Timestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The timestamps specified in the ShardFilter parameter. A timestamp is a\n Unix epoch date with precision in milliseconds. For example,\n 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if\n FROM_TIMESTAMP or AT_TIMESTAMP shard types are\n specified.

" } } }, "traits": { "smithy.api#documentation": "

The request parameter used to filter out the response of the ListShards\n API.

" } }, "com.amazonaws.kinesis#ShardFilterType": { "type": "enum", "members": { "AFTER_SHARD_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_SHARD_ID" } }, "AT_TRIM_HORIZON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AT_TRIM_HORIZON" } }, "FROM_TRIM_HORIZON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FROM_TRIM_HORIZON" } }, "AT_LATEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AT_LATEST" } }, "AT_TIMESTAMP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AT_TIMESTAMP" } }, "FROM_TIMESTAMP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FROM_TIMESTAMP" } } } }, "com.amazonaws.kinesis#ShardId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesis#ShardIdList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#ShardId" } }, "com.amazonaws.kinesis#ShardIterator": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.kinesis#ShardIteratorType": { "type": "enum", "members": { "AT_SEQUENCE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AT_SEQUENCE_NUMBER" } }, "AFTER_SEQUENCE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AFTER_SEQUENCE_NUMBER" } }, "TRIM_HORIZON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRIM_HORIZON" } }, "LATEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LATEST" } }, "AT_TIMESTAMP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AT_TIMESTAMP" } } } }, "com.amazonaws.kinesis#ShardList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#Shard" } }, "com.amazonaws.kinesis#SplitShard": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#SplitShardInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Splits a shard into two new shards in the Kinesis data stream, to increase the\n stream's capacity to ingest and transport data. SplitShard is called when\n there is a need to increase the overall capacity of a stream because of an expected\n increase in the volume of data records being ingested. This API is only supported for\n the data streams with the provisioned capacity mode.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

You can also use SplitShard when a shard appears to be approaching its\n maximum utilization; for example, the producers sending data into the specific shard are\n suddenly sending more than previously anticipated. You can also call\n SplitShard to increase stream capacity, so that more Kinesis Data\n Streams applications can simultaneously read data from the stream for real-time\n processing.

\n

You must specify the shard to be split and the new hash key, which is the position in\n the shard where the shard gets split in two. In many cases, the new hash key might be\n the average of the beginning and ending hash key, but it can be any hash key value in\n the range being mapped into the shard. For more information, see Split a\n Shard in the Amazon Kinesis Data Streams Developer\n Guide.

\n

You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the ShardToSplit\n and NewStartingHashKey parameters that are specified in the\n SplitShard request.

\n

\n SplitShard is an asynchronous operation. Upon receiving a\n SplitShard request, Kinesis Data Streams immediately returns a response\n and sets the stream status to UPDATING. After the operation is completed,\n Kinesis Data Streams sets the stream status to ACTIVE. Read and write\n operations continue to work while the stream is in the UPDATING state.

\n

You can use DescribeStreamSummary to check the status of the stream,\n which is returned in StreamStatus. If the stream is in the\n ACTIVE state, you can call SplitShard.\n

\n

If the specified stream does not exist, DescribeStreamSummary\n returns a ResourceNotFoundException. If you try to create more shards than\n are authorized for your account, you receive a LimitExceededException.

\n

For the default shard limit for an Amazon Web Services account, see Kinesis\n Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a\n LimitExceededException.

\n

\n SplitShard has a limit of five transactions per second per account.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#SplitShardInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream for the shard split.

" } }, "ShardToSplit": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The shard ID of the shard to split.

", "smithy.api#required": {} } }, "NewStartingHashKey": { "target": "com.amazonaws.kinesis#HashKey", "traits": { "smithy.api#documentation": "

A hash key value for the starting hash key of one of the child shards created by the\n split. The hash key range for a given shard constitutes a set of ordered contiguous\n positive integers. The value for NewStartingHashKey must be in the range of\n hash keys being mapped into the shard. The NewStartingHashKey hash key\n value and all higher hash key values in hash key range are distributed to one of the\n child shards. All the lower hash key values in the range are distributed to the other\n child shard.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#documentation": "

Represents the input for SplitShard.

", "smithy.api#input": {} } }, "com.amazonaws.kinesis#StartStreamEncryption": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#StartStreamEncryptionInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, { "target": "com.amazonaws.kinesis#KMSDisabledException" }, { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Enables or updates server-side encryption using an Amazon Web Services KMS key for a\n specified stream.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Updating or applying encryption\n normally takes a few seconds to complete, but it can take minutes. You can continue to\n read and write data to your stream while its status is UPDATING. Once the\n status of the stream is ACTIVE, encryption begins for records written to\n the stream.

\n

API Limits: You can successfully apply a new Amazon Web Services KMS key for\n server-side encryption 25 times in a rolling 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are encrypted. After you enable encryption, you\n can verify that encryption is applied by inspecting the API response from\n PutRecord or PutRecords.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#StartStreamEncryptionInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream for which to start encrypting records.

" } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { "smithy.api#documentation": "

The encryption type to use. The only valid value is KMS.

", "smithy.api#required": {} } }, "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#StartingPosition": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.kinesis#ShardIteratorType", "traits": { "smithy.api#documentation": "

You can set the starting position to one of the following values:

\n

\n AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the\n sequence number specified in the SequenceNumber field.

\n

\n AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted\n by the sequence number specified in the SequenceNumber field.

\n

\n AT_TIMESTAMP: Start streaming from the position denoted by the time stamp\n specified in the Timestamp field.

\n

\n TRIM_HORIZON: Start streaming at the last untrimmed record in the shard,\n which is the oldest data record in the shard.

\n

\n LATEST: Start streaming just after the most recent record in the shard,\n so that you always read the most recent data in the shard.

", "smithy.api#required": {} } }, "SequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

The sequence number of the data record in the shard from which to start streaming. To\n specify a sequence number, set StartingPosition to\n AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

" } }, "Timestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The time stamp of the data record from which to start reading. To specify a time\n stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp\n is the Unix epoch date with precision in milliseconds. For example,\n 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a\n record with this exact time stamp does not exist, records will be streamed from the next\n (later) record. If the time stamp is older than the current trim horizon, records will\n be streamed from the oldest untrimmed data record (TRIM_HORIZON).

" } } }, "traits": { "smithy.api#documentation": "

The starting position in the data stream from which to start streaming.

" } }, "com.amazonaws.kinesis#StopStreamEncryption": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#StopStreamEncryptionInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Disables server-side encryption for a specified stream.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis\n Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Stopping encryption normally takes a\n few seconds to complete, but it can take minutes. You can continue to read and write\n data to your stream while its status is UPDATING. Once the status of the\n stream is ACTIVE, records written to the stream are no longer encrypted by\n Kinesis Data Streams.

\n

API Limits: You can successfully disable server-side encryption 25 times in a rolling\n 24-hour period.

\n

Note: It can take up to 5 seconds after the stream is in an ACTIVE status\n before all records written to the stream are no longer subject to encryption. After you\n disabled encryption, you can verify that encryption is not applied by inspecting the API\n response from PutRecord or PutRecords.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#StopStreamEncryptionInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream on which to stop encrypting records.

" } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { "smithy.api#documentation": "

The encryption type. The only valid value is KMS.

", "smithy.api#required": {} } }, "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified Amazon Resource Name\n (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also\n use a master key owned by Kinesis Data Streams by specifying the alias\n aws/kinesis.

\n ", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#StreamARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws.*:kinesis:.*:\\d{12}:stream/\\S+$" } }, "com.amazonaws.kinesis#StreamDescription": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream being described.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream being described.

", "smithy.api#required": {} } }, "StreamStatus": { "target": "com.amazonaws.kinesis#StreamStatus", "traits": { "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", "smithy.api#required": {} } }, "StreamModeDetails": { "target": "com.amazonaws.kinesis#StreamModeDetails", "traits": { "smithy.api#documentation": "

Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

" } }, "Shards": { "target": "com.amazonaws.kinesis#ShardList", "traits": { "smithy.api#documentation": "

The shards that comprise the stream.

", "smithy.api#required": {} } }, "HasMoreShards": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

If set to true, more shards in the stream are available to\n describe.

", "smithy.api#required": {} } }, "RetentionPeriodHours": { "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { "smithy.api#documentation": "

The current retention period, in hours. Minimum value of 24. Maximum value of\n 168.

", "smithy.api#required": {} } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The approximate time that the stream was created.

", "smithy.api#required": {} } }, "EnhancedMonitoring": { "target": "com.amazonaws.kinesis#EnhancedMonitoringList", "traits": { "smithy.api#documentation": "

Represents the current enhanced monitoring settings of the stream.

", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { "smithy.api#documentation": "

The server-side encryption type used on the stream. This parameter can be one of the\n following values:

\n " } }, "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.

\n " } } }, "traits": { "smithy.api#documentation": "

Represents the output for DescribeStream.

" } }, "com.amazonaws.kinesis#StreamDescriptionSummary": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream being described.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the stream being described.

", "smithy.api#required": {} } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

" } }, "StreamStatus": { "target": "com.amazonaws.kinesis#StreamStatus", "traits": { "smithy.api#documentation": "

The current status of the stream being described. The stream status is one of the\n following states:

\n ", "smithy.api#required": {} } }, "StreamModeDetails": { "target": "com.amazonaws.kinesis#StreamModeDetails", "traits": { "smithy.api#documentation": "

Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

" } }, "RetentionPeriodHours": { "target": "com.amazonaws.kinesis#RetentionPeriodHours", "traits": { "smithy.api#documentation": "

The current retention period, in hours.

", "smithy.api#required": {} } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The approximate time that the stream was created.

", "smithy.api#required": {} } }, "EnhancedMonitoring": { "target": "com.amazonaws.kinesis#EnhancedMonitoringList", "traits": { "smithy.api#documentation": "

Represents the current enhanced monitoring settings of the stream.

", "smithy.api#required": {} } }, "EncryptionType": { "target": "com.amazonaws.kinesis#EncryptionType", "traits": { "smithy.api#documentation": "

The encryption type used. This value is one of the following:

\n " } }, "KeyId": { "target": "com.amazonaws.kinesis#KeyId", "traits": { "smithy.api#documentation": "

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.\n This value can be a globally unique identifier, a fully specified ARN to either an alias\n or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by\n Kinesis Data Streams by specifying the alias aws/kinesis.

\n " } }, "OpenShardCount": { "target": "com.amazonaws.kinesis#ShardCountObject", "traits": { "smithy.api#documentation": "

The number of open shards in the stream.

", "smithy.api#required": {} } }, "ConsumerCount": { "target": "com.amazonaws.kinesis#ConsumerCountObject", "traits": { "smithy.api#documentation": "

The number of enhanced fan-out consumers registered with the stream. Queues are not\n included in this count, even though they share the stream's registered consumer limit\n with enhanced fan-out consumers. QueueCount reports the number of\n queues.

" } }, "WarmThroughput": { "target": "com.amazonaws.kinesis#WarmThroughputObject", "traits": { "smithy.api#documentation": "

The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.

" } }, "MaxRecordSizeInKiB": { "target": "com.amazonaws.kinesis#MaxRecordSizeInKiB", "traits": { "smithy.api#documentation": "

The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

" } }, "ChannelCount": { "target": "com.amazonaws.kinesis#ChannelCountObject", "traits": { "smithy.api#documentation": "

The number of channels associated with the stream.

" } }, "RecordDistributionStrategy": { "target": "com.amazonaws.kinesis#RecordDistributionStrategy", "traits": { "smithy.api#documentation": "

The record distribution strategy that the stream currently uses. A value of\n AUTO indicates that Amazon Kinesis Data Streams distributes records across\n shards using service-managed algorithms. A value of USER_PARTITION_KEY\n indicates that shard placement is determined by the partition key that producers supply.\n This field is only present for streams that use the on-demand capacity mode.

" } }, "QueueCount": { "target": "com.amazonaws.kinesis#QueueCountObject", "traits": { "smithy.api#documentation": "

The number of queues created on the data stream.

" } } }, "traits": { "smithy.api#documentation": "

Represents the output for DescribeStreamSummary\n

" } }, "com.amazonaws.kinesis#StreamFilter": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source stream to filter by.

", "smithy.api#required": {} } }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The creation timestamp of the source stream.

" } } }, "traits": { "smithy.api#documentation": "

Filters ListChannels results by source stream.

" } }, "com.amazonaws.kinesis#StreamFilterList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#StreamFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10000 } } }, "com.amazonaws.kinesis#StreamId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 24 }, "smithy.api#pattern": "^[a-z0-9]{20}-[a-z0-9]{3}$" } }, "com.amazonaws.kinesis#StreamMode": { "type": "enum", "members": { "PROVISIONED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROVISIONED" } }, "ON_DEMAND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ON_DEMAND" } } } }, "com.amazonaws.kinesis#StreamModeDetails": { "type": "structure", "members": { "StreamMode": { "target": "com.amazonaws.kinesis#StreamMode", "traits": { "smithy.api#documentation": "

Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

" } }, "com.amazonaws.kinesis#StreamName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesis#StreamNameList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#StreamName" } }, "com.amazonaws.kinesis#StreamStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } } } }, "com.amazonaws.kinesis#StreamSummary": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of a stream.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.api#required": {} } }, "StreamStatus": { "target": "com.amazonaws.kinesis#StreamStatus", "traits": { "smithy.api#documentation": "

The status of the stream.

", "smithy.api#required": {} } }, "StreamModeDetails": { "target": "com.amazonaws.kinesis#StreamModeDetails" }, "StreamCreationTimestamp": { "target": "com.amazonaws.kinesis#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp at which the stream was created.

" } } }, "traits": { "smithy.api#documentation": "

The summary of a stream.

" } }, "com.amazonaws.kinesis#StreamSummaryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#StreamSummary" } }, "com.amazonaws.kinesis#SubscribeToShard": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#SubscribeToShardInput" }, "output": { "target": "com.amazonaws.kinesis#SubscribeToShardOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#DryRunOperationException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operation, see Develop enhanced fan-out consumers\n with the Amazon Web Services SDK for Java.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#SubscribeToShardEvent": { "type": "structure", "members": { "Records": { "target": "com.amazonaws.kinesis#RecordList", "traits": { "smithy.api#documentation": "

", "smithy.api#required": {} } }, "ContinuationSequenceNumber": { "target": "com.amazonaws.kinesis#SequenceNumber", "traits": { "smithy.api#documentation": "

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to\n AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use\n ContinuationSequenceNumber for checkpointing because it captures your\n shard progress even when no data is written to the shard.

", "smithy.api#required": {} } }, "MillisBehindLatest": { "target": "com.amazonaws.kinesis#MillisBehindLatest", "traits": { "smithy.api#documentation": "

The number of milliseconds the read records are from the tip of the stream, indicating\n how far behind current time the consumer is. A value of zero indicates that record\n processing is caught up, and there are no new records to process at this moment.

", "smithy.api#required": {} } }, "ChildShards": { "target": "com.amazonaws.kinesis#ChildShardList", "traits": { "smithy.api#documentation": "

The list of the child shards of the current shard, returned only at the end of the\n current shard.

" } } }, "traits": { "smithy.api#documentation": "

After you call SubscribeToShard, Kinesis Data Streams sends events\n of this type over an HTTP/2 connection to your consumer.

" } }, "com.amazonaws.kinesis#SubscribeToShardEventStream": { "type": "union", "members": { "SubscribeToShardEvent": { "target": "com.amazonaws.kinesis#SubscribeToShardEvent", "traits": { "smithy.api#documentation": "

After you call SubscribeToShard, Kinesis Data Streams sends events\n of this type to your consumer. For an example of how to handle these events, see Develop enhanced fan-out consumers\n with the Amazon Web Services SDK for Java.

" } }, "ResourceNotFoundException": { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, "ResourceInUseException": { "target": "com.amazonaws.kinesis#ResourceInUseException" }, "KMSDisabledException": { "target": "com.amazonaws.kinesis#KMSDisabledException" }, "KMSInvalidStateException": { "target": "com.amazonaws.kinesis#KMSInvalidStateException" }, "KMSAccessDeniedException": { "target": "com.amazonaws.kinesis#KMSAccessDeniedException" }, "KMSNotFoundException": { "target": "com.amazonaws.kinesis#KMSNotFoundException" }, "KMSOptInRequired": { "target": "com.amazonaws.kinesis#KMSOptInRequired" }, "KMSThrottlingException": { "target": "com.amazonaws.kinesis#KMSThrottlingException" }, "InternalFailureException": { "target": "com.amazonaws.kinesis#InternalFailureException", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

This is a tagged union for all of the types of events an enhanced fan-out consumer can\n receive over HTTP/2 after a call to SubscribeToShard.

", "smithy.api#streaming": {} } }, "com.amazonaws.kinesis#SubscribeToShardInput": { "type": "structure", "members": { "ConsumerARN": { "target": "com.amazonaws.kinesis#ConsumerARN", "traits": { "smithy.api#documentation": "

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ConsumerARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "ShardId": { "target": "com.amazonaws.kinesis#ShardId", "traits": { "smithy.api#documentation": "

The ID of the shard you want to subscribe to. To see a list of all the shards for a\n given stream, use ListShards.

", "smithy.api#required": {} } }, "StartingPosition": { "target": "com.amazonaws.kinesis#StartingPosition", "traits": { "smithy.api#documentation": "

The starting position in the data stream from which to start streaming.

", "smithy.api#required": {} } }, "DryRun": { "target": "com.amazonaws.kinesis#BooleanObject", "traits": { "smithy.api#documentation": "

Checks if your request will succeed. DryRun is an optional\n parameter.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#SubscribeToShardOutput": { "type": "structure", "members": { "EventStream": { "target": "com.amazonaws.kinesis#SubscribeToShardEventStream", "traits": { "smithy.api#documentation": "

The event stream that your consumer can use to read records from the shard.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#TableBucketARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws[-a-z0-9]*:s3tables:[-a-z0-9]+:\\d{12}:bucket/[a-z0-9_-]{3,63}$" } }, "com.amazonaws.kinesis#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.kinesis#TagKey", "traits": { "smithy.api#documentation": "

A unique identifier for the tag. Maximum length: 128 characters. Valid characters:\n Unicode letters, digits, white space, _ . / = + - % @

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.kinesis#TagValue", "traits": { "smithy.api#documentation": "

An optional string, typically used to describe or define the tag. Maximum length: 256\n characters. Valid characters: Unicode letters, digits, white space, _ . / = + - %\n @

" } } }, "traits": { "smithy.api#documentation": "

Metadata assigned to the stream or consumer, consisting of a key-value pair.

" } }, "com.amazonaws.kinesis#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.kinesis#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.kinesis#TagList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.kinesis#TagMap": { "type": "map", "key": { "target": "com.amazonaws.kinesis#TagKey" }, "value": { "target": "com.amazonaws.kinesis#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.kinesis#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#TagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can assign up to 50 tags to a Kinesis resource.

\n

The Kinesis resource can be a data stream, a queue, or an enhanced fan-out\n consumer.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#TagResourceInput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.kinesis#TagMap", "traits": { "smithy.api#documentation": "

An array of tags to be added to the Kinesis resource. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.

\n

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

", "smithy.api#required": {} } }, "ResourceARN": { "target": "com.amazonaws.kinesis#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis resource to which to add tags.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.kinesis#TargetType": { "type": "enum", "members": { "BUILT_IN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUILT_IN" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.kinesis#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A message that provides information about the error.

" } } }, "traits": { "smithy.api#documentation": "

The request was denied because the request rate is too high. Reduce the frequency of\n your requests, and retry them with exponential backoff.

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#Timestamp": { "type": "timestamp" }, "com.amazonaws.kinesis#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UntagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.

\n

The Kinesis resource can be a data stream, a queue, or an enhanced fan-out\n consumer.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UntagResourceInput": { "type": "structure", "members": { "TagKeys": { "target": "com.amazonaws.kinesis#TagKeyList", "traits": { "smithy.api#documentation": "

A list of tag key-value pairs. Existing tags of the resource whose keys are members of this list will be removed from the Kinesis resource.

", "smithy.api#required": {} } }, "ResourceARN": { "target": "com.amazonaws.kinesis#ResourceARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis resource from which to remove tags.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ResourceARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateAccountSettings": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateAccountSettingsInput" }, "output": { "target": "com.amazonaws.kinesis#UpdateAccountSettingsOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the account-level settings for Amazon Kinesis Data Streams.

\n

Updating account settings is a synchronous operation. Upon receiving the request, Kinesis Data Streams will return immediately with your account\u2019s updated settings.

\n

\n API limits\n

\n ", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateAccountSettingsInput": { "type": "structure", "members": { "MinimumThroughputBillingCommitment": { "target": "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentInput", "traits": { "smithy.api#documentation": "

Specifies the minimum throughput billing commitment configuration for your account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateAccountSettingsOutput": { "type": "structure", "members": { "MinimumThroughputBillingCommitment": { "target": "com.amazonaws.kinesis#MinimumThroughputBillingCommitmentOutput", "traits": { "smithy.api#documentation": "

The updated configuration of the minimum throughput billing commitment for your account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#UpdateChannel": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateChannelInput" }, "output": { "target": "com.amazonaws.kinesis#UpdateChannelOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the data freshness interval or the Amazon CloudWatch Logs configuration of an existing channel. You cannot change the destination, source stream, record format, schema, encryption configuration, or service execution role of an existing channel. To change any other setting, delete the channel and create a new one.

\n

Updating a channel is an asynchronous operation. Upon receiving the request, Amazon Kinesis Data Streams sets the channel to the UPDATING state and returns immediately. After the change is applied, Amazon Kinesis Data Streams sets the channel back to the ACTIVE state.

\n

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateChannelInput": { "type": "structure", "members": { "ChannelARN": { "target": "com.amazonaws.kinesis#ChannelARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the channel to update.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "ChannelARN" } } }, "S3DestinationConfiguration": { "target": "com.amazonaws.kinesis#S3DestinationUpdateInput", "traits": { "smithy.api#documentation": "

The updated configuration for a general purpose Amazon S3 destination. Specify this parameter when the channel delivers to a general purpose Amazon S3 bucket. Only DataFreshnessInSeconds can be updated.

" } }, "S3TablesDestinationConfiguration": { "target": "com.amazonaws.kinesis#S3TablesDestinationUpdateInput", "traits": { "smithy.api#documentation": "

The updated configuration for a streaming table destination. Specify this parameter when the channel delivers to streaming tables on Apache Iceberg in Amazon S3 Tables. Only DataFreshnessInSeconds can be updated.

" } }, "LoggingConfiguration": { "target": "com.amazonaws.kinesis#ChannelLoggingUpdateInput", "traits": { "smithy.api#documentation": "

The updated Amazon CloudWatch Logs configuration for the channel.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateChannelOutput": { "type": "structure", "members": { "ChannelDescription": { "target": "com.amazonaws.kinesis#ChannelDescription", "traits": { "smithy.api#documentation": "

The configuration and current status of the channel after the update, including its ARN, destination configuration, and lifecycle state. Immediately after the request, the state is UPDATING.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibility": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityInput" }, "output": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Changes the visibility timeout of up to 10 dead-letter records that you have received\n from the specified queue but not yet acknowledged. The result for each entry is reported\n individually in the response.

\n

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.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityErrorEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record whose visibility timeout was not changed.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.kinesis#ErrorCode", "traits": { "smithy.api#documentation": "

A code identifying the type of failure. One of\n ResourceNotFoundException, InvalidArgumentException,\n ThrottlingException, or InternalFailureException.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the cause of the failure.

" } } }, "traits": { "smithy.api#documentation": "

A dead-letter record whose visibility timeout was not changed, and why.

" } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityErrorEntry" } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue whose dead-letter records are updated.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "Entries": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityRequestEntryList", "traits": { "smithy.api#documentation": "

The dead-letter records whose visibility timeout is changed, identified by their\n receipt handles, and the new visibility timeout for each.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityOutput": { "type": "structure", "members": { "Successful": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityResultEntryList", "traits": { "smithy.api#documentation": "

The records whose visibility timeout was changed.

", "smithy.api#required": {} } }, "Failed": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityErrorEntryList", "traits": { "smithy.api#documentation": "

The records whose visibility timeout was not changed, each with the reason the entry\n failed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityRequestEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record, as returned by\n ReceiveDeadLetterQueueRecords.

", "smithy.api#required": {} } }, "VisibilityTimeoutSeconds": { "target": "com.amazonaws.kinesis#VisibilityTimeoutSeconds", "traits": { "smithy.api#documentation": "

The new duration, in seconds, that the record is in flight and not visible to any consumer\n instance, measured from when this request is processed. Specify 0 to make the record\n visible immediately.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A dead-letter record whose visibility timeout is changed, and the new visibility\n timeout.

" } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityRequestEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityResultEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record whose visibility timeout was changed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A dead-letter record whose visibility timeout was changed.

" } }, "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityResultEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#UpdateDeadLetterQueueRecordsVisibilityResultEntry" } }, "com.amazonaws.kinesis#UpdateMaxRecordSize": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateMaxRecordSizeInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

This allows you to update the MaxRecordSize of a single record that you can write to, and read from a stream. You can ingest and digest single records up to 10240 KiB.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateMaxRecordSizeInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream for the MaxRecordSize update.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "MaxRecordSizeInKiB": { "target": "com.amazonaws.kinesis#MaxRecordSizeInKiB", "traits": { "smithy.api#documentation": "

The maximum record size of a single record in KiB that you can write to, and read from a stream. Specify a value between 1024 and 10240 KiB (1 to 10 MiB). If you specify a value that is out of this range, UpdateMaxRecordSize sends back an ValidationException message.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateQueue": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateQueueInput" }, "output": { "target": "com.amazonaws.kinesis#UpdateQueueOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the configuration attributes of the specified queue. You can change the queue's\n visibility timeout, its dead-letter handling configuration, or both.

\n

A new visibility timeout applies to records received after the update completes. Records\n that are already in flight keep the visibility timeout they were received with. To change\n the visibility timeout of a record that is already in flight, use\n UpdateQueueRecordsVisibility.

\n

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

\n

You can't change the data stream or the starting position of a queue after you create\n it. To read from a different stream or position, create a new queue.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateQueueInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue to update.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "QueueAttributes": { "target": "com.amazonaws.kinesis#QueueAttributes", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateQueueOutput": { "type": "structure", "members": { "QueueDescription": { "target": "com.amazonaws.kinesis#QueueDescription", "traits": { "smithy.api#documentation": "

A description of the queue, including the updated attributes.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibility": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityInput" }, "output": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InternalFailureException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Changes the visibility timeout of up to 10 records that you have received from the\n specified queue but not yet acknowledged. The result for each entry is reported\n individually in the response.

\n

Extend the visibility timeout of a record when your queue consumer needs more time to\n finish processing it, so the record does not become visible and get redelivered while it is\n still being processed. Set the visibility timeout to 0 to make a record\n visible in the queue immediately, so that it can be received again without waiting for its\n current timeout to expire.

\n

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.

", "smithy.rules#staticContextParams": { "ResourceType": { "value": "queue" }, "OperationType": { "value": "data" } } } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityErrorEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record whose visibility timeout was not changed.

", "smithy.api#required": {} } }, "ErrorCode": { "target": "com.amazonaws.kinesis#ErrorCode", "traits": { "smithy.api#documentation": "

A code identifying the type of failure. One of\n ResourceNotFoundException, InvalidArgumentException,\n ThrottlingException, or InternalFailureException.

", "smithy.api#required": {} } }, "ErrorMessage": { "target": "com.amazonaws.kinesis#ErrorMessage", "traits": { "smithy.api#documentation": "

A description of the cause of the failure.

" } } }, "traits": { "smithy.api#documentation": "

A record whose visibility timeout was not changed, and why.

" } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityErrorEntry" } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityInput": { "type": "structure", "members": { "QueueARN": { "target": "com.amazonaws.kinesis#QueueARN", "traits": { "smithy.api#documentation": "

The ARN of the queue the records were received from.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "QueueARN" } } }, "Entries": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityRequestEntryList", "traits": { "smithy.api#documentation": "

The records whose visibility timeout is changed, identified by their receipt handles, and\n the new visibility timeout for each.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityOutput": { "type": "structure", "members": { "Successful": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityResultEntryList", "traits": { "smithy.api#documentation": "

The records whose visibility timeout was changed.

", "smithy.api#required": {} } }, "Failed": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityErrorEntryList", "traits": { "smithy.api#documentation": "

The records whose visibility timeout was not changed, each with the reason the entry\n failed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityRequestEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record, as returned by\n ReceiveQueueRecords.

", "smithy.api#required": {} } }, "VisibilityTimeoutSeconds": { "target": "com.amazonaws.kinesis#VisibilityTimeoutSeconds", "traits": { "smithy.api#documentation": "

The new duration, in seconds, that the record is in flight and not visible to any consumer\n instance, measured from when this request is processed. Specify 0 to make the record\n visible in the queue immediately.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A record whose visibility timeout is changed, and the new visibility timeout.

" } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityRequestEntry" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityResultEntry": { "type": "structure", "members": { "ReceiptHandle": { "target": "com.amazonaws.kinesis#ReceiptHandle", "traits": { "smithy.api#documentation": "

The receipt handle of the record whose visibility timeout was changed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A record whose visibility timeout was changed.

" } }, "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityResultEntryList": { "type": "list", "member": { "target": "com.amazonaws.kinesis#UpdateQueueRecordsVisibilityResultEntry" } }, "com.amazonaws.kinesis#UpdateShardCount": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateShardCountInput" }, "output": { "target": "com.amazonaws.kinesis#UpdateShardCountOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the shard count of the specified stream to the specified number of shards.\n This API is only supported for the data streams with the provisioned capacity\n mode.

\n \n

When invoking this API, you must use either the StreamARN or the\n StreamName parameter, or both. It is recommended that you use the\n StreamARN input parameter when you invoke this API.

\n
\n

Updating the shard count is an asynchronous operation. Upon receiving the request,\n Kinesis Data Streams returns immediately and sets the status of the stream to\n UPDATING. After the update is complete, Kinesis Data Streams sets the\n status of the stream back to ACTIVE. Depending on the size of the stream,\n the scaling action could take a few minutes to complete. You can continue to read and\n write data to your stream while its status is UPDATING.

\n

To update the shard count, Kinesis Data Streams performs splits or merges on\n individual shards. This can cause short-lived shards to be created, in addition to the\n final shards. These short-lived shards count towards your total shard limit for your\n account in the Region.

\n

When using this operation, we recommend that you specify a target shard count that is\n a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your\n shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling\n action might take longer to complete.

\n

This operation has the following default limits. By default, you cannot do the\n following:

\n \n

For the default limits for an Amazon Web Services account, see Streams\n Limits in the Amazon Kinesis Data Streams Developer\n Guide. To request an increase in the call rate limit, the shard limit for\n this API, or your overall shard limit, use the limits form.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateShardCountInput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream.

" } }, "TargetShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { "smithy.api#documentation": "

The new number of shards. This value has the following default limits. By default, you\n cannot do the following:

\n ", "smithy.api#required": {} } }, "ScalingType": { "target": "com.amazonaws.kinesis#ScalingType", "traits": { "smithy.api#documentation": "

The scaling type. Uniform scaling creates shards of equal size.

", "smithy.api#required": {} } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateShardCountOutput": { "type": "structure", "members": { "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream.

" } }, "CurrentShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { "smithy.api#documentation": "

The current number of shards.

" } }, "TargetShardCount": { "target": "com.amazonaws.kinesis#PositiveIntegerObject", "traits": { "smithy.api#documentation": "

The updated number of shards.

" } }, "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#UpdateStreamMode": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateStreamModeInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you\n can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data stream.\n

\n

If you'd still like to proactively scale your on-demand data stream\u2019s capacity, you can unlock the warm throughput feature for on-demand data streams by enabling MinimumThroughputBillingCommitment for your account. Once your account has MinimumThroughputBillingCommitment enabled, you can specify the warm throughput in MiB per second that your stream can support in writes.

\n

You can't switch a data stream from on-demand to provisioned capacity mode while the stream has one or more queues. Delete the queues with DeleteQueue before you change the capacity mode.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateStreamModeInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

Specifies the ARN of the data stream whose capacity mode you want to update.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "StreamModeDetails": { "target": "com.amazonaws.kinesis#StreamModeDetails", "traits": { "smithy.api#documentation": "

Specifies the capacity mode to which you want to set your data stream. Currently, in\n Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

", "smithy.api#required": {} } }, "WarmThroughputMiBps": { "target": "com.amazonaws.kinesis#NaturalIntegerObject", "traits": { "smithy.api#documentation": "

The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations. This field is only valid when the stream mode is being updated to on-demand.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateStreamRecordDistributionStrategy": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateStreamRecordDistributionStrategyInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the record distribution strategy for the specified Amazon Kinesis Data Streams\n on-demand data stream. The record distribution strategy determines how Amazon Kinesis\n Data Streams distributes records across the shards in a stream.

\n \n

You must specify the stream using the StreamARN parameter.

\n
\n

The record distribution strategy is a stream-level setting. You can switch between the\n following strategies at any time, and the change takes effect immediately without\n downtime, data loss, or disruption to producer or consumer applications:

\n \n

This operation is only supported for data streams that use the on-demand capacity\n mode. Provisioned capacity mode streams do not support the record distribution strategy\n setting. Attempting to set AUTO on a provisioned stream results in an\n InvalidArgumentException.

\n

New records that arrive after the change are distributed according to the new\n strategy. Records already in the stream keep their original shard assignments and are\n not redistributed.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateStreamRecordDistributionStrategyInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream to update.

", "smithy.api#required": {}, "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "RecordDistributionStrategy": { "target": "com.amazonaws.kinesis#RecordDistributionStrategy", "traits": { "smithy.api#documentation": "

The record distribution strategy to apply to the stream. Specify one of the following\n values:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateStreamWarmThroughput": { "type": "operation", "input": { "target": "com.amazonaws.kinesis#UpdateStreamWarmThroughputInput" }, "output": { "target": "com.amazonaws.kinesis#UpdateStreamWarmThroughputOutput" }, "errors": [ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, { "target": "com.amazonaws.kinesis#LimitExceededException" }, { "target": "com.amazonaws.kinesis#ResourceInUseException" }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" }, { "target": "com.amazonaws.kinesis#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the warm throughput configuration for the specified Amazon Kinesis Data Streams on-demand data stream. Updates the warm throughput configuration for the specified on-demand data stream. Use this operation to scale your stream to a specified throughput level before anticipated traffic spikes, or to release excess capacity after traffic has decreased.

\n \n

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

\n
\n

Updating the warm throughput is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.

\n

This operation is only supported for data streams with the on-demand capacity mode in accounts that have MinimumThroughputBillingCommitment enabled. Provisioned capacity mode streams do not support warm throughput configuration.

\n

To release excess capacity, call the API again and set the warm throughput to the same or a lower value.

\n

This operation has the following default limits. By default, you cannot do the following:

\n \n

For the default limits for an Amazon Web Services account, see Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" } } } }, "com.amazonaws.kinesis#UpdateStreamWarmThroughputInput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream to be updated.

", "smithy.rules#contextParam": { "name": "StreamARN" } } }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream to be updated.

" } }, "StreamId": { "target": "com.amazonaws.kinesis#StreamId", "traits": { "smithy.api#documentation": "

Not Implemented. Reserved for future use.

", "smithy.rules#contextParam": { "name": "StreamId" } } }, "WarmThroughputMiBps": { "target": "com.amazonaws.kinesis#NaturalIntegerObject", "traits": { "smithy.api#documentation": "

The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.kinesis#UpdateStreamWarmThroughputOutput": { "type": "structure", "members": { "StreamARN": { "target": "com.amazonaws.kinesis#StreamARN", "traits": { "smithy.api#documentation": "

The ARN of the stream that was updated.

" } }, "StreamName": { "target": "com.amazonaws.kinesis#StreamName", "traits": { "smithy.api#documentation": "

The name of the stream that was updated.

" } }, "WarmThroughput": { "target": "com.amazonaws.kinesis#WarmThroughputObject", "traits": { "smithy.api#documentation": "

Specifies the updated warm throughput configuration for your data stream.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.kinesis#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.kinesis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "client" } }, "com.amazonaws.kinesis#VisibilityTimeoutSeconds": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 43200 } } }, "com.amazonaws.kinesis#WarmThroughputObject": { "type": "structure", "members": { "TargetMiBps": { "target": "com.amazonaws.kinesis#NaturalIntegerObject", "traits": { "smithy.api#documentation": "

The target warm throughput value on the stream. This indicates that the stream is currently scaling towards this target value.

" } }, "CurrentMiBps": { "target": "com.amazonaws.kinesis#NaturalIntegerObject", "traits": { "smithy.api#documentation": "

The current warm throughput value on the stream. This is the write throughput in MiBps that the stream is currently scaled to handle.

" } } }, "traits": { "smithy.api#documentation": "

Represents the warm throughput configuration on the stream. This is only present for On-Demand Kinesis Data Streams in accounts that have MinimumThroughputBillingCommitment enabled.

" } } } }