opsworkscm_describe_backups: Describes backups

Description Usage Arguments Value Request syntax

View source: R/opsworkscm_operations.R

Description

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.

Usage

1
opsworkscm_describe_backups(BackupId, ServerName, NextToken, MaxResults)

Arguments

BackupId

Describes a single backup.

ServerName

Returns backups for the server with the specified ServerName.

NextToken

This is not currently implemented for describe_backups requests.

MaxResults

This is not currently implemented for describe_backups requests.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
list(
  Backups = list(
    list(
      BackupArn = "string",
      BackupId = "string",
      BackupType = "AUTOMATED"|"MANUAL",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      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 = list(
        "string"
      ),
      ServerName = "string",
      ServiceRoleArn = "string",
      Status = "IN_PROGRESS"|"OK"|"FAILED"|"DELETING",
      StatusDescription = "string",
      SubnetIds = list(
        "string"
      ),
      ToolsVersion = "string",
      UserArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
6
svc$describe_backups(
  BackupId = "string",
  ServerName = "string",
  NextToken = "string",
  MaxResults = 123
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.