aws-sdk-groundstation 1.30.0 → 1.32.0

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

@@ -10,6 +10,59 @@
 module Aws::GroundStation
   module Types
 
+    # Detailed information about the agent.
+    #
+    # @!attribute [rw] agent_version
+    #   Current agent version.
+    #   @return [String]
+    #
+    # @!attribute [rw] component_versions
+    #   List of versions being used by agent components.
+    #   @return [Array<Types::ComponentVersion>]
+    #
+    # @!attribute [rw] instance_id
+    #   ID of EC2 instance agent is running on.
+    #   @return [String]
+    #
+    # @!attribute [rw] instance_type
+    #   Type of EC2 instance agent is running on.
+    #   @return [String]
+    #
+    # @!attribute [rw] reserved_cpu_cores
+    #   Number of Cpu cores reserved for agent.
+    #   @return [Array<Integer>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/AgentDetails AWS API Documentation
+    #
+    class AgentDetails < Struct.new(
+      :agent_version,
+      :component_versions,
+      :instance_id,
+      :instance_type,
+      :reserved_cpu_cores)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Aggregate status of Agent components.
+    #
+    # @!attribute [rw] signature_map
+    #   Sparse map of failure signatures.
+    #   @return [Hash<String,Boolean>]
+    #
+    # @!attribute [rw] status
+    #   Aggregate status.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/AggregateStatus AWS API Documentation
+    #
+    class AggregateStatus < Struct.new(
+      :signature_map,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Details about an antenna demod decode `Config` used in a contact.
     #
     # @!attribute [rw] output_node
@@ -88,6 +141,41 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # Information about AwsGroundStationAgentEndpoint.
+    #
+    # @!attribute [rw] agent_status
+    #   The status of AgentEndpoint.
+    #   @return [String]
+    #
+    # @!attribute [rw] audit_results
+    #   The results of the audit.
+    #   @return [String]
+    #
+    # @!attribute [rw] egress_address
+    #   The egress address of AgentEndpoint.
+    #   @return [Types::ConnectionDetails]
+    #
+    # @!attribute [rw] ingress_address
+    #   The ingress address of AgentEndpoint.
+    #   @return [Types::RangedConnectionDetails]
+    #
+    # @!attribute [rw] name
+    #   Name string associated with AgentEndpoint. Used as a human-readable
+    #   identifier for AgentEndpoint.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/AwsGroundStationAgentEndpoint AWS API Documentation
+    #
+    class AwsGroundStationAgentEndpoint < Struct.new(
+      :agent_status,
+      :audit_results,
+      :egress_address,
+      :ingress_address,
+      :name)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] contact_id
     #   UUID of a contact.
     #   @return [String]
@@ -100,6 +188,69 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # Data on the status of agent components.
+    #
+    # @!attribute [rw] bytes_received
+    #   Bytes received by the component.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] bytes_sent
+    #   Bytes sent by the component.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] capability_arn
+    #   Capability ARN of the component.
+    #   @return [String]
+    #
+    # @!attribute [rw] component_type
+    #   The Component type.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataflow_id
+    #   Dataflow UUID associated with the component.
+    #   @return [String]
+    #
+    # @!attribute [rw] packets_dropped
+    #   Packets dropped by component.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] status
+    #   Component status.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ComponentStatusData AWS API Documentation
+    #
+    class ComponentStatusData < Struct.new(
+      :bytes_received,
+      :bytes_sent,
+      :capability_arn,
+      :component_type,
+      :dataflow_id,
+      :packets_dropped,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Version information for agent components.
+    #
+    # @!attribute [rw] component_type
+    #   Component type.
+    #   @return [String]
+    #
+    # @!attribute [rw] versions
+    #   List of versions.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ComponentVersion AWS API Documentation
+    #
+    class ComponentVersion < Struct.new(
+      :component_type,
+      :versions)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Details for certain `Config` object types in a contact.
     #
     # @note ConfigDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ConfigDetails corresponding to the set member.
@@ -253,6 +404,26 @@ module Aws::GroundStation
       class Unknown < ConfigTypeData; end
     end
 
+    # Egress address of AgentEndpoint with an optional mtu.
+    #
+    # @!attribute [rw] mtu
+    #   Maximum transmission unit (MTU) size in bytes of a dataflow
+    #   endpoint.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] socket_address
+    #   A socket address.
+    #   @return [Types::SocketAddress]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ConnectionDetails AWS API Documentation
+    #
+    class ConnectionDetails < Struct.new(
+      :mtu,
+      :socket_address)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Data describing a contact.
     #
     # @!attribute [rw] contact_id
@@ -363,6 +534,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 +557,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 = []
@@ -464,6 +649,14 @@ module Aws::GroundStation
     #   Name of a mission profile.
     #   @return [String]
     #
+    # @!attribute [rw] streams_kms_key
+    #   KMS key to use for encrypting streams.
+    #   @return [Types::KmsKey]
+    #
+    # @!attribute [rw] streams_kms_role
+    #   Role to use for encrypting streams with KMS key.
+    #   @return [String]
+    #
     # @!attribute [rw] tags
     #   Tags assigned to a mission profile.
     #   @return [Hash<String,String>]
@@ -480,6 +673,8 @@ module Aws::GroundStation
       :dataflow_edges,
       :minimum_viable_contact_duration_seconds,
       :name,
+      :streams_kms_key,
+      :streams_kms_role,
       :tags,
       :tracking_config_arn)
       SENSITIVE = []
