AWS SDK for PHP 3.x

Service ID: dsql

Version: 2018-05-10

This page describes the parameters and results for the operations of the Amazon Aurora DSQL (2018-05-10), and shows how to use the Aws\DSQL\DSQLClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateCluster ( array $params = [] ): The CreateCluster API allows you to create both single-region clusters and multi-Region clusters.
DeleteCluster ( array $params = [] ): Deletes a cluster in Amazon Aurora DSQL.
GetCluster ( array $params = [] ): Retrieves information about a cluster.
GetVpcEndpointServiceName ( array $params = [] ): Retrieves the VPC endpoint service name.
ListClusters ( array $params = [] ): Retrieves information about a list of clusters.
ListTagsForResource ( array $params = [] ): Lists all of the tags for a resource.
TagResource ( array $params = [] ): Tags a resource with a map of key and value pairs.
UntagResource ( array $params = [] ): Removes a tag from a resource.
UpdateCluster ( array $params = [] ): The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListClusters

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
ClusterActive	GetCluster	2	60
ClusterNotExists	GetCluster	2	60

Operations

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

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:

Local cluster: arn:aws:dsql:region:account-id:cluster/*
Each peer cluster: exact ARN of each specified peer cluster

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)

The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

Parameter Syntax

$result = $client->createCluster([
    'clientToken' => '<string>',
    'deletionProtectionEnabled' => true || false,
    'kmsEncryptionKey' => '<string>',
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

: Type: string

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.

deletionProtectionEnabled

: Type: boolean

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

kmsEncryptionKey

: Type: string

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.

multiRegionProperties

: Type: MultiRegionProperties structure

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

tags

: Type: Associative array of custom strings keys (TagKey) to strings

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

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'deletionProtectionEnabled' => true || false,
    'encryptionDetails' => [
        'encryptionStatus' => 'ENABLED|UPDATING|KMS_KEY_INACCESSIBLE|ENABLING',
        'encryptionType' => 'AWS_OWNED_KMS_KEY|CUSTOMER_MANAGED_KMS_KEY',
        'kmsKeyArn' => '<string>',
    ],
    'identifier' => '<string>',
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the created cluster.

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of when created the cluster.

deletionProtectionEnabled

: Required: Yes
: Type: boolean

Whether deletion protection is enabled on this cluster.

encryptionDetails

: Type: EncryptionDetails structure

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

identifier

: Required: Yes
: Type: string

The ID of the created cluster.

multiRegionProperties

: Type: MultiRegionProperties structure

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

status

: Required: Yes
: Type: string

The status of the created cluster.

Errors

ServiceQuotaExceededException:: The service limit was exceeded.
ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ConflictException:: The submitted action has conflicts.

Examples

Example 1: Create Cluster

$result = $client->createCluster([
    'deletionProtectionEnabled' => ,
    'tags' => [
        'MyKey' => 'MyValue',
    ],
]);

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Deletes a cluster in Amazon Aurora DSQL.

Parameter Syntax

$result = $client->deleteCluster([
    'clientToken' => '<string>',
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

: Type: string

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.

identifier

: Required: Yes
: Type: string

The ID of the cluster to delete.

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'identifier' => '<string>',
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the deleted cluster.

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of when the cluster was created.

identifier

: Required: Yes
: Type: string

The ID of the deleted cluster.

status

: Required: Yes
: Type: string

The status of the cluster.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.
ConflictException:: The submitted action has conflicts.

Examples

Example 1: Delete Cluster

$result = $client->deleteCluster([
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);

GetCluster

$result = $client->getCluster([/* ... */]);
$promise = $client->getClusterAsync([/* ... */]);

Retrieves information about a cluster.

Parameter Syntax

