openapi: 3.0.0 info: version: 2017-07-25 x-release: v4 title: AWS Glue DataBrew description: 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. x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: databrew x-aws-signingName: databrew x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/databrew-2017-07-25.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/databrew/ servers: - url: http://databrew.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Glue DataBrew multi-region endpoint - url: https://databrew.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS Glue DataBrew multi-region endpoint - url: http://databrew.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Glue DataBrew endpoint for China (Beijing) and China (Ningxia) - url: https://databrew.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS Glue DataBrew endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: "/recipes/{name}/batchDeleteRecipeVersion": post: operationId: BatchDeleteRecipeVersion description:

Deletes one or more versions of a recipe at a time.

The entire request will be rejected if:

The recipe does not exist.
There is an invalid version identifier in the list of versions.
The version list is empty.
The version list size exceeds 50.
The version list contains duplicate entries.

The request will complete successfully, but with partial failures, if:

A version does not exist.
A version is being used by a job.
You specify LATEST_WORKING, but it's being used by a project.
The version fails to be deleted.

The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/BatchDeleteRecipeVersionResponse" examples: BatchDeleteRecipeVersion200Example: summary: Default BatchDeleteRecipeVersion 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: BatchDeleteRecipeVersion480Example: summary: Default BatchDeleteRecipeVersion 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: BatchDeleteRecipeVersion481Example: summary: Default BatchDeleteRecipeVersion 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: BatchDeleteRecipeVersion482Example: summary: Default BatchDeleteRecipeVersion 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the recipe whose versions are to be deleted. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - RecipeVersions properties: RecipeVersions: description: An array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported. type: array items: $ref: "#/components/schemas/RecipeVersion" minItems: 1 maxItems: 50 summary: Amazon Glue DataBrew Batch Delete Recipe Version x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /datasets: post: operationId: CreateDataset description: Creates a new DataBrew dataset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateDatasetResponse" examples: CreateDataset200Example: summary: Default CreateDataset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: CreateDataset480Example: summary: Default CreateDataset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateDataset481Example: summary: Default CreateDataset 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: CreateDataset482Example: summary: Default CreateDataset 482 response x-microcks-default: true value: status: SUCCEEDED "483": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: CreateDataset483Example: summary: Default CreateDataset 483 response x-microcks-default: true value: status: SUCCEEDED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Name - Input properties: Name: description: The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. type: string minLength: 1 maxLength: 255 Format: description: The file format of a dataset that is created from an Amazon S3 file or folder. type: string enum: - CSV - JSON - PARQUET - EXCEL - ORC FormatOptions: description: Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. type: object properties: Json: allOf: - $ref: "#/components/schemas/JsonOptions" - description: Options that define how JSON input is to be interpreted by DataBrew. Excel: allOf: - $ref: "#/components/schemas/ExcelOptions" - description: Options that define how Excel input is to be interpreted by DataBrew. Csv: allOf: - $ref: "#/components/schemas/CsvOptions" - description: Options that define how CSV input is to be interpreted by DataBrew. Input: description: Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3. type: object properties: S3InputDefinition: allOf: - $ref: "#/components/schemas/S3Location" - description: The Amazon S3 location where the data is stored. DataCatalogInputDefinition: allOf: - $ref: "#/components/schemas/DataCatalogInputDefinition" - description: The Glue Data Catalog parameters for the data. DatabaseInputDefinition: allOf: - $ref: "#/components/schemas/DatabaseInputDefinition" - description: Connection information for dataset input files stored in a database. Metadata: allOf: - $ref: "#/components/schemas/Metadata" - description: Contains additional resource information needed for specific datasets. PathOptions: description: Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset. type: object properties: LastModifiedDateCondition: allOf: - $ref: "#/components/schemas/FilterExpression" - description: If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3. FilesLimit: allOf: - $ref: "#/components/schemas/FilesLimit" - description: If provided, this structure imposes a limit on a number of files that should be selected. Parameters: allOf: - $ref: "#/components/schemas/PathParametersMap" - description: A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions. Tags: description: Metadata tags to apply to this dataset. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" summary: Amazon Glue DataBrew Create Dataset x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListDatasets description: Lists all of the DataBrew datasets. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListDatasetsResponse" examples: ListDatasets200Example: summary: Default ListDatasets 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListDatasets480Example: summary: Default ListDatasets 480 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: maxResults in: query required: false description: "The maximum number of results to return in this request. " schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The token returned by a previous call to retrieve the next set of results. schema: type: string minLength: 1 maxLength: 2000 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Datasets x-microcks-operation: delay: 0 dispatcher: FALLBACK /profileJobs: post: operationId: CreateProfileJob description: Creates a new job to analyze a dataset and create its data profile. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateProfileJobResponse" examples: CreateProfileJob200Example: summary: Default CreateProfileJob 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: CreateProfileJob480Example: summary: Default CreateProfileJob 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateProfileJob481Example: summary: Default CreateProfileJob 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateProfileJob482Example: summary: Default CreateProfileJob 482 response x-microcks-default: true value: status: SUCCEEDED "483": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: CreateProfileJob483Example: summary: Default CreateProfileJob 483 response x-microcks-default: true value: status: SUCCEEDED "484": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: CreateProfileJob484Example: summary: Default CreateProfileJob 484 response x-microcks-default: true value: status: SUCCEEDED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DatasetName - Name - OutputLocation - RoleArn properties: DatasetName: description: The name of the dataset that this job is to act upon. type: string minLength: 1 maxLength: 255 EncryptionKeyArn: description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. type: string minLength: 20 maxLength: 2048 EncryptionMode: description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

type: string enum: - SSE-KMS - SSE-S3 Name: description: The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. type: string minLength: 1 maxLength: 240 LogSubscription: description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. type: string enum: - ENABLE - DISABLE MaxCapacity: description: The maximum number of nodes that DataBrew can use when the job processes data. type: integer MaxRetries: description: The maximum number of times to retry the job after a job run fails. type: integer minimum: 0 OutputLocation: description: Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job. type: object properties: Bucket: allOf: - $ref: "#/components/schemas/Bucket" - description: The Amazon S3 bucket name. Key: allOf: - $ref: "#/components/schemas/Key" - description: The unique name of the object in the bucket. BucketOwner: allOf: - $ref: "#/components/schemas/BucketOwner" - description: The Amazon Web Services account ID of the bucket owner. Configuration: description: "Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. " type: object properties: DatasetStatisticsConfiguration: allOf: - $ref: "#/components/schemas/StatisticsConfiguration" - description: "Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations. " ProfileColumns: allOf: - $ref: "#/components/schemas/ColumnSelectorList" - description: "List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns. " ColumnStatisticsConfigurations: allOf: - $ref: "#/components/schemas/ColumnStatisticsConfigurationList" - description: "List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations. " EntityDetectorConfiguration: allOf: - $ref: "#/components/schemas/EntityDetectorConfiguration" - description: Configuration of entity detection for a profile job. When undefined, entity detection is disabled. ValidationConfigurations: description: List of validation configurations that are applied to the profile job. type: array items: $ref: "#/components/schemas/ValidationConfiguration" minItems: 1 RoleArn: description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. type: string minLength: 20 maxLength: 2048 Tags: description: Metadata tags to apply to this job. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" Timeout: description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. type: integer minimum: 0 JobSample: description: A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. type: object properties: Mode: allOf: - $ref: "#/components/schemas/SampleMode" - description:

A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

FULL_DATASET - The profile job is run on the entire dataset.
CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

Size: allOf: - $ref: "#/components/schemas/JobSize" - description:

The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

summary: Amazon Glue DataBrew Create Profile Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /projects: post: operationId: CreateProject description: Creates a new DataBrew project. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateProjectResponse" examples: CreateProject200Example: summary: Default CreateProject 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateProject480Example: summary: Default CreateProject 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" examples: CreateProject481Example: summary: Default CreateProject 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: CreateProject482Example: summary: Default CreateProject 482 response x-microcks-default: true value: status: SUCCEEDED "483": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: CreateProject483Example: summary: Default CreateProject 483 response x-microcks-default: true value: status: SUCCEEDED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - DatasetName - Name - RecipeName - RoleArn properties: DatasetName: description: The name of an existing dataset to associate this project with. type: string minLength: 1 maxLength: 255 Name: description: A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. type: string minLength: 1 maxLength: 255 RecipeName: description: The name of an existing recipe to associate with the project. type: string minLength: 1 maxLength: 255 Sample: description: Represents the sample size and sampling type for DataBrew to use for interactive data analysis. type: object properties: Size: allOf: - $ref: "#/components/schemas/SampleSize" - description: The number of rows in the sample. Type: allOf: - $ref: "#/components/schemas/SampleType" - description: The way in which DataBrew obtains rows from a dataset. RoleArn: description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request. type: string minLength: 20 maxLength: 2048 Tags: description: Metadata tags to apply to this project. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" summary: Amazon Glue DataBrew Create Project x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListProjects description: Lists all of the DataBrew projects that are defined. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListProjectsResponse" examples: ListProjects200Example: summary: Default ListProjects 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListProjects480Example: summary: Default ListProjects 480 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: nextToken in: query required: false description: The token returned by a previous call to retrieve the next set of results. schema: type: string minLength: 1 maxLength: 2000 - name: maxResults in: query required: false description: "The maximum number of results to return in this request. " schema: type: integer minimum: 1 maximum: 100 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Projects x-microcks-operation: delay: 0 dispatcher: FALLBACK /recipes: post: operationId: CreateRecipe description: Creates a new DataBrew recipe. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateRecipeResponse" examples: CreateRecipe200Example: summary: Default CreateRecipe 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateRecipe480Example: summary: Default CreateRecipe 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: CreateRecipe481Example: summary: Default CreateRecipe 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: CreateRecipe482Example: summary: Default CreateRecipe 482 response x-microcks-default: true value: status: SUCCEEDED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Name - Steps properties: Description: description: A description for the recipe. type: string maxLength: 1024 Name: description: A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. type: string minLength: 1 maxLength: 255 Steps: description: 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. type: array items: $ref: "#/components/schemas/RecipeStep" Tags: description: Metadata tags to apply to this recipe. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" summary: Amazon Glue DataBrew Create Recipe x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListRecipes description: Lists all of the DataBrew recipes that are defined. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListRecipesResponse" examples: ListRecipes200Example: summary: Default ListRecipes 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListRecipes480Example: summary: Default ListRecipes 480 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: maxResults in: query required: false description: "The maximum number of results to return in this request. " schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The token returned by a previous call to retrieve the next set of results. schema: type: string minLength: 1 maxLength: 2000 - name: recipeVersion in: query required: false description: "

Return only those recipes with a version identifier of LATEST_WORKING or LATEST_PUBLISHED. If RecipeVersion is omitted, ListRecipes returns all of the LATEST_PUBLISHED recipe versions.

Valid values: LATEST_WORKING | LATEST_PUBLISHED

" schema: type: string minLength: 1 maxLength: 16 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Recipes x-microcks-operation: delay: 0 dispatcher: FALLBACK /recipeJobs: post: operationId: CreateRecipeJob description: Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateRecipeJobResponse" examples: CreateRecipeJob200Example: summary: Default CreateRecipeJob 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: CreateRecipeJob480Example: summary: Default CreateRecipeJob 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateRecipeJob481Example: summary: Default CreateRecipeJob 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: CreateRecipeJob482Example: summary: Default CreateRecipeJob 482 response x-microcks-default: true value: status: SUCCEEDED "483": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: CreateRecipeJob483Example: summary: Default CreateRecipeJob 483 response x-microcks-default: true value: status: SUCCEEDED "484": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: CreateRecipeJob484Example: summary: Default CreateRecipeJob 484 response x-microcks-default: true value: status: SUCCEEDED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Name - RoleArn properties: DatasetName: description: The name of the dataset that this job processes. type: string minLength: 1 maxLength: 255 EncryptionKeyArn: description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. type: string minLength: 20 maxLength: 2048 EncryptionMode: description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

