aws-sdk-groundstation 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f28fef1ccf14310628814ae5baffbf87cae0db3c3e80625de93ada955f28632
-  data.tar.gz: b852252cf13a8294976ffde486f776a6b82ada0dd71f74709d6880d055f84fad
+  metadata.gz: 4f81601bf76df148196ec209a859d1ecb84fd10bc3acd806cabf79b401fe3e5d
+  data.tar.gz: c0b6183670ea5b39f5072350fa76e1cb31e781bc0e068be14987cc3dc6b6d8a0
 SHA512:
-  metadata.gz: 6559ec0e35ed7faba690bb2d66e2b62fc02aeb110bda03c7ec0ac750b564e874e242cd25c1b809e9f77c9c685412c87f250d62fc4114b379bc859b032a124146
-  data.tar.gz: e8c93ee7c8928a08eac4d3ad6d8d970c067d3afe232d8f44be11065363c09bc305b7307737a92d6b8a0bb1bae11875349b3b991f453b6287dae120cee2bbd2af
+  metadata.gz: db2b0d6362d6b7df9c64ebf4281b3eb373c22111b873b7043ddfb5322c0e00a8a3b2ce6e7c9144e78f9140994e1a4787ec3f02883693da1f88cf5d1ada9c47df
+  data.tar.gz: 1c7569ad6d5e1def50be9bce16b426616d8b40aecc418a66b4369054db8e248111f8ffcd924098d41f21b1952476a96b321b8bf7785126f483faa5f0bc4a0c96

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.31.0 (2023-01-19)
+------------------
+
+* Feature - Add configurable prepass and postpass times for DataflowEndpointGroup. Add Waiter to allow customers to wait for a contact that was reserved through ReserveContact
+
 1.30.0 (2023-01-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.30.0
+1.31.0

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

@@ -513,6 +513,16 @@ module Aws::GroundStation
     # When a contact uses multiple `DataflowEndpointConfig` objects, each
     # `Config` must match a `DataflowEndpoint` in the same group.
     #
+    # @option params [Integer] :contact_post_pass_duration_seconds
+    #   Amount of time, in seconds, after a contact ends for the contact to
+    #   remain in a `POSTPASS` state. A CloudWatch event is emitted when the
+    #   contact enters and exits the `POSTPASS` state.
+    #
+    # @option params [Integer] :contact_pre_pass_duration_seconds
+    #   Amount of time, in seconds, prior to contact start for the contact to
+    #   remain in a `PREPASS` state. A CloudWatch event is emitted when the
+    #   contact enters and exits the `PREPASS` state.
+    #
     # @option params [required, Array<Types::EndpointDetails>] :endpoint_details
     #   Endpoint details of each endpoint in the dataflow endpoint group.
     #
@@ -526,6 +536,8 @@ module Aws::GroundStation
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_dataflow_endpoint_group({
+    #     contact_post_pass_duration_seconds: 1,
+    #     contact_pre_pass_duration_seconds: 1,
     #     endpoint_details: [ # required
     #       {
     #         endpoint: {
@@ -921,6 +933,11 @@ module Aws::GroundStation
     #   resp.tags #=> Hash
     #   resp.tags["String"] #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * contact_scheduled
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DescribeContact AWS API Documentation
     #
     # @overload describe_contact(params = {})
@@ -1061,6 +1078,8 @@ module Aws::GroundStation
     #
     # @return [Types::GetDataflowEndpointGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
+    #   * {Types::GetDataflowEndpointGroupResponse#contact_post_pass_duration_seconds #contact_post_pass_duration_seconds} => Integer
+    #   * {Types::GetDataflowEndpointGroupResponse#contact_pre_pass_duration_seconds #contact_pre_pass_duration_seconds} => Integer
     #   * {Types::GetDataflowEndpointGroupResponse#dataflow_endpoint_group_arn #dataflow_endpoint_group_arn} => String
     #   * {Types::GetDataflowEndpointGroupResponse#dataflow_endpoint_group_id #dataflow_endpoint_group_id} => String
     #   * {Types::GetDataflowEndpointGroupResponse#endpoints_details #endpoints_details} => Array&lt;Types::EndpointDetails&gt;
@@ -1074,6 +1093,8 @@ module Aws::GroundStation
     #
     # @example Response structure
     #
+    #   resp.contact_post_pass_duration_seconds #=> Integer
+    #   resp.contact_pre_pass_duration_seconds #=> Integer
     #   resp.dataflow_endpoint_group_arn #=> String
     #   resp.dataflow_endpoint_group_id #=> String
     #   resp.endpoints_details #=> Array
@@ -1950,14 +1971,127 @@ module Aws::GroundStation
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-groundstation'
-      context[:gem_version] = '1.30.0'
+      context[:gem_version] = '1.31.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 |
+    # | ----------------- | ------------------------- | -------- | ------------- |
+    # | contact_scheduled | {Client#describe_contact} | 5        | 180           |
+    #
+    # @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
+      {
+        contact_scheduled: Waiters::ContactScheduled
+      }
     end
 
     class << self

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

@@ -47,6 +47,7 @@ module Aws::GroundStation
     DataflowEndpoint = Shapes::StructureShape.new(name: 'DataflowEndpoint')
     DataflowEndpointConfig = Shapes::StructureShape.new(name: 'DataflowEndpointConfig')
     DataflowEndpointGroupArn = Shapes::StringShape.new(name: 'DataflowEndpointGroupArn')
+    DataflowEndpointGroupDurationInSeconds = Shapes::IntegerShape.new(name: 'DataflowEndpointGroupDurationInSeconds')
     DataflowEndpointGroupIdResponse = Shapes::StructureShape.new(name: 'DataflowEndpointGroupIdResponse')
     DataflowEndpointGroupList = Shapes::ListShape.new(name: 'DataflowEndpointGroupList')
     DataflowEndpointListItem = Shapes::StructureShape.new(name: 'DataflowEndpointListItem')
@@ -263,6 +264,8 @@ module Aws::GroundStation
     CreateConfigRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagsMap, location_name: "tags"))
     CreateConfigRequest.struct_class = Types::CreateConfigRequest
 
+    CreateDataflowEndpointGroupRequest.add_member(:contact_post_pass_duration_seconds, Shapes::ShapeRef.new(shape: DataflowEndpointGroupDurationInSeconds, location_name: "contactPostPassDurationSeconds"))
+    CreateDataflowEndpointGroupRequest.add_member(:contact_pre_pass_duration_seconds, Shapes::ShapeRef.new(shape: DataflowEndpointGroupDurationInSeconds, location_name: "contactPrePassDurationSeconds"))
     CreateDataflowEndpointGroupRequest.add_member(:endpoint_details, Shapes::ShapeRef.new(shape: EndpointDetailsList, required: true, location_name: "endpointDetails"))
     CreateDataflowEndpointGroupRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagsMap, location_name: "tags"))
     CreateDataflowEndpointGroupRequest.struct_class = Types::CreateDataflowEndpointGroupRequest
