lib/aws-sdk-gluedatabrew/client.rb in aws-sdk-gluedatabrew-1.0.0 vs lib/aws-sdk-gluedatabrew/client.rb in aws-sdk-gluedatabrew-1.1.0

- old
+ new

@@ -327,15 +327,44 @@ # @!group API Operations # 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 verision list is empty. + # + # * The version list size exceeds 50. + # + # * The verison 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. + # # @option params [required, String] :name - # The name of the recipe to be modified. + # The name of the recipe whose versions are to be deleted. # # @option params [required, Array<String>] :recipe_versions - # An array of version identifiers to be deleted. + # 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. # # @return [Types::BatchDeleteRecipeVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::BatchDeleteRecipeVersionResponse#name #name} => String # * {Types::BatchDeleteRecipeVersionResponse#errors #errors} => Array&lt;Types::RecipeVersionErrorDetail&gt; @@ -362,22 +391,22 @@ def batch_delete_recipe_version(params = {}, options = {}) req = build_request(:batch_delete_recipe_version, params) req.send_request(options) end - # Creates a new AWS Glue DataBrew dataset for this AWS account. + # Creates a new DataBrew dataset. # # @option params [required, String] :name - # The name of the dataset to be created. + # The name of the dataset to be created. Valid characters are + # alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space. # # @option params [Types::FormatOptions] :format_options - # Options that define how Microsoft Excel input is to be interpreted by - # DataBrew. + # Options that define the structure of either Csv, Excel, or JSON input. # # @option params [required, Types::Input] :input - # Information on how AWS Glue DataBrew can find data, in either the AWS - # Glue Data Catalog or Amazon S3. + # Information on how DataBrew can find data, in either the AWS Glue Data + # Catalog or Amazon S3. # # @option params [Hash<String,String>] :tags # Metadata tags to apply to this dataset. # # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -394,10 +423,13 @@ # }, # excel: { # sheet_names: ["SheetName"], # sheet_indexes: [1], # }, + # csv: { + # delimiter: "Delimiter", + # }, # }, # input: { # required # s3_input_definition: { # bucket: "Bucket", # required # key: "Key", @@ -428,12 +460,11 @@ def create_dataset(params = {}, options = {}) req = build_request(:create_dataset, params) req.send_request(options) end - # Creates a new job to profile an AWS Glue DataBrew dataset that exists - # in the current AWS account. + # Creates a new job to analyze a dataset and create its data profile. # # @option params [required, String] :dataset_name # The name of the dataset that this job is to act upon. # # @option params [String] :encryption_key_arn @@ -447,16 +478,16 @@ # KMS-managed keys. # # * `SSE-S3` - Server-side encryption with keys managed by Amazon S3. # # @option params [required, String] :name - # The name of the job to be created. + # The name of the job to be created. Valid characters are alphanumeric + # (A-Z, a-z, 0-9), hyphen (-), period (.), and space. # # @option params [String] :log_subscription - # A value that enables or disables Amazon CloudWatch logging for the - # current AWS account. If logging is enabled, CloudWatch writes one log - # stream for each job run. + # Enables or disables Amazon CloudWatch logging for the job. If logging + # is enabled, CloudWatch writes one log stream for each job run. # # @option params [Integer] :max_capacity # The maximum number of nodes that DataBrew can use when the job # processes data. # @@ -467,11 +498,11 @@ # An Amazon S3 location (bucket name an object key) where DataBrew can # read input data, or write output from a job. # # @option params [required, String] :role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access - # Management (IAM) role to be assumed for this request. + # Management (IAM) role to be assumed when DataBrew runs the job. # # @option params [Hash<String,String>] :tags # Metadata tags to apply to this job. # # @option params [Integer] :timeout @@ -514,24 +545,25 @@ def create_profile_job(params = {}, options = {}) req = build_request(:create_profile_job, params) req.send_request(options) end - # Creates a new AWS Glue DataBrew project in the current AWS account. + # Creates a new DataBrew project. # # @option params [required, String] :dataset_name - # The name of the dataset to associate this project with. + # The name of an existing dataset to associate this project with. # # @option params [required, String] :name - # A unique name for the new project. + # A unique name for the new project. Valid characters are alphanumeric + # (A-Z, a-z, 0-9), hyphen (-), period (.), and space. # # @option params [required, String] :recipe_name # The name of an existing recipe to associate with the project. # # @option params [Types::Sample] :sample - # Represents the sample size and sampling type for AWS Glue DataBrew to - # use for interactive data analysis. + # Represents the sample size and sampling type for DataBrew to use for + # interactive data analysis. # # @option params [required, String] :role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access # Management (IAM) role to be assumed for this request. # @@ -569,17 +601,18 @@ def create_project(params = {}, options = {}) req = build_request(:create_project, params) req.send_request(options) end - # Creates a new AWS Glue DataBrew recipe for the current AWS account. + # Creates a new DataBrew recipe. # # @option params [String] :description # A description for the recipe. # # @option params [required, String] :name - # A unique name for the recipe. + # A unique name for the recipe. Valid characters are alphanumeric (A-Z, + # a-z, 0-9), hyphen (-), period (.), and space. # # @option params [required, Array<Types::RecipeStep>] :steps # 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. @@ -629,13 +662,12 @@ def create_recipe(params = {}, options = {}) req = build_request(:create_recipe, params) req.send_request(options) end - # Creates a new job for an existing AWS Glue DataBrew recipe in the - # current AWS account. You can create a standalone job using either a - # project, or a combination of a recipe and a dataset. + # Creates a new job to transform input data, using steps defined in an + # existing AWS Glue DataBrew recipe # # @option params [String] :dataset_name # The name of the dataset that this job processes. # # @option params [String] :encryption_key_arn @@ -648,16 +680,16 @@ # * `SSE-KMS` - Server-side encryption with AWS KMS-managed keys. # # * `SSE-S3` - Server-side encryption with keys managed by Amazon S3. # # @option params [required, String] :name - # A unique name for the job. + # A unique name for the job. Valid characters are alphanumeric (A-Z, + # a-z, 0-9), hyphen (-), period (.), and space. # # @option params [String] :log_subscription - # A value that enables or disables Amazon CloudWatch logging for the - # current AWS account. If logging is enabled, CloudWatch writes one log - # stream for each job run. + # Enables or disables Amazon CloudWatch logging for the job. If logging + # is enabled, CloudWatch writes one log stream for each job run. # # @option params [Integer] :max_capacity # The maximum number of nodes that DataBrew can consume when the job # processes data. # @@ -670,18 +702,18 @@ # @option params [String] :project_name # Either the name of an existing project, or a combination of a recipe # and a dataset to associate with the recipe. # # @option params [Types::RecipeReference] :recipe_reference - # Represents all of the attributes of an AWS Glue DataBrew recipe. + # Represents the name and version of a DataBrew recipe. # # @option params [required, String] :role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access - # Management (IAM) role to be assumed for this request. + # Management (IAM) role to be assumed when DataBrew runs the job. # # @option params [Hash<String,String>] :tags - # Metadata tags to apply to this job dataset. + # Metadata tags to apply to this job. # # @option params [Integer] :timeout # The job's timeout in minutes. A job that attempts to run longer than # this timeout period ends with a status of `TIMEOUT`. # @@ -707,10 +739,15 @@ # location: { # required # bucket: "Bucket", # required # key: "Key", # }, # overwrite: false, + # format_options: { + # csv: { + # delimiter: "Delimiter", + # }, + # }, # }, # ], # project_name: "ProjectName", # recipe_reference: { # name: "RecipeName", # required @@ -734,25 +771,31 @@ def create_recipe_job(params = {}, options = {}) req = build_request(:create_recipe_job, params) req.send_request(options) end - # Creates a new schedule for one or more AWS Glue DataBrew jobs. Jobs - # can be run at a specific date and time, or at regular intervals. + # Creates a new schedule for one or more DataBrew jobs. Jobs can be run + # at a specific date and time, or at regular intervals. # # @option params [Array<String>] :job_names # The name or names of one or more jobs to be run. # # @option params [required, String] :cron_expression - # The date or dates and time or times, in `cron` format, when the jobs - # are to be run. + # The date or dates and time or times when the jobs are to be run. For + # more information, see [Cron expressions][1] in the *AWS Glue DataBrew + # Developer Guide*. # + # + # + # [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html + # # @option params [Hash<String,String>] :tags # Metadata tags to apply to this schedule. # # @option params [required, String] :name - # A unique name for the schedule. + # A unique name for the schedule. Valid characters are alphanumeric + # (A-Z, a-z, 0-9), hyphen (-), period (.), and space. # # @return [Types::CreateScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateScheduleResponse#name #name} => String # @@ -778,11 +821,11 @@ def create_schedule(params = {}, options = {}) req = build_request(:create_schedule, params) req.send_request(options) end - # Deletes a dataset from AWS Glue DataBrew. + # Deletes a dataset from DataBrew. # # @option params [required, String] :name # The name of the dataset to be deleted. # # @return [Types::DeleteDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -806,12 +849,11 @@ def delete_dataset(params = {}, options = {}) req = build_request(:delete_dataset, params) req.send_request(options) end - # Deletes the specified AWS Glue DataBrew job from the current AWS - # account. The job can be for a recipe or for a profile. + # Deletes the specified DataBrew job. # # @option params [required, String] :name # The name of the job to be deleted. # # @return [Types::DeleteJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -835,12 +877,11 @@ def delete_job(params = {}, options = {}) req = build_request(:delete_job, params) req.send_request(options) end - # Deletes an existing AWS Glue DataBrew project from the current AWS - # account. + # Deletes an existing DataBrew project. # # @option params [required, String] :name # The name of the project to be deleted. # # @return [Types::DeleteProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -864,17 +905,19 @@ def delete_project(params = {}, options = {}) req = build_request(:delete_project, params) req.send_request(options) end - # Deletes a single version of an AWS Glue DataBrew recipe. + # Deletes a single version of a DataBrew recipe. # # @option params [required, String] :name - # The name of the recipe to be deleted. + # The name of the recipe. # # @option params [required, String] :recipe_version - # The version of the recipe to be deleted. + # The version of the recipe to be deleted. You can specify a numeric + # versions (`X.Y`) or `LATEST_WORKING`. `LATEST_PUBLISHED` is not + # supported. # # @return [Types::DeleteRecipeVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteRecipeVersionResponse#name #name} => String # * {Types::DeleteRecipeVersionResponse#recipe_version #recipe_version} => String @@ -898,12 +941,11 @@ def delete_recipe_version(params = {}, options = {}) req = build_request(:delete_recipe_version, params) req.send_request(options) end - # Deletes the specified AWS Glue DataBrew schedule from the current AWS - # account. + # Deletes the specified DataBrew schedule. # # @option params [required, String] :name # The name of the schedule to be deleted. # # @return [Types::DeleteScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -927,12 +969,11 @@ def delete_schedule(params = {}, options = {}) req = build_request(:delete_schedule, params) req.send_request(options) end - # Returns the definition of a specific AWS Glue DataBrew dataset that is - # in the current AWS account. + # Returns the definition of a specific DataBrew dataset. # # @option params [required, String] :name # The name of the dataset to be described. # # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -962,10 +1003,11 @@ # resp.format_options.json.multi_line #=> Boolean # resp.format_options.excel.sheet_names #=> Array # resp.format_options.excel.sheet_names[0] #=> String # resp.format_options.excel.sheet_indexes #=> Array # resp.format_options.excel.sheet_indexes[0] #=> Integer + # resp.format_options.csv.delimiter #=> String # resp.input.s3_input_definition.bucket #=> String # resp.input.s3_input_definition.key #=> String # resp.input.data_catalog_input_definition.catalog_id #=> String # resp.input.data_catalog_input_definition.database_name #=> String # resp.input.data_catalog_input_definition.table_name #=> String @@ -985,12 +1027,11 @@ def describe_dataset(params = {}, options = {}) req = build_request(:describe_dataset, params) req.send_request(options) end - # Returns the definition of a specific AWS Glue DataBrew job that is in - # the current AWS account. + # Returns the definition of a specific DataBrew job. # # @option params [required, String] :name # The name of the job to be described. # # @return [Types::DescribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1041,10 +1082,11 @@ # resp.outputs[0].partition_columns #=> Array # resp.outputs[0].partition_columns[0] #=> String # resp.outputs[0].location.bucket #=> String # resp.outputs[0].location.key #=> String # resp.outputs[0].overwrite #=> Boolean + # resp.outputs[0].format_options.csv.delimiter #=> String # resp.project_name #=> String # resp.recipe_reference.name #=> String # resp.recipe_reference.recipe_version #=> String # resp.resource_arn #=> String # resp.role_arn #=> String @@ -1059,12 +1101,11 @@ def describe_job(params = {}, options = {}) req = build_request(:describe_job, params) req.send_request(options) end - # Returns the definition of a specific AWS Glue DataBrew project that is - # in the current AWS account. + # Returns the definition of a specific DataBrew project. # # @option params [required, String] :name # The name of the project to be described. # # @return [Types::DescribeProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1116,12 +1157,12 @@ def describe_project(params = {}, options = {}) req = build_request(:describe_project, params) req.send_request(options) end - # Returns the definition of a specific AWS Glue DataBrew recipe that is - # in the current AWS account. + # Returns the definition of a specific DataBrew recipe corresponding to + # a particular version. # # @option params [required, String] :name # The name of the recipe to be described. # # @option params [String] :recipe_version @@ -1182,12 +1223,11 @@ def describe_recipe(params = {}, options = {}) req = build_request(:describe_recipe, params) req.send_request(options) end - # Returns the definition of a specific AWS Glue DataBrew schedule that - # is in the current AWS account. + # Returns the definition of a specific DataBrew schedule. # # @option params [required, String] :name # The name of the schedule to be described. # # @return [Types::DescribeScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1229,21 +1269,18 @@ def describe_schedule(params = {}, options = {}) req = build_request(:describe_schedule, params) req.send_request(options) end - # Lists all of the AWS Glue DataBrew datasets for the current AWS - # account. + # Lists all of the DataBrew datasets. # # @option params [Integer] :max_results # The maximum number of results to return in this request. # # @option params [String] :next_token - # 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. + # The token returned by a previous call to retrieve the next set of + # results. # # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::Dataset&gt; # * {Types::ListDatasetsResponse#next_token #next_token} => String @@ -1267,10 +1304,11 @@ # resp.datasets[0].format_options.json.multi_line #=> Boolean # resp.datasets[0].format_options.excel.sheet_names #=> Array # resp.datasets[0].format_options.excel.sheet_names[0] #=> String # resp.datasets[0].format_options.excel.sheet_indexes #=> Array # resp.datasets[0].format_options.excel.sheet_indexes[0] #=> Integer + # resp.datasets[0].format_options.csv.delimiter #=> String # resp.datasets[0].input.s3_input_definition.bucket #=> String # resp.datasets[0].input.s3_input_definition.key #=> String # resp.datasets[0].input.data_catalog_input_definition.catalog_id #=> String # resp.datasets[0].input.data_catalog_input_definition.database_name #=> String # resp.datasets[0].input.data_catalog_input_definition.table_name #=> String @@ -1291,24 +1329,21 @@ def list_datasets(params = {}, options = {}) req = build_request(:list_datasets, params) req.send_request(options) end - # Lists all of the previous runs of a particular AWS Glue DataBrew job - # in the current AWS account. + # Lists all of the previous runs of a particular DataBrew job. # # @option params [required, String] :name # The name of the job. # # @option params [Integer] :max_results # The maximum number of results to return in this request. # # @option params [String] :next_token - # A token generated by AWS Glue 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. + # The token returned by a previous call to retrieve the next set of + # results. # # @return [Types::ListJobRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListJobRunsResponse#job_runs #job_runs} => Array&lt;Types::JobRun&gt; # * {Types::ListJobRunsResponse#next_token #next_token} => String @@ -1342,10 +1377,11 @@ # resp.job_runs[0].outputs[0].partition_columns #=> Array # resp.job_runs[0].outputs[0].partition_columns[0] #=> String # resp.job_runs[0].outputs[0].location.bucket #=> String # resp.job_runs[0].outputs[0].location.key #=> String # resp.job_runs[0].outputs[0].overwrite #=> Boolean + # resp.job_runs[0].outputs[0].format_options.csv.delimiter #=> String # resp.job_runs[0].recipe_reference.name #=> String # resp.job_runs[0].recipe_reference.recipe_version #=> String # resp.job_runs[0].started_by #=> String # resp.job_runs[0].started_on #=> Time # resp.next_token #=> String @@ -1357,11 +1393,11 @@ def list_job_runs(params = {}, options = {}) req = build_request(:list_job_runs, params) req.send_request(options) end - # Lists the AWS Glue DataBrew jobs in the current AWS account. + # Lists all of the DataBrew jobs that are defined. # # @option params [String] :dataset_name # The name of a dataset. Using this parameter indicates to return only # those jobs that act on the specified dataset. # @@ -1416,10 +1452,11 @@ # resp.jobs[0].outputs[0].partition_columns #=> Array # resp.jobs[0].outputs[0].partition_columns[0] #=> String # resp.jobs[0].outputs[0].location.bucket #=> String # resp.jobs[0].outputs[0].location.key #=> String # resp.jobs[0].outputs[0].overwrite #=> Boolean + # resp.jobs[0].outputs[0].format_options.csv.delimiter #=> String # resp.jobs[0].project_name #=> String # resp.jobs[0].recipe_reference.name #=> String # resp.jobs[0].recipe_reference.recipe_version #=> String # resp.jobs[0].resource_arn #=> String # resp.jobs[0].role_arn #=> String @@ -1435,14 +1472,15 @@ def list_jobs(params = {}, options = {}) req = build_request(:list_jobs, params) req.send_request(options) end - # Lists all of the DataBrew projects in the current AWS account. + # Lists all of the DataBrew projects that are defined. # # @option params [String] :next_token - # A pagination token that can be used in a subsequent request. + # The token returned by a previous call to retrieve the next set of + # results. # # @option params [Integer] :max_results # The maximum number of results to return in this request. # # @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1487,18 +1525,19 @@ def list_projects(params = {}, options = {}) req = build_request(:list_projects, params) req.send_request(options) end - # Lists all of the versions of a particular AWS Glue DataBrew recipe in - # the current AWS account. + # Lists the versions of a particular DataBrew recipe, except for + # `LATEST_WORKING`. # # @option params [Integer] :max_results # The maximum number of results to return in this request. # # @option params [String] :next_token - # A pagination token that can be used in a subsequent request. + # The token returned by a previous call to retrieve the next set of + # results. # # @option params [required, String] :name # The name of the recipe for which to return version information. # # @return [Types::ListRecipeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1549,22 +1588,26 @@ def list_recipe_versions(params = {}, options = {}) req = build_request(:list_recipe_versions, params) req.send_request(options) end - # Lists all of the AWS Glue DataBrew recipes in the current AWS account. + # Lists all of the DataBrew recipes that are defined. # # @option params [Integer] :max_results # The maximum number of results to return in this request. # # @option params [String] :next_token - # A pagination token that can be used in a subsequent request. + # The token returned by a previous call to retrieve the next set of + # results. # # @option params [String] :recipe_version - # A version identifier. Using this parameter indicates to return only - # those recipes that have this version identifier. + # 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` + # # @return [Types::ListRecipesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListRecipesResponse#recipes #recipes} => Array&lt;Types::Recipe&gt; # * {Types::ListRecipesResponse#next_token #next_token} => String # @@ -1611,20 +1654,21 @@ def list_recipes(params = {}, options = {}) req = build_request(:list_recipes, params) req.send_request(options) end - # Lists the AWS Glue DataBrew schedules in the current AWS account. + # Lists the DataBrew schedules that are defined. # # @option params [String] :job_name # The name of the job that these schedules apply to. # # @option params [Integer] :max_results # The maximum number of results to return in this request. # # @option params [String] :next_token - # A pagination token that can be used in a subsequent request. + # The token returned by a previous call to retrieve the next set of + # results. # # @return [Types::ListSchedulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListSchedulesResponse#schedules #schedules} => Array&lt;Types::Schedule&gt; # * {Types::ListSchedulesResponse#next_token #next_token} => String @@ -1663,11 +1707,11 @@ def list_schedules(params = {}, options = {}) req = build_request(:list_schedules, params) req.send_request(options) end - # Lists all the tags for an AWS Glue DataBrew resource. + # Lists all the tags for a DataBrew resource. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) string that uniquely identifies the # DataBrew resource. # @@ -1693,12 +1737,11 @@ def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end - # Publishes a new major version of an AWS Glue DataBrew recipe that - # exists in the current AWS account. + # Publishes a new version of a DataBrew recipe. # # @option params [String] :description # A description of the recipe to be published, for this version of the # recipe. # @@ -1727,23 +1770,22 @@ def publish_recipe(params = {}, options = {}) req = build_request(:publish_recipe, params) req.send_request(options) end - # Performs a recipe step within an interactive AWS Glue DataBrew session - # that's currently open. + # Performs a recipe step within an interactive DataBrew session that's + # currently open. # # @option params [Boolean] :preview - # Returns the result of the recipe step, without applying it. The result - # isn't added to the view frame stack. + # If true, the result of the recipe step will be returned, but not + # applied. # # @option params [required, String] :name # The name of the project to apply the action to. # # @option params [Types::RecipeStep] :recipe_step - # Represents a single step to be performed in an AWS Glue DataBrew - # recipe. + # Represents a single step from a DataBrew recipe to be performed. # # @option params [Integer] :step_index # 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. @@ -1751,12 +1793,11 @@ # @option params [String] :client_session_id # A unique identifier for an interactive session that's currently open # and ready for work. The action will be performed on this session. # # @option params [Types::ViewFrame] :view_frame - # Represents the data being being transformed during an AWS Glue - # DataBrew project session. + # Represents the data being being transformed during an action. # # @return [Types::SendProjectSessionActionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::SendProjectSessionActionResponse#result #result} => String # * {Types::SendProjectSessionActionResponse#name #name} => String @@ -1804,11 +1845,11 @@ def send_project_session_action(params = {}, options = {}) req = build_request(:send_project_session_action, params) req.send_request(options) end - # Runs an AWS Glue DataBrew job that exists in the current AWS account. + # Runs a DataBrew job. # # @option params [required, String] :name # The name of the job to be run. # # @return [Types::StartJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1832,11 +1873,11 @@ def start_job_run(params = {}, options = {}) req = build_request(:start_job_run, params) req.send_request(options) end - # Creates an interactive session, enabling you to manipulate an AWS Glue + # Creates an interactive session, enabling you to manipulate data in a # DataBrew project. # # @option params [required, String] :name # The name of the project to act upon. # @@ -1868,11 +1909,11 @@ def start_project_session(params = {}, options = {}) req = build_request(:start_project_session, params) req.send_request(options) end - # Stops the specified job from running in the current AWS account. + # Stops a particular run of a job. # # @option params [required, String] :name # The name of the job to be stopped. # # @option params [required, String] :run_id @@ -1900,12 +1941,12 @@ def stop_job_run(params = {}, options = {}) req = build_request(:stop_job_run, params) req.send_request(options) end - # Adds metadata tags to an AWS Glue DataBrew resource, such as a - # dataset, job, project, or recipe. + # Adds metadata tags to a DataBrew resource, such as a dataset, project, + # recipe, job, or schedule. # # @option params [required, String] :resource_arn # 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. @@ -1931,14 +1972,14 @@ def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end - # Removes metadata tags from an AWS Glue DataBrew resource. + # Removes metadata tags from a DataBrew resource. # # @option params [required, String] :resource_arn - # An DataBrew resource from which you want to remove a tag or tags. The + # A DataBrew resource from which you want to remove a tag or tags. The # value for this parameter is an Amazon Resource Name (ARN). # # @option params [required, Array<String>] :tag_keys # The tag keys (names) of one or more tags to be removed. # @@ -1958,23 +1999,21 @@ def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end - # Modifies the definition of an existing AWS Glue DataBrew dataset in - # the current AWS account. + # Modifies the definition of an existing DataBrew dataset. # # @option params [required, String] :name # The name of the dataset to be updated. # # @option params [Types::FormatOptions] :format_options - # Options that define how Microsoft Excel input is to be interpreted by - # DataBrew. + # Options that define the structure of either Csv, Excel, or JSON input. # # @option params [required, Types::Input] :input - # Information on how AWS Glue DataBrew can find data, in either the AWS - # Glue Data Catalog or Amazon S3. + # Information on how DataBrew can find data, in either the AWS Glue Data + # Catalog or Amazon S3. # # @return [Types::UpdateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDatasetResponse#name #name} => String # @@ -1988,10 +2027,13 @@ # }, # excel: { # sheet_names: ["SheetName"], # sheet_indexes: [1], # }, + # csv: { + # delimiter: "Delimiter", + # }, # }, # input: { # required # s3_input_definition: { # bucket: "Bucket", # required # key: "Key", @@ -2019,12 +2061,11 @@ def update_dataset(params = {}, options = {}) req = build_request(:update_dataset, params) req.send_request(options) end - # Modifies the definition of an existing AWS Glue DataBrew job in the - # current AWS account. + # Modifies the definition of an existing profile job. # # @option params [String] :encryption_key_arn # The Amazon Resource Name (ARN) of an encryption key that is used to # protect the job. # @@ -2037,16 +2078,15 @@ # # @option params [required, String] :name # The name of the job to be updated. # # @option params [String] :log_subscription - # A value that enables or disables Amazon CloudWatch logging for the - # current AWS account. If logging is enabled, CloudWatch writes one log - # stream for each job run. + # Enables or disables Amazon CloudWatch logging for the job. If logging + # is enabled, CloudWatch writes one log stream for each job run. # # @option params [Integer] :max_capacity - # The maximum number of nodes that DataBrew can use when the job + # The maximum number of compute nodes that DataBrew can use when the job # processes data. # # @option params [Integer] :max_retries # The maximum number of times to retry the job after a job run fails. # @@ -2054,11 +2094,11 @@ # An Amazon S3 location (bucket name an object key) where DataBrew can # read input data, or write output from a job. # # @option params [required, String] :role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access - # Management (IAM) role to be assumed for this request. + # Management (IAM) role to be assumed when DataBrew runs the job. # # @option params [Integer] :timeout # The job's timeout in minutes. A job that attempts to run longer than # this timeout period ends with a status of `TIMEOUT`. # @@ -2094,16 +2134,15 @@ def update_profile_job(params = {}, options = {}) req = build_request(:update_profile_job, params) req.send_request(options) end - # Modifies the definition of an existing AWS Glue DataBrew project in - # the current AWS account. + # Modifies the definition of an existing DataBrew project. # # @option params [Types::Sample] :sample - # Represents the sample size and sampling type for AWS Glue DataBrew to - # use for interactive data analysis. + # Represents the sample size and sampling type for DataBrew to use for + # interactive data analysis. # # @option params [required, String] :role_arn # The Amazon Resource Name (ARN) of the IAM role to be assumed for this # request. # @@ -2138,12 +2177,12 @@ def update_project(params = {}, options = {}) req = build_request(:update_project, params) req.send_request(options) end - # Modifies the definition of the latest working version of an AWS Glue - # DataBrew recipe in the current AWS account. + # Modifies the definition of the `LATEST_WORKING` version of a DataBrew + # recipe. # # @option params [String] :description # A description of the recipe. # # @option params [required, String] :name @@ -2192,12 +2231,11 @@ def update_recipe(params = {}, options = {}) req = build_request(:update_recipe, params) req.send_request(options) end - # Modifies the definition of an existing AWS Glue DataBrew recipe job in - # the current AWS account. + # Modifies the definition of an existing DataBrew recipe job. # # @option params [String] :encryption_key_arn # The Amazon Resource Name (ARN) of an encryption key that is used to # protect the job. # @@ -2210,13 +2248,12 @@ # # @option params [required, String] :name # The name of the job to update. # # @option params [String] :log_subscription - # A value that enables or disables Amazon CloudWatch logging for the - # current AWS account. If logging is enabled, CloudWatch writes one log - # stream for each job run. + # Enables or disables Amazon CloudWatch logging for the job. If logging + # is enabled, CloudWatch writes one log stream for each job run. # # @option params [Integer] :max_capacity # The maximum number of nodes that DataBrew can consume when the job # processes data. # @@ -2226,11 +2263,11 @@ # @option params [required, Array<Types::Output>] :outputs # One or more artifacts that represent the output from running the job. # # @option params [required, String] :role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access - # Management (IAM) role to be assumed for this request. + # Management (IAM) role to be assumed when DataBrew runs the job. # # @option params [Integer] :timeout # The job's timeout in minutes. A job that attempts to run longer than # this timeout period ends with a status of `TIMEOUT`. # @@ -2255,10 +2292,15 @@ # location: { # required # bucket: "Bucket", # required # key: "Key", # }, # overwrite: false, + # format_options: { + # csv: { + # delimiter: "Delimiter", + # }, + # }, # }, # ], # role_arn: "Arn", # required # timeout: 1, # }) @@ -2274,20 +2316,24 @@ def update_recipe_job(params = {}, options = {}) req = build_request(:update_recipe_job, params) req.send_request(options) end - # Modifies the definition of an existing AWS Glue DataBrew schedule in - # the current AWS account. + # Modifies the definition of an existing DataBrew schedule. # # @option params [Array<String>] :job_names # The name or names of one or more jobs to be run for this schedule. # # @option params [required, String] :cron_expression - # The date or dates and time or times, in `cron` format, when the jobs - # are to be run. + # The date or dates and time or times when the jobs are to be run. For + # more information, see [Cron expressions][1] in the *AWS Glue DataBrew + # Developer Guide*. # + # + # + # [1]: https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html + # # @option params [required, String] :name # The name of the schedule to update. # # @return [Types::UpdateScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -2325,10 +2371,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-gluedatabrew' - context[:gem_version] = '1.0.0' + context[:gem_version] = '1.1.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated