@datafire/amazonaws_databrew

Client library for AWS Glue DataBrew

Installation and Usage

``bash
npm install --save @datafire/amazonaws_databrew
`
`js
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

$3

`js
amazonaws_databrew.ListDatasets({}, context)
`

#### Input
* input object
* maxResults integer
* nextToken string
* MaxResults string
* NextToken string

#### Output
* output ListDatasetsResponse

$3

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

#### Input
* input object
* FormatOptions object: Options that define how Microsoft Excel input is to be interpreted by DataBrew.
* Excel
* SheetIndexes
* items SheetIndex
* SheetNames
* items SheetName
* Json
* MultiLine
* 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
* output CreateDatasetResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DeleteDatasetResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DescribeDatasetResponse

$3

`js
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.
* Excel
* SheetIndexes
* items SheetIndex
* SheetNames
* items SheetName
* Json
* MultiLine
* 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
* output UpdateDatasetResponse

$3

`js
amazonaws_databrew.ListJobs({}, context)
`

#### Input
* input object
* datasetName string
* maxResults integer
* nextToken string
* projectName string
* MaxResults string
* NextToken string

#### Output
* output ListJobsResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DeleteJobResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DescribeJobResponse

$3

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

#### Input
* input object
* name required string
* runId required string

#### Output
* output StopJobRunResponse

$3

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

#### Input
* input object
* name required string
* maxResults integer
* nextToken string
* MaxResults string
* NextToken string

#### Output
* output ListJobRunsResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output StartJobRunResponse

$3

`js
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
* output CreateProfileJobResponse

$3

`js
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
* output UpdateProfileJobResponse

$3

`js
amazonaws_databrew.ListProjects({}, context)
`

#### Input
* input object
* nextToken string
* maxResults integer
* MaxResults string
* NextToken string

#### Output
* output ListProjectsResponse

$3

`js
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
* output CreateProjectResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DeleteProjectResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DescribeProjectResponse

$3

`js
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
* output UpdateProjectResponse

$3

`js
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.
* Action
* Operation required
* Parameters
* ConditionExpressions
* items ConditionExpression
* 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
* items ColumnName
* StartColumnIndex

#### Output
* output SendProjectSessionActionResponse

$3

`js
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
* output StartProjectSessionResponse

$3

`js
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.
* items Output
* 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
* output CreateRecipeJobResponse

$3

`js
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.
* items Output
* 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
* output UpdateRecipeJobResponse

$3

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

#### Input
* input object
* maxResults integer
* nextToken string
* name required string
* MaxResults string
* NextToken string

#### Output
* output ListRecipeVersionsResponse

$3

`js
amazonaws_databrew.ListRecipes({}, context)
`

#### Input
* input object
* maxResults integer
* nextToken string
* recipeVersion string
* MaxResults string
* NextToken string

#### Output
* output ListRecipesResponse

$3

`js
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.
* items RecipeStep
* Tags object: Metadata tags to apply to this recipe.

#### Output
* output CreateRecipeResponse

$3

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

#### Input
* input object
* name required string
* recipeVersion string

#### Output
* output DescribeRecipeResponse

$3

`js
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.
* items RecipeStep

#### Output
* output UpdateRecipeResponse

$3

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

#### Input
* input object
* name required string
* RecipeVersions required array: An array of version identifiers to be deleted.
* items RecipeVersion

#### Output
* output BatchDeleteRecipeVersionResponse

$3

`js
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
* output PublishRecipeResponse

$3

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

#### Input
* input object
* name required string
* recipeVersion required string

#### Output
* output DeleteRecipeVersionResponse

$3

`js
amazonaws_databrew.ListSchedules({}, context)
`

#### Input
* input object
* jobName string
* maxResults integer
* nextToken string
* MaxResults string
* NextToken string

#### Output
* output ListSchedulesResponse

$3

`js
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.
* items JobName
* Name required string: A unique name for the schedule.
* Tags object: Metadata tags to apply to this schedule.

#### Output
* output CreateScheduleResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DeleteScheduleResponse

$3

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

#### Input
* input object
* name required string

#### Output
* output DescribeScheduleResponse

$3

`js
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.
* items JobName

#### Output
* output UpdateScheduleResponse

$3

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

#### Input
* input object
* ResourceArn required string

#### Output
* output ListTagsForResourceResponse

$3