@@ -458,6 +461,8 @@ module Aws::GroundStation
     GetDataflowEndpointGroupRequest.add_member(:dataflow_endpoint_group_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location: "uri", location_name: "dataflowEndpointGroupId"))
     GetDataflowEndpointGroupRequest.struct_class = Types::GetDataflowEndpointGroupRequest
 
+    GetDataflowEndpointGroupResponse.add_member(:contact_post_pass_duration_seconds, Shapes::ShapeRef.new(shape: DataflowEndpointGroupDurationInSeconds, location_name: "contactPostPassDurationSeconds"))
+    GetDataflowEndpointGroupResponse.add_member(:contact_pre_pass_duration_seconds, Shapes::ShapeRef.new(shape: DataflowEndpointGroupDurationInSeconds, location_name: "contactPrePassDurationSeconds"))
     GetDataflowEndpointGroupResponse.add_member(:dataflow_endpoint_group_arn, Shapes::ShapeRef.new(shape: DataflowEndpointGroupArn, location_name: "dataflowEndpointGroupArn"))
     GetDataflowEndpointGroupResponse.add_member(:dataflow_endpoint_group_id, Shapes::ShapeRef.new(shape: Uuid, location_name: "dataflowEndpointGroupId"))
     GetDataflowEndpointGroupResponse.add_member(:endpoints_details, Shapes::ShapeRef.new(shape: EndpointDetailsList, location_name: "endpointsDetails"))

data/lib/aws-sdk-groundstation/endpoint_parameters.rb

@@ -50,6 +50,9 @@ module Aws::GroundStation
 
     def initialize(options = {})
       self[:region] = options[:region]
+      if self[:region].nil?
+        raise ArgumentError, "Missing required EndpointParameter: :region"
+      end
       self[:use_dual_stack] = options[:use_dual_stack]
       self[:use_dual_stack] = false if self[:use_dual_stack].nil?
       if self[:use_dual_stack].nil?

data/lib/aws-sdk-groundstation/endpoint_provider.rb

@@ -15,7 +15,7 @@ module Aws::GroundStation
       use_fips = parameters.use_fips
       endpoint = parameters.endpoint
       if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
