"documentation":"<p>Deletes one or more versions of a recipe at a time.</p> <p>The entire request will be rejected if:</p> <ul> <li> <p>The recipe does not exist.</p> </li> <li> <p>There is an invalid version identifier in the list of versions.</p> </li> <li> <p>The version list is empty.</p> </li> <li> <p>The version list size exceeds 50.</p> </li> <li> <p>The version list contains duplicate entries.</p> </li> </ul> <p>The request will complete successfully, but with partial failures, if:</p> <ul> <li> <p>A version does not exist.</p> </li> <li> <p>A version is being used by a job.</p> </li> <li> <p>You specify <code>LATEST_WORKING</code>, but it's being used by a project.</p> </li> <li> <p>The version fails to be deleted.</p> </li> </ul> <p>The <code>LATEST_WORKING</code> version will only be deleted if the recipe has no other versions. If you try to delete <code>LATEST_WORKING</code> while other versions exist (or if they can't be deleted), then <code>LATEST_WORKING</code> will be listed as partial failure in the response.</p>"
"documentation":"<p>One or more column statistics to allow for columns that contain detected entities.</p>"
}
},
"documentation":"<p>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.</p>"
"documentation":"<p>An array of version identifiers, for the recipe versions to be deleted. You can specify numeric versions (<code>X.Y</code>) or <code>LATEST_WORKING</code>. <code>LATEST_PUBLISHED</code> is not supported.</p>"
"documentation":"<p>A regular expression for selecting a column from a dataset.</p>"
},
"Name":{
"shape":"ColumnName",
"documentation":"<p>The name of a column from a dataset.</p>"
}
},
"documentation":"<p>Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular expression.</p>"
},
"ColumnSelectorList":{
"type":"list",
"member":{"shape":"ColumnSelector"},
"min":1
},
"ColumnStatisticsConfiguration":{
"type":"structure",
"required":["Statistics"],
"members":{
"Selectors":{
"shape":"ColumnSelectorList",
"documentation":"<p>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. </p>"
},
"Statistics":{
"shape":"StatisticsConfiguration",
"documentation":"<p>Configuration for evaluations. Statistics can be used to select evaluations and override parameters of evaluations. </p>"
}
},
"documentation":"<p>Configuration for column evaluations for a profile job. ColumnStatisticsConfiguration can be used to select evaluations and override parameters of evaluations for particular columns. </p>"
"documentation":"<p>A specific condition to apply to a recipe action. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipes.html#recipes.structure\">Recipe structure</a> in the <i>Glue DataBrew Developer Guide</i>.</p>"
"documentation":"<p>Represents an individual condition that evaluates to true or false.</p> <p>Conditions are used with recipe actions. The action is only performed for column values where the condition evaluates to true.</p> <p>If a recipe requires more than one condition, then the recipe must specify multiple <code>ConditionExpression</code> elements. Each condition is applied to the rows in a dataset first, before the recipe action is performed.</p>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Metadata tags to apply to this job.</p>"
},
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>"
},
"DatabaseOutputs":{
"shape":"DatabaseOutputList",
"documentation":"<p>Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to. </p>"
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
}
}
},
"CreateRecipeJobResponse":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"JobName",
"documentation":"<p>The name of the job that you created.</p>"
}
}
},
"CreateRecipeRequest":{
"type":"structure",
"required":[
"Name",
"Steps"
],
"members":{
"Description":{
"shape":"RecipeDescription",
"documentation":"<p>A description for the recipe.</p>"
"documentation":"<p>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.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>Metadata tags to apply to this recipe.</p>"
}
}
},
"CreateRecipeResponse":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"RecipeName",
"documentation":"<p>The name of the recipe that you created.</p>"
"documentation":"<p>The date or dates and time or times when the jobs are to be run. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>Glue DataBrew Developer Guide</i>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Represents a set of options that define how DataBrew will read a comma-separated value (CSV) file when creating a dataset from that file.</p>"
"documentation":"<p>Represents an Amazon location where DataBrew can store intermediate results.</p>"
}
},
"documentation":"<p>Represents how metadata stored in the Glue Data Catalog is defined in a DataBrew dataset. </p>"
},
"DataCatalogOutput":{
"type":"structure",
"required":[
"DatabaseName",
"TableName"
],
"members":{
"CatalogId":{
"shape":"CatalogId",
"documentation":"<p>The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.</p>"
},
"DatabaseName":{
"shape":"DatabaseName",
"documentation":"<p>The name of a database in the Data Catalog.</p>"
},
"TableName":{
"shape":"TableName",
"documentation":"<p>The name of a table in the Data Catalog.</p>"
},
"S3Options":{
"shape":"S3TableOutputOptions",
"documentation":"<p>Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.</p>"
},
"DatabaseOptions":{
"shape":"DatabaseTableOutputOptions",
"documentation":"<p>Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.</p>"
},
"Overwrite":{
"shape":"OverwriteOutput",
"documentation":"<p>A value that, if true, means that any data in the location specified for output is overwritten with new output. Not supported with DatabaseOptions.</p>"
"documentation":"<p>The name of the parameter that is used in the dataset's Amazon S3 path.</p>"
},
"Type":{
"shape":"ParameterType",
"documentation":"<p>The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.</p>"
},
"DatetimeOptions":{
"shape":"DatetimeOptions",
"documentation":"<p>Additional parameter options such as a format and a timezone. Required for datetime parameters.</p>"
},
"CreateColumn":{
"shape":"CreateColumn",
"documentation":"<p>Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.</p>"
},
"Filter":{
"shape":"FilterExpression",
"documentation":"<p>The optional filter expression structure to apply additional matching criteria to the parameter.</p>"
"documentation":"<p>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\".</p>"
},
"TimezoneOffset":{
"shape":"TimezoneOffset",
"documentation":"<p>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.</p>"
},
"LocaleCode":{
"shape":"LocaleCode",
"documentation":"<p>Optional value for a non-US locale code, needed for correct interpretation of some date formats.</p>"
}
},
"documentation":"<p>Represents additional options for correct interpretation of datetime parameters used in the Amazon S3 path of a dataset.</p>"
"documentation":"<p>The version of the recipe to be deleted. You can specify a numeric versions (<code>X.Y</code>) or <code>LATEST_WORKING</code>. <code>LATEST_PUBLISHED</code> is not supported.</p>",
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>The job type, which must be one of the following:</p> <ul> <li> <p> <code>PROFILE</code> - The job analyzes the dataset to determine its size, data types, data distribution, and more.</p> </li> <li> <p> <code>RECIPE</code> - The job applies one or more transformations to a dataset.</p> </li> </ul>"
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The identifier (user name) of the user who last modified the job.</p>"
},
"LastModifiedDate":{
"shape":"Date",
"documentation":"<p>The date and time that the job was last modified.</p>"
"documentation":"<p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>"
},
"DatabaseOutputs":{
"shape":"DatabaseOutputList",
"documentation":"<p>Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Metadata tags associated with this job.</p>"
},
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>"
},
"DatabaseOutputs":{
"shape":"DatabaseOutputList",
"documentation":"<p>Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the user who started the job run.</p>"
},
"StartedOn":{
"shape":"Date",
"documentation":"<p>The date and time when the job run began.</p>"
},
"JobSample":{
"shape":"JobSample",
"documentation":"<p>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.</p>"
"documentation":"<p>Metadata tags associated with this project.</p>"
},
"SessionStatus":{
"shape":"SessionStatus",
"documentation":"<p>Describes the current state of the session:</p> <ul> <li> <p> <code>PROVISIONING</code> - allocating resources for the session.</p> </li> <li> <p> <code>INITIALIZING</code> - getting the session ready for first use.</p> </li> <li> <p> <code>ASSIGNED</code> - the session is ready for use.</p> </li> </ul>"
},
"OpenedBy":{
"shape":"OpenedBy",
"documentation":"<p>The identifier (user name) of the user that opened the project for use. </p>"
},
"OpenDate":{
"shape":"Date",
"documentation":"<p>The date and time when the project was opened. </p>"
}
}
},
"DescribeRecipeRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"RecipeName",
"documentation":"<p>The name of the recipe to be described.</p>",
"location":"uri",
"locationName":"name"
},
"RecipeVersion":{
"shape":"RecipeVersion",
"documentation":"<p>The recipe version identifier. If this parameter isn't specified, then the latest published version is returned.</p>",
"location":"querystring",
"locationName":"recipeVersion"
}
}
},
"DescribeRecipeResponse":{
"type":"structure",
"required":["Name"],
"members":{
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The identifier (user name) of the user who created the recipe.</p>"
},
"CreateDate":{
"shape":"Date",
"documentation":"<p>The date and time that the recipe was created.</p>"
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The identifier (user name) of the user who last modified the recipe.</p>"
},
"LastModifiedDate":{
"shape":"Date",
"documentation":"<p>The date and time that the recipe was last modified.</p>"
},
"ProjectName":{
"shape":"ProjectName",
"documentation":"<p>The name of the project associated with this recipe.</p>"
},
"PublishedBy":{
"shape":"PublishedBy",
"documentation":"<p>The identifier (user name) of the user who last published the recipe.</p>"
},
"PublishedDate":{
"shape":"Date",
"documentation":"<p>The date and time when the recipe was last published.</p>"
},
"Description":{
"shape":"RecipeDescription",
"documentation":"<p>The description of the recipe.</p>"
},
"Name":{
"shape":"RecipeName",
"documentation":"<p>The name of the recipe.</p>"
},
"Steps":{
"shape":"RecipeStepList",
"documentation":"<p>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.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>Metadata tags associated with this project.</p>"
},
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the recipe.</p>"
},
"RecipeVersion":{
"shape":"RecipeVersion",
"documentation":"<p>The recipe version identifier.</p>"
"documentation":"<p>The date or dates and time or times when the jobs are to be run for the schedule. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>Glue DataBrew Developer Guide</i>.</p>"
"documentation":"<p>Entity types to detect. Can be any of the following:</p> <ul> <li> <p>USA_SSN</p> </li> <li> <p>EMAIL</p> </li> <li> <p>USA_ITIN</p> </li> <li> <p>USA_PASSPORT_NUMBER</p> </li> <li> <p>PHONE_NUMBER</p> </li> <li> <p>USA_DRIVING_LICENSE</p> </li> <li> <p>BANK_ACCOUNT</p> </li> <li> <p>CREDIT_CARD</p> </li> <li> <p>IP_ADDRESS</p> </li> <li> <p>MAC_ADDRESS</p> </li> <li> <p>USA_DEA_NUMBER</p> </li> <li> <p>USA_HCPCS_CODE</p> </li> <li> <p>USA_NATIONAL_PROVIDER_IDENTIFIER</p> </li> <li> <p>USA_NATIONAL_DRUG_CODE</p> </li> <li> <p>USA_HEALTH_INSURANCE_CLAIM_NUMBER</p> </li> <li> <p>USA_MEDICARE_BENEFICIARY_IDENTIFIER</p> </li> <li> <p>USA_CPT_CODE</p> </li> <li> <p>PERSON_NAME</p> </li> <li> <p>DATE</p> </li> </ul> <p>The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.</p>"
},
"AllowedStatistics":{
"shape":"AllowedStatisticList",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Configuration of entity detection for a profile job. When undefined, entity detection is disabled.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.</p>"
"documentation":"<p>The number of Amazon S3 files to select.</p>"
},
"OrderedBy":{
"shape":"OrderedBy",
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected Amazon S3 path.</p>"
},
"FilterExpression":{
"type":"structure",
"required":[
"Expression",
"ValuesMap"
],
"members":{
"Expression":{
"shape":"Expression",
"documentation":"<p>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.</p>"
},
"ValuesMap":{
"shape":"ValuesMap",
"documentation":"<p>The map of substitution variable names to their values used in this filter expression.</p>"
"documentation":"<p>Represents a structure for defining parameter conditions. Supported conditions are described here: <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets\">Supported conditions for dynamic datasets</a> in the <i>Glue DataBrew Developer Guide</i>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html\">Encrypting data written by DataBrew jobs</a> </p>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>The unique name of the job.</p>"
},
"Type":{
"shape":"JobType",
"documentation":"<p>The job type of the job, which must be one of the following:</p> <ul> <li> <p> <code>PROFILE</code> - A job to analyze a dataset, to determine its size, data types, data distribution, and more.</p> </li> <li> <p> <code>RECIPE</code> - A job to apply one or more transformations to a dataset.</p> </li> </ul>"
"documentation":"<p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>"
},
"DatabaseOutputs":{
"shape":"DatabaseOutputList",
"documentation":"<p>Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.</p>"
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>Metadata tags that have been applied to the job.</p>"
"documentation":"<p>A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a <code>JobSample</code> 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.</p>"
"documentation":"<p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>"
},
"DatabaseOutputs":{
"shape":"DatabaseOutputList",
"documentation":"<p>Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.</p>"
"documentation":"<p>A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a <code>JobSample</code> 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.</p>"
"documentation":"<p>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:</p> <ul> <li> <p>FULL_DATASET - The profile job is run on the entire dataset.</p> </li> <li> <p>CUSTOM_ROWS - The profile job is run on the number of rows specified in the <code>Size</code> parameter.</p> </li> </ul>"
"documentation":"<p>The <code>Size</code> 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.</p> <p>Long.MAX_VALUE = 9223372036854775807</p>"
"documentation":"<p>A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a <code>JobSample</code> 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.</p>"
"documentation":"<p>The name of a dataset. Using this parameter indicates to return only those jobs that act on the specified dataset.</p>",
"location":"querystring",
"locationName":"datasetName"
},
"MaxResults":{
"shape":"MaxResults100",
"documentation":"<p>The maximum number of results to return in this request. </p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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. </p>",
"location":"querystring",
"locationName":"nextToken"
},
"ProjectName":{
"shape":"ProjectName",
"documentation":"<p>The name of a project. Using this parameter indicates to return only those jobs that are associated with the specified project.</p>",
"documentation":"<p>Return only those recipes with a version identifier of <code>LATEST_WORKING</code> or <code>LATEST_PUBLISHED</code>. If <code>RecipeVersion</code> is omitted, <code>ListRecipes</code> returns all of the <code>LATEST_PUBLISHED</code> recipe versions.</p> <p>Valid values: <code>LATEST_WORKING</code> | <code>LATEST_PUBLISHED</code> </p>",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"targetArn"
},
"MaxResults":{
"shape":"MaxResults100",
"documentation":"<p>The maximum number of results to return in this request.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListRulesetsResponse":{
"type":"structure",
"required":["Rulesets"],
"members":{
"Rulesets":{
"shape":"RulesetItemList",
"documentation":"<p>A list of RulesetItem. RulesetItem contains meta data of a ruleset.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.</p>"
"documentation":"<p>If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.</p>"
},
"FilesLimit":{
"shape":"FilesLimit",
"documentation":"<p>If provided, this structure imposes a limit on a number of files that should be selected.</p>"
},
"Parameters":{
"shape":"PathParametersMap",
"documentation":"<p>A structure that maps names of parameters used in the Amazon S3 path of a dataset to their definitions.</p>"
}
},
"documentation":"<p>Represents a set of options that define how DataBrew selects files for a given Amazon S3 path in a dataset.</p>"
},
"PathParameterName":{
"type":"string",
"max":255,
"min":1
},
"PathParametersMap":{
"type":"map",
"key":{"shape":"PathParameterName"},
"value":{"shape":"DatasetParameter"},
"documentation":"<p>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.</p>",
"documentation":"<p>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. </p>"
},
"ProfileColumns":{
"shape":"ColumnSelectorList",
"documentation":"<p>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. </p>"
},
"ColumnStatisticsConfigurations":{
"shape":"ColumnStatisticsConfigurationList",
"documentation":"<p>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. </p>"
"documentation":"<p>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. </p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The identifier for the version for the recipe. Must be one of the following:</p> <ul> <li> <p>Numeric version (<code>X.Y</code>) - <code>X</code> and <code>Y</code> stand for major and minor version numbers. The maximum length of each is 6 digits, and neither can be negative values. Both <code>X</code> and <code>Y</code> are required, and \"0.0\" isn't a valid version.</p> </li> <li> <p> <code>LATEST_WORKING</code> - the most recent valid version being developed in a DataBrew project.</p> </li> <li> <p> <code>LATEST_PUBLISHED</code> - the most recent published version.</p> </li> </ul>"
"documentation":"<p>Represents a transformation and associated parameters that are used to apply a change to a DataBrew dataset. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/recipe-actions-reference.html\">Recipe actions reference</a>.</p>"
"documentation":"<p>One or more conditions that must be met for the recipe step to succeed.</p> <note> <p>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.</p> </note>"
"documentation":"<p>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.</p>"
"documentation":"<p>The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, <code>(:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2)</code>. 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, <code>is_between :val1 and :val2</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/profile.data-quality-available-checks.html\">Available checks</a> </p>"
"documentation":"<p>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, <code>\":col1\": \"`Column A`\".</code> </p>"
},
"Threshold":{
"shape":"Threshold",
"documentation":"<p>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.</p>"
},
"ColumnSelectors":{
"shape":"ColumnSelectorList",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Represents a single data quality requirement that should be validated in the scope of this dataset.</p>"
},
"RuleCount":{
"type":"integer",
"min":0
},
"RuleList":{
"type":"list",
"member":{"shape":"Rule"},
"min":1
},
"RuleName":{
"type":"string",
"max":128,
"min":1
},
"RulesetDescription":{
"type":"string",
"max":1024
},
"RulesetItem":{
"type":"structure",
"required":[
"Name",
"TargetArn"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The ID of the Amazon Web Services account that owns the ruleset.</p>"
},
"CreatedBy":{
"shape":"CreatedBy",
"documentation":"<p>The Amazon Resource Name (ARN) of the user who created the ruleset.</p>"
},
"CreateDate":{
"shape":"Date",
"documentation":"<p>The date and time that the ruleset was created.</p>"
},
"Description":{
"shape":"RulesetDescription",
"documentation":"<p>The description of the ruleset.</p>"
},
"LastModifiedBy":{
"shape":"LastModifiedBy",
"documentation":"<p>The Amazon Resource Name (ARN) of the user who last modified the ruleset.</p>"
},
"LastModifiedDate":{
"shape":"Date",
"documentation":"<p>The modification date and time of the ruleset.</p>"
},
"Name":{
"shape":"RulesetName",
"documentation":"<p>The name of the ruleset.</p>"
},
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the ruleset.</p>"
},
"RuleCount":{
"shape":"RuleCount",
"documentation":"<p>The number of rules that are defined in the ruleset.</p>"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>Metadata tags that have been applied to the ruleset.</p>"
},
"TargetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.</p>"
}
},
"documentation":"<p>Contains metadata about the ruleset.</p>"
"documentation":"<p>Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.</p>"
"documentation":"<p>The dates and times when the job is to run. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>Glue DataBrew Developer Guide</i>.</p>"
"documentation":"<p>The name of the project to apply the action to.</p>",
"location":"uri",
"locationName":"name"
},
"RecipeStep":{"shape":"RecipeStep"},
"StepIndex":{
"shape":"StepIndex",
"documentation":"<p>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.</p>"
},
"ClientSessionId":{
"shape":"ClientSessionId",
"documentation":"<p>A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.</p>"
},
"ViewFrame":{"shape":"ViewFrame"}
}
},
"SendProjectSessionActionResponse":{
"type":"structure",
"required":["Name"],
"members":{
"Result":{
"shape":"Result",
"documentation":"<p>A message indicating the result of performing the action.</p>"
},
"Name":{
"shape":"ProjectName",
"documentation":"<p>The name of the project that was affected by the action.</p>"
},
"ActionId":{
"shape":"ActionId",
"documentation":"<p>A unique identifier for the action that was performed.</p>"
}
}
},
"ServiceQuotaExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"documentation":"<p>A service quota is exceeded.</p>",
"documentation":"<p>The name of the job to be run.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"StartJobRunResponse":{
"type":"structure",
"required":["RunId"],
"members":{
"RunId":{
"shape":"JobRunId",
"documentation":"<p>A system-generated identifier for this particular job run.</p>"
}
}
},
"StartProjectSessionRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"ProjectName",
"documentation":"<p>The name of the project to act upon.</p>",
"location":"uri",
"locationName":"name"
},
"AssumeControl":{
"shape":"AssumeControl",
"documentation":"<p>A value that, if true, enables you to take control of a session, even if a different client is currently accessing the project.</p>"
}
}
},
"StartProjectSessionResponse":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"ProjectName",
"documentation":"<p>The name of the project to be acted upon.</p>"
},
"ClientSessionId":{
"shape":"ClientSessionId",
"documentation":"<p>A system-generated identifier for the session.</p>"
"documentation":"<p>The name of an evaluation</p>"
},
"Parameters":{
"shape":"ParameterMap",
"documentation":"<p>A map that includes overrides of an evaluation’s parameters.</p>"
}
},
"documentation":"<p>Override of a particular evaluation for a profile job. </p>"
},
"StatisticOverrideList":{
"type":"list",
"member":{"shape":"StatisticOverride"},
"min":1
},
"StatisticsConfiguration":{
"type":"structure",
"members":{
"IncludedStatistics":{
"shape":"StatisticList",
"documentation":"<p>List of included evaluations. When the list is undefined, all supported evaluations will be included.</p>"
},
"Overrides":{
"shape":"StatisticOverrideList",
"documentation":"<p>List of overrides for evaluations.</p>"
}
},
"documentation":"<p>Configuration of evaluations for a profile job. This configuration can be used to select evaluations and override the parameters of selected evaluations. </p>"
"documentation":"<p>The name of the job to be stopped.</p>",
"location":"uri",
"locationName":"name"
},
"RunId":{
"shape":"JobRunId",
"documentation":"<p>The ID of the job run to be stopped.</p>",
"location":"uri",
"locationName":"runId"
}
}
},
"StopJobRunResponse":{
"type":"structure",
"required":["RunId"],
"members":{
"RunId":{
"shape":"JobRunId",
"documentation":"<p>The ID of the job run that you stopped.</p>"
}
}
},
"TableName":{
"type":"string",
"max":255,
"min":1
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":1
},
"TagMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":200,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"ResourceArn"
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>One or more tags to be assigned to the resource.</p>"
"documentation":"<p>The value of a threshold.</p>"
},
"Type":{
"shape":"ThresholdType",
"documentation":"<p>The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.</p>"
},
"Unit":{
"shape":"ThresholdUnit",
"documentation":"<p>Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.</p>"
}
},
"documentation":"<p>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.</p>"
"documentation":"<p>A DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN). </p>",
"documentation":"<p>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.</p>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.</p>"
"documentation":"<p>One or more artifacts that represent the Glue Data Catalog output from running the job.</p>"
},
"DatabaseOutputs":{
"shape":"DatabaseOutputList",
"documentation":"<p>Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.</p>"
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
}
}
},
"UpdateRecipeJobResponse":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"JobName",
"documentation":"<p>The name of the job that you updated.</p>"
}
}
},
"UpdateRecipeRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Description":{
"shape":"RecipeDescription",
"documentation":"<p>A description of the recipe.</p>"
},
"Name":{
"shape":"RecipeName",
"documentation":"<p>The name of the recipe to be updated.</p>",
"location":"uri",
"locationName":"name"
},
"Steps":{
"shape":"RecipeStepList",
"documentation":"<p>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.</p>"
}
}
},
"UpdateRecipeResponse":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"RecipeName",
"documentation":"<p>The name of the recipe that was updated.</p>"
"documentation":"<p>The date or dates and time or times when the jobs are to be run. For more information, see <a href=\"https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html\">Cron expressions</a> in the <i>Glue DataBrew Developer Guide</i>.</p>"
"documentation":"<p>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.</p>"
},
"ValidationMode":{
"shape":"ValidationMode",
"documentation":"<p>Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.</p>"
}
},
"documentation":"<p>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.</p>"
"documentation":"<p>The starting index for the range of columns to return in the view frame.</p>"
},
"ColumnRange":{
"shape":"ColumnRange",
"documentation":"<p>The number of columns to include in the view frame, beginning with the <code>StartColumnIndex</code> value and ignoring any columns in the <code>HiddenColumns</code> list.</p>"
},
"HiddenColumns":{
"shape":"HiddenColumnList",
"documentation":"<p>A list of columns to hide in the view frame.</p>"
"documentation":"<p>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.</p>"