AWS API Changes

2017/04/28 - Amazon Relational Database Service - 4 updated api methods

Changes The DescribeDBClusterSnapshots API now returns a SourceDBClusterSnapshotArn field which identifies the source DB cluster snapshot of a copied snapshot.

CopyDBClusterSnapshot (updated)

Link ¶
Changes (response)

{'DBClusterSnapshot': {'SourceDBClusterSnapshotArn': '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 region where you call the CopyDBClusterSnapshot action is the destination region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another region, you must provide the following values:

KmsKeyId - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination region.
PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source region where the DB cluster snapshot will be copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:
- KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination region, and the action contained in the pre-signed URL.
- DestinationRegion - The name of the region that the DB cluster snapshot will 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 region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 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.

TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination 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 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 region to another, see Copying a DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions in the Amazon RDS User Guide.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

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 is not case-sensitive.

You cannot copy an encrypted, shared DB cluster snapshot from one AWS region to another.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must specify a valid system snapshot in the "available" state.
If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
If the source snapshot is in a different region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying a DB Snapshot or DB Cluster Snapshot.

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 is not case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

type KmsKeyId

string

param KmsKeyId

The AWS KMS key ID for an encrypted DB 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 unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB cluster snapshot using the specified KMS encryption key.

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 KMS encryption key. If you don't specify a value for KmsKeyId , then the copy of the DB cluster snapshot is encrypted with the same 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 region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

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.

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

KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the region that the DB cluster snapshot will 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 region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 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

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot; otherwise false. The default is false.

type Tags

list

param Tags

A list of tags.

(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 cannot 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 cannot 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',
        '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
    }
}

Response Structure

(dict) --
- DBClusterSnapshot (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBClusterSnapshot
  - DeleteDBClusterSnapshot
  This data type is used as a response element in the DescribeDBClusterSnapshots action.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
    - (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.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gigabytes (GB).
  - 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.
  - 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; otherwise false.

CreateDBClusterSnapshot (updated)

Link ¶
Changes (response)

{'DBClusterSnapshot': {'SourceDBClusterSnapshotArn': 'string'}}

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

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 alphanumeric characters or hyphens.
First character must be a letter.
Cannot 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 is not case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

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 cannot 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 cannot 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',
        '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
    }
}

Response Structure

(dict) --
- DBClusterSnapshot (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBClusterSnapshot
  - DeleteDBClusterSnapshot
  This data type is used as a response element in the DescribeDBClusterSnapshots action.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
    - (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.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gigabytes (GB).
  - 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.
  - 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; otherwise false.

DeleteDBClusterSnapshot (updated)

Link ¶
Changes (response)

{'DBClusterSnapshot': {'SourceDBClusterSnapshotArn': '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 Aurora on Amazon RDS in the Amazon RDS User Guide.

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',
        '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
    }
}

Response Structure

(dict) --
- DBClusterSnapshot (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBClusterSnapshot
  - DeleteDBClusterSnapshot
  This data type is used as a response element in the DescribeDBClusterSnapshots action.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
    - (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.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gigabytes (GB).
  - 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.
  - 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; otherwise false.

DescribeDBClusterSnapshots (updated)

Link ¶
Changes (response)

{'DBClusterSnapshots': {'SourceDBClusterSnapshotArn': 'string'}}

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

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 cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type DBClusterSnapshotIdentifier

string

param DBClusterSnapshotIdentifier

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

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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 setting the IncludeShared parameter to true . You can include public DB 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 .

type Filters

list

param Filters

This parameter is not currently supported.

(dict) --

This type is not currently supported.
- Name (string) -- [REQUIRED]
  
  This parameter is not currently supported.
- Values (list) -- [REQUIRED]
  
  This parameter is not currently supported.
  - (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 that the remaining results can be retrieved.

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

Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false . The default is false .

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

Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false . The default is false . The default is false.

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',
            '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
        },
    ]
}

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 result of a successful invocation of the following actions:
    - CreateDBClusterSnapshot
    - DeleteDBClusterSnapshot
    This data type is used as a response element in the DescribeDBClusterSnapshots action.
    - AvailabilityZones (list) --
      
      Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
      - (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.
    - AllocatedStorage (integer) --
      
      Specifies the allocated storage size in gigabytes (GB).
    - 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 the 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 KMS key identifier for the encrypted DB cluster snapshot.
    - 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; otherwise false.