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

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

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

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

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

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: