AWS API Changes

2021/02/12 - Amazon Relational Database Service - 5 updated api methods

Changes EngineMode in the response of DescribeDBClusterSnapshots. SupportedEngineModes, SupportsParallelQuery and SupportsGlobalDatabases in ValidUpgradeTarget of DBEngineVersions in DescribeDBEngineVersions.

CopyDBClusterSnapshot (updated)

Link ¶
Changes (response)

{'DBClusterSnapshot': {'EngineMode': 'string'}}

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:
- KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
- DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in.
- SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115 .

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

Note

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS 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 AWS Region.

TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.

For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note

This action only applies to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

client.copy_db_cluster_snapshot(
    SourceDBClusterSnapshotIdentifier='string',
    TargetDBClusterSnapshotIdentifier='string',
    KmsKeyId='string',
    PreSignedUrl='string',
    CopyTags=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SourceRegion='string'
)

type SourceDBClusterSnapshotIdentifier

string

param SourceDBClusterSnapshotIdentifier

[REQUIRED]

The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

Constraints:

Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.

Example: my-cluster-snapshot1

type TargetDBClusterSnapshotIdentifier

string

param TargetDBClusterSnapshotIdentifier

[REQUIRED]

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

type KmsKeyId

string

param KmsKeyId

The AWS KMS key identifier for an encrypted DB cluster snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS CMK. If you don't specify a value for KmsKeyId , then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId .

To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the AWS KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. AWS KMS CMKs are specific to the AWS Region that they are created in, and you can't use CMKs from one AWS Region in another AWS Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

type PreSignedUrl

string

param PreSignedUrl

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region.

The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115 .

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

Note

If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.

type CopyTags

boolean

param CopyTags

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

type Tags

list

param Tags

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- Key (string) --
  
  A key is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
- Value (string) --
  
  A value is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

type SourceRegion

string

param SourceRegion

The ID of the region that contains the snapshot to be copied.

rtype

dict

returns

Response Syntax

