AWS API Changes

2024/12/03 - Amazon Aurora DSQL - 10 new api methods

Changes Add new API operations for Amazon Aurora DSQL. Amazon Aurora DSQL is a serverless, distributed SQL database with virtually unlimited scale, highest availability, and zero infrastructure management.

GetCluster (new)

Link ¶

Retrieves information about a cluster.

See also: AWS API Documentation

Request Syntax

client.get_cluster(
    identifier='string'
)

type identifier:

string

param identifier:

[REQUIRED]

The ID of the cluster to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False,
    'witnessRegion': 'string',
    'linkedClusterArns': [
        'string',
    ]
}

Response Structure

(dict) --

Output Mixin
- identifier (string) --
  
  The ID of the retrieved cluster.
- arn (string) --
  
  The ARN of the retrieved cluster.
- status (string) --
  
  The status of the retrieved cluster.
- creationTime (datetime) --
  
  The time of when the cluster was created.
- deletionProtectionEnabled (boolean) --
  
  Whether deletion protection is enabled in this cluster.
- witnessRegion (string) --
  
  The witness Region of the cluster. Applicable only for multi-Region clusters.
- linkedClusterArns (list) --
  
  The ARNs of the clusters linked to the retrieved cluster.
  - (string) --
    
    Cluster ARN

CreateCluster (new)

Link ¶

Creates a cluster in Amazon Aurora DSQL.

See also: AWS API Documentation

Request Syntax

client.create_cluster(
    deletionProtectionEnabled=True|False,
    tags={
        'string': 'string'
    },
    clientToken='string'
)

type deletionProtectionEnabled:

boolean

param deletionProtectionEnabled:

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

type tags:

dict

param tags:

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

(string) --

Unique tag key, maximum 128 Unicode characters in UTF-8
- (string) --
  
  Tag value, maximum 256 Unicode characters in UTF-8

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False
}

Response Structure

(dict) --

Output Mixin
- identifier (string) --
  
  The ID of the created cluster.
- arn (string) --
  
  The ARN of the created cluster.
- status (string) --
  
  The status of the created cluster.
- creationTime (datetime) --
  
  The time of when created the cluster.
- deletionProtectionEnabled (boolean) --
  
  Whether deletion protection is enabled on this cluster.

UntagResource (new)

Link ¶

Removes a tag from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource from which to remove tags.

type tagKeys:

list

param tagKeys:

[REQUIRED]

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

(string) --

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

returns:

None

ListTagsForResource (new)

Link ¶

Lists all of the tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  A map of key and value pairs that you used to tag your resource.
  - (string) --
    
    Unique tag key, maximum 128 Unicode characters in UTF-8
    - (string) --
      
      Tag value, maximum 256 Unicode characters in UTF-8

DeleteMultiRegionClusters (new)

Link ¶

Deletes a multi-Region cluster in Amazon Aurora DSQL.

See also: AWS API Documentation

Request Syntax

client.delete_multi_region_clusters(
    linkedClusterArns=[
        'string',
    ],
    clientToken='string'
)

type linkedClusterArns:

list

param linkedClusterArns:

[REQUIRED]

The ARNs of the clusters linked to the cluster you want to delete. also deletes these clusters as part of the operation.

(string) --

Cluster ARN

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

returns:

None

UpdateCluster (new)

Link ¶

Updates a cluster.

See also: AWS API Documentation

Request Syntax

client.update_cluster(
    identifier='string',
    deletionProtectionEnabled=True|False,
    clientToken='string'
)

type identifier:

string

param identifier:

[REQUIRED]

The ID of the cluster you want to update.

type deletionProtectionEnabled:

boolean

param deletionProtectionEnabled:

Specifies whether to enable deletion protection in your cluster.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False,
    'witnessRegion': 'string',
    'linkedClusterArns': [
        'string',
    ]
}

Response Structure

(dict) --

Output Mixin
- identifier (string) --
  
  The ID of the cluster to update.
- arn (string) --
  
  The ARN of the updated cluster.
- status (string) --
  
  The status of the updated cluster.
- creationTime (datetime) --
  
  The time of when the cluster was created.
- deletionProtectionEnabled (boolean) --
  
  Whether deletion protection is enabled for the updated cluster.
- witnessRegion (string) --
  
  The Region that receives all data you write to linked clusters.
- linkedClusterArns (list) --
  
  The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region clusters.
  - (string) --
    
    Cluster ARN

TagResource (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource that you want to tag.

type tags:

dict

param tags:

[REQUIRED]

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

(string) --

Unique tag key, maximum 128 Unicode characters in UTF-8
- (string) --
  
  Tag value, maximum 256 Unicode characters in UTF-8

returns:

None

ListClusters (new)

Link ¶

Retrieves information about a list of clusters.

See also: AWS API Documentation

Request Syntax

client.list_clusters(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'clusters': [
        {
            'identifier': 'string',
            'arn': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (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.
- clusters (list) --
  
  An array of the returned clusters.
  - (dict) --
    
    A summary of the properties of a cluster.
    - identifier (string) --
      
      The ID of the cluster.
    - arn (string) --
      
      The ARN of the cluster.

CreateMultiRegionClusters (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.create_multi_region_clusters(
    linkedRegionList=[
        'string',
    ],
    clusterProperties={
        'string': {
            'deletionProtectionEnabled': True|False,
            'tags': {
                'string': 'string'
            }
        }
    },
    witnessRegion='string',
    clientToken='string'
)

type linkedRegionList:

list

param linkedRegionList:

[REQUIRED]

An array of the Regions in which you want to create additional clusters.

(string) --

AWS Region name (e.g.: 'us-east-1')

type clusterProperties:

dict

param clusterProperties:

A mapping of properties to use when creating linked clusters.

(string) --

AWS Region name (e.g.: 'us-east-1')
- (dict) --
  
  Properties of linked clusters.
  - deletionProtectionEnabled (boolean) --
    
    Whether deletion protection is enabled.
  - tags (dict) --
    
    A map of key and value pairs the linked cluster is tagged with.
    - (string) --
      
      Unique tag key, maximum 128 Unicode characters in UTF-8
      - (string) --
        
        Tag value, maximum 256 Unicode characters in UTF-8

type witnessRegion:

string

param witnessRegion:

[REQUIRED]

The witness Region of multi-Region clusters.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'linkedClusterArns': [
        'string',
    ]
}

Response Structure

(dict) --
- linkedClusterArns (list) --
  
  An array that contains the ARNs of all linked clusters.
  - (string) --
    
    Cluster ARN

DeleteCluster (new)

Link ¶

Deletes a cluster in Amazon Aurora DSQL.

See also: AWS API Documentation

Request Syntax

client.delete_cluster(
    identifier='string',
    clientToken='string'
)

type identifier:

string

param identifier:

[REQUIRED]

The ID of the cluster to delete.

type clientToken:

string

param clientToken:

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.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False
}

Response Structure

(dict) --

Output Mixin
- identifier (string) --
  
  The ID of the deleted cluster.
- arn (string) --
  
  The ARN of the deleted cluster.
- status (string) --
  
  The status of the cluster.
- creationTime (datetime) --
  
  The time of when the cluster was created.
- deletionProtectionEnabled (boolean) --
  
  Specifies whether deletion protection was enabled on the cluster.