type: string enum: - SSE-KMS - SSE-S3 Name: description: A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. type: string minLength: 1 maxLength: 240 LogSubscription: description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. type: string enum: - ENABLE - DISABLE MaxCapacity: description: The maximum number of nodes that DataBrew can consume when the job processes data. type: integer MaxRetries: description: The maximum number of times to retry the job after a job run fails. type: integer minimum: 0 Outputs: description: One or more artifacts that represent the output from running the job. type: array items: $ref: "#/components/schemas/Output" minItems: 1 DataCatalogOutputs: description: One or more artifacts that represent the Glue Data Catalog output from running the job. type: array items: $ref: "#/components/schemas/DataCatalogOutput" minItems: 1 DatabaseOutputs: description: "Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to. " type: array items: $ref: "#/components/schemas/DatabaseOutput" minItems: 1 ProjectName: description: Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe. type: string minLength: 1 maxLength: 255 RecipeReference: description: Represents the name and version of a DataBrew recipe. type: object properties: Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe. RecipeVersion: allOf: - $ref: "#/components/schemas/RecipeVersion" - description: "The identifier for the version for the recipe. " RoleArn: description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. type: string minLength: 20 maxLength: 2048 Tags: description: Metadata tags to apply to this job. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" Timeout: description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. type: integer minimum: 0 summary: Amazon Glue DataBrew Create Recipe Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /rulesets: post: operationId: CreateRuleset description: Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateRulesetResponse" examples: CreateRuleset200Example: summary: Default CreateRuleset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateRuleset480Example: summary: Default CreateRuleset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: CreateRuleset481Example: summary: Default CreateRuleset 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: CreateRuleset482Example: summary: Default CreateRuleset 482 response x-microcks-default: true value: status: SUCCEEDED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Name - TargetArn - Rules properties: Name: description: The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. type: string minLength: 1 maxLength: 255 Description: description: The description of the ruleset. type: string maxLength: 1024 TargetArn: description: The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. type: string minLength: 20 maxLength: 2048 Rules: description: A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. type: array items: $ref: "#/components/schemas/Rule" minItems: 1 Tags: description: Metadata tags to apply to the ruleset. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" summary: Amazon Glue DataBrew Create Ruleset x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListRulesets description: List all rulesets available in the current account or rulesets associated with a specific resource (dataset). responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListRulesetsResponse" examples: ListRulesets200Example: summary: Default ListRulesets 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListRulesets480Example: summary: Default ListRulesets 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListRulesets481Example: summary: Default ListRulesets 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: targetArn in: query required: false description: The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource. schema: type: string minLength: 20 maxLength: 2048 - name: maxResults in: query required: false description: The maximum number of results to return in this request. schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: 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. schema: type: string minLength: 1 maxLength: 2000 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Rulesets x-microcks-operation: delay: 0 dispatcher: FALLBACK /schedules: post: operationId: CreateSchedule description: Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateScheduleResponse" examples: CreateSchedule200Example: summary: Default CreateSchedule 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: CreateSchedule480Example: summary: Default CreateSchedule 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: CreateSchedule481Example: summary: Default CreateSchedule 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: CreateSchedule482Example: summary: Default CreateSchedule 482 response x-microcks-default: true value: status: SUCCEEDED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - CronExpression - Name properties: JobNames: description: The name or names of one or more jobs to be run. type: array items: $ref: "#/components/schemas/JobName" maxItems: 50 CronExpression: description: The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide. type: string minLength: 1 maxLength: 512 Tags: description: Metadata tags to apply to this schedule. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" Name: description: A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Create Schedule x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: ListSchedules description: Lists the DataBrew schedules that are defined. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListSchedulesResponse" examples: ListSchedules200Example: summary: Default ListSchedules 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListSchedules480Example: summary: Default ListSchedules 480 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: jobName in: query required: false description: The name of the job that these schedules apply to. schema: type: string minLength: 1 maxLength: 240 - name: maxResults in: query required: false description: "The maximum number of results to return in this request. " schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The token returned by a previous call to retrieve the next set of results. schema: type: string minLength: 1 maxLength: 2000 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Schedules x-microcks-operation: delay: 0 dispatcher: FALLBACK "/datasets/{name}": delete: operationId: DeleteDataset description: Deletes a dataset from DataBrew. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteDatasetResponse" examples: DeleteDataset200Example: summary: Default DeleteDataset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeleteDataset480Example: summary: Default DeleteDataset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteDataset481Example: summary: Default DeleteDataset 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DeleteDataset482Example: summary: Default DeleteDataset 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the dataset to be deleted. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Delete Dataset x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeDataset description: Returns the definition of a specific DataBrew dataset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeDatasetResponse" examples: DescribeDataset200Example: summary: Default DescribeDataset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeDataset480Example: summary: Default DescribeDataset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DescribeDataset481Example: summary: Default DescribeDataset 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the dataset to be described. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Describe Dataset x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateDataset description: Modifies the definition of an existing DataBrew dataset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateDatasetResponse" examples: UpdateDataset200Example: summary: Default UpdateDataset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: UpdateDataset480Example: summary: Default UpdateDataset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateDataset481Example: summary: Default UpdateDataset 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UpdateDataset482Example: summary: Default UpdateDataset 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the dataset to be updated. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - Input properties: Format: description: The file format of a dataset that is created from an Amazon S3 file or folder. type: string enum: - CSV - JSON - PARQUET - EXCEL - ORC FormatOptions: description: Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. type: object properties: Json: allOf: - $ref: "#/components/schemas/JsonOptions" - description: Options that define how JSON input is to be interpreted by DataBrew. Excel: allOf: - $ref: "#/components/schemas/ExcelOptions" - description: Options that define how Excel input is to be interpreted by DataBrew. Csv: allOf: - $ref: "#/components/schemas/CsvOptions" - description: Options that define how CSV input is to be interpreted by DataBrew. Input: description: Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3. type: object properties: S3InputDefinition: allOf: - $ref: "#/components/schemas/S3Location" - description: The Amazon S3 location where the data is stored. DataCatalogInputDefinition: allOf: - $ref: "#/components/schemas/DataCatalogInputDefinition" - description: The Glue Data Catalog parameters for the data. DatabaseInputDefinition: allOf: - $ref: "#/components/schemas/DatabaseInputDefinition" - description: Connection information for dataset input files stored in a database. Metadata: allOf: - $ref: "#/components/schemas/Metadata" - description: Contains additional resource information needed for specific datasets. PathOptions: description: Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset. type: object properties: LastModifiedDateCondition: allOf: - $ref: "#/components/schemas/FilterExpression" - description: If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3. FilesLimit: allOf: - $ref: "#/components/schemas/FilesLimit" - description: If provided, this structure imposes a limit on a number of files that should be selected. Parameters: allOf: - $ref: "#/components/schemas/PathParametersMap" - description: A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions. summary: Amazon Glue DataBrew Update Dataset x-microcks-operation: delay: 0 dispatcher: FALLBACK "/jobs/{name}": delete: operationId: DeleteJob description: Deletes the specified DataBrew job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteJobResponse" examples: DeleteJob200Example: summary: Default DeleteJob 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeleteJob480Example: summary: Default DeleteJob 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteJob481Example: summary: Default DeleteJob 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DeleteJob482Example: summary: Default DeleteJob 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job to be deleted. schema: type: string minLength: 1 maxLength: 240 summary: Amazon Glue DataBrew Delete Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeJob description: Returns the definition of a specific DataBrew job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeJobResponse" examples: DescribeJob200Example: summary: Default DescribeJob 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeJob480Example: summary: Default DescribeJob 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DescribeJob481Example: summary: Default DescribeJob 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job to be described. schema: type: string minLength: 1 maxLength: 240 summary: Amazon Glue DataBrew Describe Job x-microcks-operation: delay: 0 dispatcher: FALLBACK "/projects/{name}": delete: operationId: DeleteProject description: Deletes an existing DataBrew project. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteProjectResponse" examples: DeleteProject200Example: summary: Default DeleteProject 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeleteProject480Example: summary: Default DeleteProject 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteProject481Example: summary: Default DeleteProject 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DeleteProject482Example: summary: Default DeleteProject 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the project to be deleted. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Delete Project x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeProject description: Returns the definition of a specific DataBrew project. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeProjectResponse" examples: DescribeProject200Example: summary: Default DescribeProject 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeProject480Example: summary: Default DescribeProject 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DescribeProject481Example: summary: Default DescribeProject 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the project to be described. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Describe Project x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateProject description: Modifies the definition of an existing DataBrew project. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateProjectResponse" examples: UpdateProject200Example: summary: Default UpdateProject 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateProject480Example: summary: Default UpdateProject 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UpdateProject481Example: summary: Default UpdateProject 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the project to be updated. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - RoleArn properties: Sample: description: Represents the sample size and sampling type for DataBrew to use for interactive data analysis. type: object properties: Size: allOf: - $ref: "#/components/schemas/SampleSize" - description: The number of rows in the sample. Type: allOf: - $ref: "#/components/schemas/SampleType" - description: The way in which DataBrew obtains rows from a dataset. RoleArn: description: The Amazon Resource Name (ARN) of the IAM role to be assumed for this request. type: string minLength: 20 maxLength: 2048 summary: Amazon Glue DataBrew Update Project x-microcks-operation: delay: 0 dispatcher: FALLBACK "/recipes/{name}/recipeVersion/{recipeVersion}": delete: operationId: DeleteRecipeVersion description: Deletes a single version of a DataBrew recipe. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteRecipeVersionResponse" examples: DeleteRecipeVersion200Example: summary: Default DeleteRecipeVersion 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeleteRecipeVersion480Example: summary: Default DeleteRecipeVersion 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteRecipeVersion481Example: summary: Default DeleteRecipeVersion 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DeleteRecipeVersion482Example: summary: Default DeleteRecipeVersion 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the recipe. schema: type: string minLength: 1 maxLength: 255 - name: recipeVersion in: path required: true description: The version of the recipe to be deleted. You can specify a numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported. schema: type: string minLength: 1 maxLength: 16 summary: Amazon Glue DataBrew Delete Recipe Version x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/rulesets/{name}": delete: operationId: DeleteRuleset description: Deletes a ruleset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteRulesetResponse" examples: DeleteRuleset200Example: summary: Default DeleteRuleset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteRuleset480Example: summary: Default DeleteRuleset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DeleteRuleset481Example: summary: Default DeleteRuleset 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: DeleteRuleset482Example: summary: Default DeleteRuleset 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the ruleset to be deleted. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Delete Ruleset x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeRuleset description: Retrieves detailed information about the ruleset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeRulesetResponse" examples: DescribeRuleset200Example: summary: Default DescribeRuleset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeRuleset480Example: summary: Default DescribeRuleset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DescribeRuleset481Example: summary: Default DescribeRuleset 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the ruleset to be described. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Describe Ruleset x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateRuleset description: Updates specified ruleset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateRulesetResponse" examples: UpdateRuleset200Example: summary: Default UpdateRuleset 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateRuleset480Example: summary: Default UpdateRuleset 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UpdateRuleset481Example: summary: Default UpdateRuleset 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the ruleset to be updated. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - Rules properties: Description: description: The description of the ruleset. type: string maxLength: 1024 Rules: description: A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. type: array items: $ref: "#/components/schemas/Rule" minItems: 1 summary: Amazon Glue DataBrew Update Ruleset x-microcks-operation: delay: 0 dispatcher: FALLBACK "/schedules/{name}": delete: operationId: DeleteSchedule description: Deletes the specified DataBrew schedule. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteScheduleResponse" examples: DeleteSchedule200Example: summary: Default DeleteSchedule 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteSchedule480Example: summary: Default DeleteSchedule 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DeleteSchedule481Example: summary: Default DeleteSchedule 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the schedule to be deleted. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Delete Schedule x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: DescribeSchedule description: Returns the definition of a specific DataBrew schedule. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeScheduleResponse" examples: DescribeSchedule200Example: summary: Default DescribeSchedule 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeSchedule480Example: summary: Default DescribeSchedule 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DescribeSchedule481Example: summary: Default DescribeSchedule 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the schedule to be described. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Describe Schedule x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateSchedule description: Modifies the definition of an existing DataBrew schedule. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateScheduleResponse" examples: UpdateSchedule200Example: summary: Default UpdateSchedule 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateSchedule480Example: summary: Default UpdateSchedule 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: UpdateSchedule481Example: summary: Default UpdateSchedule 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UpdateSchedule482Example: summary: Default UpdateSchedule 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the schedule to update. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object required: - CronExpression properties: JobNames: description: The name or names of one or more jobs to be run for this schedule. type: array items: $ref: "#/components/schemas/JobName" maxItems: 50 CronExpression: description: The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide. type: string minLength: 1 maxLength: 512 summary: Amazon Glue DataBrew Update Schedule x-microcks-operation: delay: 0 dispatcher: FALLBACK "/jobs/{name}/jobRun/{runId}": get: operationId: DescribeJobRun description: Represents one run of a DataBrew job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeJobRunResponse" examples: DescribeJobRun200Example: summary: Default DescribeJobRun 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeJobRun480Example: summary: Default DescribeJobRun 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DescribeJobRun481Example: summary: Default DescribeJobRun 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job being processed during this run. schema: type: string minLength: 1 maxLength: 240 - name: runId in: path required: true description: The unique identifier of the job run. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Describe Job Run x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/recipes/{name}": get: operationId: DescribeRecipe description: Returns the definition of a specific DataBrew recipe corresponding to a particular version. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeRecipeResponse" examples: DescribeRecipe200Example: summary: Default DescribeRecipe 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DescribeRecipe480Example: summary: Default DescribeRecipe 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: DescribeRecipe481Example: summary: Default DescribeRecipe 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the recipe to be described. schema: type: string minLength: 1 maxLength: 255 - name: recipeVersion in: query required: false description: The recipe version identifier. If this parameter isn't specified, then the latest published version is returned. schema: type: string minLength: 1 maxLength: 16 summary: Amazon Glue DataBrew Describe Recipe x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" put: operationId: UpdateRecipe description: Modifies the definition of the LATEST_WORKING version of a DataBrew recipe. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateRecipeResponse" examples: UpdateRecipe200Example: summary: Default UpdateRecipe 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UpdateRecipe480Example: summary: Default UpdateRecipe 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateRecipe481Example: summary: Default UpdateRecipe 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the recipe to be updated. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: Description: description: A description of the recipe. type: string maxLength: 1024 Steps: description: 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. type: array items: $ref: "#/components/schemas/RecipeStep" summary: Amazon Glue DataBrew Update Recipe x-microcks-operation: delay: 0 dispatcher: FALLBACK "/jobs/{name}/jobRuns": get: operationId: ListJobRuns description: Lists all of the previous runs of a particular DataBrew job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListJobRunsResponse" examples: ListJobRuns200Example: summary: Default ListJobRuns 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListJobRuns480Example: summary: Default ListJobRuns 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListJobRuns481Example: summary: Default ListJobRuns 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job. schema: type: string minLength: 1 maxLength: 240 - name: maxResults in: query required: false description: "The maximum number of results to return in this request. " schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The token returned by a previous call to retrieve the next set of results. schema: type: string minLength: 1 maxLength: 2000 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Job Runs x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /jobs: get: operationId: ListJobs description: Lists all of the DataBrew jobs that are defined. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListJobsResponse" examples: ListJobs200Example: summary: Default ListJobs 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListJobs480Example: summary: Default ListJobs 480 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: datasetName in: query required: false description: The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset. schema: type: string minLength: 1 maxLength: 255 - name: maxResults in: query required: false description: "The maximum number of results to return in this request. " schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: "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. " schema: type: string minLength: 1 maxLength: 2000 - name: projectName in: query required: false description: The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project. schema: type: string minLength: 1 maxLength: 255 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /recipeVersions#name: get: operationId: ListRecipeVersions description: Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListRecipeVersionsResponse" examples: ListRecipeVersions200Example: summary: Default ListRecipeVersions 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListRecipeVersions480Example: summary: Default ListRecipeVersions 480 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: maxResults in: query required: false description: "The maximum number of results to return in this request. " schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The token returned by a previous call to retrieve the next set of results. schema: type: string minLength: 1 maxLength: 2000 - name: name in: query required: true description: The name of the recipe for which to return version information. schema: type: string minLength: 1 maxLength: 255 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Glue DataBrew List Recipe Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/tags/{ResourceArn}": get: operationId: ListTagsForResource description: "Lists all the tags for a DataBrew resource. " responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" examples: ListTagsForResource200Example: summary: Default ListTagsForResource 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" examples: ListTagsForResource480Example: summary: Default ListTagsForResource 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ListTagsForResource481Example: summary: Default ListTagsForResource 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: ListTagsForResource482Example: summary: Default ListTagsForResource 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: ResourceArn in: path required: true description: "The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource. " schema: type: string minLength: 20 maxLength: 2048 summary: Amazon Glue DataBrew List Tags for Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: operationId: TagResource description: Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/TagResourceResponse" examples: TagResource200Example: summary: Default TagResource 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" examples: TagResource480Example: summary: Default TagResource 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: TagResource481Example: summary: Default TagResource 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: TagResource482Example: summary: Default TagResource 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: ResourceArn in: path required: true description: The DataBrew resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a recipe. schema: type: string minLength: 20 maxLength: 2048 requestBody: required: true content: application/json: schema: type: object required: - Tags properties: Tags: description: One or more tags to be assigned to the resource. type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" summary: Amazon Glue DataBrew Tag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK "/recipes/{name}/publishRecipe": post: operationId: PublishRecipe description: Publishes a new version of a DataBrew recipe. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PublishRecipeResponse" examples: PublishRecipe200Example: summary: Default PublishRecipe 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: PublishRecipe480Example: summary: Default PublishRecipe 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: PublishRecipe481Example: summary: Default PublishRecipe 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: PublishRecipe482Example: summary: Default PublishRecipe 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the recipe to be published. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: Description: description: A description of the recipe to be published, for this version of the recipe. type: string maxLength: 1024 summary: Amazon Glue DataBrew Publish Recipe x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/projects/{name}/sendProjectSessionAction": put: operationId: SendProjectSessionAction description: Performs a recipe step within an interactive DataBrew session that's currently open. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/SendProjectSessionActionResponse" examples: SendProjectSessionAction200Example: summary: Default SendProjectSessionAction 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: SendProjectSessionAction480Example: summary: Default SendProjectSessionAction 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: SendProjectSessionAction481Example: summary: Default SendProjectSessionAction 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: SendProjectSessionAction482Example: summary: Default SendProjectSessionAction 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the project to apply the action to. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: Preview: description: If true, the result of the recipe step will be returned, but not applied. type: boolean RecipeStep: description: Represents a single step from a DataBrew recipe to be performed. type: object properties: Action: allOf: - $ref: "#/components/schemas/RecipeAction" - description: The particular action to be performed in the recipe step. ConditionExpressions: allOf: - $ref: "#/components/schemas/ConditionExpressionList" - description:

