lib/aws-sdk-glue/client.rb in aws-sdk-glue-1.6.0 vs lib/aws-sdk-glue/client.rb in aws-sdk-glue-1.7.0
- old
+ new
@@ -511,17 +511,18 @@
def batch_get_partition(params = {}, options = {})
req = build_request(:batch_get_partition, params)
req.send_request(options)
end
- # Stops one or more job runs for a specified Job.
+ # Stops one or more job runs for a specified job definition.
#
# @option params [required, String] :job_name
- # The name of the Job in question.
+ # The name of the job definition for which to stop job runs.
#
# @option params [required, Array<String>] :job_run_ids
- # A list of the JobRunIds that should be stopped for that Job.
+ # A list of the JobRunIds that should be stopped for that job
+ # definition.
#
# @return [Types::BatchStopJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::BatchStopJobRunResponse#successful_submissions #successful_submissions} => Array<Types::BatchStopJobRunSuccessfulSubmission>
# * {Types::BatchStopJobRunResponse#errors #errors} => Array<Types::BatchStopJobRunError>
@@ -864,23 +865,24 @@
def create_dev_endpoint(params = {}, options = {})
req = build_request(:create_dev_endpoint, params)
req.send_request(options)
end
- # Creates a new job.
+ # Creates a new job definition.
#
# @option params [required, String] :name
- # The name you assign to this job. It must be unique in your account.
+ # The name you assign to this job definition. It must be unique in your
+ # account.
#
# @option params [String] :description
- # Description of the job.
+ # Description of the job being defined.
#
# @option params [String] :log_uri
# This field is reserved for future use.
#
# @option params [required, String] :role
- # The name of the IAM role associated with this job.
+ # The name or ARN of the IAM role associated with this job.
#
# @option params [Types::ExecutionProperty] :execution_property
# An ExecutionProperty specifying the maximum number of concurrent runs
# allowed for this job.
#
@@ -902,11 +904,11 @@
# topic in the developer guide.
#
#
#
# [1]: http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html
- # [2]: http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html
+ # [2]: http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
#
# @option params [Types::ConnectionsList] :connections
# The connections used for this job.
#
# @option params [Integer] :max_retries
@@ -921,10 +923,13 @@
#
#
#
# [1]: https://aws.amazon.com/glue/pricing/
#
+ # @option params [Integer] :timeout
+ # The job timeout in minutes. The default is 2880 minutes (48 hours).
+ #
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateJobResponse#name #name} => String
#
# @example Request syntax with placeholder values
@@ -947,10 +952,11 @@
# connections: {
# connections: ["GenericString"],
# },
# max_retries: 1,
# allocated_capacity: 1,
+ # timeout: 1,
# })
#
# @example Response structure
#
# resp.name #=> String
@@ -1224,10 +1230,14 @@
# The actions initiated by this trigger when it fires.
#
# @option params [String] :description
# A description of the new trigger.
#
+ # @option params [Boolean] :start_on_creation
+ # Set to true to start SCHEDULED and CONDITIONAL triggers when created.
+ # True not supported for ON\_DEMAND triggers.
+ #
# @return [Types::CreateTriggerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::CreateTriggerResponse#name #name} => String
#
# @example Request syntax with placeholder values
@@ -1240,23 +1250,25 @@
# logical: "AND", # accepts AND, ANY
# conditions: [
# {
# logical_operator: "EQUALS", # accepts EQUALS
# job_name: "NameString",
- # state: "STARTING", # accepts STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED
+ # state: "STARTING", # accepts STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED, TIMEOUT
# },
# ],
# },
# actions: [ # required
# {
# job_name: "NameString",
# arguments: {
# "GenericString" => "GenericString",
# },
+ # timeout: 1,
# },
# ],
# description: "DescriptionString",
+ # start_on_creation: false,
# })
#
# @example Response structure
#
# resp.name #=> String
@@ -1433,15 +1445,15 @@
def delete_dev_endpoint(params = {}, options = {})
req = build_request(:delete_dev_endpoint, params)
req.send_request(options)
end
- # Deletes a specified job. If the job is not found, no exception is
- # thrown.
+ # Deletes a specified job definition. If the job definition is not
+ # found, no exception is thrown.
#
# @option params [required, String] :job_name
- # The name of the job to delete.
+ # The name of the job definition to delete.
#
# @return [Types::DeleteJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::DeleteJobResponse#job_name #job_name} => String
#
@@ -2261,11 +2273,11 @@
end
# Retrieves an existing job definition.
#
# @option params [required, String] :job_name
- # The name of the job to retrieve.
+ # The name of the job definition to retrieve.
#
# @return [Types::GetJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetJobResponse#job #job} => Types::Job
#
@@ -2290,10 +2302,11 @@
# resp.job.default_arguments["GenericString"] #=> String
# resp.job.connections.connections #=> Array
# resp.job.connections.connections[0] #=> String
# resp.job.max_retries #=> Integer
# resp.job.allocated_capacity #=> Integer
+ # resp.job.timeout #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetJob AWS API Documentation
#
# @overload get_job(params = {})
# @param [Hash] params ({})
@@ -2303,11 +2316,11 @@
end
# Retrieves the metadata for a given job run.
#
# @option params [required, String] :job_name
- # Name of the job being run.
+ # Name of the job definition being run.
#
# @option params [required, String] :run_id
# The ID of the job run.
#
# @option params [Boolean] :predecessors_included
@@ -2333,32 +2346,34 @@
# resp.job_run.trigger_name #=> String
# resp.job_run.job_name #=> String
# resp.job_run.started_on #=> Time
# resp.job_run.last_modified_on #=> Time
# resp.job_run.completed_on #=> Time
- # resp.job_run.job_run_state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED"
+ # resp.job_run.job_run_state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT"
# resp.job_run.arguments #=> Hash
# resp.job_run.arguments["GenericString"] #=> String
# resp.job_run.error_message #=> String
# resp.job_run.predecessor_runs #=> Array
# resp.job_run.predecessor_runs[0].job_name #=> String
# resp.job_run.predecessor_runs[0].run_id #=> String
# resp.job_run.allocated_capacity #=> Integer
+ # resp.job_run.execution_time #=> Integer
+ # resp.job_run.timeout #=> Integer
#
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetJobRun AWS API Documentation
#
# @overload get_job_run(params = {})
# @param [Hash] params ({})
def get_job_run(params = {}, options = {})
req = build_request(:get_job_run, params)
req.send_request(options)
end
- # Retrieves metadata for all runs of a given job.
+ # Retrieves metadata for all runs of a given job definition.
#
# @option params [required, String] :job_name
- # The name of the job for which to retrieve all job runs.
+ # The name of the job definition for which to retrieve all job runs.
#
# @option params [String] :next_token
# A continuation token, if this is a continuation call.
#
# @option params [Integer] :max_results
@@ -2386,18 +2401,20 @@
# resp.job_runs[0].trigger_name #=> String
# resp.job_runs[0].job_name #=> String
# resp.job_runs[0].started_on #=> Time
# resp.job_runs[0].last_modified_on #=> Time
# resp.job_runs[0].completed_on #=> Time
- # resp.job_runs[0].job_run_state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED"
+ # resp.job_runs[0].job_run_state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT"
# resp.job_runs[0].arguments #=> Hash
# resp.job_runs[0].arguments["GenericString"] #=> String
# resp.job_runs[0].error_message #=> String
# resp.job_runs[0].predecessor_runs #=> Array
# resp.job_runs[0].predecessor_runs[0].job_name #=> String
# resp.job_runs[0].predecessor_runs[0].run_id #=> String
# resp.job_runs[0].allocated_capacity #=> Integer
+ # resp.job_runs[0].execution_time #=> Integer
+ # resp.job_runs[0].timeout #=> Integer
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetJobRuns AWS API Documentation
#
# @overload get_job_runs(params = {})
@@ -2405,11 +2422,11 @@
def get_job_runs(params = {}, options = {})
req = build_request(:get_job_runs, params)
req.send_request(options)
end
- # Retrieves all current jobs.
+ # Retrieves all current job definitions.
#
# @option params [String] :next_token
# A continuation token, if this is a continuation call.
#
# @option params [Integer] :max_results
@@ -2443,10 +2460,11 @@
# resp.jobs[0].default_arguments["GenericString"] #=> String
# resp.jobs[0].connections.connections #=> Array
# resp.jobs[0].connections.connections[0] #=> String
# resp.jobs[0].max_retries #=> Integer
# resp.jobs[0].allocated_capacity #=> Integer
+ # resp.jobs[0].timeout #=> Integer
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetJobs AWS API Documentation
#
# @overload get_jobs(params = {})
@@ -3162,15 +3180,16 @@
# resp.trigger.schedule #=> String
# resp.trigger.actions #=> Array
# resp.trigger.actions[0].job_name #=> String
# resp.trigger.actions[0].arguments #=> Hash
# resp.trigger.actions[0].arguments["GenericString"] #=> String
+ # resp.trigger.actions[0].timeout #=> Integer
# resp.trigger.predicate.logical #=> String, one of "AND", "ANY"
# resp.trigger.predicate.conditions #=> Array
# resp.trigger.predicate.conditions[0].logical_operator #=> String, one of "EQUALS"
# resp.trigger.predicate.conditions[0].job_name #=> String
- # resp.trigger.predicate.conditions[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED"
+ # resp.trigger.predicate.conditions[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetTrigger AWS API Documentation
#
# @overload get_trigger(params = {})
# @param [Hash] params ({})
@@ -3216,15 +3235,16 @@
# resp.triggers[0].schedule #=> String
# resp.triggers[0].actions #=> Array
# resp.triggers[0].actions[0].job_name #=> String
# resp.triggers[0].actions[0].arguments #=> Hash
# resp.triggers[0].actions[0].arguments["GenericString"] #=> String
+ # resp.triggers[0].actions[0].timeout #=> Integer
# resp.triggers[0].predicate.logical #=> String, one of "AND", "ANY"
# resp.triggers[0].predicate.conditions #=> Array
# resp.triggers[0].predicate.conditions[0].logical_operator #=> String, one of "EQUALS"
# resp.triggers[0].predicate.conditions[0].job_name #=> String
- # resp.triggers[0].predicate.conditions[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED"
+ # resp.triggers[0].predicate.conditions[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT"
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/GetTriggers AWS API Documentation
#
# @overload get_triggers(params = {})
@@ -3434,21 +3454,21 @@
def start_crawler_schedule(params = {}, options = {})
req = build_request(:start_crawler_schedule, params)
req.send_request(options)
end
- # Runs a job.
+ # Starts a job run using a job definition.
#
# @option params [required, String] :job_name
- # The name of the job to start.
+ # The name of the job definition to use.
#
# @option params [String] :job_run_id
# The ID of a previous JobRun to retry.
#
# @option params [Hash<String,String>] :arguments
# The job arguments specifically for this run. They override the
- # equivalent default arguments set for the job itself.
+ # equivalent default arguments set for in the job definition itself.
#
# You can specify arguments here that your own job-execution script
# consumes, as well as arguments that AWS Glue itself consumes.
#
# For information about how to specify and consume your own Job
@@ -3460,11 +3480,11 @@
# topic in the developer guide.
#
#
#
# [1]: http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html
- # [2]: http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html
+ # [2]: http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
#
# @option params [Integer] :allocated_capacity
# The number of AWS Glue data processing units (DPUs) to allocate to
# this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A
# DPU is a relative measure of processing power that consists of 4 vCPUs
@@ -3473,10 +3493,14 @@
#
#
#
# [1]: https://aws.amazon.com/glue/pricing/
#
+ # @option params [Integer] :timeout
+ # The job run timeout in minutes. It overrides the timeout value of the
+ # job.
+ #
# @return [Types::StartJobRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::StartJobRunResponse#job_run_id #job_run_id} => String
#
# @example Request syntax with placeholder values
@@ -3486,10 +3510,11 @@
# job_run_id: "IdString",
# arguments: {
# "GenericString" => "GenericString",
# },
# allocated_capacity: 1,
+ # timeout: 1,
# })
#
# @example Response structure
#
# resp.job_run_id #=> String
@@ -3907,11 +3932,11 @@
#
# @option params [required, String] :job_name
# Name of the job definition to update.
#
# @option params [required, Types::JobUpdate] :job_update
- # Specifies the values with which to update the job.
+ # Specifies the values with which to update the job definition.
#
# @return [Types::UpdateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::UpdateJobResponse#job_name #job_name} => String
#
@@ -3936,10 +3961,11 @@
# connections: {
# connections: ["GenericString"],
# },
# max_retries: 1,
# allocated_capacity: 1,
+ # timeout: 1,
# },
# })
#
# @example Response structure
#
@@ -4162,19 +4188,20 @@
# {
# job_name: "NameString",
# arguments: {
# "GenericString" => "GenericString",
# },
+ # timeout: 1,
# },
# ],
# predicate: {
# logical: "AND", # accepts AND, ANY
# conditions: [
# {
# logical_operator: "EQUALS", # accepts EQUALS
# job_name: "NameString",
- # state: "STARTING", # accepts STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED
+ # state: "STARTING", # accepts STARTING, RUNNING, STOPPING, STOPPED, SUCCEEDED, FAILED, TIMEOUT
# },
# ],
# },
# },
# })
@@ -4189,15 +4216,16 @@
# resp.trigger.schedule #=> String
# resp.trigger.actions #=> Array
# resp.trigger.actions[0].job_name #=> String
# resp.trigger.actions[0].arguments #=> Hash
# resp.trigger.actions[0].arguments["GenericString"] #=> String
+ # resp.trigger.actions[0].timeout #=> Integer
# resp.trigger.predicate.logical #=> String, one of "AND", "ANY"
# resp.trigger.predicate.conditions #=> Array
# resp.trigger.predicate.conditions[0].logical_operator #=> String, one of "EQUALS"
# resp.trigger.predicate.conditions[0].job_name #=> String
- # resp.trigger.predicate.conditions[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED"
+ # resp.trigger.predicate.conditions[0].state #=> String, one of "STARTING", "RUNNING", "STOPPING", "STOPPED", "SUCCEEDED", "FAILED", "TIMEOUT"
#
# @see http://docs.aws.amazon.com/goto/WebAPI/glue-2017-03-31/UpdateTrigger AWS API Documentation
#
# @overload update_trigger(params = {})
# @param [Hash] params ({})
@@ -4265,10 +4293,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-glue'
- context[:gem_version] = '1.6.0'
+ context[:gem_version] = '1.7.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated