aws-sdk-states 1.63.0 → 1.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af76a9325c3acf4d0967d568f80499b6eda3c2096ee1db5c692ee539300dfdbc
-  data.tar.gz: 6cf50d20b27fefb0ae8c7b6cf86b23587b00ac2defc4af2113c653e0b84763dc
+  metadata.gz: 2f040f29e37c27b335b9d19f9779b0a9690e0bbc4869e6ec00d002e0214304cc
+  data.tar.gz: 87a4f01b1b4a2b117d582ffd9c3eb6f65ce652c0f2f7dafdb0fc36b5002040d4
 SHA512:
-  metadata.gz: 8348199ae9f3eb035f118b6d22806678bc7bc110db16f277404600465b98c16bff53f6dfec1e69ad7198b5dda2a6a49bc504350ce2702a0a58e88ee575f898ac
-  data.tar.gz: c57f9e1e1ce021d66f7fd2e340281ebabd1a0c48b064eab1d6ca22f4937eab728403fb390cd3a0148f9c7e1f9db67847f70d9b8e3a6ca1d7d490d2084ca4a9f2
+  metadata.gz: 8a91fb33c1d72bf0f66a47c0b25264c8a9a0dad00cbcdae7ca5829edadff221458075b815a2165172fc7fa21e080ab1c16ec98f45966f67afbd60eb6babc4957
+  data.tar.gz: 5d41e22f1f40fc979aa325921162d9334946dc3a58b40bca00e8c4697d316ee58d6d9af778edcb952601e5da013d40b30c6f9d39cf15c1171bab3a4d92375cc4

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.65.0 (2024-04-25)
+------------------
+
+* Feature - Add new ValidateStateMachineDefinition operation, which performs syntax checking on the definition of a Amazon States Language (ASL) state machine.
+
+1.64.0 (2024-01-26)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.63.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.63.0
+1.65.0

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

@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
 require 'aws-sdk-core/plugins/response_paging.rb'
 require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/invocation_id.rb'
 require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::States
     add_plugin(Aws::Plugins::ResponsePaging)
     add_plugin(Aws::Plugins::StubResponses)
     add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::InvocationId)
     add_plugin(Aws::Plugins::JsonvalueConverter)
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::States
     #     When set to 'true' the request body will not be compressed
     #     for supported operations.
     #
-    #   @option options [String] :endpoint
-    #     The client endpoint is normally constructed from the `:region`
-    #     option. You should only configure an `:endpoint` when connecting
-    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
+    #   @option options [String, URI::HTTPS, URI::HTTP] :endpoint
+    #     Normally you should not configure the `:endpoint` option
+    #     directly. This is normally constructed from the `:region`
+    #     option. Configuring `:endpoint` is normally reserved for
+    #     connecting to test or custom endpoints. The endpoint should
+    #     be a URI formatted like:
+    #
+    #         'http://example.com'
+    #         'https://example.com'
+    #         'http://example.com:123'
+    #
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -347,50 +356,65 @@ module Aws::States
     #   @option options [Aws::States::EndpointProvider] :endpoint_provider
     #     The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::States::EndpointParameters`
     #
