AuroraDSQL ********** Client ====== class AuroraDSQL.Client A low-level client representing Amazon Aurora DSQL 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. import boto3 client = boto3.client('dsql') These are the available methods: * can_paginate * close * create_cluster * delete_cluster * generate_db_connect_admin_auth_token * generate_db_connect_auth_token * get_cluster * get_paginator * get_vpc_endpoint_service_name * get_waiter * list_clusters * list_tags_for_resource * tag_resource * untag_resource * update_cluster Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListClusters Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * ClusterActive * ClusterNotExists AuroraDSQL / Waiter / ClusterActive ClusterActive ************* class AuroraDSQL.Waiter.ClusterActive waiter = client.get_waiter('cluster_active') wait(**kwargs) Polls "AuroraDSQL.Client.get_cluster()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( identifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **identifier** (*string*) -- **[REQUIRED]** The ID of the cluster to retrieve. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None AuroraDSQL / Waiter / ClusterNotExists ClusterNotExists **************** class AuroraDSQL.Waiter.ClusterNotExists waiter = client.get_waiter('cluster_not_exists') wait(**kwargs) Polls "AuroraDSQL.Client.get_cluster()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( identifier='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **identifier** (*string*) -- **[REQUIRED]** The ID of the cluster to retrieve. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None AuroraDSQL / Paginator / ListClusters ListClusters ************ class AuroraDSQL.Paginator.ListClusters paginator = client.get_paginator('list_clusters') paginate(**kwargs) Creates an iterator that will paginate through responses from "AuroraDSQL.Client.list_clusters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'clusters': [ { 'identifier': 'string', 'arn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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. * **NextToken** *(string) --* A token to resume pagination. AuroraDSQL / Client / get_paginator get_paginator ************* AuroraDSQL.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. AuroraDSQL / Client / create_cluster create_cluster ************** AuroraDSQL.Client.create_cluster(**kwargs) 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. Note: 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) Warning: * The witness Region specified in "multiRegionProperties.witnessRegion" cannot be the same as the cluster's Region. See also: AWS API Documentation **Request Syntax** response = client.create_cluster( deletionProtectionEnabled=True|False, kmsEncryptionKey='string', tags={ 'string': 'string' }, clientToken='string', multiRegionProperties={ 'witnessRegion': 'string', 'clusters': [ 'string', ] } ) Parameters: * **deletionProtectionEnabled** (*boolean*) -- If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster. * **kmsEncryptionKey** (*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. * **tags** (*dict*) -- 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. * **clientToken** (*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. This field is autopopulated if not provided. * **multiRegionProperties** (*dict*) -- The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties. * **witnessRegion** *(string) --* The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum. * **clusters** *(list) --* The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region. * *(string) --* The Amazon Resource Name of the cluster. Return type: dict Returns: **Response Syntax** { 'identifier': 'string', 'arn': 'string', 'status': 'CREATING'|'ACTIVE'|'IDLE'|'INACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'PENDING_SETUP'|'PENDING_DELETE', 'creationTime': datetime(2015, 1, 1), 'multiRegionProperties': { 'witnessRegion': 'string', 'clusters': [ 'string', ] }, 'encryptionDetails': { 'encryptionType': 'AWS_OWNED_KMS_KEY'|'CUSTOMER_MANAGED_KMS_KEY', 'kmsKeyArn': 'string', 'encryptionStatus': 'ENABLED'|'UPDATING'|'KMS_KEY_INACCESSIBLE'|'ENABLING' }, 'deletionProtectionEnabled': True|False } **Response Structure** * *(dict) --* The output of a created cluster. * **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. * **multiRegionProperties** *(dict) --* The multi-Region cluster configuration details that were set during cluster creation * **witnessRegion** *(string) --* The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum. * **clusters** *(list) --* The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region. * *(string) --* The Amazon Resource Name of the cluster. * **encryptionDetails** *(dict) --* The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state. * **encryptionType** *(string) --* The type of encryption that protects the data on your cluster. * **kmsKeyArn** *(string) --* The ARN of the KMS key that encrypts data in the cluster. * **encryptionStatus** *(string) --* The status of encryption for the cluster. * **deletionProtectionEnabled** *(boolean) --* Whether deletion protection is enabled on this cluster. **Exceptions** * "AuroraDSQL.Client.exceptions.ServiceQuotaExceededException" * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ConflictException" AuroraDSQL / Client / delete_cluster delete_cluster ************** AuroraDSQL.Client.delete_cluster(**kwargs) Deletes a cluster in Amazon Aurora DSQL. See also: AWS API Documentation **Request Syntax** response = client.delete_cluster( identifier='string', clientToken='string' ) Parameters: * **identifier** (*string*) -- **[REQUIRED]** The ID of the cluster to delete. * **clientToken** (*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. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'identifier': 'string', 'arn': 'string', 'status': 'CREATING'|'ACTIVE'|'IDLE'|'INACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'PENDING_SETUP'|'PENDING_DELETE', 'creationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* The output from a deleted cluster. * **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. **Exceptions** * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException" * "AuroraDSQL.Client.exceptions.ConflictException" AuroraDSQL / Client / can_paginate can_paginate ************ AuroraDSQL.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. AuroraDSQL / Client / generate_db_connect_auth_token generate_db_connect_auth_token ****************************** AuroraDSQL.Client.generate_db_connect_auth_token(Hostname, Region=None, ExpiresIn=900) Generate a DSQL database token for the "DbConnect" action. Parameters: * **Hostname** (*str*) -- The DSQL endpoint host name. * **Region** (*str*) -- The AWS region where the DSQL Cluster is hosted. If None, the client region will be used. * **ExpiresIn** (*int*) -- The token expiry duration in seconds (default is 900 seconds). Returns: A presigned url which can be used as an auth token. AuroraDSQL / Client / list_tags_for_resource list_tags_for_resource ********************** AuroraDSQL.Client.list_tags_for_resource(**kwargs) Lists all of the tags for a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource for which you want to list the tags. Return type: 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. **Exceptions** * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException" AuroraDSQL / Client / untag_resource untag_resource ************** AuroraDSQL.Client.untag_resource(**kwargs) Removes a tag from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource from which to remove tags. * **tagKeys** (*list*) -- **[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 **Exceptions** * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException" AuroraDSQL / Client / generate_db_connect_admin_auth_token generate_db_connect_admin_auth_token ************************************ AuroraDSQL.Client.generate_db_connect_admin_auth_token(Hostname, Region=None, ExpiresIn=900) Generate a DSQL database token for the "DbConnectAdmin" action. Parameters: * **Hostname** (*str*) -- The DSQL endpoint host name. * **Region** (*str*) -- The AWS region where the DSQL Cluster is hosted. If None, the client region will be used. * **ExpiresIn** (*int*) -- The token expiry duration in seconds (default is 900 seconds). Returns: A presigned url which can be used as an auth token. AuroraDSQL / Client / update_cluster update_cluster ************** AuroraDSQL.Client.update_cluster(**kwargs) 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: 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.** Warning: * 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. See also: AWS API Documentation **Request Syntax** response = client.update_cluster( identifier='string', deletionProtectionEnabled=True|False, kmsEncryptionKey='string', clientToken='string', multiRegionProperties={ 'witnessRegion': 'string', 'clusters': [ 'string', ] } ) Parameters: * **identifier** (*string*) -- **[REQUIRED]** The ID of the cluster you want to update. * **deletionProtectionEnabled** (*boolean*) -- Specifies whether to enable deletion protection in your cluster. * **kmsEncryptionKey** (*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. * **clientToken** (*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. This field is autopopulated if not provided. * **multiRegionProperties** (*dict*) -- The new multi-Region cluster configuration settings to be applied during an update operation. * **witnessRegion** *(string) --* The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum. * **clusters** *(list) --* The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region. * *(string) --* The Amazon Resource Name of the cluster. Return type: dict Returns: **Response Syntax** { 'identifier': 'string', 'arn': 'string', 'status': 'CREATING'|'ACTIVE'|'IDLE'|'INACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'PENDING_SETUP'|'PENDING_DELETE', 'creationTime': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* The details of the cluster after it has been updated. * **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. **Exceptions** * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException" * "AuroraDSQL.Client.exceptions.ConflictException" AuroraDSQL / Client / get_waiter get_waiter ********** AuroraDSQL.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" AuroraDSQL / Client / close close ***** AuroraDSQL.Client.close() Closes underlying endpoint connections. AuroraDSQL / Client / get_cluster get_cluster *********** AuroraDSQL.Client.get_cluster(**kwargs) Retrieves information about a cluster. See also: AWS API Documentation **Request Syntax** response = client.get_cluster( identifier='string' ) Parameters: **identifier** (*string*) -- **[REQUIRED]** The ID of the cluster to retrieve. Return type: dict Returns: **Response Syntax** { 'identifier': 'string', 'arn': 'string', 'status': 'CREATING'|'ACTIVE'|'IDLE'|'INACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'PENDING_SETUP'|'PENDING_DELETE', 'creationTime': datetime(2015, 1, 1), 'deletionProtectionEnabled': True|False, 'multiRegionProperties': { 'witnessRegion': 'string', 'clusters': [ 'string', ] }, 'tags': { 'string': 'string' }, 'encryptionDetails': { 'encryptionType': 'AWS_OWNED_KMS_KEY'|'CUSTOMER_MANAGED_KMS_KEY', 'kmsKeyArn': 'string', 'encryptionStatus': 'ENABLED'|'UPDATING'|'KMS_KEY_INACCESSIBLE'|'ENABLING' } } **Response Structure** * *(dict) --* The output of a cluster. * **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. * **multiRegionProperties** *(dict) --* Returns the current multi-Region cluster configuration, including witness region and linked cluster information. * **witnessRegion** *(string) --* The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum. * **clusters** *(list) --* The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region. * *(string) --* The Amazon Resource Name of the cluster. * **tags** *(dict) --* Map of tags. * *(string) --* Unique tag key, maximum 128 Unicode characters in UTF-8. * *(string) --* Tag value, maximum 256 Unicode characters in UTF-8. * **encryptionDetails** *(dict) --* The current encryption configuration details for the cluster. * **encryptionType** *(string) --* The type of encryption that protects the data on your cluster. * **kmsKeyArn** *(string) --* The ARN of the KMS key that encrypts data in the cluster. * **encryptionStatus** *(string) --* The status of encryption for the cluster. **Exceptions** * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException" AuroraDSQL / Client / tag_resource tag_resource ************ AuroraDSQL.Client.tag_resource(**kwargs) Tags a resource with a map of key and value pairs. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource that you want to tag. * **tags** (*dict*) -- **[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 **Exceptions** * "AuroraDSQL.Client.exceptions.ServiceQuotaExceededException" * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException" AuroraDSQL / Client / get_vpc_endpoint_service_name get_vpc_endpoint_service_name ***************************** AuroraDSQL.Client.get_vpc_endpoint_service_name(**kwargs) Retrieves the VPC endpoint service name. See also: AWS API Documentation **Request Syntax** response = client.get_vpc_endpoint_service_name( identifier='string' ) Parameters: **identifier** (*string*) -- **[REQUIRED]** The ID of the cluster to retrieve. Return type: dict Returns: **Response Syntax** { 'serviceName': 'string' } **Response Structure** * *(dict) --* * **serviceName** *(string) --* The VPC endpoint service name. **Exceptions** * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException" AuroraDSQL / Client / list_clusters list_clusters ************* AuroraDSQL.Client.list_clusters(**kwargs) Retrieves information about a list of clusters. See also: AWS API Documentation **Request Syntax** response = client.list_clusters( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. * **nextToken** (*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. Return type: 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. **Exceptions** * "AuroraDSQL.Client.exceptions.ThrottlingException" * "AuroraDSQL.Client.exceptions.AccessDeniedException" * "AuroraDSQL.Client.exceptions.ValidationException" * "AuroraDSQL.Client.exceptions.InternalServerException" * "AuroraDSQL.Client.exceptions.ResourceNotFoundException"