Skip to content

RDS  >  Operations  >  describe_db_instance_automated_backups

describe_db_instance_automated_backups

Operation

describe_db_instance_automated_backups async

describe_db_instance_automated_backups(request: DescribeDBInstanceAutomatedBackupsInput | DescribeDBInstanceAutomatedBackupsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBInstanceAutomatedBackupsOutput
describe_db_instance_automated_backups(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBInstanceAutomatedBackupsInputDict]) -> DescribeDBInstanceAutomatedBackupsOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeDBInstanceAutomatedBackupsOutput

An instance of DescribeDBInstanceAutomatedBackupsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeDBInstanceAutomatedBackupsInput dataclass

Bases: _SerdeShape

Parameter input for DescribeDBInstanceAutomatedBackups.

Attributes
db_instance_automated_backups_arn class-attribute instance-attribute
db_instance_automated_backups_arn: str | None = ...

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

db_instance_identifier class-attribute instance-attribute
db_instance_identifier: str | None = ...

(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's automated backup. This parameter isn't case-sensitive.

dbi_resource_id class-attribute instance-attribute
dbi_resource_id: str | None = ...

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

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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

Supported filters are the following:

  • status

  • active - Automated backups for current instances.

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

  • retained - Automated backups for deleted instances and after backup replication is stopped.

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

  • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). 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.

marker class-attribute instance-attribute
marker: str | None = ...

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

max_records class-attribute instance-attribute
max_records: int | None = ...

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Dictionaries

DescribeDBInstanceAutomatedBackupsInputDict

Bases: TypedDict

Dictionary form of DescribeDBInstanceAutomatedBackupsInput.

Attributes
db_instance_automated_backups_arn instance-attribute
db_instance_automated_backups_arn: str | None

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

db_instance_identifier instance-attribute
db_instance_identifier: str | None

(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's automated backup. This parameter isn't case-sensitive.

dbi_resource_id instance-attribute
dbi_resource_id: str | None

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

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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

Supported filters are the following:

  • status

  • active - Automated backups for current instances.

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

  • retained - Automated backups for deleted instances and after backup replication is stopped.

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

  • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). 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.

marker instance-attribute
marker: str | None

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

max_records instance-attribute
max_records: int | None

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Output

DescribeDBInstanceAutomatedBackupsOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

Attributes

db_instance_automated_backups class-attribute instance-attribute
db_instance_automated_backups: list[DBInstanceAutomatedBackup] | None = ...

A list of DBInstanceAutomatedBackup instances.

marker class-attribute instance-attribute
marker: str | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.