One or more conditions that must be met for the recipe step to succeed.

All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.

StepIndex: description: 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. type: integer minimum: 0 ClientSessionId: description: A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session. type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ minLength: 1 maxLength: 255 format: password ViewFrame: description: Represents the data being transformed during an action. type: object properties: StartColumnIndex: allOf: - $ref: "#/components/schemas/StartColumnIndex" - description: The starting index for the range of columns to return in the view frame. ColumnRange: allOf: - $ref: "#/components/schemas/ColumnRange" - description: The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list. HiddenColumns: allOf: - $ref: "#/components/schemas/HiddenColumnList" - description: A list of columns to hide in the view frame. StartRowIndex: allOf: - $ref: "#/components/schemas/StartRowIndex" - description: The starting index for the range of rows to return in the view frame. RowRange: allOf: - $ref: "#/components/schemas/RowRange" - description: The number of rows to include in the view frame, beginning with the StartRowIndex value. Analytics: allOf: - $ref: "#/components/schemas/AnalyticsMode" - description: Controls if analytics computation is enabled or disabled. Enabled by default. summary: Amazon Glue DataBrew Send Project Session Action x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/jobs/{name}/startJobRun": post: operationId: StartJobRun description: Runs a DataBrew job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartJobRunResponse" examples: StartJobRun200Example: summary: Default StartJobRun 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: StartJobRun480Example: summary: Default StartJobRun 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: StartJobRun481Example: summary: Default StartJobRun 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: StartJobRun482Example: summary: Default StartJobRun 482 response x-microcks-default: true value: status: SUCCEEDED "483": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: StartJobRun483Example: summary: Default StartJobRun 483 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job to be run. schema: type: string minLength: 1 maxLength: 240 summary: Amazon Glue DataBrew Start Job Run x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/projects/{name}/startProjectSession": put: operationId: StartProjectSession description: Creates an interactive session, enabling you to manipulate data in a DataBrew project. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StartProjectSessionResponse" examples: StartProjectSession200Example: summary: Default StartProjectSession 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" examples: StartProjectSession480Example: summary: Default StartProjectSession 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: StartProjectSession481Example: summary: Default StartProjectSession 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" examples: StartProjectSession482Example: summary: Default StartProjectSession 482 response x-microcks-default: true value: status: SUCCEEDED "483": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: StartProjectSession483Example: summary: Default StartProjectSession 483 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the project to act upon. schema: type: string minLength: 1 maxLength: 255 requestBody: required: true content: application/json: schema: type: object properties: AssumeControl: description: A value that, if true, enables you to take control of a session, even if a different client is currently accessing the project. type: boolean summary: Amazon Glue DataBrew Start Project Session x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/jobs/{name}/jobRun/{runId}/stopJobRun": post: operationId: StopJobRun description: Stops a particular run of a job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/StopJobRunResponse" examples: StopJobRun200Example: summary: Default StopJobRun 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: StopJobRun480Example: summary: Default StopJobRun 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: StopJobRun481Example: summary: Default StopJobRun 481 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job to be stopped. schema: type: string minLength: 1 maxLength: 240 - name: runId in: path required: true description: The ID of the job run to be stopped. schema: type: string minLength: 1 maxLength: 255 summary: Amazon Glue DataBrew Stop Job Run x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/tags/{ResourceArn}#tagKeys": delete: operationId: UntagResource description: Removes metadata tags from a DataBrew resource. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" examples: UntagResource200Example: summary: Default UntagResource 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: ResourceArn in: path required: true description: "A DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). " schema: type: string minLength: 20 maxLength: 2048 - name: tagKeys in: query required: true description: The tag keys (names) of one or more tags to be removed. schema: type: array items: $ref: "#/components/schemas/TagKey" minItems: 1 maxItems: 200 summary: Amazon Glue DataBrew Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/profileJobs/{name}": put: operationId: UpdateProfileJob description: Modifies the definition of an existing profile job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateProfileJobResponse" examples: UpdateProfileJob200Example: summary: Default UpdateProfileJob 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: UpdateProfileJob480Example: summary: Default UpdateProfileJob 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateProfileJob481Example: summary: Default UpdateProfileJob 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UpdateProfileJob482Example: summary: Default UpdateProfileJob 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job to be updated. schema: type: string minLength: 1 maxLength: 240 requestBody: required: true content: application/json: schema: type: object required: - OutputLocation - RoleArn properties: Configuration: description: "Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. " type: object properties: DatasetStatisticsConfiguration: allOf: - $ref: "#/components/schemas/StatisticsConfiguration" - description: "Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations. " ProfileColumns: allOf: - $ref: "#/components/schemas/ColumnSelectorList" - description: "List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns. " ColumnStatisticsConfigurations: allOf: - $ref: "#/components/schemas/ColumnStatisticsConfigurationList" - description: "List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations. " EntityDetectorConfiguration: allOf: - $ref: "#/components/schemas/EntityDetectorConfiguration" - description: Configuration of entity detection for a profile job. When undefined, entity detection is disabled. EncryptionKeyArn: description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. type: string minLength: 20 maxLength: 2048 EncryptionMode: description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

FULL_DATASET - The profile job is run on the entire dataset.
CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

Size: allOf: - $ref: "#/components/schemas/JobSize" - description:

The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

summary: Amazon Glue DataBrew Update Profile Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/recipeJobs/{name}": put: operationId: UpdateRecipeJob description: Modifies the definition of an existing DataBrew recipe job. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateRecipeJobResponse" examples: UpdateRecipeJob200Example: summary: Default UpdateRecipeJob 200 response x-microcks-default: true value: status: SUCCEEDED "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" examples: UpdateRecipeJob480Example: summary: Default UpdateRecipeJob 480 response x-microcks-default: true value: status: SUCCEEDED "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateRecipeJob481Example: summary: Default UpdateRecipeJob 481 response x-microcks-default: true value: status: SUCCEEDED "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" examples: UpdateRecipeJob482Example: summary: Default UpdateRecipeJob 482 response x-microcks-default: true value: status: SUCCEEDED parameters: - name: name in: path required: true description: The name of the job to update. schema: type: string minLength: 1 maxLength: 240 requestBody: required: true content: application/json: schema: type: object required: - RoleArn properties: EncryptionKeyArn: description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. type: string minLength: 20 maxLength: 2048 EncryptionMode: description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

