AWS Backup
Developer Guide

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.

CreateBackupSelection

Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

  • Resources: "arn:aws:ec2:region:account-id:volume/volume-id"

  • ConditionKey:"department"

    ConditionValue:"finance"

    ConditionType:"STRINGEQUALS"

  • ConditionKey:"importance"

    ConditionValue:"critical"

    ConditionType:"STRINGEQUALS"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.

Request Syntax

PUT /backup/plans/backupPlanId/selections/ HTTP/1.1 Content-type: application/json { "BackupSelection": { "IamRoleArn": "string", "ListOfTags": [ { "ConditionKey": "string", "ConditionType": "string", "ConditionValue": "string" } ], "Resources": [ "string" ], "SelectionName": "string" }, "CreatorRequestId": "string" }

URI Request Parameters

The request requires the following URI parameters.

backupPlanId

Uniquely identifies the backup plan to be associated with the selection of resources.

Request Body

The request accepts the following data in JSON format.

BackupSelection

Specifies the body of a request to assign a set of resources to a backup plan.

Type: BackupSelection object

Required: Yes

CreatorRequestId

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "BackupPlanId": "string", "CreationDate": number, "SelectionId": "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.

BackupPlanId

Uniquely identifies a backup plan.

Type: String

CreationDate

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

SelectionId

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Type: String

Errors

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

AlreadyExistsException

The required resource already exists.

HTTP Status Code: 400

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

LimitExceededException

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

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