Skip to content

Retrieves the status and details of a specified automation job, including its status and outputs

Description

Retrieves the status and details of a specified automation job, including its status and outputs.

Usage

quicksight_describe_automation_job(AwsAccountId, AutomationGroupId,
  AutomationId, IncludeInputPayload, IncludeOutputPayload, JobId)

Arguments

  • AwsAccountId

    [required] The ID of the Amazon Web Services account that contains the automation job.

  • AutomationGroupId

    [required] The ID of the automation group that contains the automation.

  • AutomationId

    [required] The ID of the automation that the job belongs to.

  • IncludeInputPayload

    A Boolean value that indicates whether to include the input payload in the response. If set to true, the input payload will be included. If set to false, the input payload will be returned as null.

  • IncludeOutputPayload

    A Boolean value that indicates whether to include the output payload in the response. If set to true, the output payload will be included. If set to false, the output payload will be returned as null.

  • JobId

    [required] The ID of the automation job to describe.

Value

A list with the following syntax:

list(
  Arn = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  StartedAt = as.POSIXct(
    "2015-01-01"
  ),
  EndedAt = as.POSIXct(
    "2015-01-01"
  ),
  JobStatus = "FAILED"|"RUNNING"|"SUCCEEDED"|"QUEUED"|"STOPPED",
  InputPayload = "string",
  OutputPayload = "string",
  RequestId = "string"
)

Request syntax

svc$describe_automation_job(
  AwsAccountId = "string",
  AutomationGroupId = "string",
  AutomationId = "string",
  IncludeInputPayload = TRUE|FALSE,
  IncludeOutputPayload = TRUE|FALSE,
  JobId = "string"
)