List Jobs

locationservice_list_jobs

R Documentation

ListJobs retrieves a list of jobs with optional filtering and pagination support

Description

list_jobs retrieves a list of jobs with optional filtering and pagination support.

For more information, see Job concepts in the Amazon Location Service Developer Guide.

Usage

locationservice_list_jobs(Filter, MaxResults, NextToken)

Arguments

Filter	An optional structure containing criteria by which to filter job results.
MaxResults	Maximum number of jobs to return.
NextToken	The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Value

A list with the following syntax:

list(
  Entries = list(
    list(
      Action = "ValidateAddress",
      ActionOptions = list(
        ValidateAddress = list(
          AdditionalFeatures = list(
            "Position"|"CountrySpecificAttributes"
          )
        )
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ExecutionRoleArn = "string",
      EndedAt = as.POSIXct(
        "2015-01-01"
      ),
      Error = list(
        Code = "ValidationError"|"InternalServerError",
        Messages = list(
          "string"
        )
      ),
      InputOptions = list(
        Location = "string",
        Format = "Parquet"
      ),
      JobId = "string",
      JobArn = "string",
      Name = "string",
      OutputOptions = list(
        Format = "Parquet",
        Location = "string"
      ),
      Status = "Pending"|"Running"|"Completed"|"Failed"|"Cancelling"|"Cancelled",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_jobs(
  Filter = list(
    JobStatus = "Pending"|"Running"|"Completed"|"Failed"|"Cancelling"|"Cancelled"
  ),
  MaxResults = 123,
  NextToken = "string"
)