Neptune / Client / describe_db_cluster_snapshots

describe_db_cluster_snapshots#

Neptune.Client.describe_db_cluster_snapshots(**kwargs)#

Returns information about DB cluster snapshots. This API action 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
)
Parameters:

  • DBClusterIdentifier (string) –

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

    Constraints:

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

  • DBClusterSnapshotIdentifier (string) –

    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.

  • SnapshotType (string) –

    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 Neptune for my Amazon account.

    • manual - Return all DB cluster snapshots that have been taken by my Amazon account.

    • shared - Return all manual DB cluster snapshots that have been shared to my Amazon 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.

  • Filters (list) –

    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) –

  • MaxRecords (integer) –

    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.

  • 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.

  • IncludeShared (boolean) –

    True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is false.

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

  • IncludePublic (boolean) –

    True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise 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.

Return type:

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

Response Structure

  • (dict) –

    • 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 Neptune DB cluster snapshot

        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 a DB cluster snapshot. Must match the identifier of an existing snapshot.

          After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

          However, if you don’t specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

        • 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 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) –

          Not supported by Neptune.

        • 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 Amazon 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 Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • StorageType (string) –

          The storage type associated with the DB cluster snapshot.

Exceptions