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.

Synopsis¶

  describe-backups
[--backup-id <value>]
[--server-name <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--backup-id (string)

Describes a single backup.

--server-name (string)

Returns backups for the server with the specified ServerName.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe backups

The following describe-backups command returns information about all backups associated with your account in your default region.:

aws opsworks-cm describe-backups

The output for each backup entry returned by the command resembles the following. Output:

{
 "Backups": [
    {
       "BackupArn": "string",
       "BackupId": "automate-06-20160729133847520",
       "BackupType": "MANUAL",
       "CreatedAt": 2016-07-29T13:38:47.520Z,
       "Description": "state of my infrastructure at launch",
       "Engine": "Chef",
       "EngineModel": "Single",
       "EngineVersion": "12",
       "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2",
       "InstanceType": "m4.large",
       "KeyPair": "",
       "PreferredBackupWindow": "",
       "PreferredMaintenanceWindow": "",
       "S3LogUrl": "https://s3.amazonaws.com/automate-06/automate-06-20160729133847520",
       "SecurityGroupIds": [ "sg-1a24c270" ],
       "ServerName": "automate-06",
       "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735",
       "Status": "Successful",
       "StatusDescription": "",
       "SubnetIds": [ "subnet-49436a18" ],
       "ToolsVersion": "string",
       "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user"
    }
 ],
}

More Information

For more information, see Back Up and Restore an AWS OpsWorks for Chef Automate Server in the AWS OpsWorks User Guide.

Output¶

Backups -> (list)

Contains the response to a DescribeBackups request.

(structure)

Describes a single backup.

BackupArn -> (string)

The ARN of the backup.

BackupId -> (string)

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

BackupType -> (string)

The backup type. Valid values are automated or manual .

CreatedAt -> (timestamp)

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

Description -> (string)

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

Engine -> (string)

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

EngineModel -> (string)

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

EngineVersion -> (string)

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

InstanceProfileArn -> (string)

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.

InstanceType -> (string)

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

KeyPair -> (string)

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

PreferredBackupWindow -> (string)

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

PreferredMaintenanceWindow -> (string)

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

S3DataSize -> (integer)

This field is deprecated and is no longer used.

S3DataUrl -> (string)

This field is deprecated and is no longer used.

S3LogUrl -> (string)

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

SecurityGroupIds -> (list)

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

(string)

ServerName -> (string)

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

ServiceRoleArn -> (string)

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

Status -> (string)

The status of a backup while in progress.

StatusDescription -> (string)

An informational message about backup status.

SubnetIds -> (list)

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

(string)

ToolsVersion -> (string)

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

UserArn -> (string)

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

NextToken -> (string)

This is not currently implemented for DescribeBackups requests.

Table of Contents

Feedback

User Guide