`js
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
* output TagResourceResponse

$3

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

#### Input
* input object
* ResourceArn required string
* tagKeys required array

#### Output
* output UntagResourceResponse

Definitions

$3




$3


* AccountId string

$3

* ActionId integer

$3

* Arn string

$3

* AssumeControl boolean

$3

* Attempt integer

$3

* BatchDeleteRecipeVersionRequest object
* RecipeVersions required
* items RecipeVersion

$3

* BatchDeleteRecipeVersionResponse object
* Errors
* items RecipeVersionErrorDetail
* Name required

$3

* Bucket string

$3

* CatalogId string

$3

* ClientSessionId string

$3

* ColumnName string

$3

* ColumnNameList array
* items ColumnName

$3

* ColumnRange integer

$3

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

$3

* Condition string

$3

* 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

$3

* ConditionExpressionList array
* items ConditionExpression

$3

* ConditionValue string

$3

$3

* CreateDatasetRequest object
* FormatOptions FormatOptions
* Input required Input
* Name required
* Tags

$3

* CreateDatasetResponse object
* Name required

$3

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

$3

* CreateProfileJobResponse object
* Name required

$3

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

$3

* CreateProjectResponse object
* Name required

$3

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

$3

* CreateRecipeJobResponse object
* Name required

$3

* CreateRecipeRequest object
* Description
* Name required
* Steps required
* items RecipeStep
* Tags

$3

* CreateRecipeResponse object
* Name required

$3

* CreateScheduleRequest object
* CronExpression required
* JobNames
* items JobName
* Name required
* Tags

$3

* CreateScheduleResponse object
* Name required

$3

* CreatedBy string

$3

* CronExpression string

$3

* 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

$3

* DatabaseName string

$3

* Dataset object: Represents a dataset that can be processed by AWS Glue DataBrew.
* AccountId
* CreateDate
* CreatedBy
* FormatOptions
* Excel
* SheetIndexes
* items SheetIndex
* SheetNames
* items SheetName
* Json
* MultiLine
* Input required
* DataCatalogInputDefinition
* CatalogId
* DatabaseName required
* TableName required
* TempDirectory
* Bucket required
* Key
* S3InputDefinition
* Bucket required
* Key
* LastModifiedBy
* LastModifiedDate
* Name required
* ResourceArn
* Source
* Tags

$3

* DatasetList array
* items Dataset

$3

* DatasetName string

$3

* Date string

$3

* DeleteDatasetRequest object

$3

* DeleteDatasetResponse object
* Name required

$3

* DeleteJobRequest object

$3

* DeleteJobResponse object
* Name required

$3

* DeleteProjectRequest object

$3

* DeleteProjectResponse object
* Name required

$3

* DeleteRecipeVersionRequest object

$3

* DeleteRecipeVersionResponse object
* Name required
* RecipeVersion required

$3

* DeleteScheduleRequest object

$3

* DeleteScheduleResponse object
* Name required

$3

* DescribeDatasetRequest object

$3

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

$3

* DescribeJobRequest object

$3

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

$3

* DescribeProjectRequest object

$3

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

$3

* DescribeRecipeRequest object

$3

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

$3

* DescribeScheduleRequest object

$3

* DescribeScheduleResponse object
* CreateDate
* CreatedBy
* CronExpression
* JobNames
* items JobName
* LastModifiedBy
* LastModifiedDate
* Name required
* ResourceArn
* Tags

$3

* EncryptionKeyArn string

$3

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

$3

* ErrorCode string

$3

* ExcelOptions object: Options that define how DataBrew will interpret a Microsoft Excel file, when creating a dataset from that file.
* SheetIndexes
* items SheetIndex
* SheetNames
* items SheetName

$3

* ExecutionTime integer

$3

* FormatOptions object: Options that define how Microsoft Excel input is to be interpreted by DataBrew.
* Excel
* SheetIndexes
* items SheetIndex
* SheetNames
* items SheetName
* Json
* MultiLine

$3

* HiddenColumnList array
* items ColumnName

$3

* 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

$3

$3

* 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
* items Output
* ProjectName
* RecipeReference
* Name required
* RecipeVersion
* ResourceArn
* RoleArn
* Tags
* Timeout
* Type

$3

* JobList array
* items Job

$3

* JobName string

$3

* JobNameList array
* items JobName

$3

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

$3

* JobRunErrorMessage string

$3

* JobRunId string

$3

* JobRunList array
* items JobRun

$3

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

$3

* JobType string (values: PROFILE, RECIPE)

$3

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

$3

* Key string

$3

* LastModifiedBy string

$3

* ListDatasetsRequest object

$3

* ListDatasetsResponse object
* Datasets required
* items Dataset
* NextToken

$3

* ListJobRunsRequest object

$3

* ListJobRunsResponse object
* JobRuns required
* items JobRun
* NextToken

$3

* ListJobsRequest object

$3

* ListJobsResponse object
* Jobs required
* items Job
* NextToken

$3

* ListProjectsRequest object

$3

* ListProjectsResponse object
* NextToken
* Projects required
* items Project

$3

* ListRecipeVersionsRequest object

$3

* ListRecipeVersionsResponse object
* NextToken
* Recipes required
* items Recipe

$3

* ListRecipesRequest object

$3

* ListRecipesResponse object
* NextToken
* Recipes required
* items Recipe

$3

* ListSchedulesRequest object

$3

* ListSchedulesResponse object
* NextToken
* Schedules required
* items Schedule

$3

* ListTagsForResourceRequest object

$3

* ListTagsForResourceResponse object
* Tags

$3

* LogGroupName string

$3

* LogSubscription string (values: ENABLE, DISABLE)

$3

* MaxCapacity integer

$3

* MaxResults100 integer

$3

* MaxRetries integer

$3

* MultiLine boolean

$3

* NextToken string

$3

* OpenedBy string

$3

* Operation string

$3

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

$3

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

$3

* OutputList array
* items Output

$3

* OverwriteOutput boolean

$3

* ParameterMap object

$3

* ParameterName string

$3

* ParameterValue string

$3

* Preview boolean

$3

* 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

$3

* ProjectList array
* items Project

$3

* ProjectName string

$3

* PublishRecipeRequest object
* Description

$3

* PublishRecipeResponse object
* Name required

$3

* PublishedBy string

$3

* 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
* items RecipeStep
* Tags

$3

* 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

$3

* RecipeDescription string

$3

* RecipeErrorList array
* items RecipeVersionErrorDetail

$3

* RecipeErrorMessage string

$3

* RecipeList array
* items Recipe

$3

* RecipeName string

$3

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

$3

* RecipeStep object: Represents a single step to be performed in an AWS Glue DataBrew recipe.
* Action required
* Operation required
* Parameters
* ConditionExpressions
* items ConditionExpression

$3

* RecipeStepList array
* items RecipeStep

$3

* RecipeVersion string

$3

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

$3

* RecipeVersionList array
* items RecipeVersion

$3

$3

* Result string

$3

* 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

$3

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

$3

* SampleSize integer

$3

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

$3

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

$3

* ScheduleList array
* items Schedule

$3

* ScheduleName string

$3

* SendProjectSessionActionRequest object
* ClientSessionId
* Preview
* RecipeStep RecipeStep
* StepIndex
* ViewFrame ViewFrame

$3

* SendProjectSessionActionResponse object
* ActionId
* Name required
* Result

$3

$3

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

$3

* SheetIndex integer

$3

* SheetIndexList array
* items SheetIndex

$3

* SheetName string

$3

* SheetNameList array
* items SheetName

$3

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

$3

* StartColumnIndex integer

$3

* StartJobRunRequest object

$3

* StartJobRunResponse object
* RunId required

$3

* StartProjectSessionRequest object
* AssumeControl

$3

* StartProjectSessionResponse object
* ClientSessionId
* Name required

$3

* StartedBy string

$3

* StepIndex integer

$3

* StopJobRunRequest object

$3

* StopJobRunResponse object
* RunId required

$3

* TableName string

$3

* TagKey string

$3

* TagKeyList array
* items TagKey

$3

* TagMap object

$3

* TagResourceRequest object
* Tags required

$3

* TagResourceResponse object

$3

* TagValue string

$3

* TargetColumn string

$3

* Timeout integer

$3

* UntagResourceRequest object

$3

* UntagResourceResponse object

$3

* UpdateDatasetRequest object
* FormatOptions FormatOptions
* Input required Input

$3

* UpdateDatasetResponse object
* Name required

$3

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

$3

* UpdateProfileJobResponse object
* Name required

$3

* UpdateProjectRequest object
* RoleArn required
* Sample Sample

$3

* UpdateProjectResponse object
* LastModifiedDate
* Name required

$3

* UpdateRecipeJobRequest object
* EncryptionKeyArn
* EncryptionMode
* LogSubscription
* MaxCapacity
* MaxRetries
* Outputs required
* items Output
* RoleArn required
* Timeout

$3

* UpdateRecipeJobResponse object
* Name required

$3

* UpdateRecipeRequest object
* Description
* Steps
* items RecipeStep

$3

* UpdateRecipeResponse object
* Name required

$3

* UpdateScheduleRequest object
* CronExpression required
* JobNames
* items JobName

$3

* UpdateScheduleResponse object
* Name required

$3

$3

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