describe-db-instance-automated-backups¶

Description¶

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

Synopsis¶

  describe-db-instance-automated-backups
[--dbi-resource-id <value>]
[--db-instance-identifier <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--dbi-resource-id (string)

The resource ID of the DB instance that is the source of the automated backup. This parameter isn’t case-sensitive.

--db-instance-identifier (string)

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance’ automated backup. This parameter isn’t case-sensitive.

--filters (list)

A filter that specifies which resources to return based on status.

Supported filters are the following:

status

active - automated backups for current instances

retained - automated backups for deleted instances

creating - automated backups that are waiting for the first automated snapshot to be available

db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs.

dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:

DescribeDBClusterBacktracks

DescribeDBClusterEndpoints

DescribeDBClusters

DescribeDBInstances

DescribePendingMaintenanceActions

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

One or more filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe the automated backups for a DB instance

The following describe-db-instance-automated-backups example displays details about the automated backups for the specified DB instance.

aws rds describe-db-instance-automated-backups \
    --db-instance-identifier database-mysql

Output:

{
    "DBInstanceAutomatedBackups": [
        {
            "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:database-mysql",
            "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE",
            "Region": "us-east-1",
            "DBInstanceIdentifier": "database-mysql",
            "RestoreWindow": {
                "EarliestTime": "2019-06-13T08:39:38.359Z",
                "LatestTime": "2019-06-20T23:00:00Z"
            },
            "AllocatedStorage": 100,
            "Status": "active",
            "Port": 3306,
            "AvailabilityZone": "us-east-1b",
            "VpcId": "vpc-6594f31c",
            "InstanceCreateTime": "2019-04-30T15:45:53Z",
            "MasterUsername": "admin",
            "Engine": "mysql",
            "EngineVersion": "5.6.40",
            "LicenseModel": "general-public-license",
            "Iops": 1000,
            "OptionGroupName": "default:mysql-5-6",
            "Encrypted": true,
            "StorageType": "io1",
            "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE",
            "IAMDatabaseAuthenticationEnabled": false
        }
    ]
}

For more information, see Working With Backups in the Amazon RDS User Guide.

Output¶

Marker -> (string)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

DBInstanceAutomatedBackups -> (list)

A list of DBInstanceAutomatedBackup instances.

(structure)

An automated backup of a DB instance. It it consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

DBInstanceArn -> (string)

The Amazon Resource Name (ARN) for the automated backup.

DbiResourceId -> (string)

The identifier for the source DB instance, which can’t be changed and which is unique to an AWS Region.

Region -> (string)

The AWS Region associated with the automated backup.

DBInstanceIdentifier -> (string)

The customer id of the instance that is/was associated with the automated backup.

RestoreWindow -> (structure)

Earliest and latest time an instance can be restored to.

EarliestTime -> (timestamp)

The earliest time you can restore an instance to.

LatestTime -> (timestamp)

The latest time you can restore an instance to.

AllocatedStorage -> (integer)

Specifies the allocated storage size in gibibytes (GiB).

Status -> (string)

Provides a list of status information for an automated backup:

active - automated backups for current instances

retained - automated backups for deleted instances

creating - automated backups that are waiting for the first automated snapshot to be available.

Port -> (integer)

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

AvailabilityZone -> (string)

The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones .

VpcId -> (string)

Provides the VPC ID associated with the DB instance

InstanceCreateTime -> (timestamp)

Provides the date and time that the DB instance was created.

MasterUsername -> (string)

The license model of an automated backup.

Engine -> (string)

The name of the database engine for this automated backup.

EngineVersion -> (string)

The version of the database engine for the automated backup.

LicenseModel -> (string)

License model information for the automated backup.

Iops -> (integer)

The IOPS (I/O operations per second) value for the automated backup.

OptionGroupName -> (string)

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

TdeCredentialArn -> (string)

The ARN from the key store with which the automated backup is associated for TDE encryption.

Encrypted -> (boolean)

Specifies whether the automated backup is encrypted.

StorageType -> (string)

Specifies the storage type associated with the automated backup.

KmsKeyId -> (string)

The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Timezone -> (string)

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

IAMDatabaseAuthenticationEnabled -> (boolean)

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Table of Contents

Feedback

User Guide