backup_plan_versions
Creates, updates, deletes, gets or lists a backup_plan_versions resource.
Overview
| Name | backup_plan_versions |
| Type | Resource |
| Id | aws.backup.backup_plan_versions |
Fields
The following fields are returned by SELECT queries:
- list_backup_plan_versions
| Name | Datatype | Description |
|---|---|---|
advanced_backup_settings | array | Contains a list of BackupOptions for a resource type. |
backup_plan_arn | string | An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. |
backup_plan_id | string | Uniquely identifies a backup plan. |
backup_plan_name | string | The display name of a saved backup plan. |
creation_date | string (date-time) | The date and time a resource backup plan 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. |
creator_request_id | string | A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters. |
deletion_date | string (date-time) | The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. |
last_execution_date | string (date-time) | The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. |
version_id | string | Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_backup_plan_versions | select | backup_plan_id, region | nextToken, maxResults | Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
backup_plan_id | string | Uniquely identifies a backup plan. |
region | string | AWS region (default: us-east-1) |
maxResults | integer | The maximum number of items to be returned. |
nextToken | string | The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token. |
SELECT examples
- list_backup_plan_versions
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
SELECT
advanced_backup_settings,
backup_plan_arn,
backup_plan_id,
backup_plan_name,
creation_date,
creator_request_id,
deletion_date,
last_execution_date,
version_id
FROM aws.backup.backup_plan_versions
WHERE backup_plan_id = '{{ backup_plan_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;