{ "smithy": "2.0", "shapes": { "com.amazonaws.dsql#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.dsql#Arn": { "type": "string", "traits": { "smithy.api#documentation": "

Amazon Resource Name.

", "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^arn:.+$" } }, "com.amazonaws.dsql#BypassPolicyLockoutSafetyCheck": { "type": "boolean" }, "com.amazonaws.dsql#ClientToken": { "type": "string", "traits": { "smithy.api#documentation": "

Idempotency token so a request is only processed once.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[!-~]+$" } }, "com.amazonaws.dsql#Cluster": { "type": "resource", "identifiers": { "identifier": { "target": "com.amazonaws.dsql#ClusterId" } }, "properties": { "arn": { "target": "com.amazonaws.dsql#ClusterArn" }, "status": { "target": "com.amazonaws.dsql#ClusterStatus" }, "creationTime": { "target": "com.amazonaws.dsql#ClusterCreationTime" }, "deletionProtectionEnabled": { "target": "com.amazonaws.dsql#DeletionProtectionEnabled" }, "encryptionDetails": { "target": "com.amazonaws.dsql#EncryptionDetails" } }, "create": { "target": "com.amazonaws.dsql#CreateCluster" }, "read": { "target": "com.amazonaws.dsql#GetCluster" }, "update": { "target": "com.amazonaws.dsql#UpdateCluster" }, "delete": { "target": "com.amazonaws.dsql#DeleteCluster" }, "list": { "target": "com.amazonaws.dsql#ListClusters" }, "operations": [ { "target": "com.amazonaws.dsql#DeleteClusterPolicy" }, { "target": "com.amazonaws.dsql#GetClusterPolicy" }, { "target": "com.amazonaws.dsql#GetVpcEndpointServiceName" }, { "target": "com.amazonaws.dsql#PutClusterPolicy" } ], "traits": { "aws.api#arn": { "template": "cluster/{identifier}" } } }, "com.amazonaws.dsql#ClusterArn": { "type": "string", "traits": { "aws.api#arnReference": { "service": "com.amazonaws.dsql#DSQL", "resource": "com.amazonaws.dsql#Cluster" }, "smithy.api#documentation": "

The Amazon Resource Name of the cluster.

", "smithy.api#pattern": "^arn:aws(-[^:]+)?:dsql:[a-z0-9-]{1,20}:[0-9]{12}:cluster/[a-z0-9]{26}$" } }, "com.amazonaws.dsql#ClusterArnList": { "type": "list", "member": { "target": "com.amazonaws.dsql#ClusterArn" }, "traits": { "smithy.api#documentation": "

A list of the Amazon Resource Names of the cluster.

", "smithy.api#uniqueItems": {} } }, "com.amazonaws.dsql#ClusterCreationTime": { "type": "timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the cluster was created.

" } }, "com.amazonaws.dsql#ClusterId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID of the cluster.

", "smithy.api#pattern": "^[a-z0-9]{26}$" } }, "com.amazonaws.dsql#ClusterList": { "type": "list", "member": { "target": "com.amazonaws.dsql#ClusterSummary" }, "traits": { "smithy.api#documentation": "

The list of clusters.

", "smithy.api#uniqueItems": {} } }, "com.amazonaws.dsql#ClusterStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "IDLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IDLE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "PENDING_SETUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_SETUP" } }, "PENDING_DELETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DELETE" } } }, "traits": { "smithy.api#documentation": "

The current status of a cluster.

" } }, "com.amazonaws.dsql#ClusterSummary": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#ClusterArn", "traits": { "smithy.api#documentation": "

The ARN of the cluster.

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

A summary of the properties of a cluster.

" } }, "com.amazonaws.dsql#ClusterVpcEndpoint": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9.-]+$" } }, "com.amazonaws.dsql#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Resource Id

" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Resource Type

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

The submitted action has conflicts.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.dsql#CreateCluster": { "type": "operation", "input": { "target": "com.amazonaws.dsql#CreateClusterInput" }, "output": { "target": "com.amazonaws.dsql#CreateClusterOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ConflictException" }, { "target": "com.amazonaws.dsql#ServiceQuotaExceededException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create new clusters." }, "smithy.api#documentation": "

The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below.

Required permissions

dsql:CreateCluster

Required to create a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:TagResource

Permission to add tags to a resource.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:AddPeerCluster

When specifying multiRegionProperties.clusters, permission to add peer clusters.

Resources:

dsql:PutWitnessRegion

When specifying multiRegionProperties.witnessRegion, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

", "smithy.api#examples": [ { "title": "Create Cluster", "input": { "deletionProtectionEnabled": false, "tags": { "MyKey": "MyValue" } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster" } } }, "com.amazonaws.dsql#CreateClusterInput": { "type": "structure", "members": { "deletionProtectionEnabled": { "target": "com.amazonaws.dsql#DeletionProtectionEnabled", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.

" } }, "kmsEncryptionKey": { "target": "com.amazonaws.dsql#KmsEncryptionKey", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#notProperty": {} } }, "tags": { "target": "com.amazonaws.dsql#TagMap", "traits": { "smithy.api#documentation": "

A map of key and value pairs to use to tag your cluster.

", "smithy.api#notProperty": {} } }, "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { "smithy.api#documentation": "

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.

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

", "smithy.api#idempotencyToken": {} } }, "multiRegionProperties": { "target": "com.amazonaws.dsql#MultiRegionProperties", "traits": { "smithy.api#documentation": "

The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.

", "smithy.api#notProperty": {} } }, "policy": { "target": "com.amazonaws.dsql#PolicyDocument", "traits": { "smithy.api#documentation": "

An optional resource-based policy document in JSON format that defines access permissions for the cluster.

", "smithy.api#notProperty": {} } }, "metricGroups": { "target": "com.amazonaws.dsql#MetricGroupRequestList", "traits": { "smithy.api#documentation": "

The metric groups to enable for advanced monitoring on the cluster. Advanced monitoring collects detailed, query-level database metrics to help you analyze and resolve performance issues. If you omit this parameter, no metric groups are enabled.

", "smithy.api#notProperty": {} } }, "bypassPolicyLockoutSafetyCheck": { "target": "com.amazonaws.dsql#BypassPolicyLockoutSafetyCheck", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

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.

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#CreateClusterOutput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the created cluster.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#ClusterArn", "traits": { "smithy.api#documentation": "

The ARN of the created cluster.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#ClusterStatus", "traits": { "smithy.api#documentation": "

The status of the created cluster.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#ClusterCreationTime", "traits": { "smithy.api#documentation": "

The time of when created the cluster.

", "smithy.api#required": {} } }, "multiRegionProperties": { "target": "com.amazonaws.dsql#MultiRegionProperties", "traits": { "smithy.api#documentation": "

The multi-Region cluster configuration details that were set during cluster creation

", "smithy.api#notProperty": {} } }, "encryptionDetails": { "target": "com.amazonaws.dsql#EncryptionDetails", "traits": { "smithy.api#documentation": "

The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state.

", "smithy.api#notProperty": {} } }, "deletionProtectionEnabled": { "target": "com.amazonaws.dsql#DeletionProtectionEnabled", "traits": { "smithy.api#documentation": "

Whether deletion protection is enabled on this cluster.

", "smithy.api#required": {} } }, "endpoint": { "target": "com.amazonaws.dsql#Endpoint", "traits": { "smithy.api#documentation": "

The connection endpoint for the created cluster.

", "smithy.api#notProperty": {} } }, "metricGroups": { "target": "com.amazonaws.dsql#MetricGroupResponseList", "traits": { "smithy.api#documentation": "

The metric groups that you enabled for advanced monitoring on the created cluster.

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

The output of a created cluster.

", "smithy.api#output": {} } }, "com.amazonaws.dsql#CreateStream": { "type": "operation", "input": { "target": "com.amazonaws.dsql#CreateStreamInput" }, "output": { "target": "com.amazonaws.dsql#CreateStreamOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ConflictException" }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" }, { "target": "com.amazonaws.dsql#ServiceQuotaExceededException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to create a new stream." }, "smithy.api#documentation": "

Creates a new change data capture (CDC) stream for a cluster. The stream captures database changes and delivers them to the specified target destination.

Required permissions

dsql:CreateStream

Permission to create a new stream.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

iam:PassRole

Permission to pass the IAM role specified in the target definition to the service.

Resources: ARN of the IAM role specified in targetDefinition.kinesis.roleArn

kms:Decrypt

Required when the cluster uses a customer managed KMS key (CMK). Permission to decrypt data using the cluster's CMK.

Resources: ARN of the KMS key used by the cluster

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/stream/{clusterIdentifier}" } } }, "com.amazonaws.dsql#CreateStreamInput": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster for which to create the stream.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "targetDefinition": { "target": "com.amazonaws.dsql#TargetDefinition", "traits": { "smithy.api#documentation": "

The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.

", "smithy.api#required": {} } }, "ordering": { "target": "com.amazonaws.dsql#StreamOrdering", "traits": { "smithy.api#documentation": "

The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.dsql#StreamFormat", "traits": { "smithy.api#documentation": "

The format of the stream records.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.dsql#TagMap", "traits": { "smithy.api#documentation": "

A map of key and value pairs to use to tag your stream.

", "smithy.api#notProperty": {} } }, "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { "smithy.api#documentation": "

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.

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#CreateStreamOutput": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster for the created stream.

", "smithy.api#required": {} } }, "streamIdentifier": { "target": "com.amazonaws.dsql#StreamId", "traits": { "smithy.api#documentation": "

The ID of the created stream.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#StreamArn", "traits": { "smithy.api#documentation": "

The ARN of the created stream.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#StreamStatus", "traits": { "smithy.api#documentation": "

The status of the created stream.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#StreamCreationTime", "traits": { "smithy.api#documentation": "

The time when created the stream.

", "smithy.api#required": {} } }, "ordering": { "target": "com.amazonaws.dsql#StreamOrdering", "traits": { "smithy.api#documentation": "

The ordering mode of the created stream.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.dsql#StreamFormat", "traits": { "smithy.api#documentation": "

The format of the created stream records.

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

The output of a created stream.

", "smithy.api#output": {} } }, "com.amazonaws.dsql#DSQL": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.dsql#ListTagsForResource" }, { "target": "com.amazonaws.dsql#TagResource" }, { "target": "com.amazonaws.dsql#UntagResource" } ], "resources": [ { "target": "com.amazonaws.dsql#Cluster" }, { "target": "com.amazonaws.dsql#Stream" } ], "errors": [ { "target": "com.amazonaws.dsql#AccessDeniedException" }, { "target": "com.amazonaws.dsql#InternalServerException" }, { "target": "com.amazonaws.dsql#ThrottlingException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "aws.api#service": { "sdkId": "DSQL", "arnNamespace": "dsql", "endpointPrefix": "dsql", "cloudTrailEventSource": "dsql.amazonaws.com" }, "aws.auth#sigv4": { "name": "dsql" }, "aws.endpoints#dualStackOnlyEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, "smithy.api#documentation": "

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.

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.

", "smithy.api#title": "Amazon Aurora DSQL", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "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" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://dsql-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://dsql.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 6, "nodes": "/////wAAAAH/////AAAAAAAAAAYAAAADAAAAAQAAAAQF9eEFAAAAAgAAAAUF9eEFAAAAAwX14QMF9eEEAAAAAwX14QEF9eEC" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "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" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "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": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://dsql-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://dsql.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dsql-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dsql.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dsql-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dsql.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dsql-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dsql.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.dsql#DeleteCluster": { "type": "operation", "input": { "target": "com.amazonaws.dsql#DeleteClusterInput" }, "output": { "target": "com.amazonaws.dsql#DeleteClusterOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ConflictException" }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a cluster and all of its data." }, "smithy.api#documentation": "

Deletes a cluster in Amazon Aurora DSQL.

", "smithy.api#examples": [ { "title": "Delete Cluster", "input": { "identifier": "kiqenqglxyl2snyvkvnj2c3s2e" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/cluster/{identifier}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.dsql#DeleteClusterInput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { "smithy.api#documentation": "

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.

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

", "smithy.api#httpQuery": "client-token", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#DeleteClusterOutput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the deleted cluster.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#ClusterArn", "traits": { "smithy.api#documentation": "

The ARN of the deleted cluster.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#ClusterStatus", "traits": { "smithy.api#documentation": "

The status of the cluster.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#ClusterCreationTime", "traits": { "smithy.api#documentation": "

The time of when the cluster was created.

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

The output from a deleted cluster.

", "smithy.api#output": {} } }, "com.amazonaws.dsql#DeleteClusterPolicy": { "type": "operation", "input": { "target": "com.amazonaws.dsql#DeleteClusterPolicyInput" }, "output": { "target": "com.amazonaws.dsql#DeleteClusterPolicyOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ConflictException" }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/cluster/{identifier}/policy" }, "smithy.api#idempotent": {} } }, "com.amazonaws.dsql#DeleteClusterPolicyInput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "expectedPolicyVersion": { "target": "com.amazonaws.dsql#PolicyVersion", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "expected-policy-version", "smithy.api#notProperty": {} } }, "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { "smithy.api#httpQuery": "client-token", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#DeleteClusterPolicyOutput": { "type": "structure", "members": { "policyVersion": { "target": "com.amazonaws.dsql#PolicyVersion", "traits": { "smithy.api#documentation": "

The version of the policy that was deleted.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dsql#DeleteStream": { "type": "operation", "input": { "target": "com.amazonaws.dsql#DeleteStreamInput" }, "output": { "target": "com.amazonaws.dsql#DeleteStreamOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ConflictException" }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to delete a stream." }, "smithy.api#documentation": "

Deletes a stream from a cluster.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/stream/{clusterIdentifier}/{streamIdentifier}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.dsql#DeleteStreamInput": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster containing the stream to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "streamIdentifier": { "target": "com.amazonaws.dsql#StreamId", "traits": { "smithy.api#documentation": "

The ID of the stream to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { "smithy.api#documentation": "

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.

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

", "smithy.api#httpQuery": "client-token", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#DeleteStreamOutput": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster for the deleted stream.

", "smithy.api#required": {} } }, "streamIdentifier": { "target": "com.amazonaws.dsql#StreamId", "traits": { "smithy.api#documentation": "

The ID of the deleted stream.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#StreamArn", "traits": { "smithy.api#documentation": "

The ARN of the deleted stream.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#StreamStatus", "traits": { "smithy.api#documentation": "

The status of the stream.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#StreamCreationTime", "traits": { "smithy.api#documentation": "

The time when the stream was created.

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

The output from a deleted stream.

", "smithy.api#output": {} } }, "com.amazonaws.dsql#DeletionProtectionEnabled": { "type": "boolean", "traits": { "smithy.api#documentation": "

Indicates whether deletion protection is enabled for a cluster.

" } }, "com.amazonaws.dsql#EncryptionDetails": { "type": "structure", "members": { "encryptionType": { "target": "com.amazonaws.dsql#EncryptionType", "traits": { "smithy.api#documentation": "

The type of encryption that protects the data on your cluster.

", "smithy.api#required": {} } }, "kmsKeyArn": { "target": "com.amazonaws.dsql#KmsKeyArn", "traits": { "smithy.api#documentation": "

The ARN of the KMS key that encrypts data in the cluster.

" } }, "encryptionStatus": { "target": "com.amazonaws.dsql#EncryptionStatus", "traits": { "smithy.api#documentation": "

The status of encryption for the cluster.

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

Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.

" } }, "com.amazonaws.dsql#EncryptionStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "KMS_KEY_INACCESSIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_KEY_INACCESSIBLE" } }, "ENABLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLING" } } } }, "com.amazonaws.dsql#EncryptionType": { "type": "enum", "members": { "AWS_OWNED_KMS_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_OWNED_KMS_KEY" } }, "CUSTOMER_MANAGED_KMS_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED_KMS_KEY" } } } }, "com.amazonaws.dsql#Endpoint": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9.-]+$" } }, "com.amazonaws.dsql#GetCluster": { "type": "operation", "input": { "target": "com.amazonaws.dsql#GetClusterInput" }, "output": { "target": "com.amazonaws.dsql#GetClusterOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get information about a cluster." }, "smithy.api#documentation": "

Retrieves information about a cluster.

", "smithy.api#examples": [ { "title": "Get Cluster", "input": { "identifier": "kiqenqglxyl2snyvkvnj2c3s2e" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/cluster/{identifier}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetClusterNotFound", "params": { "identifier": "ruabtlcu6nqjdl6k6jjcug67ta" }, "expect": { "failure": { "errorId": "com.amazonaws.dsql#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ], "smithy.waiters#waitable": { "ClusterActive": { "documentation": "Wait until a Cluster is ACTIVE", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "comparator": "stringEquals", "expected": "ACTIVE" } } } ] }, "ClusterNotExists": { "documentation": "Wait until a Cluster is gone", "acceptors": [ { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } } ] } } } }, "com.amazonaws.dsql#GetClusterInput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#GetClusterOutput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the retrieved cluster.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#ClusterArn", "traits": { "smithy.api#documentation": "

The ARN of the retrieved cluster.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#ClusterStatus", "traits": { "smithy.api#documentation": "

The status of the retrieved cluster.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#ClusterCreationTime", "traits": { "smithy.api#documentation": "

The time of when the cluster was created.

", "smithy.api#required": {} } }, "deletionProtectionEnabled": { "target": "com.amazonaws.dsql#DeletionProtectionEnabled", "traits": { "smithy.api#documentation": "

Whether deletion protection is enabled in this cluster.

", "smithy.api#required": {} } }, "multiRegionProperties": { "target": "com.amazonaws.dsql#MultiRegionProperties", "traits": { "smithy.api#documentation": "

Returns the current multi-Region cluster configuration, including witness region and linked cluster information.

", "smithy.api#notProperty": {} } }, "tags": { "target": "com.amazonaws.dsql#TagMap", "traits": { "smithy.api#notProperty": {} } }, "encryptionDetails": { "target": "com.amazonaws.dsql#EncryptionDetails", "traits": { "smithy.api#documentation": "

The current encryption configuration details for the cluster.

", "smithy.api#notProperty": {} } }, "endpoint": { "target": "com.amazonaws.dsql#Endpoint", "traits": { "smithy.api#documentation": "

The connection endpoint for the cluster.

", "smithy.api#notProperty": {} } }, "metricGroups": { "target": "com.amazonaws.dsql#MetricGroupResponseList", "traits": { "smithy.api#documentation": "

The metric groups that you enabled for advanced monitoring on the cluster. If you haven't enabled any metric groups, the list is empty.

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

The output of a cluster.

", "smithy.api#output": {} } }, "com.amazonaws.dsql#GetClusterPolicy": { "type": "operation", "input": { "target": "com.amazonaws.dsql#GetClusterPolicyInput" }, "output": { "target": "com.amazonaws.dsql#GetClusterPolicyOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/cluster/{identifier}/policy" }, "smithy.api#readonly": {} } }, "com.amazonaws.dsql#GetClusterPolicyInput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster to retrieve the policy from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#GetClusterPolicyOutput": { "type": "structure", "members": { "policy": { "target": "com.amazonaws.dsql#PolicyDocument", "traits": { "smithy.api#documentation": "

The resource-based policy document attached to the cluster, returned as a JSON string.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "policyVersion": { "target": "com.amazonaws.dsql#PolicyVersion", "traits": { "smithy.api#documentation": "

The version of the policy document. This version number is incremented each time the policy is updated.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dsql#GetStream": { "type": "operation", "input": { "target": "com.amazonaws.dsql#GetStreamInput" }, "output": { "target": "com.amazonaws.dsql#GetStreamOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get information about a stream." }, "smithy.api#documentation": "

Retrieves information about a stream.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/stream/{clusterIdentifier}/{streamIdentifier}" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "StreamActive": { "documentation": "Wait until a Stream is ACTIVE", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "comparator": "stringEquals", "expected": "ACTIVE" } } } ] }, "StreamNotExists": { "documentation": "Wait until a Stream is gone", "acceptors": [ { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } } ] } } } }, "com.amazonaws.dsql#GetStreamInput": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster containing the stream to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "streamIdentifier": { "target": "com.amazonaws.dsql#StreamId", "traits": { "smithy.api#documentation": "

The ID of the stream to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#GetStreamOutput": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster for the retrieved stream.

", "smithy.api#required": {} } }, "streamIdentifier": { "target": "com.amazonaws.dsql#StreamId", "traits": { "smithy.api#documentation": "

The ID of the retrieved stream.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#StreamArn", "traits": { "smithy.api#documentation": "

The ARN of the retrieved stream.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#StreamStatus", "traits": { "smithy.api#documentation": "

The current status of the retrieved stream.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#StreamCreationTime", "traits": { "smithy.api#documentation": "

The time when the stream was created.

", "smithy.api#required": {} } }, "ordering": { "target": "com.amazonaws.dsql#StreamOrdering", "traits": { "smithy.api#documentation": "

The ordering mode of the stream.

", "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.dsql#StreamFormat", "traits": { "smithy.api#documentation": "

The format of the stream records.

", "smithy.api#required": {} } }, "targetDefinition": { "target": "com.amazonaws.dsql#TargetDefinition", "traits": { "smithy.api#documentation": "

The target definition for the stream destination.

", "smithy.api#notProperty": {} } }, "statusReason": { "target": "com.amazonaws.dsql#StatusReason", "traits": { "smithy.api#documentation": "

Stream status reason with error code and timestamp (if applicable).

", "smithy.api#notProperty": {} } }, "tags": { "target": "com.amazonaws.dsql#TagMap", "traits": { "smithy.api#documentation": "

A map of tags associated with the stream.

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

The output of a retrieved stream.

", "smithy.api#output": {} } }, "com.amazonaws.dsql#GetVpcEndpointServiceName": { "type": "operation", "input": { "target": "com.amazonaws.dsql#GetVpcEndpointServiceNameInput" }, "output": { "target": "com.amazonaws.dsql#GetVpcEndpointServiceNameOutput" }, "errors": [ { "target": "com.amazonaws.dsql#InternalServerException" }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" }, { "target": "com.amazonaws.dsql#ThrottlingException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get the VPC Endpoint Service Name for a cluster" }, "smithy.api#documentation": "

Retrieves the VPC endpoint service name.

", "smithy.api#examples": [ { "title": "Get VPC Endpoint Service Name", "input": { "identifier": "kiqenqglxyl2snyvkvnj2c3s2e" } } ], "smithy.api#http": { "code": 200, "uri": "/clusters/{identifier}/vpc-endpoint-service-name", "method": "GET" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetVpcEndpointServiceNameNotFound", "params": { "identifier": "ruabtlcu6nqjdl6k6jjcug67ta" }, "expect": { "failure": { "errorId": "com.amazonaws.dsql#ResourceNotFoundException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.dsql#GetVpcEndpointServiceNameInput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#GetVpcEndpointServiceNameOutput": { "type": "structure", "members": { "serviceName": { "target": "com.amazonaws.dsql#ServiceName", "traits": { "smithy.api#documentation": "

The VPC endpoint service name.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "clusterVpcEndpoint": { "target": "com.amazonaws.dsql#ClusterVpcEndpoint", "traits": { "smithy.api#documentation": "

The VPC connection endpoint for the cluster.

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dsql#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Retry after seconds.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

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

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.dsql#KinesisStreamArn": { "type": "string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Amazon Kinesis Data Stream.

", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:kinesis:[a-z0-9-]*:[0-9]{12}:stream/[a-zA-Z0-9+=,.@_/\\-]+$" } }, "com.amazonaws.dsql#KinesisTargetDefinition": { "type": "structure", "members": { "streamArn": { "target": "com.amazonaws.dsql#KinesisStreamArn", "traits": { "smithy.api#documentation": "

The ARN of the Kinesis stream.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.dsql#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants permission to write to the Kinesis stream. This can be a standard role (arn:aws:iam::account-id:role/role-name) or a role with a path prefix (arn:aws:iam::account-id:role/service-role/role-name), such as roles auto-created by the console.

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

Kinesis stream target configuration.

" } }, "com.amazonaws.dsql#KmsEncryptionKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[a-zA-Z0-9:/_-]+$" } }, "com.amazonaws.dsql#KmsKeyArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::KMS::Key" } } }, "com.amazonaws.dsql#ListClusters": { "type": "operation", "input": { "target": "com.amazonaws.dsql#ListClustersInput" }, "output": { "target": "com.amazonaws.dsql#ListClustersOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to get a list of cluster ARNs associated with the current endpoint and account." }, "smithy.api#documentation": "

Retrieves information about a list of clusters.

", "smithy.api#examples": [ { "title": "List Clusters", "input": { "maxResults": 20 } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/cluster" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "clusters" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListClustersSuccess", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" } } ] } }, "com.amazonaws.dsql#ListClustersInput": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.dsql#MaxResults", "traits": { "smithy.api#default": 20, "smithy.api#documentation": "

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

", "smithy.api#httpQuery": "max-results" } }, "nextToken": { "target": "com.amazonaws.dsql#NextToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "next-token" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#ListClustersOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.dsql#NextToken", "traits": { "smithy.api#documentation": "

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.

" } }, "clusters": { "target": "com.amazonaws.dsql#ClusterList", "traits": { "smithy.api#documentation": "

An array of the returned clusters.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dsql#ListStreams": { "type": "operation", "input": { "target": "com.amazonaws.dsql#ListStreamsInput" }, "output": { "target": "com.amazonaws.dsql#ListStreamsOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list streams for a cluster." }, "smithy.api#documentation": "

Retrieves information about a list of streams for a cluster.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/stream/{clusterIdentifier}" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "streams" }, "smithy.api#readonly": {} } }, "com.amazonaws.dsql#ListStreamsInput": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster for which to list streams.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.dsql#MaxResults", "traits": { "smithy.api#default": 10, "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "max-results" } }, "nextToken": { "target": "com.amazonaws.dsql#NextToken", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#httpQuery": "next-token" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#ListStreamsOutput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.dsql#NextToken", "traits": { "smithy.api#documentation": "

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.

" } }, "streams": { "target": "com.amazonaws.dsql#StreamList", "traits": { "smithy.api#documentation": "

An array of the returned streams.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dsql#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.dsql#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.dsql#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to list all tags for an ARN." }, "smithy.api#documentation": "

Lists all of the tags for a resource.

", "smithy.api#examples": [ { "title": "List Tags For Resource", "input": { "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e" } } ], "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.dsql#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.dsql#Arn", "traits": { "smithy.api#documentation": "

The ARN of the resource for which you want to list the tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#ListTagsForResourceOutput": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.dsql#TagMap", "traits": { "smithy.api#documentation": "

A map of key and value pairs that you used to tag your resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dsql#MaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "

Max results that will be returned per page.

", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.dsql#MetricGroup": { "type": "enum", "members": { "STATEMENT_STATISTICS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

Shows which SQL statements run most often or take the most time. Collects execution count, execution time, and rows for each statement.

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

The name of an advanced monitoring metric group. Advanced monitoring collects detailed, query-level database metrics to help you analyze and resolve performance issues. You choose which metric groups to collect for each cluster.

The following metric groups are available:

STATEMENT_STATISTICS

Shows which SQL statements run most often or take the most time. Collects execution count, execution time, and rows for each statement.

" } }, "com.amazonaws.dsql#MetricGroupRequest": { "type": "structure", "members": { "metricGroup": { "target": "com.amazonaws.dsql#MetricGroup", "traits": { "smithy.api#documentation": "

The name of the metric group to enable.

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

A metric group to enable for advanced monitoring.

" } }, "com.amazonaws.dsql#MetricGroupRequestList": { "type": "list", "member": { "target": "com.amazonaws.dsql#MetricGroupRequest" }, "traits": { "smithy.api#documentation": "

A list of metric groups to enable for advanced monitoring. Each metric group can appear only once.

", "smithy.api#length": { "max": 20 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.dsql#MetricGroupResponse": { "type": "structure", "members": { "metricGroup": { "target": "com.amazonaws.dsql#MetricGroup", "traits": { "smithy.api#documentation": "

The name of the metric group that you enabled.

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

A metric group that you enabled for advanced monitoring on a cluster.

" } }, "com.amazonaws.dsql#MetricGroupResponseList": { "type": "list", "member": { "target": "com.amazonaws.dsql#MetricGroupResponse" }, "traits": { "smithy.api#documentation": "

A list of metric groups that you enabled for advanced monitoring on a cluster.

", "smithy.api#length": { "max": 20 } } }, "com.amazonaws.dsql#MultiRegionProperties": { "type": "structure", "members": { "witnessRegion": { "target": "com.amazonaws.dsql#Region", "traits": { "smithy.api#documentation": "

The Region that serves as the witness region for a multi-Region cluster. The witness Region helps maintain cluster consistency and quorum.

" } }, "clusters": { "target": "com.amazonaws.dsql#ClusterArnList", "traits": { "smithy.api#documentation": "

The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.

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

Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.

" } }, "com.amazonaws.dsql#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "

Token used to retrieve next page.

" } }, "com.amazonaws.dsql#PolicyDocument": { "type": "string", "traits": { "smithy.api#documentation": "

A resource-based policy document in JSON format. Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).

", "smithy.api#length": { "min": 1, "max": 20480 } } }, "com.amazonaws.dsql#PolicyVersion": { "type": "string" }, "com.amazonaws.dsql#PutClusterPolicy": { "type": "operation", "input": { "target": "com.amazonaws.dsql#PutClusterPolicyInput" }, "output": { "target": "com.amazonaws.dsql#PutClusterPolicyOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ConflictException" }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "smithy.api#documentation": "

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.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster/{identifier}/policy" }, "smithy.api#idempotent": {} } }, "com.amazonaws.dsql#PutClusterPolicyInput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.dsql#PolicyDocument", "traits": { "smithy.api#documentation": "

The resource-based policy document to attach to the cluster. This should be a valid JSON policy document that defines permissions and conditions.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } }, "bypassPolicyLockoutSafetyCheck": { "target": "com.amazonaws.dsql#BypassPolicyLockoutSafetyCheck", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

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.

", "smithy.api#notProperty": {} } }, "expectedPolicyVersion": { "target": "com.amazonaws.dsql#PolicyVersion", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#notProperty": {} } }, "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#PutClusterPolicyOutput": { "type": "structure", "members": { "policyVersion": { "target": "com.amazonaws.dsql#PolicyVersion", "traits": { "smithy.api#documentation": "

The version of the policy after it has been updated or created.

", "smithy.api#notProperty": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dsql#Region": { "type": "string", "traits": { "smithy.api#documentation": "

Region name.

", "smithy.api#length": { "max": 50 } } }, "com.amazonaws.dsql#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The resource ID could not be found.

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

The resource type could not be found.

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

The resource could not be found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.dsql#RoleArn": { "type": "string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role.

", "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role(/[a-zA-Z0-9+=,.@_-]+)+$" } }, "com.amazonaws.dsql#ServiceName": { "type": "string", "traits": { "smithy.api#documentation": "

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.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^com\\.amazonaws\\.[a-z0-9-]+\\.dsql[a-z0-9-]*$" } }, "com.amazonaws.dsql#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The service exception for exceeding a quota.

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

The resource ID exceeds a quota.

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

The resource type exceeds a quota.

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

The request exceeds a service quota.

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

The service exceeds a quota.

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

The service limit was exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.dsql#StatusReason": { "type": "structure", "members": { "error": { "target": "com.amazonaws.dsql#StreamFailureErrorCode", "traits": { "smithy.api#documentation": "

The error code for the stream failure.

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

The timestamp when the status was updated.

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

Stream status reason with error and timestamp.

" } }, "com.amazonaws.dsql#Stream": { "type": "resource", "identifiers": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId" }, "streamIdentifier": { "target": "com.amazonaws.dsql#StreamId" } }, "properties": { "arn": { "target": "com.amazonaws.dsql#StreamArn" }, "status": { "target": "com.amazonaws.dsql#StreamStatus" }, "creationTime": { "target": "com.amazonaws.dsql#StreamCreationTime" }, "targetDefinition": { "target": "com.amazonaws.dsql#TargetDefinition" }, "ordering": { "target": "com.amazonaws.dsql#StreamOrdering" }, "format": { "target": "com.amazonaws.dsql#StreamFormat" } }, "create": { "target": "com.amazonaws.dsql#CreateStream" }, "read": { "target": "com.amazonaws.dsql#GetStream" }, "delete": { "target": "com.amazonaws.dsql#DeleteStream" }, "list": { "target": "com.amazonaws.dsql#ListStreams" }, "traits": { "aws.api#arn": { "template": "cluster/{clusterIdentifier}/stream/{streamIdentifier}" }, "smithy.api#documentation": "

This is an interface reference for Amazon Aurora DSQL Streams. It contains documentation for the programming and command line interfaces you can use to manage change data capture (CDC) streams in Amazon Aurora DSQL.

Amazon Aurora DSQL Streams enables you to capture and stream database changes to downstream targets such as Amazon Kinesis Data Streams. This allows you to build real-time data pipelines, maintain data synchronization, and implement event-driven architectures based on database changes.

" } }, "com.amazonaws.dsql#StreamArn": { "type": "string", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the stream.

", "smithy.api#pattern": "^arn:aws(-[^:]+)?:dsql:[a-z0-9-]{1,20}:[0-9]{12}:cluster/[a-z0-9]{26}/stream/[a-z0-9]{26}$" } }, "com.amazonaws.dsql#StreamCreationTime": { "type": "timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the stream was created.

" } }, "com.amazonaws.dsql#StreamFailureErrorCode": { "type": "enum", "members": { "KINESIS_THROUGHPUT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KINESIS_THROUGHPUT_EXCEEDED" } }, "KINESIS_STREAM_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KINESIS_STREAM_NOT_FOUND" } }, "ROLE_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROLE_ACCESS_DENIED" } }, "KINESIS_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KINESIS_ACCESS_DENIED" } }, "KINESIS_KMS_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KINESIS_KMS_ACCESS_DENIED" } }, "KINESIS_OVERSIZE_RECORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KINESIS_OVERSIZE_RECORD" } }, "CLUSTER_CMK_INACCESSIBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLUSTER_CMK_INACCESSIBLE" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_ERROR" } } }, "traits": { "smithy.api#documentation": "

Error codes for stream failures.

KINESIS_THROUGHPUT_EXCEEDED

The Kinesis stream throughput limit was exceeded.

KINESIS_STREAM_NOT_FOUND

The specified Kinesis stream was not found.

ROLE_ACCESS_DENIED

Access was denied for the specified IAM role.

KINESIS_ACCESS_DENIED

Access to the Kinesis stream was denied.

KINESIS_KMS_ACCESS_DENIED

Access to the KMS key for the Kinesis stream was denied.

KINESIS_OVERSIZE_RECORD

A record exceeded the Kinesis stream size limit.

CLUSTER_CMK_INACCESSIBLE

The cluster's customer-managed key is inaccessible.

INTERNAL_ERROR

An internal error occurred.

" } }, "com.amazonaws.dsql#StreamFormat": { "type": "enum", "members": { "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } } }, "traits": { "smithy.api#documentation": "

Stream record format.

JSON

Stream records are formatted as JSON.

" } }, "com.amazonaws.dsql#StreamId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID of the stream.

", "smithy.api#pattern": "^[a-z0-9]{26}$" } }, "com.amazonaws.dsql#StreamList": { "type": "list", "member": { "target": "com.amazonaws.dsql#StreamSummary" }, "traits": { "smithy.api#documentation": "

A list of stream summaries.

", "smithy.api#uniqueItems": {} } }, "com.amazonaws.dsql#StreamOrdering": { "type": "enum", "members": { "UNORDERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNORDERED" } } }, "traits": { "smithy.api#documentation": "

Stream ordering mode.

UNORDERED

Changes are streamed without ordering guarantees.

" } }, "com.amazonaws.dsql#StreamStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPAIRED" } } }, "traits": { "smithy.api#documentation": "

The current status of a stream.

CREATING

The stream is being created.

ACTIVE

The stream is active and processing changes.

DELETING

The stream is being deleted.

DELETED

The stream has been deleted.

FAILED

The stream has failed.

IMPAIRED

The stream is impaired and may not be processing changes correctly.

" } }, "com.amazonaws.dsql#StreamSummary": { "type": "structure", "members": { "clusterIdentifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster.

", "smithy.api#required": {} } }, "streamIdentifier": { "target": "com.amazonaws.dsql#StreamId", "traits": { "smithy.api#documentation": "

The ID of the stream.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#StreamArn", "traits": { "smithy.api#documentation": "

The ARN of the stream.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#StreamCreationTime", "traits": { "smithy.api#documentation": "

The timestamp when the stream was created.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#StreamStatus", "traits": { "smithy.api#documentation": "

The current status of the stream.

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

Summary information about a stream.

" } }, "com.amazonaws.dsql#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "

Unique tag key, maximum 128 Unicode characters in UTF-8.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_.:/=+\\-@ ]*$" } }, "com.amazonaws.dsql#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.dsql#TagKey" }, "traits": { "smithy.api#documentation": "

List of tag keys.

", "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.dsql#TagMap": { "type": "map", "key": { "target": "com.amazonaws.dsql#TagKey" }, "value": { "target": "com.amazonaws.dsql#TagValue" }, "traits": { "smithy.api#documentation": "

Map of tags.

", "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.dsql#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.dsql#TagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" }, { "target": "com.amazonaws.dsql#ServiceQuotaExceededException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to add tags to an ARN." }, "smithy.api#documentation": "

Tags a resource with a map of key and value pairs.

", "smithy.api#examples": [ { "title": "Tag Resource", "input": { "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e", "tags": { "MyKey": "MyValue" } } } ], "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST" }, "smithy.api#idempotent": {} } }, "com.amazonaws.dsql#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.dsql#Arn", "traits": { "smithy.api#documentation": "

The ARN of the resource that you want to tag.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.dsql#TagMap", "traits": { "smithy.api#documentation": "

A map of key and value pairs to use to tag your resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#TagValue": { "type": "string", "traits": { "smithy.api#documentation": "

Tag value, maximum 256 Unicode characters in UTF-8.

", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9_.:/=+\\-@ ]*$" } }, "com.amazonaws.dsql#TargetDefinition": { "type": "union", "members": { "kinesis": { "target": "com.amazonaws.dsql#KinesisTargetDefinition", "traits": { "smithy.api#documentation": "

Kinesis stream target configuration.

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

Target definition for stream destination.

" } }, "com.amazonaws.dsql#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The message that the request was denied due to request throttling.

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

The request exceeds a service quota.

" } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The request exceeds a request rate quota.

" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The request exceeds a request rate quota. Retry after seconds.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

The request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.dsql#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.dsql#UntagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.dsql#ResourceNotFoundException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to remove tags from an ARN." }, "smithy.api#documentation": "

Removes a tag from a resource.

", "smithy.api#examples": [ { "title": "Untag Resource", "input": { "resourceArn": "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e", "tagKeys": [ "MyKeyA", "MyKeyB" ] } } ], "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.dsql#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.dsql#Arn", "traits": { "smithy.api#documentation": "

The ARN of the resource from which to remove tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.dsql#TagKeyList", "traits": { "smithy.api#documentation": "

The array of keys of the tags that you want to remove.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#UpdateCluster": { "type": "operation", "input": { "target": "com.amazonaws.dsql#UpdateClusterInput" }, "output": { "target": "com.amazonaws.dsql#UpdateClusterOutput" }, "errors": [ { "target": "com.amazonaws.dsql#ConflictException" }, { "target": "com.amazonaws.dsql#ResourceNotFoundException" }, { "target": "com.amazonaws.dsql#ValidationException" } ], "traits": { "aws.iam#iamAction": { "documentation": "Grants permission to modify the deletion protection status of a given cluster." }, "smithy.api#documentation": "

The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.

Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.

Required permissions

dsql:UpdateCluster

Permission to update a DSQL cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:GetCluster

Permission to retrieve cluster information.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:AddPeerCluster

Permission to add peer clusters.

Resources:

dsql:RemovePeerCluster

Permission to remove peer clusters. When you list peer clusters in multiRegionProperties.clusters, you need this permission for each current peer cluster that your list omits.

Resources:

dsql:PutWitnessRegion

Permission to set a witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

Condition Keys: dsql:WitnessRegion (matching the specified witness Region)

This permission is checked both in the cluster Region and in the witness Region.

", "smithy.api#examples": [ { "title": "Update Cluster", "input": { "identifier": "kiqenqglxyl2snyvkvnj2c3s2e", "deletionProtectionEnabled": false } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster/{identifier}" } } }, "com.amazonaws.dsql#UpdateClusterInput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "deletionProtectionEnabled": { "target": "com.amazonaws.dsql#DeletionProtectionEnabled", "traits": { "smithy.api#documentation": "

Specifies whether to enable deletion protection in your cluster.

" } }, "kmsEncryptionKey": { "target": "com.amazonaws.dsql#KmsEncryptionKey", "traits": { "smithy.api#documentation": "

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.

To switch to the key owned by Amazon Web Services, specify the reserved value AWS_OWNED_KMS_KEY.

", "smithy.api#notProperty": {} } }, "clientToken": { "target": "com.amazonaws.dsql#ClientToken", "traits": { "smithy.api#documentation": "

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.

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

", "smithy.api#idempotencyToken": {} } }, "multiRegionProperties": { "target": "com.amazonaws.dsql#MultiRegionProperties", "traits": { "smithy.api#documentation": "

The new multi-Region cluster configuration settings to be applied during an update operation.

", "smithy.api#notProperty": {} } }, "metricGroups": { "target": "com.amazonaws.dsql#MetricGroupRequestList", "traits": { "smithy.api#documentation": "

The complete set of metric groups to enable for advanced monitoring on the cluster. This list replaces the current set, so any metric group that you don't include is disabled. To disable all metric groups, specify an empty list ([]). If you omit this parameter, the current setting doesn't change.

To view the metric groups enabled on a cluster, use GetCluster.

", "smithy.api#notProperty": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dsql#UpdateClusterOutput": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.dsql#ClusterId", "traits": { "smithy.api#documentation": "

The ID of the cluster to update.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.dsql#ClusterArn", "traits": { "smithy.api#documentation": "

The ARN of the updated cluster.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.dsql#ClusterStatus", "traits": { "smithy.api#documentation": "

The status of the updated cluster.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.dsql#ClusterCreationTime", "traits": { "smithy.api#documentation": "

The time of when the cluster was created.

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

The details of the cluster after it has been updated.

", "smithy.api#output": {} } }, "com.amazonaws.dsql#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.dsql#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

The reason for the validation exception.

", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.dsql#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

A list of fields that didn't validate.

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

The input failed to satisfy the constraints specified by an Amazon Web Services service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.dsql#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the field.

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

A message describing why this field failed validation.

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

Stores information about a field passed inside a request that resulted in an validation error.

" } }, "com.amazonaws.dsql#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.dsql#ValidationExceptionField" }, "traits": { "smithy.api#documentation": "

A list of fields that didn't validate.

" } }, "com.amazonaws.dsql#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "unknownOperation" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cannotParse" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "fieldValidationFailed" } }, "DELETION_PROTECTION_ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "deletionProtectionEnabled" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "other" } } }, "traits": { "smithy.api#documentation": "

The reason for the validation exception.

" } } } }