lib/aws-sdk-groundstation/client.rb in aws-sdk-groundstation-1.32.0 vs lib/aws-sdk-groundstation/client.rb in aws-sdk-groundstation-1.33.0
- old
+ new
@@ -512,18 +512,21 @@
#
# 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.
+ # Amount of time, in seconds, after a contact ends that the Ground
+ # Station Dataflow Endpoint Group will be in a `POSTPASS` state. A
+ # Ground Station Dataflow Endpoint Group State Change event will be
+ # emitted when the Dataflow Endpoint Group 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.
+ # Amount of time, in seconds, before a contact starts that the Ground
+ # Station Dataflow Endpoint Group will be in a `PREPASS` state. A Ground
+ # Station Dataflow Endpoint Group State Change event will be emitted
+ # when the Dataflow Endpoint Group enters and exits the `PREPASS` state.
#
# @option params [required, Array<Types::EndpointDetails>] :endpoint_details
# Endpoint details of each endpoint in the dataflow endpoint group.
#
# @option params [Hash<String,String>] :tags
@@ -569,10 +572,12 @@
# },
# mtu: 1,
# name: "SafeName",
# status: "created", # accepts created, creating, deleted, deleting, failed
# },
+ # health_reasons: ["NO_REGISTERED_AGENT"], # accepts NO_REGISTERED_AGENT, INVALID_IP_OWNERSHIP, NOT_AUTHORIZED_TO_CREATE_SLR, UNVERIFIED_IP_OWNERSHIP, INITIALIZING_DATAPLANE, DATAPLANE_FAILURE, HEALTHY
+ # health_status: "UNHEALTHY", # accepts UNHEALTHY, HEALTHY
# security_details: {
# role_arn: "RoleArn", # required
# security_group_ids: ["String"], # required
# subnet_ids: ["String"], # required
# },
@@ -933,10 +938,13 @@
# resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.address.name #=> String
# resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.address.port #=> Integer
# resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.mtu #=> Integer
# resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.name #=> String
# resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
+ # resp.dataflow_list[0].destination.config_details.endpoint_details.health_reasons #=> Array
+ # resp.dataflow_list[0].destination.config_details.endpoint_details.health_reasons[0] #=> String, one of "NO_REGISTERED_AGENT", "INVALID_IP_OWNERSHIP", "NOT_AUTHORIZED_TO_CREATE_SLR", "UNVERIFIED_IP_OWNERSHIP", "INITIALIZING_DATAPLANE", "DATAPLANE_FAILURE", "HEALTHY"
+ # resp.dataflow_list[0].destination.config_details.endpoint_details.health_status #=> String, one of "UNHEALTHY", "HEALTHY"
# resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.role_arn #=> String
# resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.security_group_ids #=> Array
# resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.security_group_ids[0] #=> String
# resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.subnet_ids #=> Array
# resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.subnet_ids[0] #=> String
@@ -960,10 +968,13 @@
# resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.address.name #=> String
# resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.address.port #=> Integer
# resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.mtu #=> Integer
# resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.name #=> String
# resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
+ # resp.dataflow_list[0].source.config_details.endpoint_details.health_reasons #=> Array
+ # resp.dataflow_list[0].source.config_details.endpoint_details.health_reasons[0] #=> String, one of "NO_REGISTERED_AGENT", "INVALID_IP_OWNERSHIP", "NOT_AUTHORIZED_TO_CREATE_SLR", "UNVERIFIED_IP_OWNERSHIP", "INITIALIZING_DATAPLANE", "DATAPLANE_FAILURE", "HEALTHY"
+ # resp.dataflow_list[0].source.config_details.endpoint_details.health_status #=> String, one of "UNHEALTHY", "HEALTHY"
# resp.dataflow_list[0].source.config_details.endpoint_details.security_details.role_arn #=> String
# resp.dataflow_list[0].source.config_details.endpoint_details.security_details.security_group_ids #=> Array
# resp.dataflow_list[0].source.config_details.endpoint_details.security_details.security_group_ids[0] #=> String
# resp.dataflow_list[0].source.config_details.endpoint_details.security_details.subnet_ids #=> Array
# resp.dataflow_list[0].source.config_details.endpoint_details.security_details.subnet_ids[0] #=> String
@@ -1052,10 +1063,14 @@
def describe_ephemeris(params = {}, options = {})
req = build_request(:describe_ephemeris, params)
req.send_request(options)
end
+ # <note markdown="1"> For use by AWS Ground Station Agent and shouldn't be called directly.
+ #
+ # </note>
+ #
# Gets the latest configuration information for a registered agent.
#
# @option params [required, String] :agent_id
# UUID of agent to get configuration information for.
#
@@ -1194,10 +1209,13 @@
# resp.endpoints_details[0].endpoint.address.name #=> String
# resp.endpoints_details[0].endpoint.address.port #=> Integer
# resp.endpoints_details[0].endpoint.mtu #=> Integer
# resp.endpoints_details[0].endpoint.name #=> String
# resp.endpoints_details[0].endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
+ # resp.endpoints_details[0].health_reasons #=> Array
+ # resp.endpoints_details[0].health_reasons[0] #=> String, one of "NO_REGISTERED_AGENT", "INVALID_IP_OWNERSHIP", "NOT_AUTHORIZED_TO_CREATE_SLR", "UNVERIFIED_IP_OWNERSHIP", "INITIALIZING_DATAPLANE", "DATAPLANE_FAILURE", "HEALTHY"
+ # resp.endpoints_details[0].health_status #=> String, one of "UNHEALTHY", "HEALTHY"
# resp.endpoints_details[0].security_details.role_arn #=> String
# resp.endpoints_details[0].security_details.security_group_ids #=> Array
# resp.endpoints_details[0].security_details.security_group_ids[0] #=> String
# resp.endpoints_details[0].security_details.subnet_ids #=> Array
# resp.endpoints_details[0].security_details.subnet_ids[0] #=> String
@@ -1730,36 +1748,41 @@
def list_tags_for_resource(params = {}, options = {})
req = build_request(:list_tags_for_resource, params)
req.send_request(options)
end
- # Registers a new agent with AWS Groundstation.
+ # <note markdown="1"> For use by AWS Ground Station Agent and shouldn't be called directly.
#
+ # </note>
+ #
+ # Registers a new agent with AWS Ground Station.
+ #
# @option params [required, Types::AgentDetails] :agent_details
# Detailed information about the agent being registered.
#
# @option params [required, Types::DiscoveryData] :discovery_data
- # Data for associating and agent with the capabilities it is managing.
+ # Data for associating an agent with the capabilities it is managing.
#
# @return [Types::RegisterAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RegisterAgentResponse#agent_id #agent_id} => String
#
# @example Request syntax with placeholder values
#
# resp = client.register_agent({
# agent_details: { # required
+ # agent_cpu_cores: [1],
# agent_version: "VersionString", # required
# component_versions: [ # required
# {
- # component_type: "LAMINAR_FLOW", # required, accepts LAMINAR_FLOW, PRISM, DIGITIZER
+ # component_type: "ComponentTypeString", # required
# versions: ["VersionString"], # required
# },
# ],
# instance_id: "InstanceId", # required
# instance_type: "InstanceType", # required
- # reserved_cpu_cores: [1], # required
+ # reserved_cpu_cores: [1],
# },
# discovery_data: { # required
# capability_arns: ["CapabilityArn"], # required
# private_ip_addresses: ["IpV4Address"], # required
# public_ip_addresses: ["IpV4Address"], # required
@@ -1881,10 +1904,14 @@
def untag_resource(params = {}, options = {})
req = build_request(:untag_resource, params)
req.send_request(options)
end
+ # <note markdown="1"> For use by AWS Ground Station Agent and shouldn't be called directly.
+ #
+ # </note>
+ #
# Update the status of the agent.
#
# @option params [required, String] :agent_id
# UUID of agent to update.
#
@@ -1914,11 +1941,11 @@
# component_statuses: [ # required
# {
# bytes_received: 1,
# bytes_sent: 1,
# capability_arn: "CapabilityArn", # required
- # component_type: "LAMINAR_FLOW", # required, accepts LAMINAR_FLOW, PRISM, DIGITIZER
+ # component_type: "ComponentTypeString", # required
# dataflow_id: "Uuid", # required
# packets_dropped: 1,
# status: "SUCCESS", # required, accepts SUCCESS, FAILED, ACTIVE, INACTIVE
# },
# ],
@@ -2180,10 +2207,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-groundstation'
- context[:gem_version] = '1.32.0'
+ context[:gem_version] = '1.33.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#