-    #   @option options [URI::HTTP,String] :http_proxy A proxy to send
-    #     requests through.  Formatted like 'http://proxy.com:123'.
-    #
-    #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before raising a
-    #     `Timeout::Error`.
-    #
-    #   @option options [Float] :http_read_timeout (60) The default
-    #     number of seconds to wait for response data.  This value can
-    #     safely be set per-request on the session.
-    #
-    #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idle before it is
-    #     considered stale.  Stale connections are closed and removed
-    #     from the pool before making a request.
-    #
-    #   @option options [Float] :http_continue_timeout (1) The number of
-    #     seconds to wait for a 100-continue response before sending the
-    #     request body.  This option has no effect unless the request has
-    #     "Expect" header set to "100-continue".  Defaults to `nil` which
-    #     disables this behaviour.  This value can safely be set per
-    #     request on the session.
-    #
-    #   @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
-    #     in seconds.
-    #
-    #   @option options [Boolean] :http_wire_trace (false) When `true`,
-    #     HTTP debug output will be sent to the `:logger`.
+    #   @option options [Float] :http_continue_timeout (1)
+    #     The number of seconds to wait for a 100-continue response before sending the
+    #     request body.  This option has no effect unless the request has "Expect"
+    #     header set to "100-continue".  Defaults to `nil` which  disables this
+    #     behaviour.  This value can safely be set per request on the session.
+    #
+    #   @option options [Float] :http_idle_timeout (5)
+    #     The number of seconds a connection is allowed to sit idle before it
+    #     is considered stale.  Stale connections are closed and removed from the
+    #     pool before making a request.
+    #
+    #   @option options [Float] :http_open_timeout (15)
+    #     The default number of seconds to wait for response data.
+    #     This value can safely be set per-request on the session.
+    #
+    #   @option options [URI::HTTP,String] :http_proxy
+    #     A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
+    #
+    #   @option options [Float] :http_read_timeout (60)
+    #     The default number of seconds to wait for response data.
+    #     This value can safely be set per-request on the session.
+    #
+    #   @option options [Boolean] :http_wire_trace (false)
+    #     When `true`,  HTTP debug output will be sent to the `:logger`.
+    #
+    #   @option options [Proc] :on_chunk_received
+    #     When a Proc object is provided, it will be used as callback when each chunk
+    #     of the response body is received. It provides three arguments: the chunk,
+    #     the number of bytes received, and the total number of
+    #     bytes in the response (or nil if the server did not send a `content-length`).
+    #
+    #   @option options [Proc] :on_chunk_sent
+    #     When a Proc object is provided, it will be used as callback when each chunk
+    #     of the request body is sent. It provides three arguments: the chunk,
+    #     the number of bytes read from the body, and the total number of
+    #     bytes in the body.
+    #
+    #   @option options [Boolean] :raise_response_errors (true)
+    #     When `true`, response errors are raised.
+    #
+    #   @option options [String] :ssl_ca_bundle
+    #     Full path to the SSL certificate authority bundle file that should be used when
+    #     verifying peer certificates.  If you do not pass `:ssl_ca_bundle` or
+    #     `:ssl_ca_directory` the the system default will be used if available.
+    #
+    #   @option options [String] :ssl_ca_directory
+    #     Full path of the directory that contains the unbundled SSL certificate
+    #     authority files for verifying peer certificates.  If you do
+    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
+    #     default will be used if available.
     #
-    #   @option options [Boolean] :ssl_verify_peer (true) When `true`,
-    #     SSL peer certificates are verified when establishing a
-    #     connection.
+    #   @option options [String] :ssl_ca_store
+    #     Sets the X509::Store to verify peer certificate.
     #
-    #   @option options [String] :ssl_ca_bundle Full path to the SSL
-    #     certificate authority bundle file that should be used when
-    #     verifying peer certificates.  If you do not pass
-    #     `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
-    #     will be used if available.
+    #   @option options [Float] :ssl_timeout
+    #     Sets the SSL timeout in seconds
     #
-    #   @option options [String] :ssl_ca_directory Full path of the
-    #     directory that contains the unbundled SSL certificate
-    #     authority files for verifying peer certificates.  If you do
-    #     not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
-    #     system default will be used if available.
+    #   @option options [Boolean] :ssl_verify_peer (true)
+    #     When `true`, SSL peer certificates are verified when establishing a connection.
     #
     def initialize(*args)
       super
@@ -3166,6 +3190,77 @@ module Aws::States
       req.send_request(options)
     end
 
