Describe Jobs

drs_describe_jobs

R Documentation

Returns a list of Jobs

Description

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

Usage

drs_describe_jobs(filters, maxResults, nextToken)

Arguments

filters

A set of filters by which to return Jobs.

maxResults

Maximum number of Jobs to retrieve.

nextToken

The token of the next Job to retrieve.

Value

A list with the following syntax:

list(
  items = list(
    list(
      arn = "string",
      creationDateTime = "string",
      endDateTime = "string",
      initiatedBy = "START_RECOVERY"|"START_DRILL"|"FAILBACK"|"DIAGNOSTIC"|"TERMINATE_RECOVERY_INSTANCES"|"TARGET_ACCOUNT"|"CREATE_NETWORK_RECOVERY"|"UPDATE_NETWORK_RECOVERY"|"ASSOCIATE_NETWORK_RECOVERY",
      jobID = "string",
      participatingResources = list(
        list(
          launchStatus = "PENDING"|"IN_PROGRESS"|"LAUNCHED"|"FAILED"|"TERMINATED",
          participatingResourceID = list(
            sourceNetworkID = "string"
          )
        )
      ),
      participatingServers = list(
        list(
          launchActionsStatus = list(
            runs = list(
              list(
                action = list(
                  actionCode = "string",
                  actionId = "string",
                  actionVersion = "string",
                  active = TRUE|FALSE,
                  category = "MONITORING"|"VALIDATION"|"CONFIGURATION"|"SECURITY"|"OTHER",
                  description = "string",
                  name = "string",
                  optional = TRUE|FALSE,
                  order = 123,
                  parameters = list(
                    list(
                      type = "SSM_STORE"|"DYNAMIC",
                      value = "string"
                    )
                  ),
                  type = "SSM_AUTOMATION"|"SSM_COMMAND"
                ),
                failureReason = "string",
                runId = "string",
                status = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"
              )
            ),
            ssmAgentDiscoveryDatetime = "string"
          ),
          launchStatus = "PENDING"|"IN_PROGRESS"|"LAUNCHED"|"FAILED"|"TERMINATED",
          recoveryInstanceID = "string",
          sourceServerID = "string"
        )
      ),
      status = "PENDING"|"STARTED"|"COMPLETED",
      tags = list(
        "string"
      ),
      type = "LAUNCH"|"TERMINATE"|"CREATE_CONVERTED_SNAPSHOT"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_jobs(
  filters = list(
    fromDate = "string",
    jobIDs = list(
      "string"
    ),
    toDate = "string"
  ),
  maxResults = 123,
  nextToken = "string"
)