amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.DescribeDBInstanceAutomatedBackups

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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBInstanceAutomatedBackups Source #

Parameter input for DescribeDBInstanceAutomatedBackups.

See: newDescribeDBInstanceAutomatedBackups smart constructor.

Constructors

DescribeDBInstanceAutomatedBackups' 

Fields

  • dbInstanceAutomatedBackupsArn :: Maybe Text

    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.

  • dbInstanceIdentifier :: Maybe Text

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

  • dbiResourceId :: Maybe Text

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

  • filters :: Maybe [Filter]

    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 and after backup replication is stopped
      • 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). 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 :: Maybe Text

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

  • maxRecords :: Maybe Int

    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.

Instances

Instances details
ToHeaders DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

ToPath DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

ToQuery DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

AWSPager DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

AWSRequest DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Generic DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Associated Types

type Rep DescribeDBInstanceAutomatedBackups :: Type -> Type #

Read DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Show DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

NFData DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Eq DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Hashable DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

type AWSResponse DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

type Rep DescribeDBInstanceAutomatedBackups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

type Rep DescribeDBInstanceAutomatedBackups = D1 ('MetaData "DescribeDBInstanceAutomatedBackups" "Amazonka.RDS.DescribeDBInstanceAutomatedBackups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBInstanceAutomatedBackups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbInstanceAutomatedBackupsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newDescribeDBInstanceAutomatedBackups :: DescribeDBInstanceAutomatedBackups Source #

Create a value of DescribeDBInstanceAutomatedBackups with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDBInstanceAutomatedBackups, describeDBInstanceAutomatedBackups_dbInstanceAutomatedBackupsArn - 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.

DescribeDBInstanceAutomatedBackups, describeDBInstanceAutomatedBackups_dbInstanceIdentifier - (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.

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

$sel:filters:DescribeDBInstanceAutomatedBackups', describeDBInstanceAutomatedBackups_filters - 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 and after backup replication is stopped
    • 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). 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.

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

$sel:maxRecords:DescribeDBInstanceAutomatedBackups', describeDBInstanceAutomatedBackups_maxRecords - 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.

Request Lenses

describeDBInstanceAutomatedBackups_dbInstanceAutomatedBackupsArn :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

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.

describeDBInstanceAutomatedBackups_dbInstanceIdentifier :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

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

describeDBInstanceAutomatedBackups_dbiResourceId :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

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

describeDBInstanceAutomatedBackups_filters :: Lens' DescribeDBInstanceAutomatedBackups (Maybe [Filter]) Source #

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 and after backup replication is stopped
    • 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). 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.

describeDBInstanceAutomatedBackups_marker :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Text) Source #

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

describeDBInstanceAutomatedBackups_maxRecords :: Lens' DescribeDBInstanceAutomatedBackups (Maybe Int) Source #

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.

Destructuring the Response

data DescribeDBInstanceAutomatedBackupsResponse Source #

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

See: newDescribeDBInstanceAutomatedBackupsResponse smart constructor.

Constructors

DescribeDBInstanceAutomatedBackupsResponse' 

Fields

Instances

Instances details
Generic DescribeDBInstanceAutomatedBackupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Read DescribeDBInstanceAutomatedBackupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Show DescribeDBInstanceAutomatedBackupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

NFData DescribeDBInstanceAutomatedBackupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

Eq DescribeDBInstanceAutomatedBackupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

type Rep DescribeDBInstanceAutomatedBackupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBInstanceAutomatedBackups

type Rep DescribeDBInstanceAutomatedBackupsResponse = D1 ('MetaData "DescribeDBInstanceAutomatedBackupsResponse" "Amazonka.RDS.DescribeDBInstanceAutomatedBackups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBInstanceAutomatedBackupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstanceAutomatedBackups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBInstanceAutomatedBackup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBInstanceAutomatedBackupsResponse Source #

Create a value of DescribeDBInstanceAutomatedBackupsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbInstanceAutomatedBackups:DescribeDBInstanceAutomatedBackupsResponse', describeDBInstanceAutomatedBackupsResponse_dbInstanceAutomatedBackups - A list of DBInstanceAutomatedBackup instances.

DescribeDBInstanceAutomatedBackups, describeDBInstanceAutomatedBackupsResponse_marker - 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.

$sel:httpStatus:DescribeDBInstanceAutomatedBackupsResponse', describeDBInstanceAutomatedBackupsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBInstanceAutomatedBackupsResponse_marker :: Lens' DescribeDBInstanceAutomatedBackupsResponse (Maybe Text) Source #

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.