+    # Validates the syntax of a state machine definition.
+    #
+    # You can validate that a state machine definition is correct without
+    # creating a state machine resource. Step Functions will implicitly
+    # perform the same syntax check when you invoke `CreateStateMachine` and
+    # `UpdateStateMachine`. State machine definitions are specified using a
+    # JSON-based, structured language. For more information on Amazon States
+    # Language see [Amazon States Language][1] (ASL).
+    #
+    # Suggested uses for `ValidateStateMachineDefinition`:
+    #
+    # * Integrate automated checks into your code review or Continuous
+    #   Integration (CI) process to validate state machine definitions
+    #   before starting deployments.
+    #
+    # * Run the validation from a Git pre-commit hook to check your state
+    #   machine definitions before committing them to your source
+    #   repository.
+    #
+    # <note markdown="1"> Errors found in the state machine definition will be returned in the
+    # response as a list of **diagnostic elements**, rather than raise an
+    # exception.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html
+    #
+    # @option params [required, String] :definition
+    #   The Amazon States Language definition of the state machine. For more
+    #   information, see [Amazon States Language][1] (ASL).
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html
+    #
+    # @option params [String] :type
+    #   The target type of state machine for this definition. The default is
+    #   `STANDARD`.
+    #
+    # @return [Types::ValidateStateMachineDefinitionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ValidateStateMachineDefinitionOutput#result #result} => String
+    #   * {Types::ValidateStateMachineDefinitionOutput#diagnostics #diagnostics} => Array&lt;Types::ValidateStateMachineDefinitionDiagnostic&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.validate_state_machine_definition({
+    #     definition: "Definition", # required
+    #     type: "STANDARD", # accepts STANDARD, EXPRESS
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.result #=> String, one of "OK", "FAIL"
+    #   resp.diagnostics #=> Array
+    #   resp.diagnostics[0].severity #=> String, one of "ERROR"
+    #   resp.diagnostics[0].code #=> String
+    #   resp.diagnostics[0].message #=> String
+    #   resp.diagnostics[0].location #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ValidateStateMachineDefinition AWS API Documentation
+    #
+    # @overload validate_state_machine_definition(params = {})
+    # @param [Hash] params ({})
+    def validate_state_machine_definition(params = {}, options = {})
+      req = build_request(:validate_state_machine_definition, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -3179,7 +3274,7 @@ module Aws::States
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-states'
-      context[:gem_version] = '1.63.0'
+      context[:gem_version] = '1.65.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-states/client_api.rb

@@ -238,6 +238,15 @@ module Aws::States
     UpdateStateMachineAliasOutput = Shapes::StructureShape.new(name: 'UpdateStateMachineAliasOutput')
     UpdateStateMachineInput = Shapes::StructureShape.new(name: 'UpdateStateMachineInput')
     UpdateStateMachineOutput = Shapes::StructureShape.new(name: 'UpdateStateMachineOutput')
+    ValidateStateMachineDefinitionCode = Shapes::StringShape.new(name: 'ValidateStateMachineDefinitionCode')
+    ValidateStateMachineDefinitionDiagnostic = Shapes::StructureShape.new(name: 'ValidateStateMachineDefinitionDiagnostic')
+    ValidateStateMachineDefinitionDiagnosticList = Shapes::ListShape.new(name: 'ValidateStateMachineDefinitionDiagnosticList')
+    ValidateStateMachineDefinitionInput = Shapes::StructureShape.new(name: 'ValidateStateMachineDefinitionInput')
+    ValidateStateMachineDefinitionLocation = Shapes::StringShape.new(name: 'ValidateStateMachineDefinitionLocation')
+    ValidateStateMachineDefinitionMessage = Shapes::StringShape.new(name: 'ValidateStateMachineDefinitionMessage')
+    ValidateStateMachineDefinitionOutput = Shapes::StructureShape.new(name: 'ValidateStateMachineDefinitionOutput')
+    ValidateStateMachineDefinitionResultCode = Shapes::StringShape.new(name: 'ValidateStateMachineDefinitionResultCode')
+    ValidateStateMachineDefinitionSeverity = Shapes::StringShape.new(name: 'ValidateStateMachineDefinitionSeverity')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
     ValidationExceptionReason = Shapes::StringShape.new(name: 'ValidationExceptionReason')
     VersionDescription = Shapes::StringShape.new(name: 'VersionDescription')
@@ -1028,6 +1037,22 @@ module Aws::States
     UpdateStateMachineOutput.add_member(:state_machine_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "stateMachineVersionArn"))
     UpdateStateMachineOutput.struct_class = Types::UpdateStateMachineOutput
 
+    ValidateStateMachineDefinitionDiagnostic.add_member(:severity, Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionSeverity, required: true, location_name: "severity"))
+    ValidateStateMachineDefinitionDiagnostic.add_member(:code, Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionCode, required: true, location_name: "code"))
+    ValidateStateMachineDefinitionDiagnostic.add_member(:message, Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionMessage, required: true, location_name: "message"))
+    ValidateStateMachineDefinitionDiagnostic.add_member(:location, Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionLocation, location_name: "location"))
+    ValidateStateMachineDefinitionDiagnostic.struct_class = Types::ValidateStateMachineDefinitionDiagnostic
+
+    ValidateStateMachineDefinitionDiagnosticList.member = Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionDiagnostic)
+
+    ValidateStateMachineDefinitionInput.add_member(:definition, Shapes::ShapeRef.new(shape: Definition, required: true, location_name: "definition"))
+    ValidateStateMachineDefinitionInput.add_member(:type, Shapes::ShapeRef.new(shape: StateMachineType, location_name: "type"))
+    ValidateStateMachineDefinitionInput.struct_class = Types::ValidateStateMachineDefinitionInput
+
+    ValidateStateMachineDefinitionOutput.add_member(:result, Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionResultCode, required: true, location_name: "result"))
+    ValidateStateMachineDefinitionOutput.add_member(:diagnostics, Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionDiagnosticList, required: true, location_name: "diagnostics"))
+    ValidateStateMachineDefinitionOutput.struct_class = Types::ValidateStateMachineDefinitionOutput
+
     ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     ValidationException.add_member(:reason, Shapes::ShapeRef.new(shape: ValidationExceptionReason, location_name: "reason"))
     ValidationException.struct_class = Types::ValidationException