@@ -887,6 +1082,30 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # Data for agent discovery.
+    #
+    # @!attribute [rw] capability_arns
+    #   List of capabilities to associate with agent.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] private_ip_addresses
+    #   List of private IP addresses to associate with agent.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] public_ip_addresses
+    #   List of public IP addresses to associate with agent.
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DiscoveryData AWS API Documentation
+    #
+    class DiscoveryData < Struct.new(
+      :capability_arns,
+      :private_ip_addresses,
+      :public_ip_addresses)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Object that represents EIRP.
     #
     # @!attribute [rw] units
@@ -927,6 +1146,10 @@ module Aws::GroundStation
 
     # Information about the endpoint details.
     #
+    # @!attribute [rw] aws_ground_station_agent_endpoint
+    #   An agent endpoint.
+    #   @return [Types::AwsGroundStationAgentEndpoint]
+    #
     # @!attribute [rw] endpoint
     #   A dataflow endpoint.
     #   @return [Types::DataflowEndpoint]
@@ -939,6 +1162,7 @@ module Aws::GroundStation
     # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/EndpointDetails AWS API Documentation
     #
     class EndpointDetails < Struct.new(
+      :aws_ground_station_agent_endpoint,
       :endpoint,
       :security_details)
       SENSITIVE = []
@@ -1166,6 +1390,35 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # @!attribute [rw] agent_id
+    #   UUID of agent to get configuration information for.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetAgentConfigurationRequest AWS API Documentation
+    #
+    class GetAgentConfigurationRequest < Struct.new(
+      :agent_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] agent_id
+    #   UUID of agent.
+    #   @return [String]
+    #
+    # @!attribute [rw] tasking_document
+    #   Tasking document for agent.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetAgentConfigurationResponse AWS API Documentation
+    #
+    class GetAgentConfigurationResponse < Struct.new(
+      :agent_id,
+      :tasking_document)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] config_id
     #   UUID of a `Config`.
     #   @return [String]
@@ -1232,6 +1485,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 +1516,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,
@@ -1362,6 +1629,14 @@ module Aws::GroundStation
     #   Region of a mission profile.
     #   @return [String]
     #
+    # @!attribute [rw] streams_kms_key
+    #   KMS key to use for encrypting streams.
+    #   @return [Types::KmsKey]
+    #
+    # @!attribute [rw] streams_kms_role
+    #   Role to use for encrypting streams with KMS key.
+    #   @return [String]
+    #
     # @!attribute [rw] tags
     #   Tags assigned to a mission profile.
     #   @return [Hash<String,String>]
@@ -1381,6 +1656,8 @@ module Aws::GroundStation
       :mission_profile_id,
       :name,
       :region,
+      :streams_kms_key,
+      :streams_kms_role,
       :tags,
       :tracking_config_arn)
       SENSITIVE = []
@@ -1456,6 +1733,25 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # An integer range that has a minimum and maximum value.
+    #
+    # @!attribute [rw] maximum
+    #   A maximum value.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] minimum
+    #   A minimum value.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/IntegerRange AWS API Documentation
+    #
+    class IntegerRange < Struct.new(
+      :maximum,
+      :minimum)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # One or more parameters are not valid.
     #
     # @!attribute [rw] message
