OpsWorksCM / Client / describe_backups

describe_backups#

OpsWorksCM.Client.describe_backups(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_backups(
    BackupId='string',
    ServerName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • BackupId (string) – Describes a single backup.

  • ServerName (string) – Returns backups for the server with the specified ServerName.

  • NextToken (string) – This is not currently implemented for DescribeBackups requests.

  • MaxResults (integer) – This is not currently implemented for DescribeBackups requests.

Return type:

dict

Returns:

Response Syntax

{
    'Backups': [
        {
            'BackupArn': 'string',
            'BackupId': 'string',
            'BackupType': 'AUTOMATED'|'MANUAL',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Engine': 'string',
            'EngineModel': 'string',
            'EngineVersion': 'string',
            'InstanceProfileArn': 'string',
            'InstanceType': 'string',
            'KeyPair': 'string',
            'PreferredBackupWindow': 'string',
            'PreferredMaintenanceWindow': 'string',
            'S3DataSize': 123,
            'S3DataUrl': 'string',
            'S3LogUrl': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'ServerName': 'string',
            'ServiceRoleArn': 'string',
            'Status': 'IN_PROGRESS'|'OK'|'FAILED'|'DELETING',
            'StatusDescription': 'string',
            'SubnetIds': [
                'string',
            ],
            'ToolsVersion': 'string',
            'UserArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Backups (list) –

      Contains the response to a DescribeBackups request.

      • (dict) –

        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 (datetime) –

          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.

Exceptions