type: string enum: - SSE-KMS - SSE-S3 LogSubscription: description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. type: string enum: - ENABLE - DISABLE MaxCapacity: description: The maximum number of nodes that DataBrew can consume when the job processes data. type: integer MaxRetries: description: The maximum number of times to retry the job after a job run fails. type: integer minimum: 0 Outputs: description: "One or more artifacts that represent the output from running the job. " type: array items: $ref: "#/components/schemas/Output" minItems: 1 DataCatalogOutputs: description: One or more artifacts that represent the Glue Data Catalog output from running the job. type: array items: $ref: "#/components/schemas/DataCatalogOutput" minItems: 1 DatabaseOutputs: description: Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. type: array items: $ref: "#/components/schemas/DatabaseOutput" minItems: 1 RoleArn: description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. type: string minLength: 20 maxLength: 2048 Timeout: description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. type: integer minimum: 0 summary: Amazon Glue DataBrew Update Recipe Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: BatchDeleteRecipeVersionResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe that was modified. Errors: allOf: - $ref: "#/components/schemas/RecipeErrorList" - description: Errors, if any, that occurred while attempting to delete the recipe versions. RecipeVersion: type: string minLength: 1 maxLength: 16 ConflictException: {} ResourceNotFoundException: {} ValidationException: {} CreateDatasetResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset that you created. JsonOptions: type: object properties: MultiLine: allOf: - $ref: "#/components/schemas/MultiLine" - description: A value that specifies whether JSON input contains embedded new line characters. description: Represents the JSON-specific options that define how input is to be interpreted by Glue DataBrew. ExcelOptions: type: object properties: SheetNames: allOf: - $ref: "#/components/schemas/SheetNameList" - description: One or more named sheets in the Excel file that will be included in the dataset. SheetIndexes: allOf: - $ref: "#/components/schemas/SheetIndexList" - description: One or more sheet numbers in the Excel file that will be included in the dataset. HeaderRow: allOf: - $ref: "#/components/schemas/HeaderRow" - description: A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated. description: Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file. CsvOptions: type: object properties: Delimiter: allOf: - $ref: "#/components/schemas/Delimiter" - description: A single character that specifies the delimiter being used in the CSV file. HeaderRow: allOf: - $ref: "#/components/schemas/HeaderRow" - description: A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated. description: Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file. S3Location: type: object required: - Bucket properties: Bucket: allOf: - $ref: "#/components/schemas/Bucket" - description: The Amazon S3 bucket name. Key: allOf: - $ref: "#/components/schemas/Key" - description: The unique name of the object in the bucket. BucketOwner: allOf: - $ref: "#/components/schemas/BucketOwner" - description: The Amazon Web Services account ID of the bucket owner. description: Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job. DataCatalogInputDefinition: type: object required: - DatabaseName - TableName properties: CatalogId: allOf: - $ref: "#/components/schemas/CatalogId" - description: The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data. DatabaseName: allOf: - $ref: "#/components/schemas/DatabaseName" - description: The name of a database in the Data Catalog. TableName: allOf: - $ref: "#/components/schemas/TableName" - description: The name of a database table in the Data Catalog. This table corresponds to a DataBrew dataset. TempDirectory: allOf: - $ref: "#/components/schemas/S3Location" - description: Represents an Amazon location where DataBrew can store intermediate results. description: "Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew dataset. " DatabaseInputDefinition: type: object required: - GlueConnectionName properties: GlueConnectionName: allOf: - $ref: "#/components/schemas/GlueConnectionName" - description: The Glue Connection that stores the connection information for the target database. DatabaseTableName: allOf: - $ref: "#/components/schemas/DatabaseTableName" - description: The table within the target database. TempDirectory: $ref: "#/components/schemas/S3Location" QueryString: allOf: - $ref: "#/components/schemas/QueryString" - description: Custom SQL to run against the provided Glue connection. This SQL will be used as the input for DataBrew projects and jobs. description: Connection information for dataset input files stored in a database. Metadata: type: object properties: SourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow. description: Contains additional resource information needed for specific datasets. FilterExpression: type: object required: - Expression - ValuesMap properties: Expression: allOf: - $ref: "#/components/schemas/Expression" - description: The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, "(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)". Substitution variables should start with ':' symbol. ValuesMap: allOf: - $ref: "#/components/schemas/ValuesMap" - description: The map of substitution variable names to their values used in this filter expression. description: 'Represents a structure for defining parameter conditions. Supported conditions are described here: Supported conditions for dynamic datasets in the Glue DataBrew Developer Guide.' FilesLimit: type: object required: - MaxFiles properties: MaxFiles: allOf: - $ref: "#/components/schemas/MaxFiles" - description: The number of Amazon S3 files to select. OrderedBy: allOf: - $ref: "#/components/schemas/OrderedBy" - description: A criteria to use for Amazon S3 files sorting before their selection. By default uses LAST_MODIFIED_DATE as a sorting criteria. Currently it's the only allowed value. Order: allOf: - $ref: "#/components/schemas/Order" - description: A criteria to use for Amazon S3 files sorting before their selection. By default uses DESCENDING order, i.e. most recent files are selected first. Another possible value is ASCENDING. description: Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path. PathParametersMap: type: object description: A structure that map names of parameters used in the Amazon S3 path of a dataset to their definitions. A definition includes parameter type and conditions. minProperties: 1 maxProperties: 10 additionalProperties: $ref: "#/components/schemas/DatasetParameter" TagValue: type: string maxLength: 256 AccessDeniedException: {} ServiceQuotaExceededException: {} CreateProfileJobResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job that was created. Bucket: type: string minLength: 3 maxLength: 63 Key: type: string minLength: 1 maxLength: 1280 BucketOwner: type: string pattern: ^[0-9]{12}$ minLength: 12 maxLength: 12 StatisticsConfiguration: type: object properties: IncludedStatistics: allOf: - $ref: "#/components/schemas/StatisticList" - description: List of included evaluations. When the list is undefined, all supported evaluations will be included. Overrides: allOf: - $ref: "#/components/schemas/StatisticOverrideList" - description: List of overrides for evaluations. description: "Configuration of evaluations for a profile job. This configuration can be used to select evaluations and override the parameters of selected evaluations. " ColumnSelectorList: type: array items: $ref: "#/components/schemas/ColumnSelector" minItems: 1 ColumnStatisticsConfigurationList: type: array items: $ref: "#/components/schemas/ColumnStatisticsConfiguration" minItems: 1 EntityDetectorConfiguration: type: object required: - EntityTypes properties: EntityTypes: allOf: - $ref: "#/components/schemas/EntityTypeList" - description:

Entity types to detect. Can be any of the following:

USA_SSN
EMAIL
USA_ITIN
USA_PASSPORT_NUMBER
PHONE_NUMBER
USA_DRIVING_LICENSE
BANK_ACCOUNT
CREDIT_CARD
IP_ADDRESS
MAC_ADDRESS
USA_DEA_NUMBER
USA_HCPCS_CODE
USA_NATIONAL_PROVIDER_IDENTIFIER
USA_NATIONAL_DRUG_CODE
USA_HEALTH_INSURANCE_CLAIM_NUMBER
USA_MEDICARE_BENEFICIARY_IDENTIFIER
USA_CPT_CODE
PERSON_NAME
DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

AllowedStatistics: allOf: - $ref: "#/components/schemas/AllowedStatisticList" - description: Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities. description: Configuration of entity detection for a profile job. When undefined, entity detection is disabled. ValidationConfiguration: type: object required: - RulesetArn properties: RulesetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job. ValidationMode: allOf: - $ref: "#/components/schemas/ValidationMode" - description: Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset. description: Configuration for data quality validation. Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation. SampleMode: type: string enum: - FULL_DATASET - CUSTOM_ROWS JobSize: type: integer CreateProjectResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project that you created. SampleSize: type: integer minimum: 1 maximum: 5000 SampleType: type: string enum: - FIRST_N - LAST_N - RANDOM InternalServerException: {} CreateRecipeResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe that you created. RecipeStep: type: object required: - Action properties: Action: allOf: - $ref: "#/components/schemas/RecipeAction" - description: The particular action to be performed in the recipe step. ConditionExpressions: allOf: - $ref: "#/components/schemas/ConditionExpressionList" - description:

One or more conditions that must be met for the recipe step to succeed.

All of the conditions in the array must be met. In other words, all of the conditions must be combined using a logical AND operation.

description: Represents a single step from a DataBrew recipe to be performed. CreateRecipeJobResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job that you created. Output: type: object required: - Location properties: CompressionFormat: allOf: - $ref: "#/components/schemas/CompressionFormat" - description: The compression algorithm used to compress the output text of the job. Format: allOf: - $ref: "#/components/schemas/OutputFormat" - description: The data format of the output of the job. PartitionColumns: allOf: - $ref: "#/components/schemas/ColumnNameList" - description: The names of one or more partition columns for the output of the job. Location: allOf: - $ref: "#/components/schemas/S3Location" - description: The location in Amazon S3 where the job writes its output. Overwrite: allOf: - $ref: "#/components/schemas/OverwriteOutput" - description: A value that, if true, means that any data in the location specified for output is overwritten with new output. FormatOptions: allOf: - $ref: "#/components/schemas/OutputFormatOptions" - description: Represents options that define how DataBrew formats job output files. MaxOutputFiles: allOf: - $ref: "#/components/schemas/MaxOutputFiles" - description: Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition. description: Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs. DataCatalogOutput: type: object required: - DatabaseName - TableName properties: CatalogId: allOf: - $ref: "#/components/schemas/CatalogId" - description: The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data. DatabaseName: allOf: - $ref: "#/components/schemas/DatabaseName" - description: The name of a database in the Data Catalog. TableName: allOf: - $ref: "#/components/schemas/TableName" - description: The name of a table in the Data Catalog. S3Options: allOf: - $ref: "#/components/schemas/S3TableOutputOptions" - description: Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs. DatabaseOptions: allOf: - $ref: "#/components/schemas/DatabaseTableOutputOptions" - description: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. Overwrite: allOf: - $ref: "#/components/schemas/OverwriteOutput" - description: A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions. description: Represents options that specify how and where in the Glue Data Catalog DataBrew writes the output generated by recipe jobs. DatabaseOutput: type: object required: - GlueConnectionName - DatabaseOptions properties: GlueConnectionName: allOf: - $ref: "#/components/schemas/GlueConnectionName" - description: The Glue connection that stores the connection information for the target database. DatabaseOptions: allOf: - $ref: "#/components/schemas/DatabaseTableOutputOptions" - description: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. DatabaseOutputMode: allOf: - $ref: "#/components/schemas/DatabaseOutputMode" - description: "The output mode to write into the database. Currently supported option: NEW_TABLE." description: Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into. RecipeName: type: string minLength: 1 maxLength: 255 CreateRulesetResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RulesetName" - description: The unique name of the created ruleset. Rule: type: object required: - Name - CheckExpression properties: Name: allOf: - $ref: "#/components/schemas/RuleName" - description: The name of the rule. Disabled: allOf: - $ref: "#/components/schemas/Disabled" - description: A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false. CheckExpression: allOf: - $ref: "#/components/schemas/Expression" - description:

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

For more information, see Available checks

SubstitutionMap: allOf: - $ref: "#/components/schemas/ValuesMap" - description: "The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, \":col1\": \"`Column A`\". " Threshold: allOf: - $ref: "#/components/schemas/Threshold" - description: The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds. ColumnSelectors: allOf: - $ref: "#/components/schemas/ColumnSelectorList" - description: List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns. description: Represents a single data quality requirement that should be validated in the scope of this dataset. CreateScheduleResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/ScheduleName" - description: The name of the schedule that was created. JobName: type: string minLength: 1 maxLength: 240 DeleteDatasetResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset that you deleted. DeleteJobResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job that you deleted. DeleteProjectResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project that you deleted. DeleteRecipeVersionResponse: type: object required: - Name - RecipeVersion properties: Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe that was deleted. RecipeVersion: allOf: - $ref: "#/components/schemas/RecipeVersion" - description: The version of the recipe that was deleted. DeleteRulesetResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RulesetName" - description: The name of the deleted ruleset. DeleteScheduleResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/ScheduleName" - description: The name of the schedule that was deleted. DescribeDatasetResponse: type: object required: - Name - Input properties: CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The identifier (user name) of the user who created the dataset. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the dataset was created. Name: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset. Format: allOf: - $ref: "#/components/schemas/InputFormat" - description: The file format of a dataset that is created from an Amazon S3 file or folder. FormatOptions: $ref: "#/components/schemas/FormatOptions" Input: $ref: "#/components/schemas/Input" LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the dataset was last modified. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The identifier (user name) of the user who last modified the dataset. Source: allOf: - $ref: "#/components/schemas/Source" - description: The location of the data for this dataset, Amazon S3 or the Glue Data Catalog. PathOptions: allOf: - $ref: "#/components/schemas/PathOptions" - description: A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags associated with this dataset. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the dataset. DescribeJobResponse: type: object required: - Name properties: CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the job was created. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The identifier (user name) of the user associated with the creation of the job. DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The dataset that the job acts upon. EncryptionKeyArn: allOf: - $ref: "#/components/schemas/EncryptionKeyArn" - description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. EncryptionMode: allOf: - $ref: "#/components/schemas/EncryptionMode" - description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Name: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job. Type: allOf: - $ref: "#/components/schemas/JobType" - description:

