npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_databrew

v5.0.0

Published

DataFire integration for AWS Glue DataBrew

Downloads

7

Readme

@datafire/amazonaws_databrew

Client library for AWS Glue DataBrew

Installation and Usage

npm install --save @datafire/amazonaws_databrew
let amazonaws_databrew = require('@datafire/amazonaws_databrew').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew simplifies data preparation tasks, targeting data issues that are hard to spot and time-consuming to fix. DataBrew empowers users of all technical levels to visualize the data and perform one-click data transformations, with no coding required.

Actions

ListDatasets

amazonaws_databrew.ListDatasets({}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

CreateDataset

amazonaws_databrew.CreateDataset({
  "Name": "",
  "Input": {}
}, context)

Input

  • input object
    • FormatOptions object: Options that define how Microsoft Excel input is to be interpreted by DataBrew.
    • Input required object: Information on how AWS Glue DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.
      • DataCatalogInputDefinition
        • CatalogId
        • DatabaseName required
        • TableName required
        • TempDirectory
          • Bucket required
          • Key
      • S3InputDefinition
        • Bucket required
        • Key
    • Name required string: The name of the dataset to be created.
    • Tags object: Metadata tags to apply to this dataset.

Output

DeleteDataset

amazonaws_databrew.DeleteDataset({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

DescribeDataset

amazonaws_databrew.DescribeDataset({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

UpdateDataset

amazonaws_databrew.UpdateDataset({
  "name": "",
  "Input": {}
}, context)

Input

  • input object
    • name required string
    • FormatOptions object: Options that define how Microsoft Excel input is to be interpreted by DataBrew.
    • Input required object: Information on how AWS Glue DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.
      • DataCatalogInputDefinition
        • CatalogId
        • DatabaseName required
        • TableName required
        • TempDirectory
          • Bucket required
          • Key
      • S3InputDefinition
        • Bucket required
        • Key

Output

ListJobs

amazonaws_databrew.ListJobs({}, context)

Input

  • input object
    • datasetName string
    • maxResults integer
    • nextToken string
    • projectName string
    • MaxResults string
    • NextToken string

Output

DeleteJob

amazonaws_databrew.DeleteJob({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

DescribeJob

amazonaws_databrew.DescribeJob({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

StopJobRun

amazonaws_databrew.StopJobRun({
  "name": "",
  "runId": ""
}, context)

Input

  • input object
    • name required string
    • runId required string

Output

ListJobRuns

amazonaws_databrew.ListJobRuns({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

StartJobRun

amazonaws_databrew.StartJobRun({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

CreateProfileJob

amazonaws_databrew.CreateProfileJob({
  "DatasetName": "",
  "Name": "",
  "OutputLocation": {},
  "RoleArn": ""
}, context)

Input

  • input object
    • DatasetName required string: The name of the dataset that this job is to act upon.
    • EncryptionKeyArn string: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
    • EncryptionMode string (values: SSE-KMS, SSE-S3): The encryption mode for the job, which can be one of the following: SSE-KMS - para>SSE-KMS - server-side encryption with AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3.
    • LogSubscription string (values: ENABLE, DISABLE): A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.
    • MaxCapacity integer: The maximum number of nodes that DataBrew can use when the job processes data.
    • MaxRetries integer: The maximum number of times to retry the job after a job run fails.
    • Name required string: The name of the job to be created.
    • OutputLocation required object: An Amazon S3 location (bucket name an object key) where DataBrew can read input data, or write output from a job.
      • Bucket
      • Key
    • RoleArn required string: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.
    • Tags object: Metadata tags to apply to this job.
    • Timeout integer: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Output

UpdateProfileJob

amazonaws_databrew.UpdateProfileJob({
  "name": "",
  "OutputLocation": {},
  "RoleArn": ""
}, context)

Input

  • input object
    • name required string
    • EncryptionKeyArn string: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
    • EncryptionMode string (values: SSE-KMS, SSE-S3): The encryption mode for the job, which can be one of the following: SSE-KMS - Server-side encryption with AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3.
    • LogSubscription string (values: ENABLE, DISABLE): A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.
    • MaxCapacity integer: The maximum number of nodes that DataBrew can use when the job processes data.
    • MaxRetries integer: The maximum number of times to retry the job after a job run fails.
    • OutputLocation required object: An Amazon S3 location (bucket name an object key) where DataBrew can read input data, or write output from a job.
      • Bucket
      • Key
    • RoleArn required string: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.
    • Timeout integer: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Output

ListProjects

amazonaws_databrew.ListProjects({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

CreateProject

amazonaws_databrew.CreateProject({
  "DatasetName": "",
  "Name": "",
  "RecipeName": "",
  "RoleArn": ""
}, context)

Input

  • input object
    • DatasetName required string: The name of the dataset to associate this project with.
    • Name required string: A unique name for the new project.
    • RecipeName required string: The name of an existing recipe to associate with the project.
    • RoleArn required string: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.
    • Sample object: Represents the sample size and sampling type for AWS Glue DataBrew to use for interactive data analysis.
      • Size
      • Type
    • Tags object: Metadata tags to apply to this project.

Output

DeleteProject

amazonaws_databrew.DeleteProject({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

DescribeProject

amazonaws_databrew.DescribeProject({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

UpdateProject

amazonaws_databrew.UpdateProject({
  "name": "",
  "RoleArn": ""
}, context)

Input

  • input object
    • name required string
    • RoleArn required string: The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.
    • Sample object: Represents the sample size and sampling type for AWS Glue DataBrew to use for interactive data analysis.
      • Size
      • Type

Output

SendProjectSessionAction

amazonaws_databrew.SendProjectSessionAction({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • ClientSessionId string: A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.
    • Preview boolean: Returns the result of the recipe step, without applying it. The result isn't added to the view frame stack.
    • RecipeStep object: Represents a single step to be performed in an AWS Glue DataBrew recipe.
    • StepIndex integer: The index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack.
    • ViewFrame object: Represents the data being being transformed during an AWS Glue DataBrew project session.
      • ColumnRange
      • HiddenColumns
      • StartColumnIndex

Output

StartProjectSession

amazonaws_databrew.StartProjectSession({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • AssumeControl boolean: A value that, if true, enables you to take control of a session, even if a different client is currently accessing the project.

Output

CreateRecipeJob

amazonaws_databrew.CreateRecipeJob({
  "Name": "",
  "Outputs": [],
  "RoleArn": ""
}, context)

Input

  • input object
    • DatasetName string: The name of the dataset that this job processes.
    • EncryptionKeyArn string: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
    • EncryptionMode string (values: SSE-KMS, SSE-S3): The encryption mode for the job, which can be one of the following: SSE-KMS - Server-side encryption with AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3.
    • LogSubscription string (values: ENABLE, DISABLE): A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.
    • MaxCapacity integer: The maximum number of nodes that DataBrew can consume when the job processes data.
    • MaxRetries integer: The maximum number of times to retry the job after a job run fails.
    • Name required string: A unique name for the job.
    • Outputs required array: One or more artifacts that represent the output from running the job.
    • ProjectName string: Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
    • RecipeReference object: Represents all of the attributes of an AWS Glue DataBrew recipe.
      • Name
      • RecipeVersion
    • RoleArn required string: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.
    • Tags object: Metadata tags to apply to this job dataset.
    • Timeout integer: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Output

UpdateRecipeJob

amazonaws_databrew.UpdateRecipeJob({
  "name": "",
  "Outputs": [],
  "RoleArn": ""
}, context)

Input

  • input object
    • name required string
    • EncryptionKeyArn string: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
    • EncryptionMode string (values: SSE-KMS, SSE-S3): The encryption mode for the job, which can be one of the following: SSE-KMS - Server-side encryption with AWS KMS-managed keys. SSE-S3 - Server-side encryption with keys managed by Amazon S3.
    • LogSubscription string (values: ENABLE, DISABLE): A value that enables or disables Amazon CloudWatch logging for the current AWS account. If logging is enabled, CloudWatch writes one log stream for each job run.
    • MaxCapacity integer: The maximum number of nodes that DataBrew can consume when the job processes data.
    • MaxRetries integer: The maximum number of times to retry the job after a job run fails.
    • Outputs required array: One or more artifacts that represent the output from running the job.
    • RoleArn required string: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be assumed for this request.
    • Timeout integer: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Output

ListRecipeVersions

amazonaws_databrew.ListRecipeVersions({
  "name": ""
}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • name required string
    • MaxResults string
    • NextToken string

Output

ListRecipes

amazonaws_databrew.ListRecipes({}, context)

Input

  • input object
    • maxResults integer
    • nextToken string
    • recipeVersion string
    • MaxResults string
    • NextToken string

Output

CreateRecipe

amazonaws_databrew.CreateRecipe({
  "Name": "",
  "Steps": []
}, context)

Input

  • input object
    • Description string: A description for the recipe.
    • Name required string: A unique name for the recipe.
    • Steps required array: An array containing the steps to be performed by the recipe. Each recipe step consists of one recipe action and (optionally) an array of condition expressions.
    • Tags object: Metadata tags to apply to this recipe.

Output

DescribeRecipe

amazonaws_databrew.DescribeRecipe({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • recipeVersion string

Output

UpdateRecipe

amazonaws_databrew.UpdateRecipe({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • Description string: A description of the recipe.
    • Steps array: One or more steps to be performed by the recipe. Each step consists of an action, and the conditions under which the action should succeed.

Output

BatchDeleteRecipeVersion

amazonaws_databrew.BatchDeleteRecipeVersion({
  "name": "",
  "RecipeVersions": []
}, context)

Input

  • input object
    • name required string
    • RecipeVersions required array: An array of version identifiers to be deleted.

Output

PublishRecipe

amazonaws_databrew.PublishRecipe({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • Description string: A description of the recipe to be published, for this version of the recipe.

Output

DeleteRecipeVersion

amazonaws_databrew.DeleteRecipeVersion({
  "name": "",
  "recipeVersion": ""
}, context)

Input

  • input object
    • name required string
    • recipeVersion required string

Output

ListSchedules

amazonaws_databrew.ListSchedules({}, context)

Input

  • input object
    • jobName string
    • maxResults integer
    • nextToken string
    • MaxResults string
    • NextToken string

Output

CreateSchedule

amazonaws_databrew.CreateSchedule({
  "CronExpression": "",
  "Name": ""
}, context)

Input

  • input object
    • CronExpression required string: The date or dates and time or times, in cron format, when the jobs are to be run.
    • JobNames array: The name or names of one or more jobs to be run.
    • Name required string: A unique name for the schedule.
    • Tags object: Metadata tags to apply to this schedule.

Output

DeleteSchedule

amazonaws_databrew.DeleteSchedule({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

DescribeSchedule

amazonaws_databrew.DescribeSchedule({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

UpdateSchedule

amazonaws_databrew.UpdateSchedule({
  "name": "",
  "CronExpression": ""
}, context)

Input

  • input object
    • name required string
    • CronExpression required string: The date or dates and time or times, in cron format, when the jobs are to be run.
    • JobNames array: The name or names of one or more jobs to be run for this schedule.

Output

ListTagsForResource

amazonaws_databrew.ListTagsForResource({
  "ResourceArn": ""
}, context)

Input

  • input object
    • ResourceArn required string

Output

TagResource

amazonaws_databrew.TagResource({
  "ResourceArn": "",
  "Tags": {}
}, context)

Input

  • input object
    • ResourceArn required string
    • Tags required object: One or more tags to be assigned to the resource.

Output

UntagResource

amazonaws_databrew.UntagResource({
  "ResourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • ResourceArn required string
    • tagKeys required array

Output

Definitions

AccessDeniedException

AccountId

  • AccountId string

ActionId

  • ActionId integer

Arn

  • Arn string

AssumeControl

  • AssumeControl boolean

Attempt

  • Attempt integer

BatchDeleteRecipeVersionRequest

  • BatchDeleteRecipeVersionRequest object

BatchDeleteRecipeVersionResponse

Bucket

  • Bucket string

CatalogId

  • CatalogId string

ClientSessionId

  • ClientSessionId string

ColumnName

  • ColumnName string

ColumnNameList

ColumnRange

  • ColumnRange integer

CompressionFormat

  • CompressionFormat string (values: GZIP, LZ4, SNAPPY, BZIP2, DEFLATE, LZO, BROTLI, ZSTD, ZLIB)

Condition

  • Condition string

ConditionExpression

  • ConditionExpression object: Represents an individual condition that evaluates to true or false. Conditions are used with recipe actions: The action is only performed for column values where the condition evaluates to true. If a recipe requires more than one condition, then the recipe must specify multiple ConditionExpression elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.
    • Condition required
    • TargetColumn required
    • Value

ConditionExpressionList

ConditionValue

  • ConditionValue string

ConflictException

CreateDatasetRequest

  • CreateDatasetRequest object

CreateDatasetResponse

  • CreateDatasetResponse object
    • Name required

CreateProfileJobRequest

  • CreateProfileJobRequest object
    • DatasetName required
    • EncryptionKeyArn
    • EncryptionMode
    • LogSubscription
    • MaxCapacity
    • MaxRetries
    • Name required
    • OutputLocation required S3Location
    • RoleArn required
    • Tags
    • Timeout

CreateProfileJobResponse

  • CreateProfileJobResponse object
    • Name required

CreateProjectRequest

  • CreateProjectRequest object
    • DatasetName required
    • Name required
    • RecipeName required
    • RoleArn required
    • Sample Sample
    • Tags

CreateProjectResponse

  • CreateProjectResponse object
    • Name required

CreateRecipeJobRequest

  • CreateRecipeJobRequest object
    • DatasetName
    • EncryptionKeyArn
    • EncryptionMode
    • LogSubscription
    • MaxCapacity
    • MaxRetries
    • Name required
    • Outputs required
    • ProjectName
    • RecipeReference RecipeReference
    • RoleArn required
    • Tags
    • Timeout

CreateRecipeJobResponse

  • CreateRecipeJobResponse object
    • Name required

CreateRecipeRequest

  • CreateRecipeRequest object
    • Description
    • Name required
    • Steps required
    • Tags

CreateRecipeResponse

  • CreateRecipeResponse object
    • Name required

CreateScheduleRequest

  • CreateScheduleRequest object
    • CronExpression required
    • JobNames
    • Name required
    • Tags

CreateScheduleResponse

  • CreateScheduleResponse object
    • Name required

CreatedBy

  • CreatedBy string

CronExpression

  • CronExpression string

DataCatalogInputDefinition

  • DataCatalogInputDefinition object: Represents how metadata stored in the AWS Glue Data Catalog is defined in an AWS Glue DataBrew dataset.
    • CatalogId
    • DatabaseName required
    • TableName required
    • TempDirectory
      • Bucket required
      • Key

DatabaseName

  • DatabaseName string

Dataset

  • Dataset object: Represents a dataset that can be processed by AWS Glue DataBrew.
    • AccountId
    • CreateDate
    • CreatedBy
    • FormatOptions
    • Input required
      • DataCatalogInputDefinition
        • CatalogId
        • DatabaseName required
        • TableName required
        • TempDirectory
          • Bucket required
          • Key
      • S3InputDefinition
        • Bucket required
        • Key
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • ResourceArn
    • Source
    • Tags

DatasetList

DatasetName

  • DatasetName string

Date

  • Date string

DeleteDatasetRequest

  • DeleteDatasetRequest object

DeleteDatasetResponse

  • DeleteDatasetResponse object
    • Name required

DeleteJobRequest

  • DeleteJobRequest object

DeleteJobResponse

  • DeleteJobResponse object
    • Name required

DeleteProjectRequest

  • DeleteProjectRequest object

DeleteProjectResponse

  • DeleteProjectResponse object
    • Name required

DeleteRecipeVersionRequest

  • DeleteRecipeVersionRequest object

DeleteRecipeVersionResponse

  • DeleteRecipeVersionResponse object
    • Name required
    • RecipeVersion required

DeleteScheduleRequest

  • DeleteScheduleRequest object

DeleteScheduleResponse

  • DeleteScheduleResponse object
    • Name required

DescribeDatasetRequest

  • DescribeDatasetRequest object

DescribeDatasetResponse

  • DescribeDatasetResponse object
    • CreateDate
    • CreatedBy
    • FormatOptions FormatOptions
    • Input required Input
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • ResourceArn
    • Source
    • Tags

DescribeJobRequest

  • DescribeJobRequest object

DescribeJobResponse

  • DescribeJobResponse object
    • CreateDate
    • CreatedBy
    • DatasetName
    • EncryptionKeyArn
    • EncryptionMode
    • LastModifiedBy
    • LastModifiedDate
    • LogSubscription
    • MaxCapacity
    • MaxRetries
    • Name required
    • Outputs
    • ProjectName
    • RecipeReference RecipeReference
    • ResourceArn
    • RoleArn
    • Tags
    • Timeout
    • Type

DescribeProjectRequest

  • DescribeProjectRequest object

DescribeProjectResponse

  • DescribeProjectResponse object
    • CreateDate
    • CreatedBy
    • DatasetName
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • OpenDate
    • OpenedBy
    • RecipeName
    • ResourceArn
    • RoleArn
    • Sample Sample
    • SessionStatus
    • Tags

DescribeRecipeRequest

  • DescribeRecipeRequest object

DescribeRecipeResponse

  • DescribeRecipeResponse object
    • CreateDate
    • CreatedBy
    • Description
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • ProjectName
    • PublishedBy
    • PublishedDate
    • RecipeVersion
    • ResourceArn
    • Steps
    • Tags

DescribeScheduleRequest

  • DescribeScheduleRequest object

DescribeScheduleResponse

  • DescribeScheduleResponse object
    • CreateDate
    • CreatedBy
    • CronExpression
    • JobNames
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • ResourceArn
    • Tags

EncryptionKeyArn

  • EncryptionKeyArn string

EncryptionMode

  • EncryptionMode string (values: SSE-KMS, SSE-S3)

ErrorCode

  • ErrorCode string

ExcelOptions

  • ExcelOptions object: Options that define how DataBrew will interpret a Microsoft Excel file, when creating a dataset from that file.

ExecutionTime

  • ExecutionTime integer

FormatOptions

  • FormatOptions object: Options that define how Microsoft Excel input is to be interpreted by DataBrew.

HiddenColumnList

Input

  • Input object: Information on how AWS Glue DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.
    • DataCatalogInputDefinition
      • CatalogId
      • DatabaseName required
      • TableName required
      • TempDirectory
        • Bucket required
        • Key
    • S3InputDefinition
      • Bucket required
      • Key

InternalServerException

Job

  • Job object: Represents all of the attributes of an AWS Glue DataBrew job.
    • AccountId
    • CreateDate
    • CreatedBy
    • DatasetName
    • EncryptionKeyArn
    • EncryptionMode
    • LastModifiedBy
    • LastModifiedDate
    • LogSubscription
    • MaxCapacity
    • MaxRetries
    • Name required
    • Outputs
    • ProjectName
    • RecipeReference
      • Name required
      • RecipeVersion
    • ResourceArn
    • RoleArn
    • Tags
    • Timeout
    • Type

JobList

  • JobList array

JobName

  • JobName string

JobNameList

JobRun

  • JobRun object: Represents one run of an AWS Glue DataBrew job.
    • Attempt
    • CompletedOn
    • DatasetName
    • ErrorMessage
    • ExecutionTime
    • JobName
    • LogGroupName
    • LogSubscription
    • Outputs
    • RecipeReference
      • Name required
      • RecipeVersion
    • RunId
    • StartedBy
    • StartedOn
    • State

JobRunErrorMessage

  • JobRunErrorMessage string

JobRunId

  • JobRunId string

JobRunList

JobRunState

  • JobRunState string (values: STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED, TIMEOUT)

JobType

  • JobType string (values: PROFILE, RECIPE)

JsonOptions

  • JsonOptions object: Represents the JSON-specific options that define how input is to be interpreted by AWS Glue DataBrew.
    • MultiLine

Key

  • Key string

LastModifiedBy

  • LastModifiedBy string

ListDatasetsRequest

  • ListDatasetsRequest object

ListDatasetsResponse

  • ListDatasetsResponse object
    • Datasets required
    • NextToken

ListJobRunsRequest

  • ListJobRunsRequest object

ListJobRunsResponse

  • ListJobRunsResponse object
    • JobRuns required
    • NextToken

ListJobsRequest

  • ListJobsRequest object

ListJobsResponse

  • ListJobsResponse object
    • Jobs required
    • NextToken

ListProjectsRequest

  • ListProjectsRequest object

ListProjectsResponse

  • ListProjectsResponse object
    • NextToken
    • Projects required

ListRecipeVersionsRequest

  • ListRecipeVersionsRequest object

ListRecipeVersionsResponse

  • ListRecipeVersionsResponse object
    • NextToken
    • Recipes required

ListRecipesRequest

  • ListRecipesRequest object

ListRecipesResponse

  • ListRecipesResponse object
    • NextToken
    • Recipes required

ListSchedulesRequest

  • ListSchedulesRequest object

ListSchedulesResponse

  • ListSchedulesResponse object
    • NextToken
    • Schedules required

ListTagsForResourceRequest

  • ListTagsForResourceRequest object

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • Tags

LogGroupName

  • LogGroupName string

LogSubscription

  • LogSubscription string (values: ENABLE, DISABLE)

MaxCapacity

  • MaxCapacity integer

MaxResults100

  • MaxResults100 integer

MaxRetries

  • MaxRetries integer

MultiLine

  • MultiLine boolean

NextToken

  • NextToken string

OpenedBy

  • OpenedBy string

Operation

  • Operation string

Output

  • Output object: Represents individual output from a particular job run.
    • CompressionFormat
    • Format
    • Location required
      • Bucket required
      • Key
    • Overwrite
    • PartitionColumns

OutputFormat

  • OutputFormat string (values: CSV, JSON, PARQUET, GLUEPARQUET, AVRO, ORC, XML)

OutputList

OverwriteOutput

  • OverwriteOutput boolean

ParameterMap

  • ParameterMap object

ParameterName

  • ParameterName string

ParameterValue

  • ParameterValue string

Preview

  • Preview boolean

Project

  • Project object: Represents all of the attributes of an AWS Glue DataBrew project.
    • AccountId
    • CreateDate
    • CreatedBy
    • DatasetName
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • OpenDate
    • OpenedBy
    • RecipeName required
    • ResourceArn
    • RoleArn
    • Sample
      • Size
      • Type required
    • Tags

ProjectList

ProjectName

  • ProjectName string

PublishRecipeRequest

  • PublishRecipeRequest object
    • Description

PublishRecipeResponse

  • PublishRecipeResponse object
    • Name required

PublishedBy

  • PublishedBy string

Recipe

  • Recipe object: Represents one or more actions to be performed on an AWS Glue DataBrew dataset.
    • CreateDate
    • CreatedBy
    • Description
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • ProjectName
    • PublishedBy
    • PublishedDate
    • RecipeVersion
    • ResourceArn
    • Steps
    • Tags

RecipeAction

  • RecipeAction object: Represents a transformation and associated parameters that are used to apply a change to an AWS Glue DataBrew dataset. For more information, see Recipe structure and ecipe actions reference .
    • Operation required
    • Parameters

RecipeDescription

  • RecipeDescription string

RecipeErrorList

RecipeErrorMessage

  • RecipeErrorMessage string

RecipeList

RecipeName

  • RecipeName string

RecipeReference

  • RecipeReference object: Represents all of the attributes of an AWS Glue DataBrew recipe.
    • Name required
    • RecipeVersion

RecipeStep

  • RecipeStep object: Represents a single step to be performed in an AWS Glue DataBrew recipe.

RecipeStepList

RecipeVersion

  • RecipeVersion string

RecipeVersionErrorDetail

  • RecipeVersionErrorDetail object: Represents any errors encountered when attempting to delete multiple recipe versions.
    • ErrorCode
    • ErrorMessage
    • RecipeVersion

RecipeVersionList

ResourceNotFoundException

Result

  • Result string

S3Location

  • S3Location object: An Amazon S3 location (bucket name an object key) where DataBrew can read input data, or write output from a job.
    • Bucket required
    • Key

Sample

  • Sample object: Represents the sample size and sampling type for AWS Glue DataBrew to use for interactive data analysis.
    • Size
    • Type required

SampleSize

  • SampleSize integer

SampleType

  • SampleType string (values: FIRST_N, LAST_N, RANDOM)

Schedule

  • Schedule object: Represents one or more dates and times when a job is to run.
    • AccountId
    • CreateDate
    • CreatedBy
    • CronExpression
    • JobNames
    • LastModifiedBy
    • LastModifiedDate
    • Name required
    • ResourceArn
    • Tags

ScheduleList

ScheduleName

  • ScheduleName string

SendProjectSessionActionRequest

  • SendProjectSessionActionRequest object

SendProjectSessionActionResponse

  • SendProjectSessionActionResponse object
    • ActionId
    • Name required
    • Result

ServiceQuotaExceededException

SessionStatus

  • SessionStatus string (values: ASSIGNED, FAILED, INITIALIZING, PROVISIONING, READY, RECYCLING, ROTATING, TERMINATED, TERMINATING, UPDATING)

SheetIndex

  • SheetIndex integer

SheetIndexList

SheetName

  • SheetName string

SheetNameList

Source

  • Source string (values: S3, DATA-CATALOG)

StartColumnIndex

  • StartColumnIndex integer

StartJobRunRequest

  • StartJobRunRequest object

StartJobRunResponse

  • StartJobRunResponse object
    • RunId required

StartProjectSessionRequest

  • StartProjectSessionRequest object
    • AssumeControl

StartProjectSessionResponse

  • StartProjectSessionResponse object
    • ClientSessionId
    • Name required

StartedBy

  • StartedBy string

StepIndex

  • StepIndex integer

StopJobRunRequest

  • StopJobRunRequest object

StopJobRunResponse

  • StopJobRunResponse object
    • RunId required

TableName

  • TableName string

TagKey

  • TagKey string

TagKeyList

TagMap

  • TagMap object

TagResourceRequest

  • TagResourceRequest object
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

TargetColumn

  • TargetColumn string

Timeout

  • Timeout integer

UntagResourceRequest

  • UntagResourceRequest object

UntagResourceResponse

  • UntagResourceResponse object

UpdateDatasetRequest

UpdateDatasetResponse

  • UpdateDatasetResponse object
    • Name required

UpdateProfileJobRequest

  • UpdateProfileJobRequest object
    • EncryptionKeyArn
    • EncryptionMode
    • LogSubscription
    • MaxCapacity
    • MaxRetries
    • OutputLocation required S3Location
    • RoleArn required
    • Timeout

UpdateProfileJobResponse

  • UpdateProfileJobResponse object
    • Name required

UpdateProjectRequest

  • UpdateProjectRequest object

UpdateProjectResponse

  • UpdateProjectResponse object
    • LastModifiedDate
    • Name required

UpdateRecipeJobRequest

  • UpdateRecipeJobRequest object
    • EncryptionKeyArn
    • EncryptionMode
    • LogSubscription
    • MaxCapacity
    • MaxRetries
    • Outputs required
    • RoleArn required
    • Timeout

UpdateRecipeJobResponse

  • UpdateRecipeJobResponse object
    • Name required

UpdateRecipeRequest

  • UpdateRecipeRequest object

UpdateRecipeResponse

  • UpdateRecipeResponse object
    • Name required

UpdateScheduleRequest

  • UpdateScheduleRequest object
    • CronExpression required
    • JobNames

UpdateScheduleResponse

  • UpdateScheduleResponse object
    • Name required

ValidationException

ViewFrame

  • ViewFrame object: Represents the data being being transformed during an AWS Glue DataBrew project session.
    • ColumnRange
    • HiddenColumns
    • StartColumnIndex required