$result = $client->getCluster([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

identifier

: Required: Yes
: Type: string

The ID of the cluster to retrieve.

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'deletionProtectionEnabled' => true || false,
    'encryptionDetails' => [
        'encryptionStatus' => 'ENABLED|UPDATING|KMS_KEY_INACCESSIBLE|ENABLING',
        'encryptionType' => 'AWS_OWNED_KMS_KEY|CUSTOMER_MANAGED_KMS_KEY',
        'kmsKeyArn' => '<string>',
    ],
    'identifier' => '<string>',
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
    'tags' => ['<string>', ...],
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the retrieved cluster.

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of when the cluster was created.

deletionProtectionEnabled

: Required: Yes
: Type: boolean

Whether deletion protection is enabled in this cluster.

encryptionDetails

: Type: EncryptionDetails structure

The current encryption configuration details for the cluster.

identifier

: Required: Yes
: Type: string

The ID of the retrieved cluster.

multiRegionProperties

: Type: MultiRegionProperties structure

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

status

: Required: Yes
: Type: string

The status of the retrieved cluster.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Map of tags.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.

Examples

Example 1: Get Cluster

$result = $client->getCluster([
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);

GetVpcEndpointServiceName

$result = $client->getVpcEndpointServiceName([/* ... */]);
$promise = $client->getVpcEndpointServiceNameAsync([/* ... */]);

Retrieves the VPC endpoint service name.

Parameter Syntax

$result = $client->getVpcEndpointServiceName([
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

identifier

: Required: Yes
: Type: string

The ID of the cluster to retrieve.

Result Syntax

[
    'serviceName' => '<string>',
]

Result Details

Members

serviceName

: Required: Yes
: Type: string

The VPC endpoint service name.

Errors

ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.

Examples

Example 1: Get VPC Endpoint Service Name

$result = $client->getVpcEndpointServiceName([
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Retrieves information about a list of clusters.

Parameter Syntax

$result = $client->listClusters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

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

nextToken

: Type: string

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.

Result Syntax

[
    'clusters' => [
        [
            'arn' => '<string>',
            'identifier' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

clusters

: Required: Yes
: Type: Array of ClusterSummary structures

An array of the returned clusters.

nextToken

: Type: string

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.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.

Examples

Example 1: List Clusters

$result = $client->listClusters([
    'maxResults' => 20,
]);

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all of the tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Type: Associative array of custom strings keys (TagKey) to strings

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

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.

Examples

Example 1: List Tags For Resource

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e',
]);

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The ARN of the resource that you want to tag.

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:: The service limit was exceeded.
ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.

Examples

Example 1: Tag Resource

$result = $client->tagResource([
    'resourceArn' => 'arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e',
    'tags' => [
        'MyKey' => 'MyValue',
    ],
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The ARN of the resource from which to remove tags.

tagKeys

: Required: Yes
: Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.

Examples

Example 1: Untag Resource

$result = $client->untagResource([
    'resourceArn' => 'arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e',
    'tagKeys' => [
        'MyKeyA',
        'MyKeyB',
    ],
]);

UpdateCluster

$result = $client->updateCluster([/* ... */]);
$promise = $client->updateClusterAsync([/* ... */]);

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:

Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id
Each peer cluster: exact ARN of each specified peer cluster

dsql:RemovePeerCluster

Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

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

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.

The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.
When updating clusters with peer relationships, permissions are checked for both adding and removing peers.
The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Parameter Syntax

$result = $client->updateCluster([
    'clientToken' => '<string>',
    'deletionProtectionEnabled' => true || false,
    'identifier' => '<string>', // REQUIRED
    'kmsEncryptionKey' => '<string>',
    'multiRegionProperties' => [
        'clusters' => ['<string>', ...],
        'witnessRegion' => '<string>',
    ],
]);

Parameter Details

Members

clientToken

: Type: string

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.

deletionProtectionEnabled

: Type: boolean

Specifies whether to enable deletion protection in your cluster.

identifier

: Required: Yes
: Type: string

The ID of the cluster you want to update.

kmsEncryptionKey

: Type: string

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.

multiRegionProperties

: Type: MultiRegionProperties structure

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

Result Syntax

[
    'arn' => '<string>',
    'creationTime' => <DateTime>,
    'identifier' => '<string>',
    'status' => 'CREATING|ACTIVE|IDLE|INACTIVE|UPDATING|DELETING|DELETED|FAILED|PENDING_SETUP|PENDING_DELETE',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the updated cluster.

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time of when the cluster was created.

identifier

: Required: Yes
: Type: string

The ID of the cluster to update.

status

: Required: Yes
: Type: string

The status of the updated cluster.

Errors

ThrottlingException:: The request was denied due to request throttling.
ValidationException:: The input failed to satisfy the constraints specified by an Amazon Web Services service.
AccessDeniedException:: You do not have sufficient access to perform this action.
InternalServerException:: The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException:: The resource could not be found.
ConflictException:: The submitted action has conflicts.

Examples

Example 1: Update Cluster

$result = $client->updateCluster([
    'deletionProtectionEnabled' => ,
    'identifier' => 'kiqenqglxyl2snyvkvnj2c3s2e',
]);

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

message

: Required: Yes
: Type: string

ClusterSummary

Description

A summary of the properties of a cluster.

Members

arn

: Required: Yes
: Type: string

The ARN of the cluster.

identifier

: Required: Yes
: Type: string

The ID of the cluster.

ConflictException

Description

The submitted action has conflicts.

Members

message

: Required: Yes
: Type: string

resourceId

: Type: string

Resource Id

resourceType

: Type: string

Resource Type

EncryptionDetails

Description

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

Members

encryptionStatus

: Required: Yes
: Type: string

The status of encryption for the cluster.

encryptionType

: Required: Yes
: Type: string

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

kmsKeyArn

: Type: string

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

InternalServerException

Description

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

Members

message

: Required: Yes
: Type: string

retryAfterSeconds

: Type: int

Retry after seconds.

MultiRegionProperties

Description

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

Members

clusters

: Type: Array of strings

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

witnessRegion

: Type: string

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

ResourceNotFoundException

Description

The resource could not be found.

Members

message

: Required: Yes
: Type: string

resourceId

: Required: Yes
: Type: string

The resource ID could not be found.

resourceType

: Required: Yes
: Type: string

The resource type could not be found.

ServiceQuotaExceededException

Description

The service limit was exceeded.

Members

message

: Required: Yes
: Type: string

The service exception for exceeding a quota.

quotaCode

: Required: Yes
: Type: string

The service exceeds a quota.

resourceId

: Required: Yes
: Type: string

The resource ID exceeds a quota.

resourceType

: Required: Yes
: Type: string

The resource type exceeds a quota.

serviceCode

: Required: Yes
: Type: string

The request exceeds a service quota.

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

: Required: Yes
: Type: string

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

quotaCode

: Type: string

The request exceeds a request rate quota.

retryAfterSeconds

: Type: int

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

serviceCode

: Type: string

The request exceeds a service quota.

ValidationException

Description

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

Members

fieldList

: Type: Array of ValidationExceptionField structures

A list of fields that didn't validate.

message

: Required: Yes
: Type: string

reason

: Required: Yes
: Type: string

The reason for the validation exception.

ValidationExceptionField

Description

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

Members

message

: Required: Yes
: Type: string

A message describing why this field failed validation.

name

: Required: Yes
: Type: string

The name of the field.

Amazon Aurora DSQL 2018-05-10

Operation Summary

Paginators

Waiters

Operations

CreateCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: Create Cluster

DeleteCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: Delete Cluster

GetCluster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: Get Cluster

GetVpcEndpointServiceName

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: Get VPC Endpoint Service Name

ListClusters

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: List Clusters

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: List Tags For Resource

TagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: Tag Resource

UntagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details