The job type, which must be one of the following:

PROFILE - The job analyzes the dataset to determine its size, data types, data distribution, and more.
RECIPE - The job applies one or more transformations to a dataset.

LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The identifier (user name) of the user who last modified the job. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the job was last modified. LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: Indicates whether Amazon CloudWatch logging is enabled for this job. MaxCapacity: allOf: - $ref: "#/components/schemas/MaxCapacity" - description: The maximum number of compute nodes that DataBrew can consume when the job processes data. MaxRetries: allOf: - $ref: "#/components/schemas/MaxRetries" - description: The maximum number of times to retry the job after a job run fails. Outputs: allOf: - $ref: "#/components/schemas/OutputList" - description: One or more artifacts that represent the output from running the job. DataCatalogOutputs: allOf: - $ref: "#/components/schemas/DataCatalogOutputList" - description: One or more artifacts that represent the Glue Data Catalog output from running the job. DatabaseOutputs: allOf: - $ref: "#/components/schemas/DatabaseOutputList" - description: Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. ProjectName: allOf: - $ref: "#/components/schemas/ProjectName" - description: The DataBrew project associated with this job. ProfileConfiguration: allOf: - $ref: "#/components/schemas/ProfileConfiguration" - description: Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings. ValidationConfigurations: allOf: - $ref: "#/components/schemas/ValidationConfigurationList" - description: List of validation configurations that are applied to the profile job. RecipeReference: $ref: "#/components/schemas/RecipeReference" ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the job. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags associated with this job. Timeout: allOf: - $ref: "#/components/schemas/Timeout" - description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. JobSample: allOf: - $ref: "#/components/schemas/JobSample" - description: Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. DescribeJobRunResponse: type: object required: - JobName properties: Attempt: allOf: - $ref: "#/components/schemas/Attempt" - description: The number of times that DataBrew has attempted to run the job. CompletedOn: allOf: - $ref: "#/components/schemas/Date" - description: The date and time when the job completed processing. DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset for the job to process. ErrorMessage: allOf: - $ref: "#/components/schemas/JobRunErrorMessage" - description: A message indicating an error (if any) that was encountered when the job ran. ExecutionTime: allOf: - $ref: "#/components/schemas/ExecutionTime" - description: The amount of time, in seconds, during which the job run consumed resources. JobName: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job being processed during this run. ProfileConfiguration: allOf: - $ref: "#/components/schemas/ProfileConfiguration" - description: Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings. ValidationConfigurations: allOf: - $ref: "#/components/schemas/ValidationConfigurationList" - description: List of validation configurations that are applied to the profile job. RunId: allOf: - $ref: "#/components/schemas/JobRunId" - description: The unique identifier of the job run. State: allOf: - $ref: "#/components/schemas/JobRunState" - description: The current state of the job run entity itself. LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: The current status of Amazon CloudWatch logging for the job run. LogGroupName: allOf: - $ref: "#/components/schemas/LogGroupName" - description: The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs. Outputs: allOf: - $ref: "#/components/schemas/OutputList" - description: One or more output artifacts from a job run. DataCatalogOutputs: allOf: - $ref: "#/components/schemas/DataCatalogOutputList" - description: One or more artifacts that represent the Glue Data Catalog output from running the job. DatabaseOutputs: allOf: - $ref: "#/components/schemas/DatabaseOutputList" - description: Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. RecipeReference: $ref: "#/components/schemas/RecipeReference" StartedBy: allOf: - $ref: "#/components/schemas/StartedBy" - description: The Amazon Resource Name (ARN) of the user who started the job run. StartedOn: allOf: - $ref: "#/components/schemas/Date" - description: The date and time when the job run began. JobSample: allOf: - $ref: "#/components/schemas/JobSample" - description: Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter. DescribeProjectResponse: type: object required: - Name properties: CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the project was created. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The identifier (user name) of the user who created the project. DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The dataset associated with the project. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the project was last modified. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The identifier (user name) of the user who last modified the project. Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project. RecipeName: allOf: - $ref: "#/components/schemas/RecipeName" - description: The recipe associated with this job. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the project. Sample: $ref: "#/components/schemas/Sample" RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags associated with this project. SessionStatus: allOf: - $ref: "#/components/schemas/SessionStatus" - description:

Describes the current state of the session:

PROVISIONING - allocating resources for the session.
INITIALIZING - getting the session ready for first use.
ASSIGNED - the session is ready for use.

OpenedBy: allOf: - $ref: "#/components/schemas/OpenedBy" - description: "The identifier (user name) of the user that opened the project for use. " OpenDate: allOf: - $ref: "#/components/schemas/Date" - description: "The date and time when the project was opened. " DescribeRecipeResponse: type: object required: - Name properties: CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The identifier (user name) of the user who created the recipe. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the recipe was created. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The identifier (user name) of the user who last modified the recipe. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the recipe was last modified. ProjectName: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project associated with this recipe. PublishedBy: allOf: - $ref: "#/components/schemas/PublishedBy" - description: The identifier (user name) of the user who last published the recipe. PublishedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time when the recipe was last published. Description: allOf: - $ref: "#/components/schemas/RecipeDescription" - description: The description of the recipe. Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe. Steps: allOf: - $ref: "#/components/schemas/RecipeStepList" - description: 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. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags associated with this project. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the recipe. RecipeVersion: allOf: - $ref: "#/components/schemas/RecipeVersion" - description: The recipe version identifier. DescribeRulesetResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RulesetName" - description: The name of the ruleset. Description: allOf: - $ref: "#/components/schemas/RulesetDescription" - description: The description of the ruleset. TargetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. Rules: allOf: - $ref: "#/components/schemas/RuleList" - description: A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the ruleset was created. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The Amazon Resource Name (ARN) of the user who created the ruleset. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The Amazon Resource Name (ARN) of the user who last modified the ruleset. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The modification date and time of the ruleset. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) for the ruleset. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags that have been applied to the ruleset. DescribeScheduleResponse: type: object required: - Name properties: CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the schedule was created. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: "The identifier (user name) of the user who created the schedule. " JobNames: allOf: - $ref: "#/components/schemas/JobNameList" - description: The name or names of one or more jobs to be run by using the schedule. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The identifier (user name) of the user who last modified the schedule. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the schedule was last modified. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the schedule. CronExpression: allOf: - $ref: "#/components/schemas/CronExpression" - description: The date or dates and time or times when the jobs are to be run for the schedule. For more information, see Cron expressions in the Glue DataBrew Developer Guide. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags associated with this schedule. Name: allOf: - $ref: "#/components/schemas/ScheduleName" - description: The name of the schedule. ListDatasetsResponse: type: object required: - Datasets properties: Datasets: allOf: - $ref: "#/components/schemas/DatasetList" - description: A list of datasets that are defined. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. ListJobRunsResponse: type: object required: - JobRuns properties: JobRuns: allOf: - $ref: "#/components/schemas/JobRunList" - description: A list of job runs that have occurred for the specified job. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. ListJobsResponse: type: object required: - Jobs properties: Jobs: allOf: - $ref: "#/components/schemas/JobList" - description: A list of jobs that are defined. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. ListProjectsResponse: type: object required: - Projects properties: Projects: allOf: - $ref: "#/components/schemas/ProjectList" - description: A list of projects that are defined . NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. ListRecipeVersionsResponse: type: object required: - Recipes properties: NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. Recipes: allOf: - $ref: "#/components/schemas/RecipeList" - description: A list of versions for the specified recipe. ListRecipesResponse: type: object required: - Recipes properties: Recipes: allOf: - $ref: "#/components/schemas/RecipeList" - description: A list of recipes that are defined. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. ListRulesetsResponse: type: object required: - Rulesets properties: Rulesets: allOf: - $ref: "#/components/schemas/RulesetItemList" - description: A list of RulesetItem. RulesetItem contains meta data of a ruleset. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. ListSchedulesResponse: type: object required: - Schedules properties: Schedules: allOf: - $ref: "#/components/schemas/ScheduleList" - description: A list of schedules that are defined. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: A token that you can use in a subsequent call to retrieve the next set of results. ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: A list of tags associated with the DataBrew resource. PublishRecipeResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe that you published. SendProjectSessionActionResponse: type: object required: - Name properties: Result: allOf: - $ref: "#/components/schemas/Result" - description: A message indicating the result of performing the action. Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project that was affected by the action. ActionId: allOf: - $ref: "#/components/schemas/ActionId" - description: A unique identifier for the action that was performed. RecipeAction: type: object required: - Operation properties: Operation: allOf: - $ref: "#/components/schemas/Operation" - description: The name of a valid DataBrew transformation to be performed on the data. Parameters: allOf: - $ref: "#/components/schemas/ParameterMap" - description: Contextual parameters for the transformation. description: Represents a transformation and associated parameters that are used to apply a change to a DataBrew dataset. For more information, see Recipe actions reference. ConditionExpressionList: type: array items: $ref: "#/components/schemas/ConditionExpression" StartColumnIndex: type: integer minimum: 0 ColumnRange: type: integer minimum: 0 maximum: 20 HiddenColumnList: type: array items: $ref: "#/components/schemas/ColumnName" StartRowIndex: type: integer minimum: 0 RowRange: type: integer AnalyticsMode: type: string enum: - ENABLE - DISABLE StartJobRunResponse: type: object required: - RunId properties: RunId: allOf: - $ref: "#/components/schemas/JobRunId" - description: A system-generated identifier for this particular job run. StartProjectSessionResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project to be acted upon. ClientSessionId: allOf: - $ref: "#/components/schemas/ClientSessionId" - description: A system-generated identifier for the session. StopJobRunResponse: type: object required: - RunId properties: RunId: allOf: - $ref: "#/components/schemas/JobRunId" - description: The ID of the job run that you stopped. TagResourceResponse: type: object properties: {} UntagResourceResponse: type: object properties: {} TagKey: type: string minLength: 1 maxLength: 128 UpdateDatasetResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset that you updated. UpdateProfileJobResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job that was updated. UpdateProjectResponse: type: object required: - Name properties: LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the project was last modified. Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project that you updated. UpdateRecipeResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe that was updated. UpdateRecipeJobResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job that you updated. UpdateRulesetResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RulesetName" - description: The name of the updated ruleset. UpdateScheduleResponse: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/ScheduleName" - description: The name of the schedule that was updated. AccountId: type: string maxLength: 255 ActionId: type: integer AllowedStatistics: type: object required: - Statistics properties: Statistics: allOf: - $ref: "#/components/schemas/StatisticList" - description: One or more column statistics to allow for columns that contain detected entities. description: Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities. AllowedStatisticList: type: array items: $ref: "#/components/schemas/AllowedStatistics" minItems: 1 StatisticList: type: array items: $ref: "#/components/schemas/Statistic" minItems: 1 Arn: type: string minLength: 20 maxLength: 2048 AssumeControl: type: boolean Attempt: type: integer RecipeVersionList: type: array items: $ref: "#/components/schemas/RecipeVersion" minItems: 1 maxItems: 50 BatchDeleteRecipeVersionRequest: type: object required: - RecipeVersions title: BatchDeleteRecipeVersionRequest properties: RecipeVersions: allOf: - $ref: "#/components/schemas/RecipeVersionList" - description: An array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (X.Y) or LATEST_WORKING. LATEST_PUBLISHED is not supported. RecipeErrorList: type: array items: $ref: "#/components/schemas/RecipeVersionErrorDetail" CatalogId: type: string minLength: 1 maxLength: 255 ClientSessionId: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ minLength: 1 maxLength: 255 format: password ColumnName: type: string minLength: 1 maxLength: 255 ColumnNameList: type: array items: $ref: "#/components/schemas/ColumnName" maxItems: 200 ColumnSelector: type: object properties: Regex: allOf: - $ref: "#/components/schemas/ColumnName" - description: A regular expression for selecting a column from a dataset. Name: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of a column from a dataset. description: Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression. ColumnStatisticsConfiguration: type: object required: - Statistics properties: Selectors: allOf: - $ref: "#/components/schemas/ColumnSelectorList" - description: "List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns. " Statistics: allOf: - $ref: "#/components/schemas/StatisticsConfiguration" - description: "Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations. " description: "Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns. " CompressionFormat: type: string enum: - GZIP - LZ4 - SNAPPY - BZIP2 - DEFLATE - LZO - BROTLI - ZSTD - ZLIB Condition: type: string pattern: ^[A-Z\_]+$ minLength: 1 maxLength: 128 ConditionValue: type: string maxLength: 1024 TargetColumn: type: string minLength: 1 maxLength: 1024 ConditionExpression: type: object required: - Condition - TargetColumn properties: Condition: allOf: - $ref: "#/components/schemas/Condition" - description: A specific condition to apply to a recipe action. For more information, see Recipe structure in the Glue DataBrew Developer Guide. Value: allOf: - $ref: "#/components/schemas/ConditionValue" - description: A value that the condition must evaluate to for the condition to succeed. TargetColumn: allOf: - $ref: "#/components/schemas/TargetColumn" - description: A column to apply this condition to. description:

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.