{
    'DBClusterSnapshot': {
        'AvailabilityZones': [
            'string',
        ],
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'EngineMode': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- DBClusterSnapshot (dict) --
  
  Contains the details for an Amazon RDS DB cluster snapshot
  
  This data type is used as a response element in the DescribeDBClusterSnapshots action.
  - AvailabilityZones (list) --
    
    Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    - (string) --
  - DBClusterSnapshotIdentifier (string) --
    
    Specifies the identifier for the DB cluster snapshot.
  - DBClusterIdentifier (string) --
    
    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
  - SnapshotCreateTime (datetime) --
    
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - Engine (string) --
    
    Specifies the name of the database engine for this DB cluster snapshot.
  - EngineMode (string) --
    
    Provides the engine mode of the database engine for this DB cluster snapshot.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gibibytes (GiB).
  - Status (string) --
    
    Specifies the status of this DB cluster snapshot.
  - Port (integer) --
    
    Specifies the port that the DB cluster was listening on at the time of the snapshot.
  - VpcId (string) --
    
    Provides the VPC ID associated with the DB cluster snapshot.
  - ClusterCreateTime (datetime) --
    
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - MasterUsername (string) --
    
    Provides the master username for this DB cluster snapshot.
  - EngineVersion (string) --
    
    Provides the version of the database engine for this DB cluster snapshot.
  - LicenseModel (string) --
    
    Provides the license model information for this DB cluster snapshot.
  - SnapshotType (string) --
    
    Provides the type of the DB cluster snapshot.
  - PercentProgress (integer) --
    
    Specifies the percentage of the estimated data that has been transferred.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster snapshot is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
  - DBClusterSnapshotArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
  - SourceDBClusterSnapshotArn (string) --
    
    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - TagList (list) --
    
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    - (dict) --
      
      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
      - Key (string) --
        
        A key is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
      - Value (string) --
        
        A value is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

CreateDBClusterSnapshot (updated)

Link ¶
Changes (response)

{'DBClusterSnapshot': {'EngineMode': 'string'}}

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note

This action only applies to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

client.create_db_cluster_snapshot(
    DBClusterSnapshotIdentifier='string',
    DBClusterIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type DBClusterSnapshotIdentifier

string

param DBClusterSnapshotIdentifier

[REQUIRED]

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

Example: my-cluster1

type Tags

list

param Tags

The tags to be assigned to the DB cluster snapshot.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- Key (string) --
  
  A key is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
- Value (string) --
  
  A value is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

rtype

dict

returns

Response Syntax

{
    'DBClusterSnapshot': {
        'AvailabilityZones': [
            'string',
        ],
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'EngineMode': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- DBClusterSnapshot (dict) --
  
  Contains the details for an Amazon RDS DB cluster snapshot
  
  This data type is used as a response element in the DescribeDBClusterSnapshots action.
  - AvailabilityZones (list) --
    
    Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    - (string) --
  - DBClusterSnapshotIdentifier (string) --
    
    Specifies the identifier for the DB cluster snapshot.
  - DBClusterIdentifier (string) --
    
    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
  - SnapshotCreateTime (datetime) --
    
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - Engine (string) --
    
    Specifies the name of the database engine for this DB cluster snapshot.
  - EngineMode (string) --
    
    Provides the engine mode of the database engine for this DB cluster snapshot.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gibibytes (GiB).
  - Status (string) --
    
    Specifies the status of this DB cluster snapshot.
  - Port (integer) --
    
    Specifies the port that the DB cluster was listening on at the time of the snapshot.
  - VpcId (string) --
    
    Provides the VPC ID associated with the DB cluster snapshot.
  - ClusterCreateTime (datetime) --
    
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - MasterUsername (string) --
    
    Provides the master username for this DB cluster snapshot.
  - EngineVersion (string) --
    
    Provides the version of the database engine for this DB cluster snapshot.
  - LicenseModel (string) --
    
    Provides the license model information for this DB cluster snapshot.
  - SnapshotType (string) --
    
    Provides the type of the DB cluster snapshot.
  - PercentProgress (integer) --
    
    Specifies the percentage of the estimated data that has been transferred.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster snapshot is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
  - DBClusterSnapshotArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
  - SourceDBClusterSnapshotArn (string) --
    
    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - TagList (list) --
    
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    - (dict) --
      
      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
      - Key (string) --
        
        A key is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
      - Value (string) --
        
        A value is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

DeleteDBClusterSnapshot (updated)

Link ¶
Changes (response)

{'DBClusterSnapshot': {'EngineMode': 'string'}}

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

Note

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note

This action only applies to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

client.delete_db_cluster_snapshot(
    DBClusterSnapshotIdentifier='string'
)

type DBClusterSnapshotIdentifier

string

param DBClusterSnapshotIdentifier

[REQUIRED]

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

rtype

dict

returns

Response Syntax

{
    'DBClusterSnapshot': {
        'AvailabilityZones': [
            'string',
        ],
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'EngineMode': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- DBClusterSnapshot (dict) --
  
  Contains the details for an Amazon RDS DB cluster snapshot
  
  This data type is used as a response element in the DescribeDBClusterSnapshots action.
  - AvailabilityZones (list) --
    
    Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    - (string) --
  - DBClusterSnapshotIdentifier (string) --
    
    Specifies the identifier for the DB cluster snapshot.
  - DBClusterIdentifier (string) --
    
    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
  - SnapshotCreateTime (datetime) --
    
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - Engine (string) --
    
    Specifies the name of the database engine for this DB cluster snapshot.
  - EngineMode (string) --
    
    Provides the engine mode of the database engine for this DB cluster snapshot.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gibibytes (GiB).
  - Status (string) --
    
    Specifies the status of this DB cluster snapshot.
  - Port (integer) --
    
    Specifies the port that the DB cluster was listening on at the time of the snapshot.
  - VpcId (string) --
    
    Provides the VPC ID associated with the DB cluster snapshot.
  - ClusterCreateTime (datetime) --
    
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - MasterUsername (string) --
    
    Provides the master username for this DB cluster snapshot.
  - EngineVersion (string) --
    
    Provides the version of the database engine for this DB cluster snapshot.
  - LicenseModel (string) --
    
    Provides the license model information for this DB cluster snapshot.
  - SnapshotType (string) --
    
    Provides the type of the DB cluster snapshot.
  - PercentProgress (integer) --
    
    Specifies the percentage of the estimated data that has been transferred.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster snapshot is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    
    The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
  - DBClusterSnapshotArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
  - SourceDBClusterSnapshotArn (string) --
    
    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - TagList (list) --
    
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
    - (dict) --
      
      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
      - Key (string) --
        
        A key is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
      - Value (string) --
        
        A value is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

DescribeDBClusterSnapshots (updated)

Link ¶
Changes (response)

{'DBClusterSnapshots': {'EngineMode': 'string'}}

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

Note

This action only applies to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

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
)

type DBClusterIdentifier

string

param DBClusterIdentifier

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

If supplied, must match the identifier of an existing DBCluster.

type DBClusterSnapshotIdentifier

string

param DBClusterSnapshotIdentifier

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

type SnapshotType

string

param SnapshotType

The type of DB cluster snapshots to be returned. You can specify one of the following values:

automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual - Return all DB cluster snapshots that have been taken by my AWS account.
shared - Return all manual DB cluster snapshots that have been shared to my AWS account.
public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

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 .

type Filters

list

param Filters

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.
snapshot-type - Accepts types of DB cluster snapshots.
engine - Accepts names of database engines.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusters
- DescribeDBInstances
- DescribePendingMaintenanceActions
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxRecords

integer

param MaxRecords

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

type IncludeShared

boolean

param IncludeShared

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

type IncludePublic

boolean

param IncludePublic

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'DBClusterSnapshots': [
        {
            'AvailabilityZones': [
                'string',
            ],
            'DBClusterSnapshotIdentifier': 'string',
            'DBClusterIdentifier': 'string',
            'SnapshotCreateTime': datetime(2015, 1, 1),
            'Engine': 'string',
            'EngineMode': 'string',
            'AllocatedStorage': 123,
            'Status': 'string',
            'Port': 123,
            'VpcId': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1),
            'MasterUsername': 'string',
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'SnapshotType': 'string',
            'PercentProgress': 123,
            'StorageEncrypted': True|False,
            'KmsKeyId': 'string',
            'DBClusterSnapshotArn': 'string',
            'SourceDBClusterSnapshotArn': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
- Marker (string) --
  
  An optional pagination token provided by a previous DescribeDBClusterSnapshots 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 DB cluster snapshots for the user.
  - (dict) --
    
    Contains the details for an Amazon RDS DB cluster snapshot
    
    This data type is used as a response element in the DescribeDBClusterSnapshots action.
    - AvailabilityZones (list) --
      
      Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
      - (string) --
    - DBClusterSnapshotIdentifier (string) --
      
      Specifies the identifier for the DB cluster snapshot.
    - DBClusterIdentifier (string) --
      
      Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
    - SnapshotCreateTime (datetime) --
      
      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
    - Engine (string) --
      
      Specifies the name of the database engine for this DB cluster snapshot.
    - EngineMode (string) --
      
      Provides the engine mode of the database engine for this DB cluster snapshot.
    - AllocatedStorage (integer) --
      
      Specifies the allocated storage size in gibibytes (GiB).
    - Status (string) --
      
      Specifies the status of this DB cluster snapshot.
    - Port (integer) --
      
      Specifies the port that the DB cluster was listening on at the time of the snapshot.
    - VpcId (string) --
      
      Provides the VPC ID associated with the DB cluster snapshot.
    - ClusterCreateTime (datetime) --
      
      Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
    - MasterUsername (string) --
      
      Provides the master username for this DB cluster snapshot.
    - EngineVersion (string) --
      
      Provides the version of the database engine for this DB cluster snapshot.
    - LicenseModel (string) --
      
      Provides the license model information for this DB cluster snapshot.
    - SnapshotType (string) --
      
      Provides the type of the DB cluster snapshot.
    - PercentProgress (integer) --
      
      Specifies the percentage of the estimated data that has been transferred.
    - StorageEncrypted (boolean) --
      
      Specifies whether the DB cluster snapshot is encrypted.
    - KmsKeyId (string) --
      
      If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
      
      The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
    - DBClusterSnapshotArn (string) --
      
      The Amazon Resource Name (ARN) for the DB cluster snapshot.
    - SourceDBClusterSnapshotArn (string) --
      
      If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
    - IAMDatabaseAuthenticationEnabled (boolean) --
      
      True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    - TagList (list) --
      
      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
      - (dict) --
        
        Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
        
        Key (string) --
        
        A key is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
        
        Value (string) --
        
        A value is 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 only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

DescribeDBEngineVersions (updated)

Link ¶
Changes (response)

{'DBEngineVersions': {'ValidUpgradeTarget': {'SupportedEngineModes': ['string'],
                                             'SupportsGlobalDatabases': 'boolean',
                                             'SupportsParallelQuery': 'boolean'}}}

Returns a list of the available DB engines.

See also: AWS API Documentation

Request Syntax

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,
    IncludeAll=True|False
)

type Engine

string

param Engine

The database engine to return.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web

type EngineVersion

string

param EngineVersion

The database engine version to return.

Example: 5.1.49

type DBParameterGroupFamily

string

param DBParameterGroupFamily

The name of a specific DB parameter group family to return details for.

Constraints:

If supplied, must match an existing DBParameterGroupFamily.

type Filters

list

param Filters

This parameter isn't currently supported.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusters
- DescribeDBInstances
- DescribePendingMaintenanceActions
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxRecords

integer

param MaxRecords

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

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 .

type DefaultOnly

boolean

param DefaultOnly

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

type ListSupportedCharacterSets

boolean

param ListSupportedCharacterSets

A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance , the response includes a list of supported character sets for each engine version.

type ListSupportedTimezones

boolean

param ListSupportedTimezones

A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance , the response includes a list of supported time zones for each engine version.

type IncludeAll

boolean

param IncludeAll

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'DBEngineVersions': [
        {
            'Engine': 'string',
            'EngineVersion': 'string',
            'DBParameterGroupFamily': 'string',
            'DBEngineDescription': 'string',
            'DBEngineVersionDescription': 'string',
            'DefaultCharacterSet': {
                'CharacterSetName': 'string',
                'CharacterSetDescription': 'string'
            },
            'SupportedCharacterSets': [
                {
                    'CharacterSetName': 'string',
                    'CharacterSetDescription': 'string'
                },
            ],
            'SupportedNcharCharacterSets': [
                {
                    'CharacterSetName': 'string',
                    'CharacterSetDescription': 'string'
                },
            ],
            'ValidUpgradeTarget': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'Description': 'string',
                    'AutoUpgrade': True|False,
                    'IsMajorVersionUpgrade': True|False,
                    'SupportedEngineModes': [
                        'string',
                    ],
                    'SupportsParallelQuery': True|False,
                    'SupportsGlobalDatabases': True|False
                },
            ],
            'SupportedTimezones': [
                {
                    'TimezoneName': 'string'
                },
            ],
            'ExportableLogTypes': [
                'string',
            ],
            'SupportsLogExportsToCloudwatchLogs': True|False,
            'SupportsReadReplica': True|False,
            'SupportedEngineModes': [
                'string',
            ],
            'SupportedFeatureNames': [
                'string',
            ],
            'Status': 'string',
            'SupportsParallelQuery': True|False,
            'SupportsGlobalDatabases': True|False
        },
    ]
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeDBEngineVersions 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 .
- DBEngineVersions (list) --
  
  A list of DBEngineVersion elements.
  - (dict) --
    
    This data type is used as a response element in the action DescribeDBEngineVersions .
    - Engine (string) --
      
      The name of the database engine.
    - EngineVersion (string) --
      
      The version number of the database engine.
    - DBParameterGroupFamily (string) --
      
      The name of the DB parameter group family for the database engine.
    - DBEngineDescription (string) --
      
      The description of the database engine.
    - DBEngineVersionDescription (string) --
      
      The description of the database engine version.
    - DefaultCharacterSet (dict) --
      
      The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
      - CharacterSetName (string) --
        
        The name of the character set.
      - CharacterSetDescription (string) --
        
        The description of the character set.
    - SupportedCharacterSets (list) --
      
      A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
      - (dict) --
        
        This data type is used as a response element in the action DescribeDBEngineVersions .
        
        CharacterSetName (string) --
        
        The name of the character set.
        
        CharacterSetDescription (string) --
        
        The description of the character set.
    - SupportedNcharCharacterSets (list) --
      
      A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
      - (dict) --
        
        This data type is used as a response element in the action DescribeDBEngineVersions .
        
        CharacterSetName (string) --
        
        The name of the character set.
        
        CharacterSetDescription (string) --
        
        The description of the character set.
    - ValidUpgradeTarget (list) --
      
      A list of engine versions that this database engine version can be upgraded to.
      - (dict) --
        
        The version of the database engine that a DB 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 a DB 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 upgrading to the target version requires upgrading the major version of the database engine.
        
        SupportedEngineModes (list) --
        
        A list of the supported DB engine modes for the target engine version.
        
        (string) --
        
        SupportsParallelQuery (boolean) --
        
        A value that indicates whether you can use Aurora parallel query with the target engine version.
        
        SupportsGlobalDatabases (boolean) --
        
        A value that indicates whether you can use Aurora global databases with the target engine version.
    - SupportedTimezones (list) --
      
      A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
      - (dict) --
        
        A time zone associated with a DBInstance or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
        
        TimezoneName (string) --
        
        The name of the time zone.
    - ExportableLogTypes (list) --
      
      The types of logs that the database engine has available for export to CloudWatch Logs.
      - (string) --
    - SupportsLogExportsToCloudwatchLogs (boolean) --
      
      A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
    - SupportsReadReplica (boolean) --
      
      Indicates whether the database engine version supports read replicas.
    - SupportedEngineModes (list) --
      
      A list of the supported DB engine modes.
      - (string) --
    - SupportedFeatureNames (list) --
      
      A list of features supported by the DB engine. Supported feature names include the following.
      - s3Import
      - (string) --
    - Status (string) --
      
      The status of the DB engine version, either available or deprecated .
    - SupportsParallelQuery (boolean) --
      
      A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
    - SupportsGlobalDatabases (boolean) --
      
      A value that indicates whether you can use Aurora global databases with a specific DB engine version.