Creates a cluster in Amazon Aurora DSQL.
" }, "CreateMultiRegionClusters":{ "name":"CreateMultiRegionClusters", "http":{ "method":"POST", "requestUri":"/multi-region-clusters", "responseCode":200 }, "input":{"shape":"CreateMultiRegionClustersInput"}, "output":{"shape":"CreateMultiRegionClustersOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], "documentation":"Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.
" }, "DeleteCluster":{ "name":"DeleteCluster", "http":{ "method":"DELETE", "requestUri":"/cluster/{identifier}", "responseCode":200 }, "input":{"shape":"DeleteClusterInput"}, "output":{"shape":"DeleteClusterOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"Deletes a cluster in Amazon Aurora DSQL.
", "idempotent":true }, "DeleteMultiRegionClusters":{ "name":"DeleteMultiRegionClusters", "http":{ "method":"DELETE", "requestUri":"/multi-region-clusters", "responseCode":200 }, "input":{"shape":"DeleteMultiRegionClustersInput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"Deletes a multi-Region cluster in Amazon Aurora DSQL.
", "idempotent":true }, "GetCluster":{ "name":"GetCluster", "http":{ "method":"GET", "requestUri":"/cluster/{identifier}", "responseCode":200 }, "input":{"shape":"GetClusterInput"}, "output":{"shape":"GetClusterOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves information about a cluster.
" }, "ListClusters":{ "name":"ListClusters", "http":{ "method":"GET", "requestUri":"/cluster", "responseCode":200 }, "input":{"shape":"ListClustersInput"}, "output":{"shape":"ListClustersOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Retrieves information about a list of clusters.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Lists all of the tags for a resource.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceInput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Tags a resource with a map of key and value pairs.
", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceInput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Removes a tag from a resource.
", "idempotent":true }, "UpdateCluster":{ "name":"UpdateCluster", "http":{ "method":"POST", "requestUri":"/cluster/{identifier}", "responseCode":200 }, "input":{"shape":"UpdateClusterInput"}, "output":{"shape":"UpdateClusterOutput"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"Updates a cluster.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "Arn":{ "type":"string", "documentation":"Amazon Resource Name
", "max":1011, "min":1, "pattern":"arn:.+" }, "ClientToken":{ "type":"string", "documentation":"Idempotency Token
", "max":128, "min":1, "pattern":"[!-~]+" }, "ClusterArn":{ "type":"string", "documentation":"Cluster ARN
" }, "ClusterArnList":{ "type":"list", "member":{"shape":"ClusterArn"}, "documentation":"List of cluster arns
" }, "ClusterCreationTime":{ "type":"timestamp", "documentation":"Timestamp when the Cluster was created
" }, "ClusterId":{ "type":"string", "documentation":"The ID of the cluster
" }, "ClusterList":{ "type":"list", "member":{"shape":"ClusterSummary"}, "documentation":"List of clusters
" }, "ClusterPropertyMap":{ "type":"map", "key":{"shape":"Region"}, "value":{"shape":"LinkedClusterProperties"}, "documentation":"Properties for each linked cluster
" }, "ClusterStatus":{ "type":"string", "documentation":"Cluster Status
", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED" ] }, "ClusterSummary":{ "type":"structure", "required":[ "identifier", "arn" ], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the cluster.
" }, "arn":{ "shape":"ClusterArn", "documentation":"The ARN of the cluster.
" } }, "documentation":"A summary of the properties of a cluster.
" }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"Resource Id
" }, "resourceType":{ "shape":"String", "documentation":"Resource Type
" } }, "documentation":"The submitted action has conflicts.
", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CreateClusterInput":{ "type":"structure", "members":{ "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.
" }, "tags":{ "shape":"TagMap", "documentation":"A map of key and value pairs to use to tag your cluster.
" }, "clientToken":{ "shape":"ClientToken", "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.
", "idempotencyToken":true } } }, "CreateClusterOutput":{ "type":"structure", "required":[ "identifier", "arn", "status", "creationTime", "deletionProtectionEnabled" ], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the created cluster.
" }, "arn":{ "shape":"ClusterArn", "documentation":"The ARN of the created cluster.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The status of the created cluster.
" }, "creationTime":{ "shape":"ClusterCreationTime", "documentation":"The time of when created the cluster.
" }, "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"Whether deletion protection is enabled on this cluster.
" } }, "documentation":"Output Mixin
" }, "CreateMultiRegionClustersInput":{ "type":"structure", "required":[ "linkedRegionList", "witnessRegion" ], "members":{ "linkedRegionList":{ "shape":"RegionList", "documentation":"An array of the Regions in which you want to create additional clusters.
" }, "clusterProperties":{ "shape":"ClusterPropertyMap", "documentation":"A mapping of properties to use when creating linked clusters.
" }, "witnessRegion":{ "shape":"Region", "documentation":"The witness Region of multi-Region clusters.
" }, "clientToken":{ "shape":"ClientToken", "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.
", "idempotencyToken":true } } }, "CreateMultiRegionClustersOutput":{ "type":"structure", "required":["linkedClusterArns"], "members":{ "linkedClusterArns":{ "shape":"ClusterArnList", "documentation":"An array that contains the ARNs of all linked clusters.
" } } }, "DeleteClusterInput":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the cluster to delete.
", "location":"uri", "locationName":"identifier" }, "clientToken":{ "shape":"ClientToken", "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.
", "idempotencyToken":true, "location":"querystring", "locationName":"client-token" } } }, "DeleteClusterOutput":{ "type":"structure", "required":[ "identifier", "arn", "status", "creationTime", "deletionProtectionEnabled" ], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the deleted cluster.
" }, "arn":{ "shape":"ClusterArn", "documentation":"The ARN of the deleted cluster.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The status of the cluster.
" }, "creationTime":{ "shape":"ClusterCreationTime", "documentation":"The time of when the cluster was created.
" }, "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"Specifies whether deletion protection was enabled on the cluster.
" } }, "documentation":"Output Mixin
" }, "DeleteMultiRegionClustersInput":{ "type":"structure", "required":["linkedClusterArns"], "members":{ "linkedClusterArns":{ "shape":"ClusterArnList", "documentation":"The ARNs of the clusters linked to the cluster you want to delete. also deletes these clusters as part of the operation.
", "location":"querystring", "locationName":"linked-cluster-arns" }, "clientToken":{ "shape":"ClientToken", "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.
", "idempotencyToken":true, "location":"querystring", "locationName":"client-token" } } }, "DeletionProtectionEnabled":{ "type":"boolean", "documentation":"Deletion Protection
", "box":true }, "GetClusterInput":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the cluster to retrieve.
", "location":"uri", "locationName":"identifier" } } }, "GetClusterOutput":{ "type":"structure", "required":[ "identifier", "arn", "status", "creationTime", "deletionProtectionEnabled" ], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the retrieved cluster.
" }, "arn":{ "shape":"ClusterArn", "documentation":"The ARN of the retrieved cluster.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The status of the retrieved cluster.
" }, "creationTime":{ "shape":"ClusterCreationTime", "documentation":"The time of when the cluster was created.
" }, "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"Whether deletion protection is enabled in this cluster.
" }, "witnessRegion":{ "shape":"Region", "documentation":"The witness Region of the cluster. Applicable only for multi-Region clusters.
" }, "linkedClusterArns":{ "shape":"ClusterArnList", "documentation":"The ARNs of the clusters linked to the retrieved cluster.
" } }, "documentation":"Output Mixin
" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "retryAfterSeconds":{ "shape":"Integer", "documentation":"Retry after seconds.
", "location":"header", "locationName":"Retry-After" } }, "documentation":"The request processing has failed because of an unknown error, exception or failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "LinkedClusterProperties":{ "type":"structure", "members":{ "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"Whether deletion protection is enabled.
" }, "tags":{ "shape":"TagMap", "documentation":"A map of key and value pairs the linked cluster is tagged with.
" } }, "documentation":"Properties of linked clusters.
" }, "ListClustersInput":{ "type":"structure", "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
", "location":"querystring", "locationName":"max-results" }, "nextToken":{ "shape":"NextToken", "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.
", "location":"querystring", "locationName":"next-token" } } }, "ListClustersOutput":{ "type":"structure", "required":["clusters"], "members":{ "nextToken":{ "shape":"NextToken", "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":{ "shape":"ClusterList", "documentation":"An array of the returned clusters.
" } } }, "ListTagsForResourceInput":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The ARN of the resource for which you want to list the tags.
", "location":"uri", "locationName":"resourceArn" } } }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"A map of key and value pairs that you used to tag your resource.
" } } }, "MaxResults":{ "type":"integer", "documentation":"Max results that will be returned per page
", "box":true, "max":100, "min":1 }, "NextToken":{ "type":"string", "documentation":"Opaque token used to retrieve next page
" }, "Region":{ "type":"string", "documentation":"AWS Region name (e.g.: 'us-east-1')
", "max":20, "min":0 }, "RegionList":{ "type":"list", "member":{"shape":"Region"}, "documentation":"List of regions
" }, "ResourceNotFoundException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType" ], "members":{ "message":{"shape":"String"}, "resourceId":{ "shape":"String", "documentation":"Hypothetical identifier of the resource which does not exist
" }, "resourceType":{ "shape":"String", "documentation":"Hypothetical type of the resource which does not exist
" } }, "documentation":"The resource could not be found.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "message", "resourceId", "resourceType", "serviceCode", "quotaCode" ], "members":{ "message":{ "shape":"String", "documentation":"Description of the error
" }, "resourceId":{ "shape":"String", "documentation":"Identifier of the resource affected
" }, "resourceType":{ "shape":"String", "documentation":"Type of the resource affected
" }, "serviceCode":{ "shape":"String", "documentation":"Service Quotas requirement to identify originating service
" }, "quotaCode":{ "shape":"String", "documentation":"Service Quotas requirement to identify originating quota
" } }, "documentation":"The service limit was exceeded.
", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "String":{"type":"string"}, "TagKey":{ "type":"string", "documentation":"Unique tag key, maximum 128 Unicode characters in UTF-8
", "max":128, "min":1, "pattern":"[a-zA-Z0-9_.:/=+\\-@ ]*" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "documentation":"List of tag keys
", "max":200, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "documentation":"Map of tags
", "max":200, "min":0 }, "TagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The ARN of the resource that you want to tag.
", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"A map of key and value pairs to use to tag your resource.
" } } }, "TagValue":{ "type":"string", "documentation":"Tag value, maximum 256 Unicode characters in UTF-8
", "max":256, "min":0, "pattern":"[a-zA-Z0-9_.:/=+\\-@ ]*" }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"Description of the error
" }, "serviceCode":{ "shape":"String", "documentation":"Service Quotas requirement to identify originating service
" }, "quotaCode":{ "shape":"String", "documentation":"Service Quotas requirement to identify originating quota
" }, "retryAfterSeconds":{ "shape":"Integer", "documentation":"Advice to clients on when the call can be safely retried
", "location":"header", "locationName":"Retry-After" } }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":true} }, "UntagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The ARN of the resource from which to remove tags.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"The array of keys of the tags that you want to remove.
", "location":"querystring", "locationName":"tagKeys" } } }, "UpdateClusterInput":{ "type":"structure", "required":["identifier"], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the cluster you want to update.
", "location":"uri", "locationName":"identifier" }, "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"Specifies whether to enable deletion protection in your cluster.
" }, "clientToken":{ "shape":"ClientToken", "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.
", "idempotencyToken":true } } }, "UpdateClusterOutput":{ "type":"structure", "required":[ "identifier", "arn", "status", "creationTime", "deletionProtectionEnabled" ], "members":{ "identifier":{ "shape":"ClusterId", "documentation":"The ID of the cluster to update.
" }, "arn":{ "shape":"ClusterArn", "documentation":"The ARN of the updated cluster.
" }, "status":{ "shape":"ClusterStatus", "documentation":"The status of the updated cluster.
" }, "creationTime":{ "shape":"ClusterCreationTime", "documentation":"The time of when the cluster was created.
" }, "deletionProtectionEnabled":{ "shape":"DeletionProtectionEnabled", "documentation":"Whether deletion protection is enabled for the updated cluster.
" }, "witnessRegion":{ "shape":"Region", "documentation":"The Region that receives all data you write to linked clusters.
" }, "linkedClusterArns":{ "shape":"ClusterArnList", "documentation":"The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region clusters.
" } }, "documentation":"Output Mixin
" }, "ValidationException":{ "type":"structure", "required":[ "message", "reason" ], "members":{ "message":{"shape":"String"}, "reason":{"shape":"ValidationExceptionReason"}, "fieldList":{"shape":"ValidationExceptionFieldList"} }, "documentation":"The input failed to satisfy the constraints specified by an Amazon Web Services service.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"String", "documentation":"The name of the field.
" }, "message":{ "shape":"String", "documentation":"A message describing why this field failed validation.
" } }, "documentation":"Stores information about a field passed inside a request that resulted in an validation error.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"}, "documentation":"List of fields that caused the error
" }, "ValidationExceptionReason":{ "type":"string", "documentation":"Reason the request failed validation
", "enum":[ "unknownOperation", "cannotParse", "fieldValidationFailed", "deletionProtectionEnabled", "other" ] } }, "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. Aurora DSQL 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. Aurora DSQL lets you focus on using your data to acquire new insights for your business and customers.
" }