CreateColumn: type: boolean DatasetName: type: string minLength: 1 maxLength: 255 InputFormat: type: string enum: - CSV - JSON - PARQUET - EXCEL - ORC FormatOptions: type: object properties: Json: allOf: - $ref: "#/components/schemas/JsonOptions" - description: Options that define how JSON input is to be interpreted by DataBrew. Excel: allOf: - $ref: "#/components/schemas/ExcelOptions" - description: Options that define how Excel input is to be interpreted by DataBrew. Csv: allOf: - $ref: "#/components/schemas/CsvOptions" - description: Options that define how CSV input is to be interpreted by DataBrew. description: Represents a set of options that define the structure of either comma-separated value (CSV), Excel, or JSON input. Input: type: object properties: S3InputDefinition: allOf: - $ref: "#/components/schemas/S3Location" - description: The Amazon S3 location where the data is stored. DataCatalogInputDefinition: allOf: - $ref: "#/components/schemas/DataCatalogInputDefinition" - description: The Glue Data Catalog parameters for the data. DatabaseInputDefinition: allOf: - $ref: "#/components/schemas/DatabaseInputDefinition" - description: Connection information for dataset input files stored in a database. Metadata: allOf: - $ref: "#/components/schemas/Metadata" - description: Contains additional resource information needed for specific datasets. description: Represents information on how DataBrew can find data, in either the Glue Data Catalog or Amazon S3. PathOptions: type: object properties: LastModifiedDateCondition: allOf: - $ref: "#/components/schemas/FilterExpression" - description: If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3. FilesLimit: allOf: - $ref: "#/components/schemas/FilesLimit" - description: If provided, this structure imposes a limit on a number of files that should be selected. Parameters: allOf: - $ref: "#/components/schemas/PathParametersMap" - description: A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions. description: Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset. TagMap: type: object minProperties: 1 maxProperties: 200 additionalProperties: $ref: "#/components/schemas/TagValue" CreateDatasetRequest: type: object required: - Name - Input title: CreateDatasetRequest properties: Name: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Format: allOf: - $ref: "#/components/schemas/InputFormat" - description: The file format of a dataset that is created from an Amazon S3 file or folder. FormatOptions: $ref: "#/components/schemas/FormatOptions" Input: $ref: "#/components/schemas/Input" PathOptions: allOf: - $ref: "#/components/schemas/PathOptions" - description: A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags to apply to this dataset. EncryptionKeyArn: type: string minLength: 20 maxLength: 2048 EncryptionMode: type: string enum: - SSE-KMS - SSE-S3 LogSubscription: type: string enum: - ENABLE - DISABLE MaxCapacity: type: integer MaxRetries: type: integer minimum: 0 ProfileConfiguration: type: object properties: DatasetStatisticsConfiguration: allOf: - $ref: "#/components/schemas/StatisticsConfiguration" - description: "Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations. " ProfileColumns: allOf: - $ref: "#/components/schemas/ColumnSelectorList" - description: "List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns. " ColumnStatisticsConfigurations: allOf: - $ref: "#/components/schemas/ColumnStatisticsConfigurationList" - description: "List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations. " EntityDetectorConfiguration: allOf: - $ref: "#/components/schemas/EntityDetectorConfiguration" - description: Configuration of entity detection for a profile job. When undefined, entity detection is disabled. description: "Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns. " ValidationConfigurationList: type: array items: $ref: "#/components/schemas/ValidationConfiguration" minItems: 1 Timeout: type: integer minimum: 0 JobSample: type: object properties: Mode: allOf: - $ref: "#/components/schemas/SampleMode" - description:

A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

FULL_DATASET - The profile job is run on the entire dataset.
CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

Size: allOf: - $ref: "#/components/schemas/JobSize" - description:

The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

description: A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. CreateProfileJobRequest: type: object required: - DatasetName - Name - OutputLocation - RoleArn title: CreateProfileJobRequest properties: DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset that this job is to act upon. EncryptionKeyArn: allOf: - $ref: "#/components/schemas/EncryptionKeyArn" - description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. EncryptionMode: allOf: - $ref: "#/components/schemas/EncryptionMode" - description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - SSE-KMS - Server-side encryption with KMS-managed keys.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Name: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. MaxCapacity: allOf: - $ref: "#/components/schemas/MaxCapacity" - description: The maximum number of nodes that DataBrew can use when the job processes data. MaxRetries: allOf: - $ref: "#/components/schemas/MaxRetries" - description: The maximum number of times to retry the job after a job run fails. OutputLocation: $ref: "#/components/schemas/S3Location" Configuration: allOf: - $ref: "#/components/schemas/ProfileConfiguration" - description: Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings. ValidationConfigurations: allOf: - $ref: "#/components/schemas/ValidationConfigurationList" - description: List of validation configurations that are applied to the profile job. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags to apply to this job. Timeout: allOf: - $ref: "#/components/schemas/Timeout" - description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. JobSample: allOf: - $ref: "#/components/schemas/JobSample" - description: Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter. ProjectName: type: string minLength: 1 maxLength: 255 Sample: type: object required: - Type properties: Size: allOf: - $ref: "#/components/schemas/SampleSize" - description: The number of rows in the sample. Type: allOf: - $ref: "#/components/schemas/SampleType" - description: The way in which DataBrew obtains rows from a dataset. description: Represents the sample size and sampling type for DataBrew to use for interactive data analysis. CreateProjectRequest: type: object required: - DatasetName - Name - RecipeName - RoleArn title: CreateProjectRequest properties: DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of an existing dataset to associate this project with. Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: A unique name for the new project. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. RecipeName: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of an existing recipe to associate with the project. Sample: $ref: "#/components/schemas/Sample" RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags to apply to this project. OutputList: type: array items: $ref: "#/components/schemas/Output" minItems: 1 DataCatalogOutputList: type: array items: $ref: "#/components/schemas/DataCatalogOutput" minItems: 1 DatabaseOutputList: type: array items: $ref: "#/components/schemas/DatabaseOutput" minItems: 1 RecipeReference: type: object required: - Name properties: Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of the recipe. RecipeVersion: allOf: - $ref: "#/components/schemas/RecipeVersion" - description: "The identifier for the version for the recipe. " description: Represents the name and version of a DataBrew recipe. CreateRecipeJobRequest: type: object required: - Name - RoleArn title: CreateRecipeJobRequest properties: DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset that this job processes. EncryptionKeyArn: allOf: - $ref: "#/components/schemas/EncryptionKeyArn" - description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. EncryptionMode: allOf: - $ref: "#/components/schemas/EncryptionMode" - description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Name: allOf: - $ref: "#/components/schemas/JobName" - description: A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. MaxCapacity: allOf: - $ref: "#/components/schemas/MaxCapacity" - description: The maximum number of nodes that DataBrew can consume when the job processes data. MaxRetries: allOf: - $ref: "#/components/schemas/MaxRetries" - description: The maximum number of times to retry the job after a job run fails. Outputs: allOf: - $ref: "#/components/schemas/OutputList" - description: One or more artifacts that represent the output from running the job. DataCatalogOutputs: allOf: - $ref: "#/components/schemas/DataCatalogOutputList" - description: One or more artifacts that represent the Glue Data Catalog output from running the job. DatabaseOutputs: allOf: - $ref: "#/components/schemas/DatabaseOutputList" - description: "Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to. " ProjectName: allOf: - $ref: "#/components/schemas/ProjectName" - description: Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe. RecipeReference: $ref: "#/components/schemas/RecipeReference" RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags to apply to this job. Timeout: allOf: - $ref: "#/components/schemas/Timeout" - description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. RecipeDescription: type: string maxLength: 1024 RecipeStepList: type: array items: $ref: "#/components/schemas/RecipeStep" CreateRecipeRequest: type: object required: - Name - Steps title: CreateRecipeRequest properties: Description: allOf: - $ref: "#/components/schemas/RecipeDescription" - description: A description for the recipe. Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: A unique name for the recipe. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Steps: allOf: - $ref: "#/components/schemas/RecipeStepList" - description: 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: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags to apply to this recipe. RulesetName: type: string minLength: 1 maxLength: 255 RulesetDescription: type: string maxLength: 1024 RuleList: type: array items: $ref: "#/components/schemas/Rule" minItems: 1 CreateRulesetRequest: type: object required: - Name - TargetArn - Rules title: CreateRulesetRequest properties: Name: allOf: - $ref: "#/components/schemas/RulesetName" - description: The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. Description: allOf: - $ref: "#/components/schemas/RulesetDescription" - description: The description of the ruleset. TargetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. Rules: allOf: - $ref: "#/components/schemas/RuleList" - description: A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags to apply to the ruleset. JobNameList: type: array items: $ref: "#/components/schemas/JobName" maxItems: 50 CronExpression: type: string minLength: 1 maxLength: 512 ScheduleName: type: string minLength: 1 maxLength: 255 CreateScheduleRequest: type: object required: - CronExpression - Name title: CreateScheduleRequest properties: JobNames: allOf: - $ref: "#/components/schemas/JobNameList" - description: The name or names of one or more jobs to be run. CronExpression: allOf: - $ref: "#/components/schemas/CronExpression" - description: The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags to apply to this schedule. Name: allOf: - $ref: "#/components/schemas/ScheduleName" - description: A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. CreatedBy: type: string Delimiter: type: string minLength: 1 maxLength: 1 HeaderRow: type: boolean CsvOutputOptions: type: object properties: Delimiter: allOf: - $ref: "#/components/schemas/Delimiter" - description: A single character that specifies the delimiter used to create CSV job output. description: Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file. DatabaseName: type: string minLength: 1 maxLength: 255 TableName: type: string minLength: 1 maxLength: 255 S3TableOutputOptions: type: object required: - Location properties: Location: allOf: - $ref: "#/components/schemas/S3Location" - description: Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output from a job. description: Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs. DatabaseTableOutputOptions: type: object required: - TableName properties: TempDirectory: allOf: - $ref: "#/components/schemas/S3Location" - description: Represents an Amazon S3 location (bucket name and object key) where DataBrew can store intermediate results. TableName: allOf: - $ref: "#/components/schemas/DatabaseTableName" - description: A prefix for the name of a table DataBrew will create in the database. description: Represents options that specify how and where DataBrew writes the database output generated by recipe jobs. OverwriteOutput: type: boolean GlueConnectionName: type: string minLength: 1 maxLength: 255 DatabaseTableName: type: string minLength: 1 maxLength: 255 QueryString: type: string minLength: 1 maxLength: 10000 DatabaseOutputMode: type: string enum: - NEW_TABLE Date: type: string format: date-time LastModifiedBy: type: string Source: type: string enum: - S3 - DATA-CATALOG - DATABASE Dataset: type: object required: - Name - Input properties: AccountId: allOf: - $ref: "#/components/schemas/AccountId" - description: The ID of the Amazon Web Services account that owns the dataset. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The Amazon Resource Name (ARN) of the user who created the dataset. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the dataset was created. Name: allOf: - $ref: "#/components/schemas/DatasetName" - description: The unique name of the dataset. Format: allOf: - $ref: "#/components/schemas/InputFormat" - description: The file format of a dataset that is created from an Amazon S3 file or folder. FormatOptions: allOf: - $ref: "#/components/schemas/FormatOptions" - description: A set of options that define how DataBrew interprets the data in the dataset. Input: allOf: - $ref: "#/components/schemas/Input" - description: Information on how DataBrew can find the dataset, in either the Glue Data Catalog or Amazon S3. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The last modification date and time of the dataset. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The Amazon Resource Name (ARN) of the user who last modified the dataset. Source: allOf: - $ref: "#/components/schemas/Source" - description: The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog. PathOptions: allOf: - $ref: "#/components/schemas/PathOptions" - description: A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags that have been applied to the dataset. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The unique Amazon Resource Name (ARN) for the dataset. description: Represents a dataset that can be processed by DataBrew. DatasetList: type: array items: $ref: "#/components/schemas/Dataset" PathParameterName: type: string minLength: 1 maxLength: 255 ParameterType: type: string enum: - Datetime - Number - String DatetimeOptions: type: object required: - Format properties: Format: allOf: - $ref: "#/components/schemas/DatetimeFormat" - description: Required option, that defines the datetime format used for a date parameter in the Amazon S3 path. Should use only supported datetime specifiers and separation characters, all literal a-z or A-Z characters should be escaped with single quotes. E.g. "MM.dd.yyyy-'at'-HH:mm". TimezoneOffset: allOf: - $ref: "#/components/schemas/TimezoneOffset" - description: Optional value for a timezone offset of the datetime parameter value in the Amazon S3 path. Shouldn't be used if Format for this parameter includes timezone fields. If no offset specified, UTC is assumed. LocaleCode: allOf: - $ref: "#/components/schemas/LocaleCode" - description: Optional value for a non-US locale code, needed for correct interpretation of some date formats. description: Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset. DatasetParameter: type: object required: - Name - Type properties: Name: allOf: - $ref: "#/components/schemas/PathParameterName" - description: The name of the parameter that is used in the dataset's Amazon S3 path. Type: allOf: - $ref: "#/components/schemas/ParameterType" - description: The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'. DatetimeOptions: allOf: - $ref: "#/components/schemas/DatetimeOptions" - description: Additional parameter options such as a format and a timezone. Required for datetime parameters. CreateColumn: allOf: - $ref: "#/components/schemas/CreateColumn" - description: Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset. Filter: allOf: - $ref: "#/components/schemas/FilterExpression" - description: The optional filter expression structure to apply additional matching criteria to the parameter. description: Represents a dataset parameter that defines type and conditions for a parameter in the Amazon S3 path of the dataset. DatetimeFormat: type: string minLength: 2 maxLength: 100 TimezoneOffset: type: string pattern: ^(Z|[-+](\d|\d{2}|\d{2}:?\d{2}))$ minLength: 1 maxLength: 6 LocaleCode: type: string pattern: ^[A-Za-z0-9_\.#@\-]+$ minLength: 2 maxLength: 100 DeleteDatasetRequest: type: object title: DeleteDatasetRequest properties: {} DeleteJobRequest: type: object title: DeleteJobRequest properties: {} DeleteProjectRequest: type: object title: DeleteProjectRequest properties: {} DeleteRecipeVersionRequest: type: object title: DeleteRecipeVersionRequest properties: {} DeleteRulesetRequest: type: object title: DeleteRulesetRequest properties: {} DeleteScheduleRequest: type: object title: DeleteScheduleRequest properties: {} DescribeDatasetRequest: type: object title: DescribeDatasetRequest properties: {} DescribeJobRequest: type: object title: DescribeJobRequest properties: {} JobType: type: string enum: - PROFILE - RECIPE JobRunId: type: string minLength: 1 maxLength: 255 DescribeJobRunRequest: type: object title: DescribeJobRunRequest properties: {} JobRunErrorMessage: type: string ExecutionTime: type: integer JobRunState: type: string enum: - STARTING - RUNNING - STOPPING - STOPPED - SUCCEEDED - FAILED - TIMEOUT LogGroupName: type: string minLength: 1 maxLength: 512 StartedBy: type: string DescribeProjectRequest: type: object title: DescribeProjectRequest properties: {} SessionStatus: type: string enum: - ASSIGNED - FAILED - INITIALIZING - PROVISIONING - READY - RECYCLING - ROTATING - TERMINATED - TERMINATING - UPDATING OpenedBy: type: string DescribeRecipeRequest: type: object title: DescribeRecipeRequest properties: {} PublishedBy: type: string DescribeRulesetRequest: type: object title: DescribeRulesetRequest properties: {} DescribeScheduleRequest: type: object title: DescribeScheduleRequest properties: {} Disabled: type: boolean EntityTypeList: type: array items: $ref: "#/components/schemas/EntityType" minItems: 1 EntityType: type: string pattern: ^[A-Z_][A-Z\\d_]*$ minLength: 1 maxLength: 128 ErrorCode: type: string pattern: ^[1-5][0-9][0-9]$ SheetNameList: type: array items: $ref: "#/components/schemas/SheetName" minItems: 1 maxItems: 1 SheetIndexList: type: array items: $ref: "#/components/schemas/SheetIndex" minItems: 1 maxItems: 1 Expression: type: string pattern: ^[<>0-9A-Za-z_.,:)(!= ]+$ minLength: 4 maxLength: 1024 MaxFiles: type: integer minimum: 1 OrderedBy: type: string enum: - LAST_MODIFIED_DATE Order: type: string enum: - DESCENDING - ASCENDING ValuesMap: type: object additionalProperties: $ref: "#/components/schemas/ConditionValue" Job: type: object required: - Name properties: AccountId: allOf: - $ref: "#/components/schemas/AccountId" - description: The ID of the Amazon Web Services account that owns the job. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The Amazon Resource Name (ARN) of the user who created the job. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the job was created. DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: A dataset that the job is to process. EncryptionKeyArn: allOf: - $ref: "#/components/schemas/EncryptionKeyArn" - description: 'The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs ' EncryptionMode: allOf: - $ref: "#/components/schemas/EncryptionMode" - description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Name: allOf: - $ref: "#/components/schemas/JobName" - description: The unique name of the job. Type: allOf: - $ref: "#/components/schemas/JobType" - description:

