Skip to content
AWS for Query.Farm

aws.opsworkscm.describe_backups

Example SQL Queries

SELECT * FROM
aws.opsworkscm.describe_backups;

Description

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.

Table Definition

Column NameColumn Data Type
backup_id Input Column

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS 

VARCHAR
server_name Input Column

The name of the server from which the backup was made. 

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.

backup_arn

The ARN of the backup. 

VARCHAR
backup_type

The backup type. Valid values are automated or manual. 

VARCHAR
created_at

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z 

TIMESTAMP_S
description

A user-provided description for a manual backup. This field is empty for automated backups. 

VARCHAR
engine

The engine type that is obtained from the server when the backup is created. 

VARCHAR
engine_model

The engine model that is obtained from the server when the backup is created. 

VARCHAR
engine_version

The engine version that is obtained from the server when the backup is created. 

VARCHAR
instance_profile_arn

The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup. 

VARCHAR
instance_type

The instance type that is obtained from the server when the backup is created. 

VARCHAR
key_pair

The key pair that is obtained from the server when the backup is created. 

VARCHAR
preferred_backup_window

The preferred backup period that is obtained from the server when the backup is created. 

VARCHAR
preferred_maintenance_window

The preferred maintenance period that is obtained from the server when the backup is created. 

VARCHAR
s3_data_size

This field is deprecated and is no longer used. 

BIGINT
s3_data_url

This field is deprecated and is no longer used. 

VARCHAR
s3_log_url

The Amazon S3 URL of the backup's log file. 

VARCHAR
security_group_ids

The security group IDs that are obtained from the server when the backup is created. 

VARCHAR[]
Show child fields
security_group_ids[]
service_role_arn

The service role ARN that is obtained from the server when the backup is created. 

VARCHAR
status

The status of a backup while in progress. 

VARCHAR
status_description

An informational message about backup status. 

VARCHAR
subnet_ids

The subnet IDs that are obtained from the server when the backup is created. 

VARCHAR[]
Show child fields
subnet_ids[]
tools_version

The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created. 

VARCHAR
user_arn

The IAM user ARN of the requester for manual backups. This field is empty for automated backups. 

VARCHAR