-        if Aws::Endpoints::Matchers.set?(endpoint) && (url = Aws::Endpoints::Matchers.parse_url(endpoint))
+        if Aws::Endpoints::Matchers.set?(endpoint)
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
             raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
           end

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

@@ -363,6 +363,18 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # @!attribute [rw] contact_post_pass_duration_seconds
+    #   Amount of time, in seconds, after a contact ends for the contact to
+    #   remain in a `POSTPASS` state. A CloudWatch event is emitted when the
+    #   contact enters and exits the `POSTPASS` state.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] contact_pre_pass_duration_seconds
+    #   Amount of time, in seconds, prior to contact start for the contact
+    #   to remain in a `PREPASS` state. A CloudWatch event is emitted when
+    #   the contact enters and exits the `PREPASS` state.
+    #   @return [Integer]
+    #
     # @!attribute [rw] endpoint_details
     #   Endpoint details of each endpoint in the dataflow endpoint group.
     #   @return [Array<Types::EndpointDetails>]
@@ -374,6 +386,8 @@ module Aws::GroundStation
     # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateDataflowEndpointGroupRequest AWS API Documentation
     #
     class CreateDataflowEndpointGroupRequest < Struct.new(
+      :contact_post_pass_duration_seconds,
+      :contact_pre_pass_duration_seconds,
       :endpoint_details,
       :tags)
       SENSITIVE = []
@@ -1232,6 +1246,18 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # @!attribute [rw] contact_post_pass_duration_seconds
+    #   Amount of time, in seconds, after a contact ends for the contact to
+    #   remain in a `POSTPASS` state. A CloudWatch event is emitted when the
+    #   contact enters and exits the `POSTPASS` state.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] contact_pre_pass_duration_seconds
+    #   Amount of time, in seconds, prior to contact start for the contact
+    #   to remain in a `PREPASS` state. A CloudWatch event is emitted when
+    #   the contact enters and exits the `PREPASS` state.
+    #   @return [Integer]
+    #
     # @!attribute [rw] dataflow_endpoint_group_arn
     #   ARN of a dataflow endpoint group.
     #   @return [String]
@@ -1251,6 +1277,8 @@ module Aws::GroundStation
     # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetDataflowEndpointGroupResponse AWS API Documentation
     #
     class GetDataflowEndpointGroupResponse < Struct.new(
+      :contact_post_pass_duration_seconds,
+      :contact_pre_pass_duration_seconds,
       :dataflow_endpoint_group_arn,
       :dataflow_endpoint_group_id,
       :endpoints_details,

data/lib/aws-sdk-groundstation/waiters.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::GroundStation
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available 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 |
+  # | ----------------- | ------------------------- | -------- | ------------- |
+  # | contact_scheduled | {Client#describe_contact} | 5        | 180           |
+  #
+  module Waiters
+
+    # Waits until a contact has been scheduled
+    class ContactScheduled
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (180)
+      # @option options [Integer] :delay (5)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 180,
+          delay: 5,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :describe_contact,
+            acceptors: [
+              {
+                "matcher" => "path",
+                "argument" => "contact_status",
+                "state" => "failure",
+                "expected" => "FAILED_TO_SCHEDULE"
+              },
+              {
+                "matcher" => "path",
+                "argument" => "contact_status",
+                "state" => "success",
+                "expected" => "SCHEDULED"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#describe_contact)
+      # @return (see Client#describe_contact)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+  end
+end

data/lib/aws-sdk-groundstation.rb

@@ -16,6 +16,7 @@ require_relative 'aws-sdk-groundstation/client_api'
 require_relative 'aws-sdk-groundstation/plugins/endpoints.rb'
 require_relative 'aws-sdk-groundstation/client'
 require_relative 'aws-sdk-groundstation/errors'
+require_relative 'aws-sdk-groundstation/waiters'
 require_relative 'aws-sdk-groundstation/resource'
 require_relative 'aws-sdk-groundstation/endpoint_parameters'
 require_relative 'aws-sdk-groundstation/endpoint_provider'
@@ -52,6 +53,6 @@ require_relative 'aws-sdk-groundstation/customizations'
 # @!group service
 module Aws::GroundStation
 
-  GEM_VERSION = '1.30.0'
+  GEM_VERSION = '1.31.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-groundstation
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 1.31.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -66,6 +66,7 @@ files:
 - lib/aws-sdk-groundstation/plugins/endpoints.rb
 - lib/aws-sdk-groundstation/resource.rb
 - lib/aws-sdk-groundstation/types.rb
+- lib/aws-sdk-groundstation/waiters.rb
 homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0