The job type of the job, which must be one of the following:

PROFILE - A job to analyze a dataset, to determine its size, data types, data distribution, and more.
RECIPE - A job to apply one or more transformations to a dataset.

LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The Amazon Resource Name (ARN) of the user who last modified the job. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The modification date and time of the job. LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: The current status of Amazon CloudWatch logging for the job. MaxCapacity: allOf: - $ref: "#/components/schemas/MaxCapacity" - description: The maximum number of nodes that can be consumed when the job processes data. MaxRetries: allOf: - $ref: "#/components/schemas/MaxRetries" - description: The maximum number of times to retry the job after a job run fails. Outputs: allOf: - $ref: "#/components/schemas/OutputList" - description: One or more artifacts that represent output from running the job. DataCatalogOutputs: allOf: - $ref: "#/components/schemas/DataCatalogOutputList" - description: One or more artifacts that represent the Glue Data Catalog output from running the job. DatabaseOutputs: allOf: - $ref: "#/components/schemas/DatabaseOutputList" - description: Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. ProjectName: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project that the job is associated with. RecipeReference: allOf: - $ref: "#/components/schemas/RecipeReference" - description: A set of steps that the job runs. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The unique Amazon Resource Name (ARN) for the job. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the role to be assumed for this job. Timeout: allOf: - $ref: "#/components/schemas/Timeout" - description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags that have been applied to the job. JobSample: allOf: - $ref: "#/components/schemas/JobSample" - description: A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. ValidationConfigurations: allOf: - $ref: "#/components/schemas/ValidationConfigurationList" - description: List of validation configurations that are applied to the profile job. description: Represents all of the attributes of a DataBrew job. JobList: type: array items: $ref: "#/components/schemas/Job" JobRun: type: object properties: Attempt: allOf: - $ref: "#/components/schemas/Attempt" - description: The number of times that DataBrew has attempted to run the job. CompletedOn: allOf: - $ref: "#/components/schemas/Date" - description: The date and time when the job completed processing. DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The name of the dataset for the job to process. ErrorMessage: allOf: - $ref: "#/components/schemas/JobRunErrorMessage" - description: A message indicating an error (if any) that was encountered when the job ran. ExecutionTime: allOf: - $ref: "#/components/schemas/ExecutionTime" - description: The amount of time, in seconds, during which a job run consumed resources. JobName: allOf: - $ref: "#/components/schemas/JobName" - description: The name of the job being processed during this run. RunId: allOf: - $ref: "#/components/schemas/JobRunId" - description: The unique identifier of the job run. State: allOf: - $ref: "#/components/schemas/JobRunState" - description: The current state of the job run entity itself. LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: The current status of Amazon CloudWatch logging for the job run. LogGroupName: allOf: - $ref: "#/components/schemas/LogGroupName" - description: The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs. Outputs: allOf: - $ref: "#/components/schemas/OutputList" - description: One or more output artifacts from a job run. DataCatalogOutputs: allOf: - $ref: "#/components/schemas/DataCatalogOutputList" - description: One or more artifacts that represent the Glue Data Catalog output from running the job. DatabaseOutputs: allOf: - $ref: "#/components/schemas/DatabaseOutputList" - description: Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. RecipeReference: allOf: - $ref: "#/components/schemas/RecipeReference" - description: The set of steps processed by the job. StartedBy: allOf: - $ref: "#/components/schemas/StartedBy" - description: "The Amazon Resource Name (ARN) of the user who initiated the job run. " StartedOn: allOf: - $ref: "#/components/schemas/Date" - description: "The date and time when the job run began. " JobSample: allOf: - $ref: "#/components/schemas/JobSample" - description: A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter. ValidationConfigurations: allOf: - $ref: "#/components/schemas/ValidationConfigurationList" - description: List of validation configurations that are applied to the profile job run. description: Represents one run of a DataBrew job. JobRunList: type: array items: $ref: "#/components/schemas/JobRun" MultiLine: type: boolean MaxResults100: type: integer minimum: 1 maximum: 100 NextToken: type: string minLength: 1 maxLength: 2000 ListDatasetsRequest: type: object title: ListDatasetsRequest properties: {} ListJobRunsRequest: type: object title: ListJobRunsRequest properties: {} ListJobsRequest: type: object title: ListJobsRequest properties: {} ListProjectsRequest: type: object title: ListProjectsRequest properties: {} ProjectList: type: array items: $ref: "#/components/schemas/Project" ListRecipeVersionsRequest: type: object title: ListRecipeVersionsRequest properties: {} RecipeList: type: array items: $ref: "#/components/schemas/Recipe" ListRecipesRequest: type: object title: ListRecipesRequest properties: {} ListRulesetsRequest: type: object title: ListRulesetsRequest properties: {} RulesetItemList: type: array items: $ref: "#/components/schemas/RulesetItem" ListSchedulesRequest: type: object title: ListSchedulesRequest properties: {} ScheduleList: type: array items: $ref: "#/components/schemas/Schedule" ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} MaxOutputFiles: type: integer minimum: 1 maximum: 999 Operation: type: string pattern: ^[A-Z\_]+$ minLength: 1 maxLength: 128 OutputFormat: type: string enum: - CSV - JSON - PARQUET - GLUEPARQUET - AVRO - ORC - XML - TABLEAUHYPER OutputFormatOptions: type: object properties: Csv: allOf: - $ref: "#/components/schemas/CsvOutputOptions" - description: Represents a set of options that define the structure of comma-separated value (CSV) job output. description: Represents a set of options that define the structure of comma-separated (CSV) job output. ParameterValue: type: string minLength: 1 maxLength: 32768 ParameterMap: type: object additionalProperties: $ref: "#/components/schemas/ParameterValue" ParameterName: type: string pattern: ^[A-Za-z0-9]+$ minLength: 1 maxLength: 128 Preview: type: boolean Project: type: object required: - Name - RecipeName properties: AccountId: allOf: - $ref: "#/components/schemas/AccountId" - description: The ID of the Amazon Web Services account that owns the project. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the project was created. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The Amazon Resource Name (ARN) of the user who crated the project. DatasetName: allOf: - $ref: "#/components/schemas/DatasetName" - description: The dataset that the project is to act upon. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The last modification date and time for the project. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The Amazon Resource Name (ARN) of the user who last modified the project. Name: allOf: - $ref: "#/components/schemas/ProjectName" - description: The unique name of a project. RecipeName: allOf: - $ref: "#/components/schemas/RecipeName" - description: The name of a recipe that will be developed during a project session. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) for the project. Sample: allOf: - $ref: "#/components/schemas/Sample" - description: The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample consists of the first 500 rows from the dataset. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags that have been applied to the project. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the role that will be assumed for this project. OpenedBy: allOf: - $ref: "#/components/schemas/OpenedBy" - description: The Amazon Resource Name (ARN) of the user that opened the project for use. OpenDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time when the project was opened. description: Represents all of the attributes of a DataBrew project. PublishRecipeRequest: type: object title: PublishRecipeRequest properties: Description: allOf: - $ref: "#/components/schemas/RecipeDescription" - description: A description of the recipe to be published, for this version of the recipe. Recipe: type: object required: - Name properties: CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The Amazon Resource Name (ARN) of the user who created the recipe. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the recipe was created. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The Amazon Resource Name (ARN) of the user who last modified the recipe. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The last modification date and time of the recipe. ProjectName: allOf: - $ref: "#/components/schemas/ProjectName" - description: The name of the project that the recipe is associated with. PublishedBy: allOf: - $ref: "#/components/schemas/PublishedBy" - description: The Amazon Resource Name (ARN) of the user who published the recipe. PublishedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time when the recipe was published. Description: allOf: - $ref: "#/components/schemas/RecipeDescription" - description: The description of the recipe. Name: allOf: - $ref: "#/components/schemas/RecipeName" - description: The unique name for the recipe. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) for the recipe. Steps: allOf: - $ref: "#/components/schemas/RecipeStepList" - description: A list of steps that are defined by the recipe. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags that have been applied to the recipe. RecipeVersion: allOf: - $ref: "#/components/schemas/RecipeVersion" - description:

