Table of Contents
DocDB.Client¶A low-level client representing Amazon DocumentDB with MongoDB compatibility (DocDB)
Amazon DocumentDB API documentation
import boto3
client = boto3.client('docdb')
These are the available methods:
add_source_identifier_to_subscription()add_tags_to_resource()apply_pending_maintenance_action()can_paginate()close()copy_db_cluster_parameter_group()copy_db_cluster_snapshot()create_db_cluster()create_db_cluster_parameter_group()create_db_cluster_snapshot()create_db_instance()create_db_subnet_group()create_event_subscription()create_global_cluster()delete_db_cluster()delete_db_cluster_parameter_group()delete_db_cluster_snapshot()delete_db_instance()delete_db_subnet_group()delete_event_subscription()delete_global_cluster()describe_certificates()describe_db_cluster_parameter_groups()describe_db_cluster_parameters()describe_db_cluster_snapshot_attributes()describe_db_cluster_snapshots()describe_db_clusters()describe_db_engine_versions()describe_db_instances()describe_db_subnet_groups()describe_engine_default_cluster_parameters()describe_event_categories()describe_event_subscriptions()describe_events()describe_global_clusters()describe_orderable_db_instance_options()describe_pending_maintenance_actions()failover_db_cluster()get_paginator()get_waiter()list_tags_for_resource()modify_db_cluster()modify_db_cluster_parameter_group()modify_db_cluster_snapshot_attribute()modify_db_instance()modify_db_subnet_group()modify_event_subscription()modify_global_cluster()reboot_db_instance()remove_from_global_cluster()remove_source_identifier_from_subscription()remove_tags_from_resource()reset_db_cluster_parameter_group()restore_db_cluster_from_snapshot()restore_db_cluster_to_point_in_time()start_db_cluster()stop_db_cluster()add_source_identifier_to_subscription(**kwargs)¶Adds a source identifier to an existing event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.add_source_identifier_to_subscription(
SubscriptionName='string',
SourceIdentifier='string'
)
[REQUIRED]
The name of the Amazon DocumentDB event notification subscription that you want to add a source identifier to.
[REQUIRED]
The identifier of the event source to be added:
DBInstanceIdentifier must be provided.DBSecurityGroupName must be provided.DBParameterGroupName must be provided.DBSnapshotIdentifier must be provided.dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Detailed information about an event to which you have subscribed.
CustomerAwsId (string) --
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
CustSubscriptionId (string) --
The Amazon DocumentDB event notification subscription ID.
SnsTopicArn (string) --
The topic ARN of the Amazon DocumentDB event notification subscription.
Status (string) --
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating , modifying , deleting , active , no-permission , topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time at which the Amazon DocumentDB event notification subscription was created.
SourceType (string) --
The source type for the Amazon DocumentDB event notification subscription.
SourceIdsList (list) --
A list of source IDs for the Amazon DocumentDB event notification subscription.
EventCategoriesList (list) --
A list of event categories for the Amazon DocumentDB event notification subscription.
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
DocDB.Client.exceptions.SubscriptionNotFoundFaultDocDB.Client.exceptions.SourceNotFoundFaultAdds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .
[REQUIRED]
The tags to be assigned to the Amazon DocumentDB resource.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
None
Exceptions
DocDB.Client.exceptions.DBInstanceNotFoundFaultDocDB.Client.exceptions.DBSnapshotNotFoundFaultDocDB.Client.exceptions.DBClusterNotFoundFaultapply_pending_maintenance_action(**kwargs)¶Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
See also: AWS API Documentation
Request Syntax
response = client.apply_pending_maintenance_action(
ResourceIdentifier='string',
ApplyAction='string',
OptInType='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.
[REQUIRED]
The pending maintenance action to apply to this resource.
Valid values: system-update , db-upgrade
[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.
Valid values:
immediate - Apply the maintenance action immediately.next-maintenance - Apply the maintenance action during the next maintenance window for the resource.undo-opt-in - Cancel any existing next-maintenance opt-in requests.dict
Response Syntax
{
'ResourcePendingMaintenanceActions': {
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
}
}
Response Structure
(dict) --
ResourcePendingMaintenanceActions (dict) --
Represents the output of ApplyPendingMaintenanceAction .
ResourceIdentifier (string) --
The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.
PendingMaintenanceActionDetails (list) --
A list that provides details about the pending maintenance actions for the resource.
(dict) --
Provides information about a pending maintenance action for a resource.
Action (string) --
The type of pending maintenance action that is available for the resource.
AutoAppliedAfterDate (datetime) --
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 opt-in requests are ignored.
ForcedApplyDate (datetime) --
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 opt-in requests are ignored.
OptInStatus (string) --
Indicates the type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
The effective date when the pending maintenance action is applied to the resource.
Description (string) --
A description providing more detail about the maintenance action.
Exceptions
DocDB.Client.exceptions.ResourceNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidDBInstanceStateFaultcan_paginate(operation_name)¶Check if an operation can be paginated.
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").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
copy_db_cluster_parameter_group(**kwargs)¶Copies the specified cluster parameter group.
See also: AWS API Documentation
Request Syntax
response = client.copy_db_cluster_parameter_group(
SourceDBClusterParameterGroupIdentifier='string',
TargetDBClusterParameterGroupIdentifier='string',
TargetDBClusterParameterGroupDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.
Constraints:
my-db-cluster-param-group , or a valid ARN.arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group .[REQUIRED]
The identifier for the copied cluster parameter group.
Constraints:
Example: my-cluster-param-group1
[REQUIRED]
A description for the copied cluster parameter group.
The tags that are to be assigned to the parameter group.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
dict
Response Syntax
{
'DBClusterParameterGroup': {
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
}
}
Response Structure
(dict) --
DBClusterParameterGroup (dict) --
Detailed information about a cluster parameter group.
DBClusterParameterGroupName (string) --
Provides the name of the cluster parameter group.
DBParameterGroupFamily (string) --
Provides the name of the parameter group family that this cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the cluster parameter group.
Exceptions
DocDB.Client.exceptions.DBParameterGroupNotFoundFaultDocDB.Client.exceptions.DBParameterGroupQuotaExceededFaultDocDB.Client.exceptions.DBParameterGroupAlreadyExistsFaultcopy_db_cluster_snapshot(**kwargs)¶Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
See also: AWS API Documentation
Request Syntax
response = client.copy_db_cluster_snapshot(
SourceDBClusterSnapshotIdentifier='string',
TargetDBClusterSnapshotIdentifier='string',
KmsKeyId='string',
CopyTags=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SourceRegion='string'
)
[REQUIRED]
The identifier of the cluster snapshot to copy. This parameter is not case sensitive.
Constraints:
Example: my-cluster-snapshot1
[REQUIRED]
The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.
Constraints:
Example: my-cluster-snapshot2
The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you copy an encrypted cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId , then the copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot.
If you copy an encrypted cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId .
To copy an encrypted cluster snapshot to another Amazon Web Services Region, set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. 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 cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
The URL that contains a Signature Version 4 signed request for the``CopyDBClusterSnapshot`` API action in the Amazon Web Services Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another Amazon Web Services Region.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:
SourceRegion - The ID of the region that contains the snapshot to be copied.SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot .TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false . The default is false .The tags to be assigned to the cluster snapshot.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
dict
Response Syntax
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string'
}
}
Response Structure
(dict) --
DBClusterSnapshot (dict) --
Detailed information about a cluster snapshot.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the cluster snapshot.
DBClusterIdentifier (string) --
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in UTC.
Engine (string) --
Specifies the name of the database engine.
Status (string) --
Specifies the status of this cluster snapshot.
Port (integer) --
Specifies the port that the cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master user name for the cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this cluster snapshot.
SnapshotType (string) --
Provides the type of the cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
Exceptions
DocDB.Client.exceptions.DBClusterSnapshotAlreadyExistsFaultDocDB.Client.exceptions.DBClusterSnapshotNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidDBClusterSnapshotStateFaultDocDB.Client.exceptions.SnapshotQuotaExceededFaultDocDB.Client.exceptions.KMSKeyNotAccessibleFaultcreate_db_cluster(**kwargs)¶Creates a new Amazon DocumentDB cluster.
See also: AWS API Documentation
Request Syntax
response = client.create_db_cluster(
AvailabilityZones=[
'string',
],
BackupRetentionPeriod=123,
DBClusterIdentifier='string',
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
DBSubnetGroupName='string',
Engine='string',
EngineVersion='string',
Port=123,
MasterUsername='string',
MasterUserPassword='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageEncrypted=True|False,
KmsKeyId='string',
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False,
GlobalClusterIdentifier='string',
SourceRegion='string'
)
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
[REQUIRED]
The cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster
A list of EC2 VPC security groups to associate with this cluster.
A subnet group to associate with this cluster.
Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.
Example: mySubnetgroup
[REQUIRED]
The name of the database engine to be used for this cluster.
Valid values: docdb
--engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.The name of the master user for the cluster.
Constraints:
The password for the master database user. 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.
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
Constraints:
hh24:mi-hh24:mi .The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is 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.
The tags to be assigned to the cluster.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The KMS key identifier for an encrypted 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 Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key is not specified in KmsKeyId :
StorageEncrypted parameter is true , Amazon DocumentDB uses your default encryption key.KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
Not currently supported.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterAlreadyExistsFaultDocDB.Client.exceptions.InsufficientStorageClusterCapacityFaultDocDB.Client.exceptions.DBClusterQuotaExceededFaultDocDB.Client.exceptions.StorageQuotaExceededFaultDocDB.Client.exceptions.DBSubnetGroupNotFoundFaultDocDB.Client.exceptions.InvalidVPCNetworkStateFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidDBSubnetGroupStateFaultDocDB.Client.exceptions.InvalidSubnetDocDB.Client.exceptions.InvalidDBInstanceStateFaultDocDB.Client.exceptions.DBClusterParameterGroupNotFoundFaultDocDB.Client.exceptions.KMSKeyNotAccessibleFaultDocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.DBInstanceNotFoundFaultDocDB.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsDocDB.Client.exceptions.GlobalClusterNotFoundFaultDocDB.Client.exceptions.InvalidGlobalClusterStateFaultcreate_db_cluster_parameter_group(**kwargs)¶Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group , modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups .
See also: AWS API Documentation
Request Syntax
response = client.create_db_cluster_parameter_group(
DBClusterParameterGroupName='string',
DBParameterGroupFamily='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the cluster parameter group.
Constraints:
DBClusterParameterGroup .Note
This value is stored as a lowercase string.
[REQUIRED]
The cluster parameter group family name.
[REQUIRED]
The description for the cluster parameter group.
The tags to be assigned to the cluster parameter group.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
dict
Response Syntax
{
'DBClusterParameterGroup': {
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
}
}
Response Structure
(dict) --
DBClusterParameterGroup (dict) --
Detailed information about a cluster parameter group.
DBClusterParameterGroupName (string) --
Provides the name of the cluster parameter group.
DBParameterGroupFamily (string) --
Provides the name of the parameter group family that this cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the cluster parameter group.
Exceptions
DocDB.Client.exceptions.DBParameterGroupQuotaExceededFaultDocDB.Client.exceptions.DBParameterGroupAlreadyExistsFaultcreate_db_cluster_snapshot(**kwargs)¶Creates a snapshot of a cluster.
See also: AWS API Documentation
Request Syntax
response = client.create_db_cluster_snapshot(
DBClusterSnapshotIdentifier='string',
DBClusterIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier of the cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster-snapshot1
[REQUIRED]
The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.
Constraints:
DBCluster .Example: my-cluster
The tags to be assigned to the cluster snapshot.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
dict
Response Syntax
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string'
}
}
Response Structure
(dict) --
DBClusterSnapshot (dict) --
Detailed information about a cluster snapshot.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the cluster snapshot.
DBClusterIdentifier (string) --
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in UTC.
Engine (string) --
Specifies the name of the database engine.
Status (string) --
Specifies the status of this cluster snapshot.
Port (integer) --
Specifies the port that the cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master user name for the cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this cluster snapshot.
SnapshotType (string) --
Provides the type of the cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
Exceptions
DocDB.Client.exceptions.DBClusterSnapshotAlreadyExistsFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.SnapshotQuotaExceededFaultDocDB.Client.exceptions.InvalidDBClusterSnapshotStateFaultcreate_db_instance(**kwargs)¶Creates a new instance.
See also: AWS API Documentation
Request Syntax
response = client.create_db_instance(
DBInstanceIdentifier='string',
DBInstanceClass='string',
Engine='string',
AvailabilityZone='string',
PreferredMaintenanceWindow='string',
AutoMinorVersionUpgrade=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DBClusterIdentifier='string',
CopyTagsToSnapshot=True|False,
PromotionTier=123,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string'
)
[REQUIRED]
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
[REQUIRED]
The compute and memory capacity of the instance; for example, db.r5.large .
[REQUIRED]
The name of the database engine to be used for this instance.
Valid value: docdb
The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is 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.
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
[REQUIRED]
The identifier of the cluster that the instance will belong to.
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
]
}
}
Response Structure
(dict) --
DBInstance (dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included , bring-your-own-license , general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently "read replication ."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
Exceptions
DocDB.Client.exceptions.DBInstanceAlreadyExistsFaultDocDB.Client.exceptions.InsufficientDBInstanceCapacityFaultDocDB.Client.exceptions.DBParameterGroupNotFoundFaultDocDB.Client.exceptions.DBSecurityGroupNotFoundFaultDocDB.Client.exceptions.InstanceQuotaExceededFaultDocDB.Client.exceptions.StorageQuotaExceededFaultDocDB.Client.exceptions.DBSubnetGroupNotFoundFaultDocDB.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidSubnetDocDB.Client.exceptions.InvalidVPCNetworkStateFaultDocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.StorageTypeNotSupportedFaultDocDB.Client.exceptions.AuthorizationNotFoundFaultDocDB.Client.exceptions.KMSKeyNotAccessibleFaultcreate_db_subnet_group(**kwargs)¶Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.create_db_subnet_group(
DBSubnetGroupName='string',
DBSubnetGroupDescription='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name for the subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
[REQUIRED]
The description for the subnet group.
[REQUIRED]
The Amazon EC2 subnet IDs for the subnet group.
The tags to be assigned to the subnet group.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
dict
Response Syntax
{
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
}
}
Response Structure
(dict) --
DBSubnetGroup (dict) --
Detailed information about a subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
Exceptions
DocDB.Client.exceptions.DBSubnetGroupAlreadyExistsFaultDocDB.Client.exceptions.DBSubnetGroupQuotaExceededFaultDocDB.Client.exceptions.DBSubnetQuotaExceededFaultDocDB.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsDocDB.Client.exceptions.InvalidSubnetcreate_event_subscription(**kwargs)¶Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType ) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds ) that trigger the events, and you can provide a list of event categories (EventCategories ) for events that you want to be notified of. For example, you can specify SourceType = db-instance , SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup .
If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1 ), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier , you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier , you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
See also: AWS API Documentation
Request Syntax
response = client.create_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
SourceIds=[
'string',
],
Enabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the subscription.
Constraints: The name must be fewer than 255 characters.
[REQUIRED]
The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance . If this value is not specified, all events are returned.
Valid values: db-instance , db-cluster , db-parameter-group , db-security-group , db-cluster-snapshot
A list of event categories for a SourceType that you want to subscribe to.
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
Constraints:
SourceIds are provided, SourceType must also be provided.DBInstanceIdentifier must be provided.DBSecurityGroupName must be provided.DBParameterGroupName must be provided.DBSnapshotIdentifier must be provided.true to activate the subscription, set to false to create the subscription but not active it.The tags to be assigned to the event subscription.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Detailed information about an event to which you have subscribed.
CustomerAwsId (string) --
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
CustSubscriptionId (string) --
The Amazon DocumentDB event notification subscription ID.
SnsTopicArn (string) --
The topic ARN of the Amazon DocumentDB event notification subscription.
Status (string) --
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating , modifying , deleting , active , no-permission , topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time at which the Amazon DocumentDB event notification subscription was created.
SourceType (string) --
The source type for the Amazon DocumentDB event notification subscription.
SourceIdsList (list) --
A list of source IDs for the Amazon DocumentDB event notification subscription.
EventCategoriesList (list) --
A list of event categories for the Amazon DocumentDB event notification subscription.
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
DocDB.Client.exceptions.EventSubscriptionQuotaExceededFaultDocDB.Client.exceptions.SubscriptionAlreadyExistFaultDocDB.Client.exceptions.SNSInvalidTopicFaultDocDB.Client.exceptions.SNSNoAuthorizationFaultDocDB.Client.exceptions.SNSTopicArnNotFoundFaultDocDB.Client.exceptions.SubscriptionCategoryNotFoundFaultDocDB.Client.exceptions.SourceNotFoundFaultcreate_global_cluster(**kwargs)¶Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
Note
This action only applies to Amazon DocumentDB clusters.
See also: AWS API Documentation
Request Syntax
response = client.create_global_cluster(
GlobalClusterIdentifier='string',
SourceDBClusterIdentifier='string',
Engine='string',
EngineVersion='string',
DeletionProtection=True|False,
DatabaseName='string',
StorageEncrypted=True|False
)
[REQUIRED]
The cluster identifier of the new global cluster.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
Exceptions
DocDB.Client.exceptions.GlobalClusterAlreadyExistsFaultDocDB.Client.exceptions.GlobalClusterQuotaExceededFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.DBClusterNotFoundFaultdelete_db_cluster(**kwargs)¶Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_cluster(
DBClusterIdentifier='string',
SkipFinalSnapshot=True|False,
FinalDBSnapshotIdentifier='string'
)
[REQUIRED]
The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
Constraints:
DBClusterIdentifier .Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.
Note
If SkipFinalSnapshot is false , you must specify a FinalDBSnapshotIdentifier parameter.
Default: false
The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false .
Note
Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
Constraints:
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.DBClusterSnapshotAlreadyExistsFaultDocDB.Client.exceptions.SnapshotQuotaExceededFaultDocDB.Client.exceptions.InvalidDBClusterSnapshotStateFaultdelete_db_cluster_parameter_group(**kwargs)¶Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_cluster_parameter_group(
DBClusterParameterGroupName='string'
)
[REQUIRED]
The name of the cluster parameter group.
Constraints:
Exceptions
DocDB.Client.exceptions.InvalidDBParameterGroupStateFaultDocDB.Client.exceptions.DBParameterGroupNotFoundFaultdelete_db_cluster_snapshot(**kwargs)¶Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
Note
The cluster snapshot must be in the available state to be deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_cluster_snapshot(
DBClusterSnapshotIdentifier='string'
)
[REQUIRED]
The identifier of the cluster snapshot to delete.
Constraints: Must be the name of an existing cluster snapshot in the available state.
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string'
}
}
Response Structure
Detailed information about a cluster snapshot.
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
Specifies the identifier for the cluster snapshot.
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
Provides the time when the snapshot was taken, in UTC.
Specifies the name of the database engine.
Specifies the status of this cluster snapshot.
Specifies the port that the cluster was listening on at the time of the snapshot.
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
Provides the master user name for the cluster snapshot.
Provides the version of the database engine for this cluster snapshot.
Provides the type of the cluster snapshot.
Specifies the percentage of the estimated data that has been transferred.
Specifies whether the cluster snapshot is encrypted.
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot.
The Amazon Resource Name (ARN) for the cluster snapshot.
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
Exceptions
DocDB.Client.exceptions.InvalidDBClusterSnapshotStateFaultDocDB.Client.exceptions.DBClusterSnapshotNotFoundFaultdelete_db_instance(**kwargs)¶Deletes a previously provisioned instance.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_instance(
DBInstanceIdentifier='string'
)
[REQUIRED]
The instance identifier for the instance to be deleted. This parameter isn't case sensitive.
Constraints:
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
]
}
}
Response Structure
Detailed information about an instance.
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
Contains the name of the compute and memory capacity class of the instance.
Provides the name of the database engine to be used for this instance.
Specifies the current state of this database.
Specifies the connection endpoint.
Specifies the DNS address of the instance.
Specifies the port that the database engine is listening on.
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Provides the date and time that the instance was created.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the number of days for which automatic snapshots are retained.
Provides a list of VPC security group elements that the instance belongs to.
Used as a response element for queries on virtual private cloud (VPC) security group membership.
The name of the VPC security group.
The status of the VPC security group.
Specifies the name of the Availability Zone that the instance is located in.
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
The name of the subnet group.
Provides the description of the subnet group.
Provides the virtual private cloud (VPC) ID of the subnet group.
Provides the status of the subnet group.
Detailed information about one or more subnets within a subnet group.
Detailed information about a subnet.
Specifies the identifier of the subnet.
Specifies the Availability Zone for the subnet.
The name of the Availability Zone.
Specifies the status of the subnet.
The Amazon Resource Name (ARN) for the DB subnet group.
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
Contains the pending or currently in-progress change of the master credentials for the instance.
Specifies the pending port for the instance.
Specifies the pending number of days for which automated backups are retained.
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
Indicates the database engine version.
The license model for the instance.
Valid values: license-included , bring-your-own-license , general-public-license
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
Specifies the storage type to be associated with the instance.
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
The new subnet group for the instance.
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
Specifies the latest time to which a database can be restored with point-in-time restore.
Indicates the database engine version.
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .
The status of a read replica. If the instance is not a read replica, this is blank.
Provides a list of status information for an instance.
This value is currently "read replication ."
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
Specifies whether or not the instance is encrypted.
If StorageEncrypted is true , the KMS key identifier for the encrypted instance.
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
The identifier of the CA certificate for this DB instance.
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
The Amazon Resource Name (ARN) for the instance.
A list of log types that this instance is configured to export to CloudWatch Logs.
Exceptions
DocDB.Client.exceptions.DBInstanceNotFoundFaultDocDB.Client.exceptions.InvalidDBInstanceStateFaultDocDB.Client.exceptions.DBSnapshotAlreadyExistsFaultDocDB.Client.exceptions.SnapshotQuotaExceededFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultdelete_db_subnet_group(**kwargs)¶Deletes a subnet group.
Note
The specified database subnet group must not be associated with any DB instances.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_subnet_group(
DBSubnetGroupName='string'
)
[REQUIRED]
The name of the database subnet group to delete.
Note
You can't delete the default subnet group.
Constraints:
Must match the name of an existing DBSubnetGroup . Must not be default.
Example: mySubnetgroup
Exceptions
DocDB.Client.exceptions.InvalidDBSubnetGroupStateFaultDocDB.Client.exceptions.InvalidDBSubnetStateFaultDocDB.Client.exceptions.DBSubnetGroupNotFoundFaultdelete_event_subscription(**kwargs)¶Deletes an Amazon DocumentDB event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_subscription(
SubscriptionName='string'
)
[REQUIRED]
The name of the Amazon DocumentDB event notification subscription that you want to delete.
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
Detailed information about an event to which you have subscribed.
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
The Amazon DocumentDB event notification subscription ID.
The topic ARN of the Amazon DocumentDB event notification subscription.
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating , modifying , deleting , active , no-permission , topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
The time at which the Amazon DocumentDB event notification subscription was created.
The source type for the Amazon DocumentDB event notification subscription.
A list of source IDs for the Amazon DocumentDB event notification subscription.
A list of event categories for the Amazon DocumentDB event notification subscription.
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
DocDB.Client.exceptions.SubscriptionNotFoundFaultDocDB.Client.exceptions.InvalidEventSubscriptionStateFaultdelete_global_cluster(**kwargs)¶Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
Note
This action only applies to Amazon DocumentDB clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_global_cluster(
GlobalClusterIdentifier='string'
)
[REQUIRED]
The cluster identifier of the global cluster being deleted.
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
A data type representing an Amazon DocumentDB global cluster.
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
The Amazon Resource Name (ARN) for the global cluster.
Specifies the current state of this global cluster.
The Amazon DocumentDB database engine used by the global cluster.
Indicates the database engine version.
The default database name within the new global cluster.
The storage encryption setting for the global cluster.
The deletion protection setting for the new global cluster.
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
Exceptions
DocDB.Client.exceptions.GlobalClusterNotFoundFaultDocDB.Client.exceptions.InvalidGlobalClusterStateFaultdescribe_certificates(**kwargs)¶Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.describe_certificates(
CertificateIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.
Constraints
CertificateIdentifier .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints:
DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .dict
Response Syntax
{
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateType': 'string',
'Thumbprint': 'string',
'ValidFrom': datetime(2015, 1, 1),
'ValidTill': datetime(2015, 1, 1),
'CertificateArn': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Certificates (list) --
A list of certificates for this Amazon Web Services account.
(dict) --
A certificate authority (CA) certificate for an Amazon Web Services account.
CertificateIdentifier (string) --
The unique key that identifies a certificate.
Example: rds-ca-2019
CertificateType (string) --
The type of the certificate.
Example: CA
Thumbprint (string) --
The thumbprint of the certificate.
ValidFrom (datetime) --
The starting date-time from which the certificate is valid.
Example: 2019-07-31T17:57:09Z
ValidTill (datetime) --
The date-time after which the certificate is no longer valid.
Example: 2024-07-31T17:57:09Z
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
Marker (string) --
An optional pagination token provided if the number of records retrieved is greater than MaxRecords . If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.
Exceptions
DocDB.Client.exceptions.CertificateNotFoundFaultdescribe_db_cluster_parameter_groups(**kwargs)¶Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_parameter_groups(
DBClusterParameterGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The name of a specific cluster parameter group to return details for.
Constraints:
DBClusterParameterGroup .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'DBClusterParameterGroups': [
{
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of DBClusterParameterGroups .
Marker (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 MaxRecords .
DBClusterParameterGroups (list) --
A list of cluster parameter groups.
(dict) --
Detailed information about a cluster parameter group.
DBClusterParameterGroupName (string) --
Provides the name of the cluster parameter group.
DBParameterGroupFamily (string) --
Provides the name of the parameter group family that this cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the cluster parameter group.
Exceptions
DocDB.Client.exceptions.DBParameterGroupNotFoundFaultdescribe_db_cluster_parameters(**kwargs)¶Returns the detailed parameter list for a particular cluster parameter group.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_parameters(
DBClusterParameterGroupName='string',
Source='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of a specific cluster parameter group to return parameter details for.
Constraints:
DBClusterParameterGroup .engine , service , or customer .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Represents the output of DBClusterParameterGroup .
Parameters (list) --
Provides a list of parameters for the cluster parameter group.
(dict) --
Detailed information about an individual parameter.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine-specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
Marker (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 MaxRecords .
Exceptions
DocDB.Client.exceptions.DBParameterGroupNotFoundFaultdescribe_db_cluster_snapshot_attributes(**kwargs)¶Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_snapshot_attributes(
DBClusterSnapshotIdentifier='string'
)
[REQUIRED]
The identifier for the cluster snapshot to describe the attributes for.
{
'DBClusterSnapshotAttributesResult': {
'DBClusterSnapshotIdentifier': 'string',
'DBClusterSnapshotAttributes': [
{
'AttributeName': 'string',
'AttributeValues': [
'string',
]
},
]
}
}
Response Structure
Detailed information about the attributes that are associated with a cluster snapshot.
The identifier of the cluster snapshot that the attributes apply to.
The list of attributes and values for the cluster snapshot.
Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.
The name of the manual cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.
The values for the manual cluster snapshot attribute.
If the AttributeName field is set to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
Exceptions
DocDB.Client.exceptions.DBClusterSnapshotNotFoundFaultdescribe_db_cluster_snapshots(**kwargs)¶Returns information about cluster snapshots. This API operation supports pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_snapshots(
DBClusterIdentifier='string',
DBClusterSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False
)
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
Constraints:
DBCluster .A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
DBClusterSnapshot .SnapshotType parameter must also be specified.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.shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.public - Return all cluster snapshots that have been marked as public.If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true . You can include public cluster snapshots with these results by setting the``IncludePublic`` parameter to true .
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false . The default is false .true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false . The default is false .dict
Response Syntax
{
'Marker': 'string',
'DBClusterSnapshots': [
{
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBClusterSnapshots .
Marker (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 MaxRecords .
DBClusterSnapshots (list) --
Provides a list of cluster snapshots.
(dict) --
Detailed information about a cluster snapshot.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the cluster snapshot.
DBClusterIdentifier (string) --
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in UTC.
Engine (string) --
Specifies the name of the database engine.
Status (string) --
Specifies the status of this cluster snapshot.
Port (integer) --
Specifies the port that the cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master user name for the cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this cluster snapshot.
SnapshotType (string) --
Provides the type of the cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
Exceptions
DocDB.Client.exceptions.DBClusterSnapshotNotFoundFaultdescribe_db_clusters(**kwargs)¶Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_clusters(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.
Constraints:
DBClusterIdentifier .A filter that specifies one or more clusters to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'DBClusters': [
{
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBClusters .
Marker (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 MaxRecords .
DBClusters (list) --
A list of clusters.
(dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterNotFoundFaultdescribe_db_engine_versions(**kwargs)¶Returns a list of the available engines.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_engine_versions(
Engine='string',
EngineVersion='string',
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
DefaultOnly=True|False,
ListSupportedCharacterSets=True|False,
ListSupportedTimezones=True|False
)
The database engine version to return.
Example: 3.6.0
The name of a specific parameter group family to return details for.
Constraints:
DBParameterGroupFamily .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .CharacterSetName parameter for CreateDBInstance , the response includes a list of supported character sets for each engine version.TimeZone parameter for CreateDBInstance , the response includes a list of supported time zones for each engine version.dict
Response Syntax
{
'Marker': 'string',
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBEngineVersions .
Marker (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 MaxRecords .
DBEngineVersions (list) --
Detailed information about one or more engine versions.
(dict) --
Detailed information about an engine version.
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that an instance can be upgraded to.
Engine (string) --
The name of the upgrade target database engine.
EngineVersion (string) --
The version number of the upgrade target database engine.
Description (string) --
The version of the database engine that an instance can be upgraded to.
AutoUpgrade (boolean) --
A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true .
IsMajorVersionUpgrade (boolean) --
A value that indicates whether a database engine is upgraded to a major version.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
describe_db_instances(**kwargs)¶Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_instances(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
Constraints:
DBInstance .A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'DBInstances': [
{
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
]
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBInstances .
Marker (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 MaxRecords .
DBInstances (list) --
Detailed information about one or more instances.
(dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included , bring-your-own-license , general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently "read replication ."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
Exceptions
DocDB.Client.exceptions.DBInstanceNotFoundFaultdescribe_db_subnet_groups(**kwargs)¶Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup .
See also: AWS API Documentation
Request Syntax
response = client.describe_db_subnet_groups(
DBSubnetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'DBSubnetGroups': [
{
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBSubnetGroups .
Marker (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 MaxRecords .
DBSubnetGroups (list) --
Detailed information about one or more subnet groups.
(dict) --
Detailed information about a subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
Exceptions
DocDB.Client.exceptions.DBSubnetGroupNotFoundFaultdescribe_engine_default_cluster_parameters(**kwargs)¶Returns the default engine and system parameter information for the cluster database engine.
See also: AWS API Documentation
Request Syntax
response = client.describe_engine_default_cluster_parameters(
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of the cluster parameter group family to return the engine parameter information for.
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'EngineDefaults': {
'DBParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot'
},
]
}
}
Response Structure
(dict) --
EngineDefaults (dict) --
Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.
DBParameterGroupFamily (string) --
The name of the cluster parameter group family to return the engine parameter information for.
Marker (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 MaxRecords .
Parameters (list) --
The parameters of a particular cluster parameter group family.
(dict) --
Detailed information about an individual parameter.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine-specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
describe_event_categories(**kwargs)¶Displays a list of categories for all event source types, or, if specified, for a specified source type.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_categories(
SourceType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The type of source that is generating the events.
Valid values: db-instance , db-parameter-group , db-security-group
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
dict
Response Syntax
{
'EventCategoriesMapList': [
{
'SourceType': 'string',
'EventCategories': [
'string',
]
},
]
}
Response Structure
(dict) --
Represents the output of DescribeEventCategories .
EventCategoriesMapList (list) --
A list of event category maps.
(dict) --
An event source type, accompanied by one or more event category names.
SourceType (string) --
The source type that the returned categories belong to.
EventCategories (list) --
The event categories for the specified source type.
describe_event_subscriptions(**kwargs)¶Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName , SNSTopicARN , CustomerID , SourceType , SourceID , CreationTime , and Status .
If you specify a SubscriptionName , lists the description for that subscription.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_subscriptions(
SubscriptionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of DescribeEventSubscriptions .
Marker (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 MaxRecords .
EventSubscriptionsList (list) --
A list of event subscriptions.
(dict) --
Detailed information about an event to which you have subscribed.
CustomerAwsId (string) --
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
CustSubscriptionId (string) --
The Amazon DocumentDB event notification subscription ID.
SnsTopicArn (string) --
The topic ARN of the Amazon DocumentDB event notification subscription.
Status (string) --
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating , modifying , deleting , active , no-permission , topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time at which the Amazon DocumentDB event notification subscription was created.
SourceType (string) --
The source type for the Amazon DocumentDB event notification subscription.
SourceIdsList (list) --
A list of source IDs for the Amazon DocumentDB event notification subscription.
EventCategoriesList (list) --
A list of event categories for the Amazon DocumentDB event notification subscription.
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
DocDB.Client.exceptions.SubscriptionNotFoundFaultdescribe_events(**kwargs)¶Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_events(
SourceIdentifier='string',
SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
EventCategories=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
SourceIdentifier is provided, SourceType must also be provided.DBInstance , a DBInstanceIdentifier must be provided.DBSecurityGroup , a DBSecurityGroupName must be provided.DBParameterGroup , a DBParameterGroupName must be provided.DBSnapshot , a DBSnapshotIdentifier must be provided.The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
The number of minutes to retrieve events for.
Default: 60
A list of event categories that trigger notifications for an event notification subscription.
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
'Message': 'string',
'EventCategories': [
'string',
],
'Date': datetime(2015, 1, 1),
'SourceArn': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of DescribeEvents .
Marker (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 MaxRecords .
Events (list) --
Detailed information about one or more events.
(dict) --
Detailed information about an event.
SourceIdentifier (string) --
Provides the identifier for the source of the event.
SourceType (string) --
Specifies the source type for this event.
Message (string) --
Provides the text of this event.
EventCategories (list) --
Specifies the category for the event.
Date (datetime) --
Specifies the date and time of the event.
SourceArn (string) --
The Amazon Resource Name (ARN) for the event.
describe_global_clusters(**kwargs)¶Returns information about Amazon DocumentDB global clusters. This API supports pagination.
Note
This action only applies to Amazon DocumentDB clusters.
See also: AWS API Documentation
Request Syntax
response = client.describe_global_clusters(
GlobalClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'GlobalClusters': [
{
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
},
]
}
Response Structure
(dict) --
Marker (string) --
GlobalClusters (list) --
(dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
Exceptions
DocDB.Client.exceptions.GlobalClusterNotFoundFaultdescribe_orderable_db_instance_options(**kwargs)¶Returns a list of orderable instance options for the specified engine.
See also: AWS API Documentation
Request Syntax
response = client.describe_orderable_db_instance_options(
Engine='string',
EngineVersion='string',
DBInstanceClass='string',
LicenseModel='string',
Vpc=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of the engine to retrieve instance options for.
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'OrderableDBInstanceOptions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBInstanceClass': 'string',
'LicenseModel': 'string',
'AvailabilityZones': [
{
'Name': 'string'
},
],
'Vpc': True|False
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeOrderableDBInstanceOptions .
OrderableDBInstanceOptions (list) --
The options that are available for a particular orderable instance.
(dict) --
The options that are available for an instance.
Engine (string) --
The engine type of an instance.
EngineVersion (string) --
The engine version of an instance.
DBInstanceClass (string) --
The instance class for an instance.
LicenseModel (string) --
The license model for an instance.
AvailabilityZones (list) --
A list of Availability Zones for an instance.
(dict) --
Information about an Availability Zone.
Name (string) --
The name of the Availability Zone.
Vpc (boolean) --
Indicates whether an instance is in a virtual private cloud (VPC).
Marker (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 MaxRecords .
describe_pending_maintenance_actions(**kwargs)¶Returns a list of resources (for example, instances) that have at least one pending maintenance action.
See also: AWS API Documentation
Request Syntax
response = client.describe_pending_maintenance_actions(
ResourceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
MaxRecords .The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'PendingMaintenanceActions': [
{
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Represents the output of DescribePendingMaintenanceActions .
PendingMaintenanceActions (list) --
The maintenance actions to be applied.
(dict) --
Represents the output of ApplyPendingMaintenanceAction .
ResourceIdentifier (string) --
The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.
PendingMaintenanceActionDetails (list) --
A list that provides details about the pending maintenance actions for the resource.
(dict) --
Provides information about a pending maintenance action for a resource.
Action (string) --
The type of pending maintenance action that is available for the resource.
AutoAppliedAfterDate (datetime) --
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 opt-in requests are ignored.
ForcedApplyDate (datetime) --
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 opt-in requests are ignored.
OptInStatus (string) --
Indicates the type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
The effective date when the pending maintenance action is applied to the resource.
Description (string) --
A description providing more detail about the maintenance action.
Marker (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 MaxRecords .
Exceptions
DocDB.Client.exceptions.ResourceNotFoundFaultfailover_db_cluster(**kwargs)¶Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
See also: AWS API Documentation
Request Syntax
response = client.failover_db_cluster(
DBClusterIdentifier='string',
TargetDBInstanceIdentifier='string'
)
A cluster identifier to force a failover for. This parameter is not case sensitive.
Constraints:
DBCluster .The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1 .
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidDBInstanceStateFaultget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
Lists all tags on an Amazon DocumentDB resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
[REQUIRED]
The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
dict
Response Syntax
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of ListTagsForResource .
TagList (list) --
A list of one or more tags.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Exceptions
DocDB.Client.exceptions.DBInstanceNotFoundFaultDocDB.Client.exceptions.DBSnapshotNotFoundFaultDocDB.Client.exceptions.DBClusterNotFoundFaultmodify_db_cluster(**kwargs)¶Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster(
DBClusterIdentifier='string',
NewDBClusterIdentifier='string',
ApplyImmediately=True|False,
BackupRetentionPeriod=123,
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Port=123,
MasterUserPassword='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
CloudwatchLogsExportConfiguration={
'EnableLogTypes': [
'string',
],
'DisableLogTypes': [
'string',
]
},
EngineVersion='string',
DeletionProtection=True|False
)
[REQUIRED]
The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.
Constraints:
DBCluster .The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.
Constraints:
Example: my-cluster2
A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false , changes to the cluster are applied during the next maintenance window.
The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false , the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.
Default: false
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
A list of virtual private cloud (VPC) security groups that the cluster will belong to.
The port number on which the cluster accepts connections.
Constraints: Must be a value from 1150 to 65535 .
Default: The same port as the original cluster.
The password for the master database user. 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.
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
Constraints:
hh24:mi-hh24:mi .The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is 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.
The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.
The list of log types to enable.
The list of log types to disable.
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.StorageQuotaExceededFaultDocDB.Client.exceptions.DBSubnetGroupNotFoundFaultDocDB.Client.exceptions.InvalidVPCNetworkStateFaultDocDB.Client.exceptions.InvalidDBSubnetGroupStateFaultDocDB.Client.exceptions.InvalidSubnetDocDB.Client.exceptions.DBClusterParameterGroupNotFoundFaultDocDB.Client.exceptions.InvalidDBSecurityGroupStateFaultDocDB.Client.exceptions.InvalidDBInstanceStateFaultDocDB.Client.exceptions.DBClusterAlreadyExistsFaultmodify_db_cluster_parameter_group(**kwargs)¶Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and ApplyMethod . A maximum of 20 parameters can be modified in a single request.
Note
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
Warning
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster_parameter_group(
DBClusterParameterGroupName='string',
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot'
},
]
)
[REQUIRED]
The name of the cluster parameter group to modify.
[REQUIRED]
A list of parameters in the cluster parameter group to modify.
Detailed information about an individual parameter.
Specifies the name of the parameter.
Specifies the value of the parameter.
Provides a description of the parameter.
Indicates the source of the parameter value.
Specifies the engine-specific parameters type.
Specifies the valid data type for the parameter.
Specifies the valid range of values for the parameter.
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
Indicates when to apply parameter updates.
dict
Response Syntax
{
'DBClusterParameterGroupName': 'string'
}
Response Structure
(dict) --
Contains the name of a cluster parameter group.
DBClusterParameterGroupName (string) --
The name of a cluster parameter group.
Constraints:
Note
This value is stored as a lowercase string.
Exceptions
DocDB.Client.exceptions.DBParameterGroupNotFoundFaultDocDB.Client.exceptions.InvalidDBParameterGroupStateFaultmodify_db_cluster_snapshot_attribute(**kwargs)¶Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName , and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster_snapshot_attribute(
DBClusterSnapshotIdentifier='string',
AttributeName='string',
ValuesToAdd=[
'string',
],
ValuesToRemove=[
'string',
]
)
[REQUIRED]
The identifier for the cluster snapshot to modify the attributes for.
[REQUIRED]
The name of the cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore .
A list of cluster snapshot attributes to add to the attribute specified by AttributeName .
To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all . Do not add the all value for any manual cluster snapshots that contain private information that you don't want to be available to all Amazon Web Services accounts.
A list of cluster snapshot attributes to remove from the attribute specified by AttributeName .
To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all , an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.
dict
Response Syntax
{
'DBClusterSnapshotAttributesResult': {
'DBClusterSnapshotIdentifier': 'string',
'DBClusterSnapshotAttributes': [
{
'AttributeName': 'string',
'AttributeValues': [
'string',
]
},
]
}
}
Response Structure
(dict) --
DBClusterSnapshotAttributesResult (dict) --
Detailed information about the attributes that are associated with a cluster snapshot.
DBClusterSnapshotIdentifier (string) --
The identifier of the cluster snapshot that the attributes apply to.
DBClusterSnapshotAttributes (list) --
The list of attributes and values for the cluster snapshot.
(dict) --
Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.
AttributeName (string) --
The name of the manual cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.
AttributeValues (list) --
The values for the manual cluster snapshot attribute.
If the AttributeName field is set to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
Exceptions
DocDB.Client.exceptions.DBClusterSnapshotNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterSnapshotStateFaultDocDB.Client.exceptions.SharedSnapshotQuotaExceededFaultmodify_db_instance(**kwargs)¶Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_instance(
DBInstanceIdentifier='string',
DBInstanceClass='string',
ApplyImmediately=True|False,
PreferredMaintenanceWindow='string',
AutoMinorVersionUpgrade=True|False,
NewDBInstanceIdentifier='string',
CACertificateIdentifier='string',
CopyTagsToSnapshot=True|False,
PromotionTier=123,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string'
)
[REQUIRED]
The instance identifier. This value is stored as a lowercase string.
Constraints:
DBInstance .The new compute and memory capacity of the instance; for example, db.r5.large . Not all instance classes are available in all Amazon Web Services Regions.
If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting.
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the instance.
If this parameter is set to false , changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true . It occurs during the next maintenance window if you set Apply Immediately to false . This value is stored as a lowercase string.
Constraints:
Example: mydbinstance
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
]
}
}
Response Structure
(dict) --
DBInstance (dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included , bring-your-own-license , general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently "read replication ."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
Exceptions
DocDB.Client.exceptions.InvalidDBInstanceStateFaultDocDB.Client.exceptions.InvalidDBSecurityGroupStateFaultDocDB.Client.exceptions.DBInstanceAlreadyExistsFaultDocDB.Client.exceptions.DBInstanceNotFoundFaultDocDB.Client.exceptions.DBSecurityGroupNotFoundFaultDocDB.Client.exceptions.DBParameterGroupNotFoundFaultDocDB.Client.exceptions.InsufficientDBInstanceCapacityFaultDocDB.Client.exceptions.StorageQuotaExceededFaultDocDB.Client.exceptions.InvalidVPCNetworkStateFaultDocDB.Client.exceptions.DBUpgradeDependencyFailureFaultDocDB.Client.exceptions.StorageTypeNotSupportedFaultDocDB.Client.exceptions.AuthorizationNotFoundFaultDocDB.Client.exceptions.CertificateNotFoundFaultmodify_db_subnet_group(**kwargs)¶Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_subnet_group(
DBSubnetGroupName='string',
DBSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
[REQUIRED]
The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.
Example: mySubnetgroup
[REQUIRED]
The Amazon EC2 subnet IDs for the subnet group.
dict
Response Syntax
{
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
}
}
Response Structure
(dict) --
DBSubnetGroup (dict) --
Detailed information about a subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
Exceptions
DocDB.Client.exceptions.DBSubnetGroupNotFoundFaultDocDB.Client.exceptions.DBSubnetQuotaExceededFaultDocDB.Client.exceptions.SubnetAlreadyInUseDocDB.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsDocDB.Client.exceptions.InvalidSubnetmodify_event_subscription(**kwargs)¶Modifies an existing Amazon DocumentDB event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.modify_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
Enabled=True|False
)
[REQUIRED]
The name of the Amazon DocumentDB event notification subscription.
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, set this parameter to db-instance . If this value is not specified, all events are returned.
Valid values: db-instance , db-parameter-group , db-security-group
A list of event categories for a SourceType that you want to subscribe to.
true to activate the subscription.dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Detailed information about an event to which you have subscribed.
CustomerAwsId (string) --
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
CustSubscriptionId (string) --
The Amazon DocumentDB event notification subscription ID.
SnsTopicArn (string) --
The topic ARN of the Amazon DocumentDB event notification subscription.
Status (string) --
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating , modifying , deleting , active , no-permission , topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time at which the Amazon DocumentDB event notification subscription was created.
SourceType (string) --
The source type for the Amazon DocumentDB event notification subscription.
SourceIdsList (list) --
A list of source IDs for the Amazon DocumentDB event notification subscription.
EventCategoriesList (list) --
A list of event categories for the Amazon DocumentDB event notification subscription.
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
DocDB.Client.exceptions.EventSubscriptionQuotaExceededFaultDocDB.Client.exceptions.SubscriptionNotFoundFaultDocDB.Client.exceptions.SNSInvalidTopicFaultDocDB.Client.exceptions.SNSNoAuthorizationFaultDocDB.Client.exceptions.SNSTopicArnNotFoundFaultDocDB.Client.exceptions.SubscriptionCategoryNotFoundFaultmodify_global_cluster(**kwargs)¶Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
Note
This action only applies to Amazon DocumentDB clusters.
See also: AWS API Documentation
Request Syntax
response = client.modify_global_cluster(
GlobalClusterIdentifier='string',
NewGlobalClusterIdentifier='string',
DeletionProtection=True|False
)
[REQUIRED]
The identifier for the global cluster being modified. This parameter isn't case-sensitive.
Constraints:
The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.
Example: my-cluster2
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
Exceptions
DocDB.Client.exceptions.GlobalClusterNotFoundFaultDocDB.Client.exceptions.InvalidGlobalClusterStateFaultreboot_db_instance(**kwargs)¶You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting .
See also: AWS API Documentation
Request Syntax
response = client.reboot_db_instance(
DBInstanceIdentifier='string',
ForceFailover=True|False
)
[REQUIRED]
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
DBInstance .When true , the reboot is conducted through a Multi-AZ failover.
Constraint: You can't specify true if the instance is not configured for Multi-AZ.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
]
}
}
Response Structure
(dict) --
DBInstance (dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included , bring-your-own-license , general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently "read replication ."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
Exceptions
DocDB.Client.exceptions.InvalidDBInstanceStateFaultDocDB.Client.exceptions.DBInstanceNotFoundFaultremove_from_global_cluster(**kwargs)¶Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
Note
This action only applies to Amazon DocumentDB clusters.
See also: AWS API Documentation
Request Syntax
response = client.remove_from_global_cluster(
GlobalClusterIdentifier='string',
DbClusterIdentifier='string'
)
[REQUIRED]
The cluster identifier to detach from the Amazon DocumentDB global cluster.
[REQUIRED]
The Amazon Resource Name (ARN) identifying the cluster that was detached from the Amazon DocumentDB global cluster.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
Exceptions
DocDB.Client.exceptions.GlobalClusterNotFoundFaultDocDB.Client.exceptions.InvalidGlobalClusterStateFaultDocDB.Client.exceptions.DBClusterNotFoundFaultremove_source_identifier_from_subscription(**kwargs)¶Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.remove_source_identifier_from_subscription(
SubscriptionName='string',
SourceIdentifier='string'
)
[REQUIRED]
The name of the Amazon DocumentDB event notification subscription that you want to remove a source identifier from.
[REQUIRED]
The source identifier to be removed from the subscription, such as the instance identifier for an instance, or the name of a security group.
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Detailed information about an event to which you have subscribed.
CustomerAwsId (string) --
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
CustSubscriptionId (string) --
The Amazon DocumentDB event notification subscription ID.
SnsTopicArn (string) --
The topic ARN of the Amazon DocumentDB event notification subscription.
Status (string) --
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating , modifying , deleting , active , no-permission , topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time at which the Amazon DocumentDB event notification subscription was created.
SourceType (string) --
The source type for the Amazon DocumentDB event notification subscription.
SourceIdsList (list) --
A list of source IDs for the Amazon DocumentDB event notification subscription.
EventCategoriesList (list) --
A list of event categories for the Amazon DocumentDB event notification subscription.
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
DocDB.Client.exceptions.SubscriptionNotFoundFaultDocDB.Client.exceptions.SourceNotFoundFaultRemoves metadata tags from an Amazon DocumentDB resource.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceName='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).
[REQUIRED]
The tag key (name) of the tag to be removed.
None
Exceptions
DocDB.Client.exceptions.DBInstanceNotFoundFaultDocDB.Client.exceptions.DBSnapshotNotFoundFaultDocDB.Client.exceptions.DBClusterNotFoundFaultreset_db_cluster_parameter_group(**kwargs)¶Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod . To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.
See also: AWS API Documentation
Request Syntax
response = client.reset_db_cluster_parameter_group(
DBClusterParameterGroupName='string',
ResetAllParameters=True|False,
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot'
},
]
)
[REQUIRED]
The name of the cluster parameter group to reset.
true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true .
Detailed information about an individual parameter.
Specifies the name of the parameter.
Specifies the value of the parameter.
Provides a description of the parameter.
Indicates the source of the parameter value.
Specifies the engine-specific parameters type.
Specifies the valid data type for the parameter.
Specifies the valid range of values for the parameter.
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
Indicates when to apply parameter updates.
dict
Response Syntax
{
'DBClusterParameterGroupName': 'string'
}
Response Structure
(dict) --
Contains the name of a cluster parameter group.
DBClusterParameterGroupName (string) --
The name of a cluster parameter group.
Constraints:
Note
This value is stored as a lowercase string.
Exceptions
DocDB.Client.exceptions.InvalidDBParameterGroupStateFaultDocDB.Client.exceptions.DBParameterGroupNotFoundFaultrestore_db_cluster_from_snapshot(**kwargs)¶Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
See also: AWS API Documentation
Request Syntax
response = client.restore_db_cluster_from_snapshot(
AvailabilityZones=[
'string',
],
DBClusterIdentifier='string',
SnapshotIdentifier='string',
Engine='string',
EngineVersion='string',
Port=123,
DBSubnetGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False
)
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
[REQUIRED]
The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.
Constraints:
Example: my-snapshot-id
[REQUIRED]
The identifier for the snapshot or cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
[REQUIRED]
The database engine to use for the new cluster.
Default: The same as source.
Constraint: Must be compatible with the engine of the source.
The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150 to 65535 .
Default: The same port as the original cluster.
The name of the subnet group to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup .
Example: mySubnetgroup
A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
The tags to be assigned to the restored cluster.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterAlreadyExistsFaultDocDB.Client.exceptions.DBClusterQuotaExceededFaultDocDB.Client.exceptions.StorageQuotaExceededFaultDocDB.Client.exceptions.DBSubnetGroupNotFoundFaultDocDB.Client.exceptions.DBSnapshotNotFoundFaultDocDB.Client.exceptions.DBClusterSnapshotNotFoundFaultDocDB.Client.exceptions.InsufficientDBClusterCapacityFaultDocDB.Client.exceptions.InsufficientStorageClusterCapacityFaultDocDB.Client.exceptions.InvalidDBSnapshotStateFaultDocDB.Client.exceptions.InvalidDBClusterSnapshotStateFaultDocDB.Client.exceptions.StorageQuotaExceededFaultDocDB.Client.exceptions.InvalidVPCNetworkStateFaultDocDB.Client.exceptions.InvalidRestoreFaultDocDB.Client.exceptions.DBSubnetGroupNotFoundFaultDocDB.Client.exceptions.InvalidSubnetDocDB.Client.exceptions.KMSKeyNotAccessibleFaultrestore_db_cluster_to_point_in_time(**kwargs)¶Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.
See also: AWS API Documentation
Request Syntax
response = client.restore_db_cluster_to_point_in_time(
DBClusterIdentifier='string',
RestoreType='string',
SourceDBClusterIdentifier='string',
RestoreToTime=datetime(2015, 1, 1),
UseLatestRestorableTime=True|False,
Port=123,
DBSubnetGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False
)
[REQUIRED]
The name of the new cluster to be created.
Constraints:
The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
[REQUIRED]
The identifier of the source cluster from which to restore.
Constraints:
DBCluster .The date and time to restore the cluster to.
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
UseLatestRestorableTime parameter is not provided.UseLatestRestorableTime parameter is true .RestoreType parameter is copy-on-write .Example: 2015-03-07T23:45:00Z
A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.
Default: false
Constraints: Cannot be specified if the RestoreToTime parameter is provided.
The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150 to 65535 .
Default: The default port for the engine.
The subnet group name to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup .
Example: mySubnetgroup
A list of VPC security groups that the new cluster belongs to.
The tags to be assigned to the restored cluster.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws: " or "rds: ". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterAlreadyExistsFaultDocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.DBClusterQuotaExceededFaultDocDB.Client.exceptions.DBClusterSnapshotNotFoundFaultDocDB.Client.exceptions.DBSubnetGroupNotFoundFaultDocDB.Client.exceptions.InsufficientDBClusterCapacityFaultDocDB.Client.exceptions.InsufficientStorageClusterCapacityFaultDocDB.Client.exceptions.InvalidDBClusterSnapshotStateFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidDBSnapshotStateFaultDocDB.Client.exceptions.InvalidRestoreFaultDocDB.Client.exceptions.InvalidSubnetDocDB.Client.exceptions.InvalidVPCNetworkStateFaultDocDB.Client.exceptions.KMSKeyNotAccessibleFaultDocDB.Client.exceptions.StorageQuotaExceededFaultstart_db_cluster(**kwargs)¶Restarts the stopped cluster that is specified by DBClusterIdentifier . For more information, see Stopping and Starting an Amazon DocumentDB Cluster .
See also: AWS API Documentation
Request Syntax
response = client.start_db_cluster(
DBClusterIdentifier='string'
)
[REQUIRED]
The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
Detailed information about a cluster.
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
Specifies the number of days for which automatic snapshots are retained.
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
Specifies the name of the cluster parameter group for the cluster.
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Specifies the current state of this cluster.
Specifies the progress of the operation as a percentage.
The earliest time to which a database can be restored with point-in-time restore.
Specifies the connection endpoint for the primary instance of the cluster.
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
Specifies whether the cluster has instances in multiple Availability Zones.
Provides the name of the database engine to be used for this cluster.
Indicates the database engine version.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies the port that the database engine is listening on.
Contains the master user name for the cluster.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Contains the identifier of the source cluster if this cluster is a secondary cluster.
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
Provides the list of instances that make up the cluster.
Contains information about an instance that is part of a cluster.
Specifies the instance identifier for this member of the cluster.
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
Specifies the status of the cluster parameter group for this member of the DB cluster.
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
Used as a response element for queries on virtual private cloud (VPC) security group membership.
The name of the VPC security group.
The status of the VPC security group.
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Specifies whether the cluster is encrypted.
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
The Amazon Resource Name (ARN) for the cluster.
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.Identifies the clone group to which the DB cluster is associated.
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidDBInstanceStateFaultstop_db_cluster(**kwargs)¶Stops the running cluster that is specified by DBClusterIdentifier . The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster .
See also: AWS API Documentation
Request Syntax
response = client.stop_db_cluster(
DBClusterIdentifier='string'
)
[REQUIRED]
The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
}
}
Response Structure
Detailed information about a cluster.
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
Specifies the number of days for which automatic snapshots are retained.
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
Specifies the name of the cluster parameter group for the cluster.
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Specifies the current state of this cluster.
Specifies the progress of the operation as a percentage.
The earliest time to which a database can be restored with point-in-time restore.
Specifies the connection endpoint for the primary instance of the cluster.
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
Specifies whether the cluster has instances in multiple Availability Zones.
Provides the name of the database engine to be used for this cluster.
Indicates the database engine version.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies the port that the database engine is listening on.
Contains the master user name for the cluster.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Contains the identifier of the source cluster if this cluster is a secondary cluster.
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
Provides the list of instances that make up the cluster.
Contains information about an instance that is part of a cluster.
Specifies the instance identifier for this member of the cluster.
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
Specifies the status of the cluster parameter group for this member of the DB cluster.
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
Used as a response element for queries on virtual private cloud (VPC) security group membership.
The name of the VPC security group.
The status of the VPC security group.
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Specifies whether the cluster is encrypted.
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
The Amazon Resource Name (ARN) for the cluster.
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.Identifies the clone group to which the DB cluster is associated.
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
Exceptions
DocDB.Client.exceptions.DBClusterNotFoundFaultDocDB.Client.exceptions.InvalidDBClusterStateFaultDocDB.Client.exceptions.InvalidDBInstanceStateFaultThe available paginators are:
DocDB.Paginator.DescribeCertificatesDocDB.Paginator.DescribeDBClusterParameterGroupsDocDB.Paginator.DescribeDBClusterParametersDocDB.Paginator.DescribeDBClusterSnapshotsDocDB.Paginator.DescribeDBClustersDocDB.Paginator.DescribeDBEngineVersionsDocDB.Paginator.DescribeDBInstancesDocDB.Paginator.DescribeDBSubnetGroupsDocDB.Paginator.DescribeEventSubscriptionsDocDB.Paginator.DescribeEventsDocDB.Paginator.DescribeGlobalClustersDocDB.Paginator.DescribeOrderableDBInstanceOptionsDocDB.Paginator.DescribePendingMaintenanceActionsDocDB.Paginator.DescribeCertificates¶paginator = client.get_paginator('describe_certificates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CertificateIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.
Constraints
CertificateIdentifier .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateType': 'string',
'Thumbprint': 'string',
'ValidFrom': datetime(2015, 1, 1),
'ValidTill': datetime(2015, 1, 1),
'CertificateArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Certificates (list) --
A list of certificates for this Amazon Web Services account.
(dict) --
A certificate authority (CA) certificate for an Amazon Web Services account.
CertificateIdentifier (string) --
The unique key that identifies a certificate.
Example: rds-ca-2019
CertificateType (string) --
The type of the certificate.
Example: CA
Thumbprint (string) --
The thumbprint of the certificate.
ValidFrom (datetime) --
The starting date-time from which the certificate is valid.
Example: 2019-07-31T17:57:09Z
ValidTill (datetime) --
The date-time after which the certificate is no longer valid.
Example: 2024-07-31T17:57:09Z
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeDBClusterParameterGroups¶paginator = client.get_paginator('describe_db_cluster_parameter_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_db_cluster_parameter_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterParameterGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The name of a specific cluster parameter group to return details for.
Constraints:
DBClusterParameterGroup .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusterParameterGroups': [
{
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DBClusterParameterGroups .
DBClusterParameterGroups (list) --
A list of cluster parameter groups.
(dict) --
Detailed information about a cluster parameter group.
DBClusterParameterGroupName (string) --
Provides the name of the cluster parameter group.
DBParameterGroupFamily (string) --
Provides the name of the parameter group family that this cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the cluster parameter group.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeDBClusterParameters¶paginator = client.get_paginator('describe_db_cluster_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_db_cluster_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterParameterGroupName='string',
Source='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of a specific cluster parameter group to return parameter details for.
Constraints:
DBClusterParameterGroup .engine , service , or customer .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DBClusterParameterGroup .
Parameters (list) --
Provides a list of parameters for the cluster parameter group.
(dict) --
Detailed information about an individual parameter.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine-specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeDBClusterSnapshots¶paginator = client.get_paginator('describe_db_cluster_snapshots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_db_cluster_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterIdentifier='string',
DBClusterSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeShared=True|False,
IncludePublic=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
Constraints:
DBCluster .A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
DBClusterSnapshot .SnapshotType parameter must also be specified.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.shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.public - Return all cluster snapshots that have been marked as public.If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true . You can include public cluster snapshots with these results by setting the``IncludePublic`` parameter to true .
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false . The default is false .true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false . The default is false .A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusterSnapshots': [
{
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeDBClusterSnapshots .
DBClusterSnapshots (list) --
Provides a list of cluster snapshots.
(dict) --
Detailed information about a cluster snapshot.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the cluster snapshot.
DBClusterIdentifier (string) --
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in UTC.
Engine (string) --
Specifies the name of the database engine.
Status (string) --
Specifies the status of this cluster snapshot.
Port (integer) --
Specifies the port that the cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master user name for the cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this cluster snapshot.
SnapshotType (string) --
Provides the type of the cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster snapshot.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeDBClusters¶paginator = client.get_paginator('describe_db_clusters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_db_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.
Constraints:
DBClusterIdentifier .A filter that specifies one or more clusters to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusters': [
{
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeDBClusters .
DBClusters (list) --
A list of clusters.
(dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master user name for the cluster.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.PENDING - The IAMrole ARN is being associated with the cluster.INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeDBEngineVersions¶paginator = client.get_paginator('describe_db_engine_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_db_engine_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Engine='string',
EngineVersion='string',
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DefaultOnly=True|False,
ListSupportedCharacterSets=True|False,
ListSupportedTimezones=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The database engine version to return.
Example: 3.6.0
The name of a specific parameter group family to return details for.
Constraints:
DBParameterGroupFamily .This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
CharacterSetName parameter for CreateDBInstance , the response includes a list of supported character sets for each engine version.TimeZone parameter for CreateDBInstance , the response includes a list of supported time zones for each engine version.A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeDBEngineVersions .
DBEngineVersions (list) --
Detailed information about one or more engine versions.
(dict) --
Detailed information about an engine version.
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that an instance can be upgraded to.
Engine (string) --
The name of the upgrade target database engine.
EngineVersion (string) --
The version number of the upgrade target database engine.
Description (string) --
The version of the database engine that an instance can be upgraded to.
AutoUpgrade (boolean) --
A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true .
IsMajorVersionUpgrade (boolean) --
A value that indicates whether a database engine is upgraded to a major version.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeDBInstances¶paginator = client.get_paginator('describe_db_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_db_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
Constraints:
DBInstance .A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBInstances': [
{
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeDBInstances .
DBInstances (list) --
Detailed information about one or more instances.
(dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included , bring-your-own-license , general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false .
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently "read replication ."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating , error, stopped , or terminated .
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true , the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeDBSubnetGroups¶paginator = client.get_paginator('describe_db_subnet_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_db_subnet_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBSubnetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBSubnetGroups': [
{
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeDBSubnetGroups .
DBSubnetGroups (list) --
Detailed information about one or more subnet groups.
(dict) --
Detailed information about a subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeEventSubscriptions¶paginator = client.get_paginator('describe_event_subscriptions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_event_subscriptions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SubscriptionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeEventSubscriptions .
EventSubscriptionsList (list) --
A list of event subscriptions.
(dict) --
Detailed information about an event to which you have subscribed.
CustomerAwsId (string) --
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
CustSubscriptionId (string) --
The Amazon DocumentDB event notification subscription ID.
SnsTopicArn (string) --
The topic ARN of the Amazon DocumentDB event notification subscription.
Status (string) --
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating , modifying , deleting , active , no-permission , topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time at which the Amazon DocumentDB event notification subscription was created.
SourceType (string) --
The source type for the Amazon DocumentDB event notification subscription.
SourceIdsList (list) --
A list of source IDs for the Amazon DocumentDB event notification subscription.
EventCategoriesList (list) --
A list of event categories for the Amazon DocumentDB event notification subscription.
Enabled (boolean) --
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeEvents¶paginator = client.get_paginator('describe_events')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SourceIdentifier='string',
SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
EventCategories=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
SourceIdentifier is provided, SourceType must also be provided.DBInstance , a DBInstanceIdentifier must be provided.DBSecurityGroup , a DBSecurityGroupName must be provided.DBParameterGroup , a DBParameterGroupName must be provided.DBSnapshot , a DBSnapshotIdentifier must be provided.The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
The number of minutes to retrieve events for.
Default: 60
A list of event categories that trigger notifications for an event notification subscription.
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
'Message': 'string',
'EventCategories': [
'string',
],
'Date': datetime(2015, 1, 1),
'SourceArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeEvents .
Events (list) --
Detailed information about one or more events.
(dict) --
Detailed information about an event.
SourceIdentifier (string) --
Provides the identifier for the source of the event.
SourceType (string) --
Specifies the source type for this event.
Message (string) --
Provides the text of this event.
EventCategories (list) --
Specifies the category for the event.
Date (datetime) --
Specifies the date and time of the event.
SourceArn (string) --
The Amazon Resource Name (ARN) for the event.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeGlobalClusters¶paginator = client.get_paginator('describe_global_clusters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_global_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GlobalClusters': [
{
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GlobalClusters (list) --
(dict) --
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier (string) --
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global cluster.
Status (string) --
Specifies the current state of this global cluster.
Engine (string) --
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
IsWriter (boolean) --
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribeOrderableDBInstanceOptions¶paginator = client.get_paginator('describe_orderable_db_instance_options')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_orderable_db_instance_options().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Engine='string',
EngineVersion='string',
DBInstanceClass='string',
LicenseModel='string',
Vpc=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the engine to retrieve instance options for.
This parameter is not currently supported.
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrderableDBInstanceOptions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBInstanceClass': 'string',
'LicenseModel': 'string',
'AvailabilityZones': [
{
'Name': 'string'
},
],
'Vpc': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribeOrderableDBInstanceOptions .
OrderableDBInstanceOptions (list) --
The options that are available for a particular orderable instance.
(dict) --
The options that are available for an instance.
Engine (string) --
The engine type of an instance.
EngineVersion (string) --
The engine version of an instance.
DBInstanceClass (string) --
The instance class for an instance.
LicenseModel (string) --
The license model for an instance.
AvailabilityZones (list) --
A list of Availability Zones for an instance.
(dict) --
Information about an Availability Zone.
Name (string) --
The name of the Availability Zone.
Vpc (boolean) --
Indicates whether an instance is in a virtual private cloud (VPC).
NextToken (string) --
A token to resume pagination.
DocDB.Paginator.DescribePendingMaintenanceActions¶paginator = client.get_paginator('describe_pending_maintenance_actions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from DocDB.Client.describe_pending_maintenance_actions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the clusters identified by these ARNs.db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PendingMaintenanceActions': [
{
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the output of DescribePendingMaintenanceActions .
PendingMaintenanceActions (list) --
The maintenance actions to be applied.
(dict) --
Represents the output of ApplyPendingMaintenanceAction .
ResourceIdentifier (string) --
The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.
PendingMaintenanceActionDetails (list) --
A list that provides details about the pending maintenance actions for the resource.
(dict) --
Provides information about a pending maintenance action for a resource.
Action (string) --
The type of pending maintenance action that is available for the resource.
AutoAppliedAfterDate (datetime) --
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 opt-in requests are ignored.
ForcedApplyDate (datetime) --
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 opt-in requests are ignored.
OptInStatus (string) --
Indicates the type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
The effective date when the pending maintenance action is applied to the resource.
Description (string) --
A description providing more detail about the maintenance action.
NextToken (string) --
A token to resume pagination.
The available waiters are:
DocDB.Waiter.DBInstanceAvailable¶waiter = client.get_waiter('db_instance_available')
wait(**kwargs)¶Polls DocDB.Client.describe_db_instances() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
Constraints:
DBInstance .A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
DocDB.Waiter.DBInstanceDeleted¶waiter = client.get_waiter('db_instance_deleted')
wait(**kwargs)¶Polls DocDB.Client.describe_db_instances() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
Constraints:
DBInstance .A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
The name of the filter. Filter names are case sensitive.
One or more filter values. Filter values are case sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None