List Jobs

gluedatabrew_list_jobs

R Documentation

Lists all of the DataBrew jobs that are defined

Description

Lists all of the DataBrew jobs that are defined.

Usage

gluedatabrew_list_jobs(DatasetName, MaxResults, NextToken, ProjectName)

Arguments

DatasetName

The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.

MaxResults

The maximum number of results to return in this request.

NextToken

A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

ProjectName

The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.

Value

A list with the following syntax:

list(
  Jobs = list(
    list(
      AccountId = "string",
      CreatedBy = "string",
      CreateDate = as.POSIXct(
        "2015-01-01"
      ),
      DatasetName = "string",
      EncryptionKeyArn = "string",
      EncryptionMode = "SSE-KMS"|"SSE-S3",
      Name = "string",
      Type = "PROFILE"|"RECIPE",
      LastModifiedBy = "string",
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      LogSubscription = "ENABLE"|"DISABLE",
      MaxCapacity = 123,
      MaxRetries = 123,
      Outputs = list(
        list(
          CompressionFormat = "GZIP"|"LZ4"|"SNAPPY"|"BZIP2"|"DEFLATE"|"LZO"|"BROTLI"|"ZSTD"|"ZLIB",
          Format = "CSV"|"JSON"|"PARQUET"|"GLUEPARQUET"|"AVRO"|"ORC"|"XML"|"TABLEAUHYPER",
          PartitionColumns = list(
            "string"
          ),
          Location = list(
            Bucket = "string",
            Key = "string",
            BucketOwner = "string"
          ),
          Overwrite = TRUE|FALSE,
          FormatOptions = list(
            Csv = list(
              Delimiter = "string"
            )
          ),
          MaxOutputFiles = 123
        )
      ),
      DataCatalogOutputs = list(
        list(
          CatalogId = "string",
          DatabaseName = "string",
          TableName = "string",
          S3Options = list(
            Location = list(
              Bucket = "string",
              Key = "string",
              BucketOwner = "string"
            )
          ),
          DatabaseOptions = list(
            TempDirectory = list(
              Bucket = "string",
              Key = "string",
              BucketOwner = "string"
            ),
            TableName = "string"
          ),
          Overwrite = TRUE|FALSE
        )
      ),
      DatabaseOutputs = list(
        list(
          GlueConnectionName = "string",
          DatabaseOptions = list(
            TempDirectory = list(
              Bucket = "string",
              Key = "string",
              BucketOwner = "string"
            ),
            TableName = "string"
          ),
          DatabaseOutputMode = "NEW_TABLE"
        )
      ),
      ProjectName = "string",
      RecipeReference = list(
        Name = "string",
        RecipeVersion = "string"
      ),
      ResourceArn = "string",
      RoleArn = "string",
      Timeout = 123,
      Tags = list(
        "string"
      ),
      JobSample = list(
        Mode = "FULL_DATASET"|"CUSTOM_ROWS",
        Size = 123
      ),
      ValidationConfigurations = list(
        list(
          RulesetArn = "string",
          ValidationMode = "CHECK_ALL"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_jobs(
  DatasetName = "string",
  MaxResults = 123,
  NextToken = "string",
  ProjectName = "string"
)