{
  "version": "2.0",
  "service": "<p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p> <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to acquire new insights for your business and customers.</p>",
  "operations": {
    "CreateCluster": "<p>The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters. With the addition of the <i>multiRegionProperties</i> parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.</p> <note> <p>Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the <b>Required permissions</b> section below.</p> </note> <p> <b>Required permissions</b> </p> <dl> <dt>dsql:CreateCluster</dt> <dd> <p>Required to create a cluster.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:TagResource</dt> <dd> <p>Permission to add tags to a resource.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:PutMultiRegionProperties</dt> <dd> <p>Permission to configure multi-Region properties for a cluster.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:AddPeerCluster</dt> <dd> <p>When specifying <code>multiRegionProperties.clusters</code>, permission to add peer clusters.</p> <p>Resources:</p> <ul> <li> <p>Local cluster: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </li> <li> <p>Each peer cluster: exact ARN of each specified peer cluster</p> </li> </ul> </dd> <dt>dsql:PutWitnessRegion</dt> <dd> <p>When specifying <code>multiRegionProperties.witnessRegion</code>, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified witness region)</p> </dd> </dl> <important> <ul> <li> <p>The witness Region specified in <code>multiRegionProperties.witnessRegion</code> cannot be the same as the cluster's Region.</p> </li> </ul> </important>",
    "CreateStream": "<p>Creates a new change data capture (CDC) stream for a cluster. The stream captures database changes and delivers them to the specified target destination.</p> <p> <b>Required permissions</b> </p> <dl> <dt>dsql:CreateStream</dt> <dd> <p>Permission to create a new stream.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/cluster-id</code> </p> </dd> <dt>iam:PassRole</dt> <dd> <p>Permission to pass the IAM role specified in the target definition to the service.</p> <p>Resources: ARN of the IAM role specified in <code>targetDefinition.kinesis.roleArn</code> </p> </dd> <dt>kms:Decrypt</dt> <dd> <p>Required when the cluster uses a customer managed KMS key (CMK). Permission to decrypt data using the cluster's CMK.</p> <p>Resources: ARN of the KMS key used by the cluster</p> </dd> </dl>",
    "DeleteCluster": "<p>Deletes a cluster in Amazon Aurora DSQL.</p>",
    "DeleteClusterPolicy": "<p>Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.</p>",
    "DeleteStream": "<p>Deletes a stream from a cluster.</p>",
    "GetCluster": "<p>Retrieves information about a cluster.</p>",
    "GetClusterPolicy": "<p>Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.</p>",
    "GetStream": "<p>Retrieves information about a stream.</p>",
    "GetVpcEndpointServiceName": "<p>Retrieves the VPC endpoint service name.</p>",
    "ListClusters": "<p>Retrieves information about a list of clusters.</p>",
    "ListStreams": "<p>Retrieves information about a list of streams for a cluster.</p>",
    "ListTagsForResource": "<p>Lists all of the tags for a resource.</p>",
    "PutClusterPolicy": "<p>Attaches a resource-based policy to a cluster. This policy defines access permissions and conditions for the cluster, allowing you to control which principals can perform actions on the cluster.</p>",
    "TagResource": "<p>Tags a resource with a map of key and value pairs.</p>",
    "UntagResource": "<p>Removes a tag from a resource.</p>",
    "UpdateCluster": "<p>The <i>UpdateCluster</i> API allows you to modify both single-Region and multi-Region cluster configurations. With the <i>multiRegionProperties</i> parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.</p> <note> <p>Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.</p> </note> <p> <b>Required permissions</b> </p> <dl> <dt>dsql:UpdateCluster</dt> <dd> <p>Permission to update a DSQL cluster.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> </dl> <dl> <dt>dsql:PutMultiRegionProperties</dt> <dd> <p>Permission to configure multi-Region properties for a cluster.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> </dl> <dl> <dt>dsql:GetCluster</dt> <dd> <p>Permission to retrieve cluster information.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> <dt>dsql:AddPeerCluster</dt> <dd> <p>Permission to add peer clusters.</p> <p>Resources:</p> <ul> <li> <p>Local cluster: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </li> <li> <p>Each peer cluster: exact ARN of each specified peer cluster</p> </li> </ul> </dd> <dt>dsql:RemovePeerCluster</dt> <dd> <p>Permission to remove peer clusters. When you list peer clusters in <code>multiRegionProperties.clusters</code>, you need this permission for each current peer cluster that your list omits.</p> <p>Resources:</p> <ul> <li> <p>Each removed peer cluster: exact ARN of each removed peer cluster, in its own Region</p> </li> </ul> </dd> </dl> <dl> <dt>dsql:PutWitnessRegion</dt> <dd> <p>Permission to set a witness Region.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> <p>Condition Keys: dsql:WitnessRegion (matching the specified witness Region)</p> <p> <b>This permission is checked both in the cluster Region and in the witness Region.</b> </p> </dd> </dl> <important> <ul> <li> <p>The witness Region specified in <code>multiRegionProperties.witnessRegion</code> cannot be the same as the cluster's Region.</p> </li> <li> <p>When you list peer clusters in <code>multiRegionProperties.clusters</code>, you need <code>dsql:AddPeerCluster</code> for every peer cluster in your request. You need <code>dsql:RemovePeerCluster</code> only for the peer clusters that the update removes.</p> </li> </ul> </important>"
  },
  "shapes": {
    "AccessDeniedException": {
      "base": "<p>You do not have sufficient access to perform this action.</p>",
      "refs": {}
    },
    "Arn": {
      "base": "<p>Amazon Resource Name.</p>",
      "refs": {
        "ListTagsForResourceInput$resourceArn": "<p>The ARN of the resource for which you want to list the tags.</p>",
        "TagResourceInput$resourceArn": "<p>The ARN of the resource that you want to tag.</p>",
        "UntagResourceInput$resourceArn": "<p>The ARN of the resource from which to remove tags.</p>"
      }
    },
    "BypassPolicyLockoutSafetyCheck": {
      "base": null,
      "refs": {
        "CreateClusterInput$bypassPolicyLockoutSafetyCheck": "<p>An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.</p>",
        "PutClusterPolicyInput$bypassPolicyLockoutSafetyCheck": "<p>A flag that allows you to bypass the policy lockout safety check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.</p>"
      }
    },
    "ClientToken": {
      "base": "<p>Idempotency token so a request is only processed once.</p>",
      "refs": {
        "CreateClusterInput$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>",
        "CreateStreamInput$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>",
        "DeleteClusterInput$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>",
        "DeleteClusterPolicyInput$clientToken": null,
        "DeleteStreamInput$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>",
        "PutClusterPolicyInput$clientToken": null,
        "UpdateClusterInput$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>"
      }
    },
    "ClusterArn": {
      "base": "<p>The Amazon Resource Name of the cluster.</p>",
      "refs": {
        "ClusterArnList$member": null,
        "ClusterSummary$arn": "<p>The ARN of the cluster.</p>",
        "CreateClusterOutput$arn": "<p>The ARN of the created cluster.</p>",
        "DeleteClusterOutput$arn": "<p>The ARN of the deleted cluster.</p>",
        "GetClusterOutput$arn": "<p>The ARN of the retrieved cluster.</p>",
        "UpdateClusterOutput$arn": "<p>The ARN of the updated cluster.</p>"
      }
    },
    "ClusterArnList": {
      "base": "<p>A list of the Amazon Resource Names of the cluster.</p>",
      "refs": {
        "MultiRegionProperties$clusters": "<p>The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.</p>"
      }
    },
    "ClusterCreationTime": {
      "base": "<p>The timestamp when the cluster was created.</p>",
      "refs": {
        "CreateClusterOutput$creationTime": "<p>The time of when created the cluster.</p>",
        "DeleteClusterOutput$creationTime": "<p>The time of when the cluster was created.</p>",
        "GetClusterOutput$creationTime": "<p>The time of when the cluster was created.</p>",
        "UpdateClusterOutput$creationTime": "<p>The time of when the cluster was created.</p>"
      }
    },
    "ClusterId": {
      "base": "<p>The ID of the cluster.</p>",
      "refs": {
        "ClusterSummary$identifier": "<p>The ID of the cluster.</p>",
        "CreateClusterOutput$identifier": "<p>The ID of the created cluster.</p>",
        "CreateStreamInput$clusterIdentifier": "<p>The ID of the cluster for which to create the stream.</p>",
        "CreateStreamOutput$clusterIdentifier": "<p>The ID of the cluster for the created stream.</p>",
        "DeleteClusterInput$identifier": "<p>The ID of the cluster to delete.</p>",
        "DeleteClusterOutput$identifier": "<p>The ID of the deleted cluster.</p>",
        "DeleteClusterPolicyInput$identifier": null,
        "DeleteStreamInput$clusterIdentifier": "<p>The ID of the cluster containing the stream to delete.</p>",
        "DeleteStreamOutput$clusterIdentifier": "<p>The ID of the cluster for the deleted stream.</p>",
        "GetClusterInput$identifier": "<p>The ID of the cluster to retrieve.</p>",
        "GetClusterOutput$identifier": "<p>The ID of the retrieved cluster.</p>",
        "GetClusterPolicyInput$identifier": "<p>The ID of the cluster to retrieve the policy from.</p>",
        "GetStreamInput$clusterIdentifier": "<p>The ID of the cluster containing the stream to retrieve.</p>",
        "GetStreamOutput$clusterIdentifier": "<p>The ID of the cluster for the retrieved stream.</p>",
        "GetVpcEndpointServiceNameInput$identifier": "<p>The ID of the cluster to retrieve.</p>",
        "ListStreamsInput$clusterIdentifier": "<p>The ID of the cluster for which to list streams.</p>",
        "PutClusterPolicyInput$identifier": null,
        "StreamSummary$clusterIdentifier": "<p>The ID of the cluster.</p>",
        "UpdateClusterInput$identifier": "<p>The ID of the cluster you want to update.</p>",
        "UpdateClusterOutput$identifier": "<p>The ID of the cluster to update.</p>"
      }
    },
    "ClusterList": {
      "base": "<p>The list of clusters.</p>",
      "refs": {
        "ListClustersOutput$clusters": "<p>An array of the returned clusters.</p>"
      }
    },
    "ClusterStatus": {
      "base": "<p>The current status of a cluster.</p>",
      "refs": {
        "CreateClusterOutput$status": "<p>The status of the created cluster.</p>",
        "DeleteClusterOutput$status": "<p>The status of the cluster.</p>",
        "GetClusterOutput$status": "<p>The status of the retrieved cluster.</p>",
        "UpdateClusterOutput$status": "<p>The status of the updated cluster.</p>"
      }
    },
    "ClusterSummary": {
      "base": "<p>A summary of the properties of a cluster.</p>",
      "refs": {
        "ClusterList$member": null
      }
    },
    "ClusterVpcEndpoint": {
      "base": null,
      "refs": {
        "GetVpcEndpointServiceNameOutput$clusterVpcEndpoint": "<p>The VPC connection endpoint for the cluster.</p>"
      }
    },
    "ConflictException": {
      "base": "<p>The submitted action has conflicts.</p>",
      "refs": {}
    },
    "CreateClusterInput": {
      "base": null,
      "refs": {}
    },
    "CreateClusterOutput": {
      "base": "<p>The output of a created cluster.</p>",
      "refs": {}
    },
    "CreateStreamInput": {
      "base": null,
      "refs": {}
    },
    "CreateStreamOutput": {
      "base": "<p>The output of a created stream.</p>",
      "refs": {}
    },
    "DeleteClusterInput": {
      "base": null,
      "refs": {}
    },
    "DeleteClusterOutput": {
      "base": "<p>The output from a deleted cluster.</p>",
      "refs": {}
    },
    "DeleteClusterPolicyInput": {
      "base": null,
      "refs": {}
    },
    "DeleteClusterPolicyOutput": {
      "base": null,
      "refs": {}
    },
    "DeleteStreamInput": {
      "base": null,
      "refs": {}
    },
    "DeleteStreamOutput": {
      "base": "<p>The output from a deleted stream.</p>",
      "refs": {}
    },
    "DeletionProtectionEnabled": {
      "base": "<p>Indicates whether deletion protection is enabled for a cluster.</p>",
      "refs": {
        "CreateClusterInput$deletionProtectionEnabled": "<p>If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.</p>",
        "CreateClusterOutput$deletionProtectionEnabled": "<p>Whether deletion protection is enabled on this cluster.</p>",
        "GetClusterOutput$deletionProtectionEnabled": "<p>Whether deletion protection is enabled in this cluster.</p>",
        "UpdateClusterInput$deletionProtectionEnabled": "<p>Specifies whether to enable deletion protection in your cluster.</p>"
      }
    },
    "EncryptionDetails": {
      "base": "<p>Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.</p>",
      "refs": {
        "CreateClusterOutput$encryptionDetails": "<p>The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state.</p>",
        "GetClusterOutput$encryptionDetails": "<p>The current encryption configuration details for the cluster.</p>"
      }
    },
    "EncryptionStatus": {
      "base": null,
      "refs": {
        "EncryptionDetails$encryptionStatus": "<p>The status of encryption for the cluster.</p>"
      }
    },
    "EncryptionType": {
      "base": null,
      "refs": {
        "EncryptionDetails$encryptionType": "<p>The type of encryption that protects the data on your cluster.</p>"
      }
    },
    "Endpoint": {
      "base": null,
      "refs": {
        "CreateClusterOutput$endpoint": "<p>The connection endpoint for the created cluster.</p>",
        "GetClusterOutput$endpoint": "<p>The connection endpoint for the cluster.</p>"
      }
    },
    "GetClusterInput": {
      "base": null,
      "refs": {}
    },
    "GetClusterOutput": {
      "base": "<p>The output of a cluster.</p>",
      "refs": {}
    },
    "GetClusterPolicyInput": {
      "base": null,
      "refs": {}
    },
    "GetClusterPolicyOutput": {
      "base": null,
      "refs": {}
    },
    "GetStreamInput": {
      "base": null,
      "refs": {}
    },
    "GetStreamOutput": {
      "base": "<p>The output of a retrieved stream.</p>",
      "refs": {}
    },
    "GetVpcEndpointServiceNameInput": {
      "base": null,
      "refs": {}
    },
    "GetVpcEndpointServiceNameOutput": {
      "base": null,
      "refs": {}
    },
    "Integer": {
      "base": null,
      "refs": {
        "InternalServerException$retryAfterSeconds": "<p>Retry after seconds.</p>",
        "ThrottlingException$retryAfterSeconds": "<p>The request exceeds a request rate quota. Retry after seconds.</p>"
      }
    },
    "InternalServerException": {
      "base": "<p>The request processing has failed because of an unknown error, exception or failure.</p>",
      "refs": {}
    },
    "KinesisStreamArn": {
      "base": "<p>The Amazon Resource Name (ARN) of an Amazon Kinesis Data Stream.</p>",
      "refs": {
        "KinesisTargetDefinition$streamArn": "<p>The ARN of the Kinesis stream.</p>"
      }
    },
    "KinesisTargetDefinition": {
      "base": "<p>Kinesis stream target configuration.</p>",
      "refs": {
        "TargetDefinition$kinesis": "<p>Kinesis stream target configuration.</p>"
      }
    },
    "KmsEncryptionKey": {
      "base": null,
      "refs": {
        "CreateClusterInput$kmsEncryptionKey": "<p>The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.</p>",
        "UpdateClusterInput$kmsEncryptionKey": "<p>The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.</p> <p>To switch to the key owned by Amazon Web Services, specify the reserved value <code>AWS_OWNED_KMS_KEY</code>.</p>"
      }
    },
    "KmsKeyArn": {
      "base": null,
      "refs": {
        "EncryptionDetails$kmsKeyArn": "<p>The ARN of the KMS key that encrypts data in the cluster.</p>"
      }
    },
    "ListClustersInput": {
      "base": null,
      "refs": {}
    },
    "ListClustersOutput": {
      "base": null,
      "refs": {}
    },
    "ListStreamsInput": {
      "base": null,
      "refs": {}
    },
    "ListStreamsOutput": {
      "base": null,
      "refs": {}
    },
    "ListTagsForResourceInput": {
      "base": null,
      "refs": {}
    },
    "ListTagsForResourceOutput": {
      "base": null,
      "refs": {}
    },
    "MaxResults": {
      "base": "<p>Max results that will be returned per page.</p>",
      "refs": {
        "ListClustersInput$maxResults": "<p>An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.</p>",
        "ListStreamsInput$maxResults": "<p>An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. Default: 10.</p>"
      }
    },
    "MultiRegionProperties": {
      "base": "<p>Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.</p>",
      "refs": {
        "CreateClusterInput$multiRegionProperties": "<p>The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.</p>",
        "CreateClusterOutput$multiRegionProperties": "<p>The multi-Region cluster configuration details that were set during cluster creation</p>",
        "GetClusterOutput$multiRegionProperties": "<p>Returns the current multi-Region cluster configuration, including witness region and linked cluster information.</p>",
        "UpdateClusterInput$multiRegionProperties": "<p>The new multi-Region cluster configuration settings to be applied during an update operation.</p>"
      }
    },
    "NextToken": {
      "base": "<p>Token used to retrieve next page.</p>",
      "refs": {
        "ListClustersInput$nextToken": "<p>If your initial ListClusters operation returns a nextToken, you can include the returned nextToken in following ListClusters operations, which returns results in the next page.</p>",
        "ListClustersOutput$nextToken": "<p>If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.</p>",
        "ListStreamsInput$nextToken": "<p>If your initial ListStreams operation returns a nextToken, you can include the returned nextToken in following ListStreams operations, which returns results in the next page.</p>",
        "ListStreamsOutput$nextToken": "<p>If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.</p>"
      }
    },
    "PolicyDocument": {
      "base": "<p>A resource-based policy document in JSON format. Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).</p>",
      "refs": {
        "CreateClusterInput$policy": "<p>An optional resource-based policy document in JSON format that defines access permissions for the cluster.</p>",
        "GetClusterPolicyOutput$policy": "<p>The resource-based policy document attached to the cluster, returned as a JSON string.</p>",
        "PutClusterPolicyInput$policy": "<p>The resource-based policy document to attach to the cluster. This should be a valid JSON policy document that defines permissions and conditions.</p>"
      }
    },
    "PolicyVersion": {
      "base": null,
      "refs": {
        "DeleteClusterPolicyInput$expectedPolicyVersion": "<p>The expected version of the policy to delete. This parameter ensures that you're deleting the correct version of the policy and helps prevent accidental deletions.</p>",
        "DeleteClusterPolicyOutput$policyVersion": "<p>The version of the policy that was deleted.</p>",
        "GetClusterPolicyOutput$policyVersion": "<p>The version of the policy document. This version number is incremented each time the policy is updated.</p>",
        "PutClusterPolicyInput$expectedPolicyVersion": "<p>The expected version of the current policy. This parameter ensures that you're updating the correct version of the policy and helps prevent concurrent modification conflicts.</p>",
        "PutClusterPolicyOutput$policyVersion": "<p>The version of the policy after it has been updated or created.</p>"
      }
    },
    "PutClusterPolicyInput": {
      "base": null,
      "refs": {}
    },
    "PutClusterPolicyOutput": {
      "base": null,
      "refs": {}
    },
    "Region": {
      "base": "<p> Region name.</p>",
      "refs": {
        "MultiRegionProperties$witnessRegion": "<p>The Region that serves as the witness region for a multi-Region cluster. The witness Region helps maintain cluster consistency and quorum.</p>"
      }
    },
    "ResourceNotFoundException": {
      "base": "<p>The resource could not be found.</p>",
      "refs": {}
    },
    "RoleArn": {
      "base": "<p>The Amazon Resource Name (ARN) of an IAM role.</p>",
      "refs": {
        "KinesisTargetDefinition$roleArn": "<p>The ARN of the IAM role that grants permission to write to the Kinesis stream. This can be a standard role (<code>arn:aws:iam::account-id:role/role-name</code>) or a role with a path prefix (<code>arn:aws:iam::account-id:role/service-role/role-name</code>), such as roles auto-created by the console.</p>"
      }
    },
    "ServiceName": {
      "base": "<p>The name of the VPC endpoint service that provides access to your cluster. Use this endpoint to establish a private connection between your VPC and the cluster.</p>",
      "refs": {
        "GetVpcEndpointServiceNameOutput$serviceName": "<p>The VPC endpoint service name.</p>"
      }
    },
    "ServiceQuotaExceededException": {
      "base": "<p>The service limit was exceeded.</p>",
      "refs": {}
    },
    "StatusReason": {
      "base": "<p>Stream status reason with error and timestamp.</p>",
      "refs": {
        "GetStreamOutput$statusReason": "<p>Stream status reason with error code and timestamp (if applicable).</p>"
      }
    },
    "StreamArn": {
      "base": "<p>The Amazon Resource Name (ARN) of the stream.</p>",
      "refs": {
        "CreateStreamOutput$arn": "<p>The ARN of the created stream.</p>",
        "DeleteStreamOutput$arn": "<p>The ARN of the deleted stream.</p>",
        "GetStreamOutput$arn": "<p>The ARN of the retrieved stream.</p>",
        "StreamSummary$arn": "<p>The ARN of the stream.</p>"
      }
    },
    "StreamCreationTime": {
      "base": "<p>The timestamp when the stream was created.</p>",
      "refs": {
        "CreateStreamOutput$creationTime": "<p>The time when created the stream.</p>",
        "DeleteStreamOutput$creationTime": "<p>The time when the stream was created.</p>",
        "GetStreamOutput$creationTime": "<p>The time when the stream was created.</p>",
        "StreamSummary$creationTime": "<p>The timestamp when the stream was created.</p>"
      }
    },
    "StreamFailureErrorCode": {
      "base": "<p>Error codes for stream failures.</p> <dl> <dt>KINESIS_THROUGHPUT_EXCEEDED</dt> <dd> <p>The Kinesis stream throughput limit was exceeded.</p> </dd> <dt>KINESIS_STREAM_NOT_FOUND</dt> <dd> <p>The specified Kinesis stream was not found.</p> </dd> <dt>ROLE_ACCESS_DENIED</dt> <dd> <p>Access was denied for the specified IAM role.</p> </dd> <dt>KINESIS_ACCESS_DENIED</dt> <dd> <p>Access to the Kinesis stream was denied.</p> </dd> <dt>KINESIS_KMS_ACCESS_DENIED</dt> <dd> <p>Access to the KMS key for the Kinesis stream was denied.</p> </dd> <dt>KINESIS_OVERSIZE_RECORD</dt> <dd> <p>A record exceeded the Kinesis stream size limit.</p> </dd> <dt>CLUSTER_CMK_INACCESSIBLE</dt> <dd> <p>The cluster's customer-managed key is inaccessible.</p> </dd> <dt>INTERNAL_ERROR</dt> <dd> <p>An internal error occurred.</p> </dd> </dl>",
      "refs": {
        "StatusReason$error": "<p>The error code for the stream failure.</p>"
      }
    },
    "StreamFormat": {
      "base": "<p>Stream record format.</p> <dl> <dt>JSON</dt> <dd> <p>Stream records are formatted as JSON.</p> </dd> </dl>",
      "refs": {
        "CreateStreamInput$format": "<p>The format of the stream records.</p>",
        "CreateStreamOutput$format": "<p>The format of the created stream records.</p>",
        "GetStreamOutput$format": "<p>The format of the stream records.</p>"
      }
    },
    "StreamId": {
      "base": "<p>The ID of the stream.</p>",
      "refs": {
        "CreateStreamOutput$streamIdentifier": "<p>The ID of the created stream.</p>",
        "DeleteStreamInput$streamIdentifier": "<p>The ID of the stream to delete.</p>",
        "DeleteStreamOutput$streamIdentifier": "<p>The ID of the deleted stream.</p>",
        "GetStreamInput$streamIdentifier": "<p>The ID of the stream to retrieve.</p>",
        "GetStreamOutput$streamIdentifier": "<p>The ID of the retrieved stream.</p>",
        "StreamSummary$streamIdentifier": "<p>The ID of the stream.</p>"
      }
    },
    "StreamList": {
      "base": "<p>A list of stream summaries.</p>",
      "refs": {
        "ListStreamsOutput$streams": "<p>An array of the returned streams.</p>"
      }
    },
    "StreamOrdering": {
      "base": "<p>Stream ordering mode.</p> <dl> <dt>UNORDERED</dt> <dd> <p>Changes are streamed without ordering guarantees.</p> </dd> </dl>",
      "refs": {
        "CreateStreamInput$ordering": "<p>The ordering mode for the stream. Determines how change events are ordered when delivered to the target.</p>",
        "CreateStreamOutput$ordering": "<p>The ordering mode of the created stream.</p>",
        "GetStreamOutput$ordering": "<p>The ordering mode of the stream.</p>"
      }
    },
    "StreamStatus": {
      "base": "<p>The current status of a stream.</p> <dl> <dt>CREATING</dt> <dd> <p>The stream is being created.</p> </dd> <dt>ACTIVE</dt> <dd> <p>The stream is active and processing changes.</p> </dd> <dt>DELETING</dt> <dd> <p>The stream is being deleted.</p> </dd> <dt>DELETED</dt> <dd> <p>The stream has been deleted.</p> </dd> <dt>FAILED</dt> <dd> <p>The stream has failed.</p> </dd> <dt>IMPAIRED</dt> <dd> <p>The stream is impaired and may not be processing changes correctly.</p> </dd> </dl>",
      "refs": {
        "CreateStreamOutput$status": "<p>The status of the created stream.</p>",
        "DeleteStreamOutput$status": "<p>The status of the stream.</p>",
        "GetStreamOutput$status": "<p>The current status of the retrieved stream.</p>",
        "StreamSummary$status": "<p>The current status of the stream.</p>"
      }
    },
    "StreamSummary": {
      "base": "<p>Summary information about a stream.</p>",
      "refs": {
        "StreamList$member": null
      }
    },
    "String": {
      "base": null,
      "refs": {
        "AccessDeniedException$message": null,
        "ConflictException$message": null,
        "ConflictException$resourceId": "<p>Resource Id</p>",
        "ConflictException$resourceType": "<p>Resource Type</p>",
        "InternalServerException$message": null,
        "ResourceNotFoundException$message": null,
        "ResourceNotFoundException$resourceId": "<p>The resource ID could not be found.</p>",
        "ResourceNotFoundException$resourceType": "<p>The resource type could not be found.</p>",
        "ServiceQuotaExceededException$message": "<p>The service exception for exceeding a quota.</p>",
        "ServiceQuotaExceededException$resourceId": "<p>The resource ID exceeds a quota.</p>",
        "ServiceQuotaExceededException$resourceType": "<p>The resource type exceeds a quota.</p>",
        "ServiceQuotaExceededException$serviceCode": "<p>The request exceeds a service quota.</p>",
        "ServiceQuotaExceededException$quotaCode": "<p>The service exceeds a quota.</p>",
        "ThrottlingException$message": "<p>The message that the request was denied due to request throttling.</p>",
        "ThrottlingException$serviceCode": "<p>The request exceeds a service quota.</p>",
        "ThrottlingException$quotaCode": "<p>The request exceeds a request rate quota.</p>",
        "ValidationException$message": null,
        "ValidationExceptionField$name": "<p>The name of the field.</p>",
        "ValidationExceptionField$message": "<p>A message describing why this field failed validation.</p>"
      }
    },
    "TagKey": {
      "base": "<p>Unique tag key, maximum 128 Unicode characters in UTF-8.</p>",
      "refs": {
        "TagKeyList$member": null,
        "TagMap$key": null
      }
    },
    "TagKeyList": {
      "base": "<p>List of tag keys.</p>",
      "refs": {
        "UntagResourceInput$tagKeys": "<p>The array of keys of the tags that you want to remove.</p>"
      }
    },
    "TagMap": {
      "base": "<p>Map of tags.</p>",
      "refs": {
        "CreateClusterInput$tags": "<p>A map of key and value pairs to use to tag your cluster.</p>",
        "CreateStreamInput$tags": "<p>A map of key and value pairs to use to tag your stream.</p>",
        "GetClusterOutput$tags": null,
        "GetStreamOutput$tags": "<p>A map of tags associated with the stream.</p>",
        "ListTagsForResourceOutput$tags": "<p>A map of key and value pairs that you used to tag your resource.</p>",
        "TagResourceInput$tags": "<p>A map of key and value pairs to use to tag your resource.</p>"
      }
    },
    "TagResourceInput": {
      "base": null,
      "refs": {}
    },
    "TagValue": {
      "base": "<p>Tag value, maximum 256 Unicode characters in UTF-8.</p>",
      "refs": {
        "TagMap$value": null
      }
    },
    "TargetDefinition": {
      "base": "<p>Target definition for stream destination.</p>",
      "refs": {
        "CreateStreamInput$targetDefinition": "<p>The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.</p>",
        "GetStreamOutput$targetDefinition": "<p>The target definition for the stream destination.</p>"
      }
    },
    "ThrottlingException": {
      "base": "<p>The request was denied due to request throttling.</p>",
      "refs": {}
    },
    "Timestamp": {
      "base": null,
      "refs": {
        "StatusReason$updatedAt": "<p>The timestamp when the status was updated.</p>"
      }
    },
    "UntagResourceInput": {
      "base": null,
      "refs": {}
    },
    "UpdateClusterInput": {
      "base": null,
      "refs": {}
    },
    "UpdateClusterOutput": {
      "base": "<p>The details of the cluster after it has been updated.</p>",
      "refs": {}
    },
    "ValidationException": {
      "base": "<p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>",
      "refs": {}
    },
    "ValidationExceptionField": {
      "base": "<p>Stores information about a field passed inside a request that resulted in an validation error.</p>",
      "refs": {
        "ValidationExceptionFieldList$member": null
      }
    },
    "ValidationExceptionFieldList": {
      "base": "<p>A list of fields that didn't validate.</p>",
      "refs": {
        "ValidationException$fieldList": "<p>A list of fields that didn't validate.</p>"
      }
    },
    "ValidationExceptionReason": {
      "base": "<p>The reason for the validation exception.</p>",
      "refs": {
        "ValidationException$reason": "<p>The reason for the validation exception.</p>"
      }
    }
  }
}
