Skip to content

List Dataset Import Jobs

forecastservice_list_dataset_import_jobs R Documentation

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation

Description

Returns a list of dataset import jobs created using the create_dataset_import_job operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the describe_dataset_import_job operation. You can filter the list by providing an array of Filter objects.

Usage

forecastservice_list_dataset_import_jobs(NextToken, MaxResults, Filters)

Arguments

NextToken

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

MaxResults

The number of items to return in the response.

Filters

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the datasets that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the datasets that match the statement, specify IS. To exclude matching datasets, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetArn and Status.

  • Value - The value to match.

For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:

⁠"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]⁠

Value

A list with the following syntax: 

list(
  DatasetImportJobs = list(
    list(
      DatasetImportJobArn = "string",
      DatasetImportJobName = "string",
      DataSource = list(
        S3Config = list(
          Path = "string",
          RoleArn = "string",
          KMSKeyArn = "string"
        )
      ),
      Status = "string",
      Message = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModificationTime = as.POSIXct(
        "2015-01-01"
      ),
      ImportMode = "FULL"|"INCREMENTAL"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_dataset_import_jobs(
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Key = "string",
      Value = "string",
      Condition = "IS"|"IS_NOT"
    )
  )
)