RedshiftServerless / Client / list_snapshots

list_snapshots#

RedshiftServerless.Client.list_snapshots(**kwargs)#

Returns a list of snapshots.

See also: AWS API Documentation

Request Syntax

response = client.list_snapshots(
    endTime=datetime(2015, 1, 1),
    maxResults=123,
    namespaceArn='string',
    namespaceName='string',
    nextToken='string',
    ownerAccount='string',
    startTime=datetime(2015, 1, 1)
)
Parameters:

  • endTime (datetime) – The timestamp showing when the snapshot creation finished.

  • maxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

  • namespaceArn (string) – The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

  • namespaceName (string) – The namespace from which to list all snapshots.

  • nextToken (string) – If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • ownerAccount (string) – The owner Amazon Web Services account of the snapshot.

  • startTime (datetime) – The time when the creation of the snapshot was initiated.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'snapshots': [
        {
            'accountsWithProvisionedRestoreAccess': [
                'string',
            ],
            'accountsWithRestoreAccess': [
                'string',
            ],
            'actualIncrementalBackupSizeInMegaBytes': 123.0,
            'adminPasswordSecretArn': 'string',
            'adminPasswordSecretKmsKeyId': 'string',
            'adminUsername': 'string',
            'backupProgressInMegaBytes': 123.0,
            'currentBackupRateInMegaBytesPerSecond': 123.0,
            'elapsedTimeInSeconds': 123,
            'estimatedSecondsToCompletion': 123,
            'kmsKeyId': 'string',
            'namespaceArn': 'string',
            'namespaceName': 'string',
            'ownerAccount': 'string',
            'snapshotArn': 'string',
            'snapshotCreateTime': datetime(2015, 1, 1),
            'snapshotName': 'string',
            'snapshotRemainingDays': 123,
            'snapshotRetentionPeriod': 123,
            'snapshotRetentionStartTime': datetime(2015, 1, 1),
            'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
            'totalBackupSizeInMegaBytes': 123.0
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

    • snapshots (list) –

      All of the returned snapshot objects.

      • (dict) –

        A snapshot object that contains databases.

        • accountsWithProvisionedRestoreAccess (list) –

          All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

          • (string) –

        • accountsWithRestoreAccess (list) –

          All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

          • (string) –

        • actualIncrementalBackupSizeInMegaBytes (float) –

          The size of the incremental backup in megabytes.

        • adminPasswordSecretArn (string) –

          The Amazon Resource Name (ARN) for the namespace’s admin user credentials secret.

        • adminPasswordSecretKmsKeyId (string) –

          The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

        • adminUsername (string) –

          The username of the database within a snapshot.

        • backupProgressInMegaBytes (float) –

          The size in megabytes of the data that has been backed up to a snapshot.

        • currentBackupRateInMegaBytesPerSecond (float) –

          The rate at which data is backed up into a snapshot in megabytes per second.

        • elapsedTimeInSeconds (integer) –

          The amount of time it took to back up data into a snapshot.

        • estimatedSecondsToCompletion (integer) –

          The estimated amount of seconds until the snapshot completes backup.

        • kmsKeyId (string) –

          The unique identifier of the KMS key used to encrypt the snapshot.

        • namespaceArn (string) –

          The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        • namespaceName (string) –

          The name of the namepsace.

        • ownerAccount (string) –

          The owner Amazon Web Services; account of the snapshot.

        • snapshotArn (string) –

          The Amazon Resource Name (ARN) of the snapshot.

        • snapshotCreateTime (datetime) –

          The timestamp of when the snapshot was created.

        • snapshotName (string) –

          The name of the snapshot.

        • snapshotRemainingDays (integer) –

          The amount of days until the snapshot is deleted.

        • snapshotRetentionPeriod (integer) –

          The period of time, in days, of how long the snapshot is retained.

        • snapshotRetentionStartTime (datetime) –

          The timestamp of when data within the snapshot started getting retained.

        • status (string) –

          The status of the snapshot.

        • totalBackupSizeInMegaBytes (float) –

          The total size, in megabytes, of how big the snapshot is.

Exceptions