@@ -1473,6 +1769,35 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # AWS Key Management Service (KMS) Key.
+    #
+    # @note KmsKey is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note KmsKey is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of KmsKey corresponding to the set member.
+    #
+    # @!attribute [rw] kms_alias_arn
+    #   KMS Alias Arn.
+    #   @return [String]
+    #
+    # @!attribute [rw] kms_key_arn
+    #   KMS Key Arn.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/KmsKey AWS API Documentation
+    #
+    class KmsKey < Struct.new(
+      :kms_alias_arn,
+      :kms_key_arn,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class KmsAliasArn < KmsKey; end
+      class KmsKeyArn < KmsKey; end
+      class Unknown < KmsKey; end
+    end
+
     # @!attribute [rw] max_results
     #   Maximum number of `Configs` returned.
     #   @return [Integer]
@@ -1869,6 +2194,75 @@ module Aws::GroundStation
       include Aws::Structure
     end
 
+    # Ingress address of AgentEndpoint with a port range and an optional
+    # mtu.
+    #
+    # @!attribute [rw] mtu
+    #   Maximum transmission unit (MTU) size in bytes of a dataflow
+    #   endpoint.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] socket_address
+    #   A ranged socket address.
+    #   @return [Types::RangedSocketAddress]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/RangedConnectionDetails AWS API Documentation
+    #
+    class RangedConnectionDetails < Struct.new(
+      :mtu,
+      :socket_address)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A socket address with a port range.
+    #
+    # @!attribute [rw] name
+    #   IPv4 socket address.
+    #   @return [String]
+    #
+    # @!attribute [rw] port_range
+    #   Port range of a socket address.
+    #   @return [Types::IntegerRange]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/RangedSocketAddress AWS API Documentation
+    #
+    class RangedSocketAddress < Struct.new(
+      :name,
+      :port_range)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] agent_details
+    #   Detailed information about the agent being registered.
+    #   @return [Types::AgentDetails]
+    #
+    # @!attribute [rw] discovery_data
+    #   Data for associating and agent with the capabilities it is managing.
+    #   @return [Types::DiscoveryData]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/RegisterAgentRequest AWS API Documentation
+    #
+    class RegisterAgentRequest < Struct.new(
+      :agent_details,
+      :discovery_data)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] agent_id
+    #   UUID of registered agent.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/RegisterAgentResponse AWS API Documentation
+    #
+    class RegisterAgentResponse < Struct.new(
+      :agent_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] end_time
     #   End time of a contact in UTC.
     #   @return [Time]
@@ -2269,6 +2663,45 @@ module Aws::GroundStation
     #
     class UntagResourceResponse < Aws::EmptyStructure; end
 
+    # @!attribute [rw] agent_id
+    #   UUID of agent to update.
+    #   @return [String]
+    #
+    # @!attribute [rw] aggregate_status
+    #   Aggregate status for agent.
+    #   @return [Types::AggregateStatus]
+    #
+    # @!attribute [rw] component_statuses
+    #   List of component statuses for agent.
+    #   @return [Array<Types::ComponentStatusData>]
+    #
+    # @!attribute [rw] task_id
+    #   GUID of agent task.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateAgentStatusRequest AWS API Documentation
+    #
+    class UpdateAgentStatusRequest < Struct.new(
+      :agent_id,
+      :aggregate_status,
+      :component_statuses,
+      :task_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] agent_id
+    #   UUID of updated agent.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateAgentStatusResponse AWS API Documentation
+    #
+    class UpdateAgentStatusResponse < Struct.new(
+      :agent_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] config_data
     #   Parameters of a `Config`.
     #   @return [Types::ConfigTypeData]
@@ -2360,6 +2793,14 @@ module Aws::GroundStation
     #   Name of a mission profile.
     #   @return [String]
     #
+    # @!attribute [rw] streams_kms_key
+    #   KMS key to use for encrypting streams.
+    #   @return [Types::KmsKey]
+    #
+    # @!attribute [rw] streams_kms_role
+    #   Role to use for encrypting streams with KMS key.
+    #   @return [String]
+    #
     # @!attribute [rw] tracking_config_arn
     #   ARN of a tracking `Config`.
     #   @return [String]
@@ -2373,6 +2814,8 @@ module Aws::GroundStation
       :minimum_viable_contact_duration_seconds,
       :mission_profile_id,
       :name,
+      :streams_kms_key,
+      :streams_kms_role,
       :tracking_config_arn)
       SENSITIVE = []
       include Aws::Structure

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