Skip to content

Returns details about your report jobs

Description

Returns details about your report jobs.

Usage

backup_list_report_jobs(ByReportPlanName, ByCreationBefore,
  ByCreationAfter, ByStatus, MaxResults, NextToken)

Arguments

  • ByReportPlanName

    Returns only report jobs with the specified report plan name.

  • ByCreationBefore

    Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

  • ByCreationAfter

    Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

  • ByStatus

    Returns only report jobs that are in the specified status. The statuses are:

    CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES

    Please note that only scanning jobs finish with state completed with issues. For backup jobs this is a console interpretation of a job that finishes in completed state and has a status message.

  • MaxResults

    The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

  • NextToken

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Value

A list with the following syntax:

list(
  ReportJobs = list(
    list(
      ReportJobId = "string",
      ReportPlanArn = "string",
      ReportTemplate = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      CompletionTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "string",
      StatusMessage = "string",
      ReportDestination = list(
        S3BucketName = "string",
        S3Keys = list(
          "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_report_jobs(
  ByReportPlanName = "string",
  ByCreationBefore = as.POSIXct(
    "2015-01-01"
  ),
  ByCreationAfter = as.POSIXct(
    "2015-01-01"
  ),
  ByStatus = "string",
  MaxResults = 123,
  NextToken = "string"
)