@@ -1043,6 +1068,7 @@ module Aws::States
         "endpointPrefix" => "states",
         "jsonVersion" => "1.0",
         "protocol" => "json",
+        "protocols" => ["json"],
         "serviceAbbreviation" => "AWS SFN",
         "serviceFullName" => "AWS Step Functions",
         "serviceId" => "SFN",
@@ -1353,6 +1379,7 @@ module Aws::States
         o.errors << Shapes::ShapeRef.new(shape: ExecutionNotRedrivable)
         o.errors << Shapes::ShapeRef.new(shape: ExecutionLimitExceeded)
         o.errors << Shapes::ShapeRef.new(shape: InvalidArn)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
       end)
 
       api.add_operation(:send_task_failure, Seahorse::Model::Operation.new.tap do |o|
@@ -1510,6 +1537,15 @@ module Aws::States
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
         o.errors << Shapes::ShapeRef.new(shape: StateMachineDeleting)
       end)
+
+      api.add_operation(:validate_state_machine_definition, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ValidateStateMachineDefinition"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionInput)
+        o.output = Shapes::ShapeRef.new(shape: ValidateStateMachineDefinitionOutput)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+      end)
     end
 
   end

data/lib/aws-sdk-states/endpoints.rb

@@ -516,5 +516,19 @@ module Aws::States
       end
     end
 
+    class ValidateStateMachineDefinition
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::States::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
   end
 end

data/lib/aws-sdk-states/plugins/endpoints.rb

@@ -14,6 +14,7 @@ module Aws::States
       option(
         :endpoint_provider,
         doc_type: 'Aws::States::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\
@@ -129,6 +130,8 @@ module Aws::States
             Aws::States::Endpoints::UpdateStateMachine.build(context)
           when :update_state_machine_alias
             Aws::States::Endpoints::UpdateStateMachineAlias.build(context)
+          when :validate_state_machine_definition
+            Aws::States::Endpoints::ValidateStateMachineDefinition.build(context)
           end
         end
       end

data/lib/aws-sdk-states/types.rb

@@ -4373,6 +4373,85 @@ module Aws::States
       include Aws::Structure
     end
 
+    # Describes an error found during validation. Validation errors found in
+    # the definition return in the response as **diagnostic elements**,
+    # rather than raise an exception.
+    #
+    # @!attribute [rw] severity
+    #   A value of `ERROR` means that you cannot create or update a state
+    #   machine with this definition.
+    #   @return [String]
+    #
+    # @!attribute [rw] code
+    #   Identifying code for the diagnostic.
+    #   @return [String]
+    #
+    # @!attribute [rw] message
+    #   Message describing the diagnostic condition.
+    #   @return [String]
+    #
+    # @!attribute [rw] location
+    #   Location of the issue in the state machine, if available.
+    #
+    #   For errors specific to a field, the location could be in the format:
+    #   `/States/<StateName>/<FieldName>`, for example:
+    #   `/States/FailState/ErrorPath`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ValidateStateMachineDefinitionDiagnostic AWS API Documentation
+    #
+    class ValidateStateMachineDefinitionDiagnostic < Struct.new(
+      :severity,
+      :code,
+      :message,
+      :location)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] definition
+    #   The Amazon States Language definition of the state machine. For more
+    #   information, see [Amazon States Language][1] (ASL).
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   The target type of state machine for this definition. The default is
+    #   `STANDARD`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ValidateStateMachineDefinitionInput AWS API Documentation
+    #
+    class ValidateStateMachineDefinitionInput < Struct.new(
+      :definition,
+      :type)
+      SENSITIVE = [:definition]
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] result
+    #   The result value will be `OK` when no syntax errors are found, or
+    #   `FAIL` if the workflow definition does not pass verification.
+    #   @return [String]
+    #
+    # @!attribute [rw] diagnostics
+    #   If the result is `OK`, this field will be empty. When there are
+    #   errors, this field will contain an array of **Diagnostic** objects
+    #   to help you troubleshoot.
+    #   @return [Array<Types::ValidateStateMachineDefinitionDiagnostic>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ValidateStateMachineDefinitionOutput AWS API Documentation
+    #
+    class ValidateStateMachineDefinitionOutput < Struct.new(
+      :result,
+      :diagnostics)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The input does not satisfy the constraints specified by an Amazon Web
     # Services service.
     #

data/lib/aws-sdk-states.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-states/customizations'
 # @!group service
 module Aws::States
 
-  GEM_VERSION = '1.63.0'
+  GEM_VERSION = '1.65.0'
 
 end