Skip to content
AWS for Query.Farm

aws.redshift_serverless.get_snapshot

Example SQL Queries

SELECT * FROM
aws.redshift_serverless.get_snapshot;

Description

Returns information about a specific snapshot.

Table Definition

Column NameColumn Data Type
owner_account Input Column

The owner Amazon Web Services account of a snapshot shared with another user.

VARCHAR
snapshot_arn Input Column

The Amazon Resource Name (ARN) of the snapshot to return.

VARCHAR
snapshot_name Input Column

The name of the snapshot to return.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
snapshot

The returned snapshot object.

STRUCT(
    "accounts_with_provisioned_restore_access" VARCHAR[],
    "accounts_with_restore_access" VARCHAR[],
    "actual_incremental_backup_size_in_mega_bytes" DOUBLE,
    "admin_password_secret_arn" VARCHAR,
    "admin_password_secret_kms_key_id" VARCHAR,
    "admin_username" VARCHAR,
    "backup_progress_in_mega_bytes" DOUBLE,
    "current_backup_rate_in_mega_bytes_per_second" DOUBLE,
    "elapsed_time_in_seconds" BIGINT,
    "estimated_seconds_to_completion" BIGINT,
    "kms_key_id" VARCHAR,
    "namespace_arn" VARCHAR,
    "namespace_name" VARCHAR,
    "owner_account" VARCHAR,
    "snapshot_arn" VARCHAR,
    "snapshot_create_time" TIMESTAMP_S,
    "snapshot_name" VARCHAR,
    "snapshot_remaining_days" BIGINT,
    "snapshot_retention_period" BIGINT,
    "snapshot_retention_start_time" TIMESTAMP_S,
    "status" VARCHAR,
    "total_backup_size_in_mega_bytes" DOUBLE
)
Show child fields
snapshot.accounts_with_provisioned_restore_access[]
snapshot.accounts_with_restore_access[]
snapshot.actual_incremental_backup_size_in_mega_bytes

The size of the incremental backup in megabytes.

snapshot.admin_password_secret_arn

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

snapshot.admin_password_secret_kms_key_id

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

snapshot.admin_username

The username of the database within a snapshot.

snapshot.backup_progress_in_mega_bytes

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

snapshot.current_backup_rate_in_mega_bytes_per_second

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

snapshot.elapsed_time_in_seconds

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

snapshot.estimated_seconds_to_completion

The estimated amount of seconds until the snapshot completes backup.

snapshot.kms_key_id

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

snapshot.namespace_arn

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

snapshot.namespace_name

The name of the namepsace.

snapshot.owner_account

The owner Amazon Web Services; account of the snapshot.

snapshot.snapshot_arn

The Amazon Resource Name (ARN) of the snapshot.

snapshot.snapshot_create_time

The timestamp of when the snapshot was created.

snapshot.snapshot_name

The name of the snapshot.

snapshot.snapshot_remaining_days

The amount of days until the snapshot is deleted.

snapshot.snapshot_retention_period

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

snapshot.snapshot_retention_start_time

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

snapshot.status

The status of the snapshot.

snapshot.total_backup_size_in_mega_bytes

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