RDS / Client / describe_db_instance_automated_backups

describe_db_instance_automated_backups#

RDS.Client.describe_db_instance_automated_backups(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_db_instance_automated_backups(
    DbiResourceId='string',
    DBInstanceIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    DBInstanceAutomatedBackupsArn='string'
)
Parameters:

  • DbiResourceId (string) – The resource ID of the DB instance that is the source of the automated backup. This parameter isn’t case-sensitive.

  • DBInstanceIdentifier (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’s 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.

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

    • (dict) –

      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

      • DescribeDBRecommendations

      • DescribeDBShardGroups

      • DescribePendingMaintenanceActions

      • Name (string) – [REQUIRED]

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

      • Values (list) – [REQUIRED]

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

        • (string) –

  • MaxRecords (integer) – 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.

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

  • DBInstanceAutomatedBackupsArn (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'DBInstanceAutomatedBackups': [
        {
            'DBInstanceArn': 'string',
            'DbiResourceId': 'string',
            'Region': 'string',
            'DBInstanceIdentifier': 'string',
            'RestoreWindow': {
                'EarliestTime': datetime(2015, 1, 1),
                'LatestTime': datetime(2015, 1, 1)
            },
            'AllocatedStorage': 123,
            'Status': 'string',
            'Port': 123,
            'AvailabilityZone': 'string',
            'VpcId': 'string',
            'InstanceCreateTime': datetime(2015, 1, 1),
            'MasterUsername': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'Iops': 123,
            'OptionGroupName': 'string',
            'TdeCredentialArn': 'string',
            'Encrypted': True|False,
            'StorageType': 'string',
            'KmsKeyId': 'string',
            'Timezone': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'BackupRetentionPeriod': 123,
            'DBInstanceAutomatedBackupsArn': 'string',
            'DBInstanceAutomatedBackupsReplications': [
                {
                    'DBInstanceAutomatedBackupsArn': 'string'
                },
            ],
            'BackupTarget': 'string',
            'StorageThroughput': 123,
            'AwsBackupRecoveryPointArn': 'string',
            'DedicatedLogVolume': True|False,
            'MultiTenant': True|False
        },
    ]
}

Response Structure

  • (dict) –

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

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

      • (dict) –

        An automated backup of a DB instance. 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 backups.

        • DbiResourceId (string) –

          The resource ID for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.

        • Region (string) –

          The Amazon Web Services Region associated with the automated backup.

        • DBInstanceIdentifier (string) –

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

        • RestoreWindow (dict) –

          The earliest and latest time a DB instance can be restored to.

          • EarliestTime (datetime) –

            The earliest time you can restore an instance to.

          • LatestTime (datetime) –

            The latest time you can restore an instance to.

        • AllocatedStorage (integer) –

          The allocated storage size for the the automated backup in gibibytes (GiB).

        • Status (string) –

          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 Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

        • VpcId (string) –

          The VPC ID associated with the DB instance.

        • InstanceCreateTime (datetime) –

          The date and time when the DB instance was created.

        • MasterUsername (string) –

          The master user name 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) –

          The 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) –

          Indicates whether the automated backup is encrypted.

        • StorageType (string) –

          The storage type associated with the automated backup.

        • KmsKeyId (string) –

          The Amazon Web Services KMS key ID for an automated backup.

          The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS 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 Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • BackupRetentionPeriod (integer) –

          The retention period for the automated backups.

        • DBInstanceAutomatedBackupsArn (string) –

          The Amazon Resource Name (ARN) for the replicated automated backups.

        • DBInstanceAutomatedBackupsReplications (list) –

          The list of replications to different Amazon Web Services Regions associated with the automated backup.

          • (dict) –

            Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.

            • DBInstanceAutomatedBackupsArn (string) –

              The Amazon Resource Name (ARN) of the replicated automated backups.

        • BackupTarget (string) –

          The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

        • StorageThroughput (integer) –

          The storage throughput for the automated backup.

        • AwsBackupRecoveryPointArn (string) –

          The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        • DedicatedLogVolume (boolean) –

          Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

        • MultiTenant (boolean) –

          Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Exceptions