aws-sdk-locationservice 1.84.0 → 1.85.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6e045de761315c6bd151e0eed32edac348e2f996f053de599d724dd51f1e2b2
-  data.tar.gz: 4297c9f6512cdcea1c03ac42e59a835d335b5a4797b92142bf5ad7d48db5e937
+  metadata.gz: ac4b8383b650ff47957f7c0ce578afaa5517be3cde8e2bd0ac868f934fe56c67
+  data.tar.gz: e5ded0092642a2322a7cff4db0987170390e59b5262c666f6065350f7f040ae2
 SHA512:
-  metadata.gz: 2209b05100a35d7f845d012c30f44974901f510bb4c018ef7afbfb7dc068b2088ba3a8e24be908a1892d5702d6e129b63da5343636dc56831fdc36431e8ca817
-  data.tar.gz: 220ce2368fe61c6cd3d8ba867bc486399c2cace66d88594965f269e330583a838d29c0d06a15f582f98640afeb9541dd16b3c7f6a459015e30ec49459c83716d
+  metadata.gz: f0a6ef501ca49b70defd8ace627633f3707a77987209bc96f23bf9c4fcc974c7e968f119df3c815d3098e47ea3e8e46c22820bb3be785f915d5dc8cd43105bfc
+  data.tar.gz: 03f7118160928a454dc0a6b6ab6186e77e56f13bed15bb0a04f7ecaf5d8df349318aa55158c99ba957cfed6cf73a6da4c3c2084ca65e410f6008a5985a9d4b0a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.85.0 (2026-04-20)
+------------------
+
+* Feature - This release adds support for new Job APIs for bulk workloads. The initial job type supported is Address Validation. The new APIs added are StartJob, CancelJob, ListJobs, and GetJob.
+
 1.84.0 (2026-03-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.84.0
+1.85.0

data/lib/aws-sdk-locationservice/client.rb

@@ -1463,6 +1463,48 @@ module Aws::LocationService
       req.send_request(options)
     end
 
+    # `CancelJob` cancels a job that is currently running or pending. If the
+    # job is already in a terminal state (`Completed`, `Failed`, or
+    # `Cancelled`), the operation returns successfully with the current
+    # status.
+    #
+    # For more information, see [Job concepts][1] in the *Amazon Location
+    # Service Developer Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier of the job to cancel.
+    #
+    # @return [Types::CancelJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CancelJobResponse#job_arn #job_arn} => String
+    #   * {Types::CancelJobResponse#job_id #job_id} => String
+    #   * {Types::CancelJobResponse#status #status} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.cancel_job({
+    #     job_id: "JobId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.job_arn #=> String
+    #   resp.job_id #=> String
+    #   resp.status #=> String, one of "Pending", "Running", "Completed", "Failed", "Cancelling", "Cancelled"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/CancelJob AWS API Documentation
+    #
+    # @overload cancel_job(params = {})
+    # @param [Hash] params ({})
+    def cancel_job(params = {}, options = {})
+      req = build_request(:cancel_job, params)
+      req.send_request(options)
+    end
+
     # Creates a geofence collection, which manages and stores geofences.
     #
     # @option params [required, String] :collection_name
@@ -3262,6 +3304,80 @@ module Aws::LocationService
       req.send_request(options)
     end
 
+    # `GetJob` retrieves detailed information about a specific job,
+    # including its current status, configuration, and error information if
+    # the job failed.
+    #
+    # For more information, see [Job concepts][1] in the *Amazon Location
+    # Service Developer Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier of the job to retrieve.
+    #
+    # @return [Types::GetJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetJobResponse#action #action} => String
+    #   * {Types::GetJobResponse#action_options #action_options} => Types::JobActionOptions
+    #   * {Types::GetJobResponse#created_at #created_at} => Time
+    #   * {Types::GetJobResponse#ended_at #ended_at} => Time
+    #   * {Types::GetJobResponse#error #error} => Types::JobError
+    #   * {Types::GetJobResponse#execution_role_arn #execution_role_arn} => String
+    #   * {Types::GetJobResponse#input_options #input_options} => Types::JobInputOptions
+    #   * {Types::GetJobResponse#job_arn #job_arn} => String
+    #   * {Types::GetJobResponse#job_id #job_id} => String
+    #   * {Types::GetJobResponse#name #name} => String
+    #   * {Types::GetJobResponse#output_options #output_options} => Types::JobOutputOptions
+    #   * {Types::GetJobResponse#status #status} => String
+    #   * {Types::GetJobResponse#updated_at #updated_at} => Time
+    #   * {Types::GetJobResponse#tags #tags} => Hash<String,String>
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_job({
+    #     job_id: "JobId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.action #=> String, one of "ValidateAddress"
+    #   resp.action_options.validate_address.additional_features #=> Array
+    #   resp.action_options.validate_address.additional_features[0] #=> String, one of "Position", "CountrySpecificAttributes"
+    #   resp.created_at #=> Time
+    #   resp.ended_at #=> Time
+    #   resp.error.code #=> String, one of "ValidationError", "InternalServerError"
+    #   resp.error.messages #=> Array
+    #   resp.error.messages[0] #=> String
+    #   resp.execution_role_arn #=> String
+    #   resp.input_options.location #=> String
+    #   resp.input_options.format #=> String, one of "Parquet"
+    #   resp.job_arn #=> String
+    #   resp.job_id #=> String
+    #   resp.name #=> String
+    #   resp.output_options.format #=> String, one of "Parquet"
+    #   resp.output_options.location #=> String
+    #   resp.status #=> String, one of "Pending", "Running", "Completed", "Failed", "Cancelling", "Cancelled"
+    #   resp.updated_at #=> Time
+    #   resp.tags #=> Hash
+    #   resp.tags["TagKey"] #=> String
+    #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * job_completed
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/GetJob AWS API Documentation
+    #
+    # @overload get_job(params = {})
+    # @param [Hash] params ({})
+    def get_job(params = {}, options = {})
+      req = build_request(:get_job, params)
+      req.send_request(options)
+    end
+
     # This operation is no longer current and may be deprecated in the
     # future. We recommend upgrading to [ `GetGlyphs` ][1] unless you
     # require `Grab` data.
@@ -3963,6 +4079,76 @@ module Aws::LocationService
       req.send_request(options)
     end
 
+    # `ListJobs` retrieves a list of jobs with optional filtering and
+    # pagination support.
+    #
+    # For more information, see [Job concepts][1] in the *Amazon Location
+    # Service Developer Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html
+    #
+    # @option params [Types::JobsFilter] :filter
+    #   An optional structure containing criteria by which to filter job
+    #   results.
+    #
+    # @option params [Integer] :max_results
+    #   Maximum number of jobs to return.
+    #
+    # @option params [String] :next_token
+    #   The pagination token specifying which page of results to return in the
+    #   response. If no token is provided, the default page is the first page.
+    #
+    # @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListJobsResponse#entries #data.entries} => Array<Types::ListJobsResponseEntry> (This method conflicts with a method on Response, call it through the data member)
+    #   * {Types::ListJobsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_jobs({
+    #     filter: {
+    #       job_status: "Pending", # accepts Pending, Running, Completed, Failed, Cancelling, Cancelled
+    #     },
+    #     max_results: 1,
+    #     next_token: "LargeToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.data.entries #=> Array
+    #   resp.data.entries[0].action #=> String, one of "ValidateAddress"
+    #   resp.data.entries[0].action_options.validate_address.additional_features #=> Array
+    #   resp.data.entries[0].action_options.validate_address.additional_features[0] #=> String, one of "Position", "CountrySpecificAttributes"
+    #   resp.data.entries[0].created_at #=> Time
+    #   resp.data.entries[0].execution_role_arn #=> String
+    #   resp.data.entries[0].ended_at #=> Time
+    #   resp.data.entries[0].error.code #=> String, one of "ValidationError", "InternalServerError"
+    #   resp.data.entries[0].error.messages #=> Array
+    #   resp.data.entries[0].error.messages[0] #=> String
+    #   resp.data.entries[0].input_options.location #=> String
+    #   resp.data.entries[0].input_options.format #=> String, one of "Parquet"
+    #   resp.data.entries[0].job_id #=> String
+    #   resp.data.entries[0].job_arn #=> String
+    #   resp.data.entries[0].name #=> String
+    #   resp.data.entries[0].output_options.format #=> String, one of "Parquet"
+    #   resp.data.entries[0].output_options.location #=> String
+    #   resp.data.entries[0].status #=> String, one of "Pending", "Running", "Completed", "Failed", "Cancelling", "Cancelled"
+    #   resp.data.entries[0].updated_at #=> Time
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/ListJobs AWS API Documentation
+    #
+    # @overload list_jobs(params = {})
+    # @param [Hash] params ({})
+    def list_jobs(params = {}, options = {})
+      req = build_request(:list_jobs, params)
+      req.send_request(options)
+    end
+
     # Lists API key resources in your Amazon Web Services account.
     #
     # For more information, see [Use API keys to authenticate][1] in the
@@ -5010,6 +5196,113 @@ module Aws::LocationService
       req.send_request(options)
     end
 
+    # `StartJob` starts a new asynchronous bulk processing job. You specify
+    # the input data location in Amazon S3, the action to perform, and the
+    # output location where results are written.
+    #
+    # For more information, see [Job concepts][1] in the *Amazon Location
+    # Service Developer Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html
+    #
+    # @option params [String] :client_token
+    #   A unique identifier for this request to ensure idempotency.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [required, String] :action
+    #   The action to perform on the input data.
+    #
+    # @option params [Types::JobActionOptions] :action_options
+    #   Additional parameters that can be requested for each result.
+    #
+    # @option params [required, String] :execution_role_arn
+    #   The Amazon Resource Name (ARN) of the IAM role that Amazon Location
+    #   Service assumes during job processing. Amazon Location Service uses
+    #   this role to access the input and output locations specified for the
+    #   job.
+    #
+    #   <note markdown="1"> The IAM role must be created in the same Amazon Web Services account
+    #   where you plan to run your job.
+    #
+    #    </note>
+    #
+    #   For more information about configuring IAM roles for Amazon Location
+    #   jobs, see [Configure IAM permissions][1] in the *Amazon Location
+    #   Service Developer Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html
+    #
+    # @option params [required, Types::JobInputOptions] :input_options
+    #   Configuration for input data location and format.
+    #
+    #   <note markdown="1"> Input files have a limitation of 10gb per file, and 1gb per Parquet
+    #   row-group within the file.
+    #
+    #    </note>
+    #
+    # @option params [String] :name
+    #   An optional name for the job resource.
+    #
+    # @option params [required, Types::JobOutputOptions] :output_options
+    #   Configuration for output data location and format.
+    #
+    # @option params [Hash<String,String>] :tags
+    #   Tags and corresponding values to be associated with the job.
+    #
+    # @return [Types::StartJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartJobResponse#created_at #created_at} => Time
+    #   * {Types::StartJobResponse#job_arn #job_arn} => String
+    #   * {Types::StartJobResponse#job_id #job_id} => String
+    #   * {Types::StartJobResponse#status #status} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_job({
+    #     client_token: "ClientToken",
+    #     action: "ValidateAddress", # required, accepts ValidateAddress
+    #     action_options: {
+    #       validate_address: {
+    #         additional_features: ["Position"], # accepts Position, CountrySpecificAttributes
+    #       },
+    #     },
+    #     execution_role_arn: "IamRoleArn", # required
+    #     input_options: { # required
+    #       location: "JobInputLocation", # required
+    #       format: "Parquet", # required, accepts Parquet
+    #     },
+    #     name: "ResourceName",
+    #     output_options: { # required
+    #       format: "Parquet", # required, accepts Parquet
+    #       location: "JobOutputLocation", # required
+    #     },
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.created_at #=> Time
+    #   resp.job_arn #=> String
+    #   resp.job_id #=> String
+    #   resp.status #=> String, one of "Pending", "Running", "Completed", "Failed", "Cancelling", "Cancelled"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/location-2020-11-19/StartJob AWS API Documentation
+    #
+    # @overload start_job(params = {})
+    # @param [Hash] params ({})
+    def start_job(params = {}, options = {})
+      req = build_request(:start_job, params)
+      req.send_request(options)
+    end
+
     # Assigns one or more tags (key-value pairs) to the specified Amazon
     # Location Service resource.
     #
@@ -5668,14 +5961,127 @@ module Aws::LocationService
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-locationservice'
-      context[:gem_version] = '1.84.0'
+      context[:gem_version] = '1.85.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
+    # Polls an API operation until a resource enters a desired state.
+    #
+    # ## Basic Usage
+    #
+    # A waiter will call an API operation until:
+    #
+    # * It is successful
+    # * It enters a terminal state
+    # * It makes the maximum number of attempts
+    #
+    # In between attempts, the waiter will sleep.
+    #
+    #     # polls in a loop, sleeping between attempts
+    #     client.wait_until(waiter_name, params)
+    #
+    # ## Configuration
+    #
+    # You can configure the maximum number of polling attempts, and the
+    # delay (in seconds) between each polling attempt. You can pass
+    # configuration as the final arguments hash.
+    #
+    #     # poll for ~25 seconds
+    #     client.wait_until(waiter_name, params, {
+    #       max_attempts: 5,
+    #       delay: 5,
+    #     })
+    #
+    # ## Callbacks
+    #
+    # You can be notified before each polling attempt and before each
+    # delay. If you throw `:success` or `:failure` from these callbacks,
+    # it will terminate the waiter.
+    #
+    #     started_at = Time.now
+    #     client.wait_until(waiter_name, params, {
+    #
+    #       # disable max attempts
+    #       max_attempts: nil,
+    #
+    #       # poll for 1 hour, instead of a number of attempts
+    #       before_wait: -> (attempts, response) do
+    #         throw :failure if Time.now - started_at > 3600
+    #       end
+    #     })
+    #
+    # ## Handling Errors
+    #
+    # When a waiter is unsuccessful, it will raise an error.
+    # All of the failure errors extend from
+    # {Aws::Waiters::Errors::WaiterFailed}.
+    #
+    #     begin
+    #       client.wait_until(...)
+    #     rescue Aws::Waiters::Errors::WaiterFailed
+    #       # resource did not enter the desired state in time
+    #     end
+    #
+    # ## Valid Waiters
+    #
+    # The following table lists the valid waiter names, the operations they call,
+    # and the default `:delay` and `:max_attempts` values.
+    #
+    # | waiter_name   | params           | :delay   | :max_attempts |
+    # | ------------- | ---------------- | -------- | ------------- |
+    # | job_completed | {Client#get_job} | 60       | 5             |
+    #
+    # @raise [Errors::FailureStateError] Raised when the waiter terminates
+    #   because the waiter has entered a state that it will not transition
+    #   out of, preventing success.
+    #
+    # @raise [Errors::TooManyAttemptsError] Raised when the configured
+    #   maximum number of attempts have been made, and the waiter is not
+    #   yet successful.
+    #
+    # @raise [Errors::UnexpectedError] Raised when an error is encounted
+    #   while polling for a resource that is not expected.
+    #
+    # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
+    #   for an unknown state.
+    #
+    # @return [Boolean] Returns `true` if the waiter was successful.
+    # @param [Symbol] waiter_name
+    # @param [Hash] params ({})
+    # @param [Hash] options ({})
+    # @option options [Integer] :max_attempts
+    # @option options [Integer] :delay
+    # @option options [Proc] :before_attempt
+    # @option options [Proc] :before_wait
+    def wait_until(waiter_name, params = {}, options = {})
+      w = waiter(waiter_name, options)
+      yield(w.waiter) if block_given? # deprecated
+      w.wait(params)
+    end
+
     # @api private
     # @deprecated
     def waiter_names
-      []
+      waiters.keys
+    end
+
+    private
+
+    # @param [Symbol] waiter_name
+    # @param [Hash] options ({})
+    def waiter(waiter_name, options = {})
+      waiter_class = waiters[waiter_name]
+      if waiter_class
+        waiter_class.new(options.merge(client: self))
+      else
+        raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
+      end
+    end
+
+    def waiters
+      {
+        job_completed: Waiters::JobCompleted
+      }
     end
 
     class << self