The identifier for the version for the recipe. Must be one of the following:

Numeric version (X.Y) - X and Y stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both X and Y are required, and "0.0" isn't a valid version.
LATEST_WORKING - the most recent valid version being developed in a DataBrew project.
LATEST_PUBLISHED - the most recent published version.

description: Represents one or more actions to be performed on a DataBrew dataset. RecipeVersionErrorDetail: type: object properties: ErrorCode: allOf: - $ref: "#/components/schemas/ErrorCode" - description: The HTTP status code for the error. ErrorMessage: allOf: - $ref: "#/components/schemas/RecipeErrorMessage" - description: The text of the error message. RecipeVersion: allOf: - $ref: "#/components/schemas/RecipeVersion" - description: The identifier for the recipe version associated with this error. description: Represents any errors encountered when attempting to delete multiple recipe versions. RecipeErrorMessage: type: string Result: type: string RuleName: type: string minLength: 1 maxLength: 128 Threshold: type: object required: - Value properties: Value: allOf: - $ref: "#/components/schemas/ThresholdValue" - description: The value of a threshold. Type: allOf: - $ref: "#/components/schemas/ThresholdType" - description: The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value. Unit: allOf: - $ref: "#/components/schemas/ThresholdUnit" - description: Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation. description: The threshold used with a non-aggregate check expression. The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds. RuleCount: type: integer minimum: 0 RulesetItem: type: object required: - Name - TargetArn properties: AccountId: allOf: - $ref: "#/components/schemas/AccountId" - description: The ID of the Amazon Web Services account that owns the ruleset. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The Amazon Resource Name (ARN) of the user who created the ruleset. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the ruleset was created. Description: allOf: - $ref: "#/components/schemas/RulesetDescription" - description: The description of the ruleset. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The Amazon Resource Name (ARN) of the user who last modified the ruleset. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The modification date and time of the ruleset. Name: allOf: - $ref: "#/components/schemas/RulesetName" - description: The name of the ruleset. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) for the ruleset. RuleCount: allOf: - $ref: "#/components/schemas/RuleCount" - description: The number of rules that are defined in the ruleset. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags that have been applied to the ruleset. TargetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with. description: Contains metadata about the ruleset. Schedule: type: object required: - Name properties: AccountId: allOf: - $ref: "#/components/schemas/AccountId" - description: The ID of the Amazon Web Services account that owns the schedule. CreatedBy: allOf: - $ref: "#/components/schemas/CreatedBy" - description: The Amazon Resource Name (ARN) of the user who created the schedule. CreateDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time that the schedule was created. JobNames: allOf: - $ref: "#/components/schemas/JobNameList" - description: A list of jobs to be run, according to the schedule. LastModifiedBy: allOf: - $ref: "#/components/schemas/LastModifiedBy" - description: The Amazon Resource Name (ARN) of the user who last modified the schedule. LastModifiedDate: allOf: - $ref: "#/components/schemas/Date" - description: The date and time when the schedule was last modified. ResourceArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the schedule. CronExpression: allOf: - $ref: "#/components/schemas/CronExpression" - description: The dates and times when the job is to run. For more information, see Cron expressions in the Glue DataBrew Developer Guide. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: Metadata tags that have been applied to the schedule. Name: allOf: - $ref: "#/components/schemas/ScheduleName" - description: The name of the schedule. description: Represents one or more dates and times when a job is to run. StepIndex: type: integer minimum: 0 ViewFrame: type: object required: - StartColumnIndex properties: StartColumnIndex: allOf: - $ref: "#/components/schemas/StartColumnIndex" - description: The starting index for the range of columns to return in the view frame. ColumnRange: allOf: - $ref: "#/components/schemas/ColumnRange" - description: The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list. HiddenColumns: allOf: - $ref: "#/components/schemas/HiddenColumnList" - description: A list of columns to hide in the view frame. StartRowIndex: allOf: - $ref: "#/components/schemas/StartRowIndex" - description: The starting index for the range of rows to return in the view frame. RowRange: allOf: - $ref: "#/components/schemas/RowRange" - description: The number of rows to include in the view frame, beginning with the StartRowIndex value. Analytics: allOf: - $ref: "#/components/schemas/AnalyticsMode" - description: Controls if analytics computation is enabled or disabled. Enabled by default. description: Represents the data being transformed during an action. SendProjectSessionActionRequest: type: object title: SendProjectSessionActionRequest properties: Preview: allOf: - $ref: "#/components/schemas/Preview" - description: If true, the result of the recipe step will be returned, but not applied. RecipeStep: $ref: "#/components/schemas/RecipeStep" StepIndex: allOf: - $ref: "#/components/schemas/StepIndex" - description: 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. ClientSessionId: allOf: - $ref: "#/components/schemas/ClientSessionId" - description: A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session. ViewFrame: $ref: "#/components/schemas/ViewFrame" SheetIndex: type: integer minimum: 0 maximum: 200 SheetName: type: string minLength: 1 maxLength: 31 StartJobRunRequest: type: object title: StartJobRunRequest properties: {} StartProjectSessionRequest: type: object title: StartProjectSessionRequest properties: AssumeControl: allOf: - $ref: "#/components/schemas/AssumeControl" - description: A value that, if true, enables you to take control of a session, even if a different client is currently accessing the project. Statistic: type: string pattern: ^[A-Z\_]+$ minLength: 1 maxLength: 128 StatisticOverride: type: object required: - Statistic - Parameters properties: Statistic: allOf: - $ref: "#/components/schemas/Statistic" - description: The name of an evaluation Parameters: allOf: - $ref: "#/components/schemas/ParameterMap" - description: A map that includes overrides of an evaluation’s parameters. description: "Override of a particular evaluation for a profile job. " StatisticOverrideList: type: array items: $ref: "#/components/schemas/StatisticOverride" minItems: 1 StopJobRunRequest: type: object title: StopJobRunRequest properties: {} TagKeyList: type: array items: $ref: "#/components/schemas/TagKey" minItems: 1 maxItems: 200 TagResourceRequest: type: object required: - Tags title: TagResourceRequest properties: Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: One or more tags to be assigned to the resource. ThresholdValue: type: number format: double minimum: 0 ThresholdType: type: string enum: - GREATER_THAN_OR_EQUAL - LESS_THAN_OR_EQUAL - GREATER_THAN - LESS_THAN ThresholdUnit: type: string enum: - COUNT - PERCENTAGE UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdateDatasetRequest: type: object required: - Input title: UpdateDatasetRequest properties: Format: allOf: - $ref: "#/components/schemas/InputFormat" - description: The file format of a dataset that is created from an Amazon S3 file or folder. FormatOptions: $ref: "#/components/schemas/FormatOptions" Input: $ref: "#/components/schemas/Input" PathOptions: allOf: - $ref: "#/components/schemas/PathOptions" - description: A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. UpdateProfileJobRequest: type: object required: - OutputLocation - RoleArn title: UpdateProfileJobRequest properties: Configuration: allOf: - $ref: "#/components/schemas/ProfileConfiguration" - description: Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings. EncryptionKeyArn: allOf: - $ref: "#/components/schemas/EncryptionKeyArn" - description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. EncryptionMode: allOf: - $ref: "#/components/schemas/EncryptionMode" - description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. MaxCapacity: allOf: - $ref: "#/components/schemas/MaxCapacity" - description: The maximum number of compute nodes that DataBrew can use when the job processes data. MaxRetries: allOf: - $ref: "#/components/schemas/MaxRetries" - description: The maximum number of times to retry the job after a job run fails. OutputLocation: $ref: "#/components/schemas/S3Location" ValidationConfigurations: allOf: - $ref: "#/components/schemas/ValidationConfigurationList" - description: List of validation configurations that are applied to the profile job. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Timeout: allOf: - $ref: "#/components/schemas/Timeout" - description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. JobSample: allOf: - $ref: "#/components/schemas/JobSample" - description: Sample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter. UpdateProjectRequest: type: object required: - RoleArn title: UpdateProjectRequest properties: Sample: $ref: "#/components/schemas/Sample" RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the IAM role to be assumed for this request. UpdateRecipeJobRequest: type: object required: - RoleArn title: UpdateRecipeJobRequest properties: EncryptionKeyArn: allOf: - $ref: "#/components/schemas/EncryptionKeyArn" - description: The Amazon Resource Name (ARN) of an encryption key that is used to protect the job. EncryptionMode: allOf: - $ref: "#/components/schemas/EncryptionMode" - description:

The encryption mode for the job, which can be one of the following:

SSE-KMS - Server-side encryption with keys managed by KMS.
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

LogSubscription: allOf: - $ref: "#/components/schemas/LogSubscription" - description: Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run. MaxCapacity: allOf: - $ref: "#/components/schemas/MaxCapacity" - description: The maximum number of nodes that DataBrew can consume when the job processes data. MaxRetries: allOf: - $ref: "#/components/schemas/MaxRetries" - description: The maximum number of times to retry the job after a job run fails. Outputs: allOf: - $ref: "#/components/schemas/OutputList" - description: "One or more artifacts that represent the output from running the job. " DataCatalogOutputs: allOf: - $ref: "#/components/schemas/DataCatalogOutputList" - description: One or more artifacts that represent the Glue Data Catalog output from running the job. DatabaseOutputs: allOf: - $ref: "#/components/schemas/DatabaseOutputList" - description: Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job. Timeout: allOf: - $ref: "#/components/schemas/Timeout" - description: The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT. UpdateRecipeRequest: type: object title: UpdateRecipeRequest properties: Description: allOf: - $ref: "#/components/schemas/RecipeDescription" - description: A description of the recipe. Steps: allOf: - $ref: "#/components/schemas/RecipeStepList" - description: 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. UpdateRulesetRequest: type: object required: - Rules title: UpdateRulesetRequest properties: Description: allOf: - $ref: "#/components/schemas/RulesetDescription" - description: The description of the ruleset. Rules: allOf: - $ref: "#/components/schemas/RuleList" - description: A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset. UpdateScheduleRequest: type: object required: - CronExpression title: UpdateScheduleRequest properties: JobNames: allOf: - $ref: "#/components/schemas/JobNameList" - description: The name or names of one or more jobs to be run for this schedule. CronExpression: allOf: - $ref: "#/components/schemas/CronExpression" - description: The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions in the Glue DataBrew Developer Guide. ValidationMode: type: string enum: - CHECK_ALL ValueReference: type: string pattern: ^:[A-Za-z0-9_]+$ minLength: 2 maxLength: 128 security: - hmac: []