AWS OpsWorks CM
API Reference (API Version 2016-11-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeBackups

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.

Request Syntax

{ "BackupId": "string", "MaxResults": number, "NextToken": "string", "ServerName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

BackupId

Describes a single backup.

Type: String

Length Constraints: Maximum length of 79.

Required: No

MaxResults

This is not currently implemented for DescribeBackups requests.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

This is not currently implemented for DescribeBackups requests.

Type: String

Required: No

ServerName

Returns backups for the server with the specified ServerName.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: No

Response Syntax

{ "Backups": [ { "BackupArn": "string", "BackupId": "string", "BackupType": "string", "CreatedAt": number, "Description": "string", "Engine": "string", "EngineModel": "string", "EngineVersion": "string", "InstanceProfileArn": "string", "InstanceType": "string", "KeyPair": "string", "PreferredBackupWindow": "string", "PreferredMaintenanceWindow": "string", "S3DataSize": number, "S3DataUrl": "string", "S3LogUrl": "string", "SecurityGroupIds": [ "string" ], "ServerName": "string", "ServiceRoleArn": "string", "Status": "string", "StatusDescription": "string", "SubnetIds": [ "string" ], "ToolsVersion": "string", "UserArn": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Backups

Contains the response to a DescribeBackups request.

Type: Array of Backup objects

NextToken

This is not currently implemented for DescribeBackups requests.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

This occurs when the provided nextToken is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400

ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: