DocDBElastic ************ Client ====== class DocDBElastic.Client A low-level client representing Amazon DocumentDB Elastic Clusters (DocDB Elastic) Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances. Amazon DocumentDB elastic-clusters were created to: * provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility. * give customers higher connection limits, and to reduce downtime from patching. * continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads. import boto3 client = boto3.client('docdb-elastic') These are the available methods: * apply_pending_maintenance_action * can_paginate * close * copy_cluster_snapshot * create_cluster * create_cluster_snapshot * delete_cluster * delete_cluster_snapshot * get_cluster * get_cluster_snapshot * get_paginator * get_pending_maintenance_action * get_waiter * list_cluster_snapshots * list_clusters * list_pending_maintenance_actions * list_tags_for_resource * restore_cluster_from_snapshot * start_cluster * stop_cluster * 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: * ListClusterSnapshots * ListClusters * ListPendingMaintenanceActions DocDBElastic / Paginator / ListPendingMaintenanceActions ListPendingMaintenanceActions ***************************** class DocDBElastic.Paginator.ListPendingMaintenanceActions paginator = client.get_paginator('list_pending_maintenance_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DocDBElastic.Client.list_pending_maintenance_actions()". 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** { 'resourcePendingMaintenanceActions': [ { 'pendingMaintenanceActionDetails': [ { 'action': 'string', 'autoAppliedAfterDate': 'string', 'currentApplyDate': 'string', 'description': 'string', 'forcedApplyDate': 'string', 'optInStatus': 'string' }, ], 'resourceArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **resourcePendingMaintenanceActions** *(list) --* Provides information about a pending maintenance action for a resource. * *(dict) --* Provides information about a pending maintenance action for a resource. * **pendingMaintenanceActionDetails** *(list) --* Provides information about a pending maintenance action for a resource. * *(dict) --* Retrieves the details of maintenance actions that are pending. * **action** *(string) --* Displays the specific action of a pending maintenance action. * **autoAppliedAfterDate** *(string) --* Displays the date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any "NEXT_MAINTENANCE" "optInType" requests are ignored. * **currentApplyDate** *(string) --* Displays the effective date when the pending maintenance action is applied to the resource. * **description** *(string) --* Displays a description providing more detail about the maintenance action. * **forcedApplyDate** *(string) --* Displays the date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any "IMMEDIATE" "optInType" requests are ignored. * **optInStatus** *(string) --* Displays the type of "optInType" request that has been received for the resource. * **resourceArn** *(string) --* The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies. * **NextToken** *(string) --* A token to resume pagination. DocDBElastic / Paginator / ListClusterSnapshots ListClusterSnapshots ******************** class DocDBElastic.Paginator.ListClusterSnapshots paginator = client.get_paginator('list_cluster_snapshots') paginate(**kwargs) Creates an iterator that will paginate through responses from "DocDBElastic.Client.list_cluster_snapshots()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( clusterArn='string', snapshotType='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **clusterArn** (*string*) -- The ARN identifier of the elastic cluster. * **snapshotType** (*string*) -- The type of cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. * "manual" - Return all cluster snapshots that you have manually created for your Amazon Web Services account. * **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** { 'snapshots': [ { 'clusterArn': 'string', 'snapshotArn': 'string', 'snapshotCreationTime': 'string', 'snapshotName': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **snapshots** *(list) --* A list of snapshots for a specified elastic cluster. * *(dict) --* A list of elastic cluster snapshots. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **snapshotArn** *(string) --* The ARN identifier of the elastic cluster snapshot. * **snapshotCreationTime** *(string) --* The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC). * **snapshotName** *(string) --* The name of the elastic cluster snapshot. * **status** *(string) --* The status of the elastic cluster snapshot. * **NextToken** *(string) --* A token to resume pagination. DocDBElastic / Paginator / ListClusters ListClusters ************ class DocDBElastic.Paginator.ListClusters paginator = client.get_paginator('list_clusters') paginate(**kwargs) Creates an iterator that will paginate through responses from "DocDBElastic.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': [ { 'clusterArn': 'string', 'clusterName': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **clusters** *(list) --* A list of Amazon DocumentDB elastic clusters. * *(dict) --* A list of Amazon DocumentDB elastic clusters. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **status** *(string) --* The status of the elastic cluster. * **NextToken** *(string) --* A token to resume pagination. DocDBElastic / Client / start_cluster start_cluster ************* DocDBElastic.Client.start_cluster(**kwargs) Restarts the stopped elastic cluster that is specified by "clusterARN". See also: AWS API Documentation **Request Syntax** response = client.start_cluster( clusterArn='string' ) Parameters: **clusterArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster. Return type: dict Returns: **Response Syntax** { 'cluster': { 'adminUserName': 'string', 'authType': 'PLAIN_TEXT'|'SECRET_ARN', 'backupRetentionPeriod': 123, 'clusterArn': 'string', 'clusterEndpoint': 'string', 'clusterName': 'string', 'createTime': 'string', 'kmsKeyId': 'string', 'preferredBackupWindow': 'string', 'preferredMaintenanceWindow': 'string', 'shardCapacity': 123, 'shardCount': 123, 'shardInstanceCount': 123, 'shards': [ { 'createTime': 'string', 'shardId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* Returns information about a specific elastic cluster. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **authType** *(string) --* The authentication type for the elastic cluster. * **backupRetentionPeriod** *(integer) --* The number of days for which automatic snapshots are retained. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterEndpoint** *(string) --* The URL used to connect to the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **createTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier to use to encrypt the elastic cluster. * **preferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by "backupRetentionPeriod". * **preferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" * **shardCapacity** *(integer) --* The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** *(integer) --* The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** *(integer) --* The number of replica instances applying to all shards in the cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **shards** *(list) --* The total number of shards in the cluster. * *(dict) --* The name of the shard. * **createTime** *(string) --* The time when the shard was created in Universal Coordinated Time (UTC). * **shardId** *(string) --* The ID of the shard. * **status** *(string) --* The current status of the shard. * **status** *(string) --* The status of the elastic cluster. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups associated with thie elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / get_paginator get_paginator ************* DocDBElastic.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. DocDBElastic / Client / create_cluster create_cluster ************** DocDBElastic.Client.create_cluster(**kwargs) Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure. See also: AWS API Documentation **Request Syntax** response = client.create_cluster( adminUserName='string', adminUserPassword='string', authType='PLAIN_TEXT'|'SECRET_ARN', backupRetentionPeriod=123, clientToken='string', clusterName='string', kmsKeyId='string', preferredBackupWindow='string', preferredMaintenanceWindow='string', shardCapacity=123, shardCount=123, shardInstanceCount=123, subnetIds=[ 'string', ], tags={ 'string': 'string' }, vpcSecurityGroupIds=[ 'string', ] ) Parameters: * **adminUserName** (*string*) -- **[REQUIRED]** The name of the Amazon DocumentDB elastic clusters administrator. *Constraints*: * Must be from 1 to 63 letters or numbers. * The first character must be a letter. * Cannot be a reserved word. * **adminUserPassword** (*string*) -- **[REQUIRED]** The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters. *Constraints*: * Must contain from 8 to 100 characters. * Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@). * **authType** (*string*) -- **[REQUIRED]** The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are "PLAIN_TEXT" or "SECRET_ARN". * **backupRetentionPeriod** (*integer*) -- The number of days for which automatic snapshots are retained. * **clientToken** (*string*) -- The client token for the elastic cluster. This field is autopopulated if not provided. * **clusterName** (*string*) -- **[REQUIRED]** The name of the new elastic cluster. This parameter is stored as a lowercase string. *Constraints*: * Must contain from 1 to 63 letters, numbers, or hyphens. * The first character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. *Example*: "my-cluster" * **kmsKeyId** (*string*) -- The KMS key identifier to use to encrypt the new elastic cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region. * **preferredBackupWindow** (*string*) -- The daily time range during which automated backups are created if automated backups are enabled, as determined by the "backupRetentionPeriod". * **preferredMaintenanceWindow** (*string*) -- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" *Default*: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. *Valid days*: Mon, Tue, Wed, Thu, Fri, Sat, Sun *Constraints*: Minimum 30-minute window. * **shardCapacity** (*integer*) -- **[REQUIRED]** The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** (*integer*) -- **[REQUIRED]** The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** (*integer*) -- The number of replica instances applying to all shards in the elastic cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **subnetIds** (*list*) -- The Amazon EC2 subnet IDs for the new elastic cluster. * *(string) --* * **tags** (*dict*) -- The tags to be assigned to the new elastic cluster. * *(string) --* * *(string) --* * **vpcSecurityGroupIds** (*list*) -- A list of EC2 VPC security groups to associate with the new elastic cluster. * *(string) --* Return type: dict Returns: **Response Syntax** { 'cluster': { 'adminUserName': 'string', 'authType': 'PLAIN_TEXT'|'SECRET_ARN', 'backupRetentionPeriod': 123, 'clusterArn': 'string', 'clusterEndpoint': 'string', 'clusterName': 'string', 'createTime': 'string', 'kmsKeyId': 'string', 'preferredBackupWindow': 'string', 'preferredMaintenanceWindow': 'string', 'shardCapacity': 123, 'shardCount': 123, 'shardInstanceCount': 123, 'shards': [ { 'createTime': 'string', 'shardId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* The new elastic cluster that has been created. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **authType** *(string) --* The authentication type for the elastic cluster. * **backupRetentionPeriod** *(integer) --* The number of days for which automatic snapshots are retained. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterEndpoint** *(string) --* The URL used to connect to the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **createTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier to use to encrypt the elastic cluster. * **preferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by "backupRetentionPeriod". * **preferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" * **shardCapacity** *(integer) --* The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** *(integer) --* The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** *(integer) --* The number of replica instances applying to all shards in the cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **shards** *(list) --* The total number of shards in the cluster. * *(dict) --* The name of the shard. * **createTime** *(string) --* The time when the shard was created in Universal Coordinated Time (UTC). * **shardId** *(string) --* The ID of the shard. * **status** *(string) --* The current status of the shard. * **status** *(string) --* The status of the elastic cluster. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups associated with thie elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ServiceQuotaExceededException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / delete_cluster delete_cluster ************** DocDBElastic.Client.delete_cluster(**kwargs) Delete an elastic cluster. See also: AWS API Documentation **Request Syntax** response = client.delete_cluster( clusterArn='string' ) Parameters: **clusterArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster that is to be deleted. Return type: dict Returns: **Response Syntax** { 'cluster': { 'adminUserName': 'string', 'authType': 'PLAIN_TEXT'|'SECRET_ARN', 'backupRetentionPeriod': 123, 'clusterArn': 'string', 'clusterEndpoint': 'string', 'clusterName': 'string', 'createTime': 'string', 'kmsKeyId': 'string', 'preferredBackupWindow': 'string', 'preferredMaintenanceWindow': 'string', 'shardCapacity': 123, 'shardCount': 123, 'shardInstanceCount': 123, 'shards': [ { 'createTime': 'string', 'shardId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* Returns information about the newly deleted elastic cluster. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **authType** *(string) --* The authentication type for the elastic cluster. * **backupRetentionPeriod** *(integer) --* The number of days for which automatic snapshots are retained. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterEndpoint** *(string) --* The URL used to connect to the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **createTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier to use to encrypt the elastic cluster. * **preferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by "backupRetentionPeriod". * **preferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" * **shardCapacity** *(integer) --* The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** *(integer) --* The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** *(integer) --* The number of replica instances applying to all shards in the cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **shards** *(list) --* The total number of shards in the cluster. * *(dict) --* The name of the shard. * **createTime** *(string) --* The time when the shard was created in Universal Coordinated Time (UTC). * **shardId** *(string) --* The ID of the shard. * **status** *(string) --* The current status of the shard. * **status** *(string) --* The status of the elastic cluster. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups associated with thie elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / can_paginate can_paginate ************ DocDBElastic.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. DocDBElastic / Client / create_cluster_snapshot create_cluster_snapshot *********************** DocDBElastic.Client.create_cluster_snapshot(**kwargs) Creates a snapshot of an elastic cluster. See also: AWS API Documentation **Request Syntax** response = client.create_cluster_snapshot( clusterArn='string', snapshotName='string', tags={ 'string': 'string' } ) Parameters: * **clusterArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster of which you want to create a snapshot. * **snapshotName** (*string*) -- **[REQUIRED]** The name of the new elastic cluster snapshot. * **tags** (*dict*) -- The tags to be assigned to the new elastic cluster snapshot. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'snapshot': { 'adminUserName': 'string', 'clusterArn': 'string', 'clusterCreationTime': 'string', 'kmsKeyId': 'string', 'snapshotArn': 'string', 'snapshotCreationTime': 'string', 'snapshotName': 'string', 'snapshotType': 'MANUAL'|'AUTOMATED', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **snapshot** *(dict) --* Returns information about the new elastic cluster snapshot. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterCreationTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region. * **snapshotArn** *(string) --* The ARN identifier of the elastic cluster snapshot. * **snapshotCreationTime** *(string) --* The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC). * **snapshotName** *(string) --* The name of the elastic cluster snapshot. * **snapshotType** *(string) --* The type of cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. * "manual" - Return all cluster snapshots that you have manually created for your Amazon Web Services account. * **status** *(string) --* The status of the elastic cluster snapshot. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups to associate with the elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ServiceQuotaExceededException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / stop_cluster stop_cluster ************ DocDBElastic.Client.stop_cluster(**kwargs) Stops the running elastic cluster that is specified by "clusterArn". The elastic cluster must be in the *available* state. See also: AWS API Documentation **Request Syntax** response = client.stop_cluster( clusterArn='string' ) Parameters: **clusterArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster. Return type: dict Returns: **Response Syntax** { 'cluster': { 'adminUserName': 'string', 'authType': 'PLAIN_TEXT'|'SECRET_ARN', 'backupRetentionPeriod': 123, 'clusterArn': 'string', 'clusterEndpoint': 'string', 'clusterName': 'string', 'createTime': 'string', 'kmsKeyId': 'string', 'preferredBackupWindow': 'string', 'preferredMaintenanceWindow': 'string', 'shardCapacity': 123, 'shardCount': 123, 'shardInstanceCount': 123, 'shards': [ { 'createTime': 'string', 'shardId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* Returns information about a specific elastic cluster. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **authType** *(string) --* The authentication type for the elastic cluster. * **backupRetentionPeriod** *(integer) --* The number of days for which automatic snapshots are retained. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterEndpoint** *(string) --* The URL used to connect to the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **createTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier to use to encrypt the elastic cluster. * **preferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by "backupRetentionPeriod". * **preferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" * **shardCapacity** *(integer) --* The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** *(integer) --* The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** *(integer) --* The number of replica instances applying to all shards in the cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **shards** *(list) --* The total number of shards in the cluster. * *(dict) --* The name of the shard. * **createTime** *(string) --* The time when the shard was created in Universal Coordinated Time (UTC). * **shardId** *(string) --* The ID of the shard. * **status** *(string) --* The current status of the shard. * **status** *(string) --* The status of the elastic cluster. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups associated with thie elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / delete_cluster_snapshot delete_cluster_snapshot *********************** DocDBElastic.Client.delete_cluster_snapshot(**kwargs) Delete an elastic cluster snapshot. See also: AWS API Documentation **Request Syntax** response = client.delete_cluster_snapshot( snapshotArn='string' ) Parameters: **snapshotArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster snapshot that is to be deleted. Return type: dict Returns: **Response Syntax** { 'snapshot': { 'adminUserName': 'string', 'clusterArn': 'string', 'clusterCreationTime': 'string', 'kmsKeyId': 'string', 'snapshotArn': 'string', 'snapshotCreationTime': 'string', 'snapshotName': 'string', 'snapshotType': 'MANUAL'|'AUTOMATED', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **snapshot** *(dict) --* Returns information about the newly deleted elastic cluster snapshot. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterCreationTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region. * **snapshotArn** *(string) --* The ARN identifier of the elastic cluster snapshot. * **snapshotCreationTime** *(string) --* The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC). * **snapshotName** *(string) --* The name of the elastic cluster snapshot. * **snapshotType** *(string) --* The type of cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. * "manual" - Return all cluster snapshots that you have manually created for your Amazon Web Services account. * **status** *(string) --* The status of the elastic cluster snapshot. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups to associate with the elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / restore_cluster_from_snapshot restore_cluster_from_snapshot ***************************** DocDBElastic.Client.restore_cluster_from_snapshot(**kwargs) Restores an elastic cluster from a snapshot. See also: AWS API Documentation **Request Syntax** response = client.restore_cluster_from_snapshot( clusterName='string', kmsKeyId='string', shardCapacity=123, shardInstanceCount=123, snapshotArn='string', subnetIds=[ 'string', ], tags={ 'string': 'string' }, vpcSecurityGroupIds=[ 'string', ] ) Parameters: * **clusterName** (*string*) -- **[REQUIRED]** The name of the elastic cluster. * **kmsKeyId** (*string*) -- The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region. * **shardCapacity** (*integer*) -- The capacity of each shard in the new restored elastic cluster. * **shardInstanceCount** (*integer*) -- The number of replica instances applying to all shards in the elastic cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **snapshotArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster snapshot. * **subnetIds** (*list*) -- The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **tags** (*dict*) -- A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value. * *(string) --* * *(string) --* * **vpcSecurityGroupIds** (*list*) -- A list of EC2 VPC security groups to associate with the elastic cluster. * *(string) --* Return type: dict Returns: **Response Syntax** { 'cluster': { 'adminUserName': 'string', 'authType': 'PLAIN_TEXT'|'SECRET_ARN', 'backupRetentionPeriod': 123, 'clusterArn': 'string', 'clusterEndpoint': 'string', 'clusterName': 'string', 'createTime': 'string', 'kmsKeyId': 'string', 'preferredBackupWindow': 'string', 'preferredMaintenanceWindow': 'string', 'shardCapacity': 123, 'shardCount': 123, 'shardInstanceCount': 123, 'shards': [ { 'createTime': 'string', 'shardId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* Returns information about a the restored elastic cluster. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **authType** *(string) --* The authentication type for the elastic cluster. * **backupRetentionPeriod** *(integer) --* The number of days for which automatic snapshots are retained. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterEndpoint** *(string) --* The URL used to connect to the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **createTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier to use to encrypt the elastic cluster. * **preferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by "backupRetentionPeriod". * **preferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" * **shardCapacity** *(integer) --* The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** *(integer) --* The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** *(integer) --* The number of replica instances applying to all shards in the cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **shards** *(list) --* The total number of shards in the cluster. * *(dict) --* The name of the shard. * **createTime** *(string) --* The time when the shard was created in Universal Coordinated Time (UTC). * **shardId** *(string) --* The ID of the shard. * **status** *(string) --* The current status of the shard. * **status** *(string) --* The status of the elastic cluster. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups associated with thie elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ServiceQuotaExceededException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / list_tags_for_resource list_tags_for_resource ********************** DocDBElastic.Client.list_tags_for_resource(**kwargs) Lists all tags on a elastic cluster resource See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster resource. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The list of tags for the specified elastic cluster resource. * *(string) --* * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" DocDBElastic / Client / copy_cluster_snapshot copy_cluster_snapshot ********************* DocDBElastic.Client.copy_cluster_snapshot(**kwargs) Copies a snapshot of an elastic cluster. See also: AWS API Documentation **Request Syntax** response = client.copy_cluster_snapshot( copyTags=True|False, kmsKeyId='string', snapshotArn='string', tags={ 'string': 'string' }, targetSnapshotName='string' ) Parameters: * **copyTags** (*boolean*) -- Set to "true" to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. The default is "false". * **kmsKeyId** (*string*) -- The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key. If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for "KmsKeyId" to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for "KmsKeyId", then the copy of the elastic cluster snapshot is encrypted with the same "AWS" KMS key as the source elastic cluster snapshot. To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set "KmsKeyId" to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region. If you copy an unencrypted elastic cluster snapshot and specify a value for the "KmsKeyId" parameter, an error is returned. * **snapshotArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot. * **tags** (*dict*) -- The tags to be assigned to the elastic cluster snapshot. * *(string) --* * *(string) --* * **targetSnapshotName** (*string*) -- **[REQUIRED]** The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * The first character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens. Example: "elastic-cluster-snapshot-5" Return type: dict Returns: **Response Syntax** { 'snapshot': { 'adminUserName': 'string', 'clusterArn': 'string', 'clusterCreationTime': 'string', 'kmsKeyId': 'string', 'snapshotArn': 'string', 'snapshotCreationTime': 'string', 'snapshotName': 'string', 'snapshotType': 'MANUAL'|'AUTOMATED', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **snapshot** *(dict) --* Returns information about a specific elastic cluster snapshot. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterCreationTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region. * **snapshotArn** *(string) --* The ARN identifier of the elastic cluster snapshot. * **snapshotCreationTime** *(string) --* The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC). * **snapshotName** *(string) --* The name of the elastic cluster snapshot. * **snapshotType** *(string) --* The type of cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. * "manual" - Return all cluster snapshots that you have manually created for your Amazon Web Services account. * **status** *(string) --* The status of the elastic cluster snapshot. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups to associate with the elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ServiceQuotaExceededException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / get_cluster_snapshot get_cluster_snapshot ******************** DocDBElastic.Client.get_cluster_snapshot(**kwargs) Returns information about a specific elastic cluster snapshot See also: AWS API Documentation **Request Syntax** response = client.get_cluster_snapshot( snapshotArn='string' ) Parameters: **snapshotArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster snapshot. Return type: dict Returns: **Response Syntax** { 'snapshot': { 'adminUserName': 'string', 'clusterArn': 'string', 'clusterCreationTime': 'string', 'kmsKeyId': 'string', 'snapshotArn': 'string', 'snapshotCreationTime': 'string', 'snapshotName': 'string', 'snapshotType': 'MANUAL'|'AUTOMATED', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **snapshot** *(dict) --* Returns information about a specific elastic cluster snapshot. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterCreationTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region. * **snapshotArn** *(string) --* The ARN identifier of the elastic cluster snapshot. * **snapshotCreationTime** *(string) --* The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC). * **snapshotName** *(string) --* The name of the elastic cluster snapshot. * **snapshotType** *(string) --* The type of cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. * "manual" - Return all cluster snapshots that you have manually created for your Amazon Web Services account. * **status** *(string) --* The status of the elastic cluster snapshot. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups to associate with the elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / list_pending_maintenance_actions list_pending_maintenance_actions ******************************** DocDBElastic.Client.list_pending_maintenance_actions(**kwargs) Retrieves a list of all maintenance actions that are pending. See also: AWS API Documentation **Request Syntax** response = client.list_pending_maintenance_actions( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to include in the response. If more records exist than the specified "maxResults" value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. * **nextToken** (*string*) -- An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "maxResults". Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'resourcePendingMaintenanceActions': [ { 'pendingMaintenanceActionDetails': [ { 'action': 'string', 'autoAppliedAfterDate': 'string', 'currentApplyDate': 'string', 'description': 'string', 'forcedApplyDate': 'string', 'optInStatus': 'string' }, ], 'resourceArn': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* An optional pagination token provided by a previous request. If this parameter is displayed, the responses will include only records beyond the marker, up to the value specified by "maxResults". * **resourcePendingMaintenanceActions** *(list) --* Provides information about a pending maintenance action for a resource. * *(dict) --* Provides information about a pending maintenance action for a resource. * **pendingMaintenanceActionDetails** *(list) --* Provides information about a pending maintenance action for a resource. * *(dict) --* Retrieves the details of maintenance actions that are pending. * **action** *(string) --* Displays the specific action of a pending maintenance action. * **autoAppliedAfterDate** *(string) --* Displays the date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any "NEXT_MAINTENANCE" "optInType" requests are ignored. * **currentApplyDate** *(string) --* Displays the effective date when the pending maintenance action is applied to the resource. * **description** *(string) --* Displays a description providing more detail about the maintenance action. * **forcedApplyDate** *(string) --* Displays the date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any "IMMEDIATE" "optInType" requests are ignored. * **optInStatus** *(string) --* Displays the type of "optInType" request that has been received for the resource. * **resourceArn** *(string) --* The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies. **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / untag_resource untag_resource ************** DocDBElastic.Client.untag_resource(**kwargs) Removes metadata tags from an elastic cluster resource See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster resource. * **tagKeys** (*list*) -- **[REQUIRED]** The tag keys to be removed from the elastic cluster resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" DocDBElastic / Client / update_cluster update_cluster ************** DocDBElastic.Client.update_cluster(**kwargs) Modifies an elastic cluster. This includes updating admin- username/password, upgrading the API version, and setting up a backup window and maintenance window See also: AWS API Documentation **Request Syntax** response = client.update_cluster( adminUserPassword='string', authType='PLAIN_TEXT'|'SECRET_ARN', backupRetentionPeriod=123, clientToken='string', clusterArn='string', preferredBackupWindow='string', preferredMaintenanceWindow='string', shardCapacity=123, shardCount=123, shardInstanceCount=123, subnetIds=[ 'string', ], vpcSecurityGroupIds=[ 'string', ] ) Parameters: * **adminUserPassword** (*string*) -- The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@). *Constraints*: Must contain from 8 to 100 characters. * **authType** (*string*) -- The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are "PLAIN_TEXT" or "SECRET_ARN". * **backupRetentionPeriod** (*integer*) -- The number of days for which automatic snapshots are retained. * **clientToken** (*string*) -- The client token for the elastic cluster. This field is autopopulated if not provided. * **clusterArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster. * **preferredBackupWindow** (*string*) -- The daily time range during which automated backups are created if automated backups are enabled, as determined by the "backupRetentionPeriod". * **preferredMaintenanceWindow** (*string*) -- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" *Default*: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. *Valid days*: Mon, Tue, Wed, Thu, Fri, Sat, Sun *Constraints*: Minimum 30-minute window. * **shardCapacity** (*integer*) -- The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** (*integer*) -- The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** (*integer*) -- The number of replica instances applying to all shards in the elastic cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **subnetIds** (*list*) -- The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** (*list*) -- A list of EC2 VPC security groups to associate with the elastic cluster. * *(string) --* Return type: dict Returns: **Response Syntax** { 'cluster': { 'adminUserName': 'string', 'authType': 'PLAIN_TEXT'|'SECRET_ARN', 'backupRetentionPeriod': 123, 'clusterArn': 'string', 'clusterEndpoint': 'string', 'clusterName': 'string', 'createTime': 'string', 'kmsKeyId': 'string', 'preferredBackupWindow': 'string', 'preferredMaintenanceWindow': 'string', 'shardCapacity': 123, 'shardCount': 123, 'shardInstanceCount': 123, 'shards': [ { 'createTime': 'string', 'shardId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* Returns information about the updated elastic cluster. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **authType** *(string) --* The authentication type for the elastic cluster. * **backupRetentionPeriod** *(integer) --* The number of days for which automatic snapshots are retained. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterEndpoint** *(string) --* The URL used to connect to the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **createTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier to use to encrypt the elastic cluster. * **preferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by "backupRetentionPeriod". * **preferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" * **shardCapacity** *(integer) --* The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** *(integer) --* The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** *(integer) --* The number of replica instances applying to all shards in the cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **shards** *(list) --* The total number of shards in the cluster. * *(dict) --* The name of the shard. * **createTime** *(string) --* The time when the shard was created in Universal Coordinated Time (UTC). * **shardId** *(string) --* The ID of the shard. * **status** *(string) --* The current status of the shard. * **status** *(string) --* The status of the elastic cluster. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups associated with thie elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / get_waiter get_waiter ********** DocDBElastic.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" DocDBElastic / Client / close close ***** DocDBElastic.Client.close() Closes underlying endpoint connections. DocDBElastic / Client / list_cluster_snapshots list_cluster_snapshots ********************** DocDBElastic.Client.list_cluster_snapshots(**kwargs) Returns information about snapshots for a specified elastic cluster. See also: AWS API Documentation **Request Syntax** response = client.list_cluster_snapshots( clusterArn='string', maxResults=123, nextToken='string', snapshotType='string' ) Parameters: * **clusterArn** (*string*) -- The ARN identifier of the elastic cluster. * **maxResults** (*integer*) -- The maximum number of elastic cluster snapshot results to receive in the response. * **nextToken** (*string*) -- A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by "max-results". If there is no more data in the responce, the "nextToken" will not be returned. * **snapshotType** (*string*) -- The type of cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. * "manual" - Return all cluster snapshots that you have manually created for your Amazon Web Services account. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'snapshots': [ { 'clusterArn': 'string', 'snapshotArn': 'string', 'snapshotCreationTime': 'string', 'snapshotName': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by "max- results". If there is no more data in the responce, the "nextToken" will not be returned. * **snapshots** *(list) --* A list of snapshots for a specified elastic cluster. * *(dict) --* A list of elastic cluster snapshots. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **snapshotArn** *(string) --* The ARN identifier of the elastic cluster snapshot. * **snapshotCreationTime** *(string) --* The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC). * **snapshotName** *(string) --* The name of the elastic cluster snapshot. * **status** *(string) --* The status of the elastic cluster snapshot. **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / get_cluster get_cluster *********** DocDBElastic.Client.get_cluster(**kwargs) Returns information about a specific elastic cluster. See also: AWS API Documentation **Request Syntax** response = client.get_cluster( clusterArn='string' ) Parameters: **clusterArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster. Return type: dict Returns: **Response Syntax** { 'cluster': { 'adminUserName': 'string', 'authType': 'PLAIN_TEXT'|'SECRET_ARN', 'backupRetentionPeriod': 123, 'clusterArn': 'string', 'clusterEndpoint': 'string', 'clusterName': 'string', 'createTime': 'string', 'kmsKeyId': 'string', 'preferredBackupWindow': 'string', 'preferredMaintenanceWindow': 'string', 'shardCapacity': 123, 'shardCount': 123, 'shardInstanceCount': 123, 'shards': [ { 'createTime': 'string', 'shardId': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE', 'subnetIds': [ 'string', ], 'vpcSecurityGroupIds': [ 'string', ] } } **Response Structure** * *(dict) --* * **cluster** *(dict) --* Returns information about a specific elastic cluster. * **adminUserName** *(string) --* The name of the elastic cluster administrator. * **authType** *(string) --* The authentication type for the elastic cluster. * **backupRetentionPeriod** *(integer) --* The number of days for which automatic snapshots are retained. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterEndpoint** *(string) --* The URL used to connect to the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **createTime** *(string) --* The time when the elastic cluster was created in Universal Coordinated Time (UTC). * **kmsKeyId** *(string) --* The KMS key identifier to use to encrypt the elastic cluster. * **preferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by "backupRetentionPeriod". * **preferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). *Format*: "ddd:hh24:mi-ddd:hh24:mi" * **shardCapacity** *(integer) --* The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64. * **shardCount** *(integer) --* The number of shards assigned to the elastic cluster. Maximum is 32. * **shardInstanceCount** *(integer) --* The number of replica instances applying to all shards in the cluster. A "shardInstanceCount" value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability. * **shards** *(list) --* The total number of shards in the cluster. * *(dict) --* The name of the shard. * **createTime** *(string) --* The time when the shard was created in Universal Coordinated Time (UTC). * **shardId** *(string) --* The ID of the shard. * **status** *(string) --* The current status of the shard. * **status** *(string) --* The status of the elastic cluster. * **subnetIds** *(list) --* The Amazon EC2 subnet IDs for the elastic cluster. * *(string) --* * **vpcSecurityGroupIds** *(list) --* A list of EC2 VPC security groups associated with thie elastic cluster. * *(string) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / apply_pending_maintenance_action apply_pending_maintenance_action ******************************** DocDBElastic.Client.apply_pending_maintenance_action(**kwargs) The type of pending maintenance action to be applied to the resource. See also: AWS API Documentation **Request Syntax** response = client.apply_pending_maintenance_action( applyAction='string', applyOn='string', optInType='IMMEDIATE'|'NEXT_MAINTENANCE'|'APPLY_ON'|'UNDO_OPT_IN', resourceArn='string' ) Parameters: * **applyAction** (*string*) -- **[REQUIRED]** The pending maintenance action to apply to the resource. Valid actions are: * "ENGINE_UPDATE" * "ENGINE_UPGRADE" * "SECURITY_UPDATE" * "OS_UPDATE" * "MASTER_USER_PASSWORD_UPDATE" * **applyOn** (*string*) -- A specific date to apply the pending maintenance action. Required if opt-in-type is "APPLY_ON". Format: "yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm" * **optInType** (*string*) -- **[REQUIRED]** A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type "IMMEDIATE" can't be undone. * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies. Return type: dict Returns: **Response Syntax** { 'resourcePendingMaintenanceAction': { 'pendingMaintenanceActionDetails': [ { 'action': 'string', 'autoAppliedAfterDate': 'string', 'currentApplyDate': 'string', 'description': 'string', 'forcedApplyDate': 'string', 'optInStatus': 'string' }, ], 'resourceArn': 'string' } } **Response Structure** * *(dict) --* * **resourcePendingMaintenanceAction** *(dict) --* The output of the pending maintenance action being applied. * **pendingMaintenanceActionDetails** *(list) --* Provides information about a pending maintenance action for a resource. * *(dict) --* Retrieves the details of maintenance actions that are pending. * **action** *(string) --* Displays the specific action of a pending maintenance action. * **autoAppliedAfterDate** *(string) --* Displays the date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any "NEXT_MAINTENANCE" "optInType" requests are ignored. * **currentApplyDate** *(string) --* Displays the effective date when the pending maintenance action is applied to the resource. * **description** *(string) --* Displays a description providing more detail about the maintenance action. * **forcedApplyDate** *(string) --* Displays the date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any "IMMEDIATE" "optInType" requests are ignored. * **optInStatus** *(string) --* Displays the type of "optInType" request that has been received for the resource. * **resourceArn** *(string) --* The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies. **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / get_pending_maintenance_action get_pending_maintenance_action ****************************** DocDBElastic.Client.get_pending_maintenance_action(**kwargs) Retrieves all maintenance actions that are pending. See also: AWS API Documentation **Request Syntax** response = client.get_pending_maintenance_action( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN). Return type: dict Returns: **Response Syntax** { 'resourcePendingMaintenanceAction': { 'pendingMaintenanceActionDetails': [ { 'action': 'string', 'autoAppliedAfterDate': 'string', 'currentApplyDate': 'string', 'description': 'string', 'forcedApplyDate': 'string', 'optInStatus': 'string' }, ], 'resourceArn': 'string' } } **Response Structure** * *(dict) --* * **resourcePendingMaintenanceAction** *(dict) --* Provides information about a pending maintenance action for a resource. * **pendingMaintenanceActionDetails** *(list) --* Provides information about a pending maintenance action for a resource. * *(dict) --* Retrieves the details of maintenance actions that are pending. * **action** *(string) --* Displays the specific action of a pending maintenance action. * **autoAppliedAfterDate** *(string) --* Displays the date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any "NEXT_MAINTENANCE" "optInType" requests are ignored. * **currentApplyDate** *(string) --* Displays the effective date when the pending maintenance action is applied to the resource. * **description** *(string) --* Displays a description providing more detail about the maintenance action. * **forcedApplyDate** *(string) --* Displays the date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any "IMMEDIATE" "optInType" requests are ignored. * **optInStatus** *(string) --* Displays the type of "optInType" request that has been received for the resource. * **resourceArn** *(string) --* The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies. **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.ConflictException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" * "DocDBElastic.Client.exceptions.AccessDeniedException" DocDBElastic / Client / tag_resource tag_resource ************ DocDBElastic.Client.tag_resource(**kwargs) Adds metadata tags to an elastic cluster resource See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceArn='string', tags={ 'string': 'string' } ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN identifier of the elastic cluster resource. * **tags** (*dict*) -- **[REQUIRED]** The tags that are assigned to the elastic cluster resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.ResourceNotFoundException" DocDBElastic / Client / list_clusters list_clusters ************* DocDBElastic.Client.list_clusters(**kwargs) Returns information about provisioned Amazon DocumentDB elastic clusters. See also: AWS API Documentation **Request Syntax** response = client.list_clusters( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of elastic cluster snapshot results to receive in the response. * **nextToken** (*string*) -- A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by "max-results". If there is no more data in the responce, the "nextToken" will not be returned. Return type: dict Returns: **Response Syntax** { 'clusters': [ { 'clusterArn': 'string', 'clusterName': 'string', 'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **clusters** *(list) --* A list of Amazon DocumentDB elastic clusters. * *(dict) --* A list of Amazon DocumentDB elastic clusters. * **clusterArn** *(string) --* The ARN identifier of the elastic cluster. * **clusterName** *(string) --* The name of the elastic cluster. * **status** *(string) --* The status of the elastic cluster. * **nextToken** *(string) --* A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by "max- results". If there is no more data in the responce, the "nextToken" will not be returned. **Exceptions** * "DocDBElastic.Client.exceptions.ThrottlingException" * "DocDBElastic.Client.exceptions.ValidationException" * "DocDBElastic.Client.exceptions.InternalServerException" * "DocDBElastic.Client.exceptions.AccessDeniedException"