Class: Aws::GroundStation::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb

Overview

An API client for GroundStation. To construct a client, you need to configure a :region and :credentials.

client = Aws::GroundStation::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    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'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::GroundStation::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::GroundStation::EndpointParameters.

  • :http_continue_timeout (Float) — default: 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.

  • :http_idle_timeout (Float) — default: 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.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    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).

  • :on_chunk_sent (Proc) —

    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.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    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.

  • :ssl_ca_directory (String) —

    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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#cancel_contact(params = {}) ⇒ Types::ContactIdResponse

Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.

For contacts that:

  • Have yet to start, the contact will be cancelled.

  • Have started but have yet to finish, the contact will be stopped.

Examples:

Request syntax with placeholder values


resp = client.cancel_contact({
  contact_id: "Uuid", # required
})

Response structure


resp.contact_id #=> String
resp.version_id #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    UUID of a contact.

Returns:

See Also:



520
521
522
523
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 520

def cancel_contact(params = {}, options = {})
  req = build_request(:cancel_contact, params)
  req.send_request(options)
end

#create_config(params = {}) ⇒ Types::ConfigIdResponse

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

Examples:

Request syntax with placeholder values


resp = client.create_config({
  name: "SafeName", # required
  config_data: { # required
    antenna_downlink_config: {
      spectrum_config: { # required
        center_frequency: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        bandwidth: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        polarization: "RIGHT_HAND", # accepts RIGHT_HAND, LEFT_HAND, NONE
      },
    },
    tracking_config: {
      autotrack: "REQUIRED", # required, accepts REQUIRED, PREFERRED, REMOVED
    },
    dataflow_endpoint_config: {
      dataflow_endpoint_name: "String", # required
      dataflow_endpoint_region: "String",
    },
    antenna_downlink_demod_decode_config: {
      spectrum_config: { # required
        center_frequency: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        bandwidth: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        polarization: "RIGHT_HAND", # accepts RIGHT_HAND, LEFT_HAND, NONE
      },
      demodulation_config: { # required
        unvalidated_json: "JsonString", # required
      },
      decode_config: { # required
        unvalidated_json: "JsonString", # required
      },
    },
    antenna_uplink_config: {
      transmit_disabled: false,
      spectrum_config: { # required
        center_frequency: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        polarization: "RIGHT_HAND", # accepts RIGHT_HAND, LEFT_HAND, NONE
      },
      target_eirp: { # required
        value: 1.0, # required
        units: "dBW", # required, accepts dBW
      },
    },
    uplink_echo_config: {
      enabled: false, # required
      antenna_uplink_config_arn: "ConfigArn", # required
    },
    s3_recording_config: {
      bucket_arn: "BucketArn", # required
      role_arn: "RoleArn", # required
      prefix: "S3KeyPrefix",
    },
    telemetry_sink_config: {
      telemetry_sink_type: "KINESIS_DATA_STREAM", # required, accepts KINESIS_DATA_STREAM
      telemetry_sink_data: { # required
        kinesis_data_stream_data: {
          kinesis_role_arn: "RoleArn", # required
          kinesis_data_stream_arn: "KinesisDataStreamArn", # required
        },
      },
    },
  },
  tags: {
    "String" => "String",
  },
})

Response structure


resp.config_id #=> String
resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.config_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    Name of a Config.

  • :config_data (required, Types::ConfigTypeData) —

    Parameters of a Config.

  • :tags (Hash<String,String>) —

    Tags assigned to a Config.

Returns:

See Also:



636
637
638
639
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 636

def create_config(params = {}, options = {})
  req = build_request(:create_config, params)
  req.send_request(options)
end

#create_dataflow_endpoint_group(params = {}) ⇒ Types::DataflowEndpointGroupIdResponse

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.

When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

Examples:

Request syntax with placeholder values


resp = client.create_dataflow_endpoint_group({
  endpoint_details: [ # required
    {
      security_details: {
        subnet_ids: ["String"], # required
        security_group_ids: ["String"], # required
        role_arn: "RoleArn", # required
      },
      endpoint: {
        name: "SafeName",
        address: {
          name: "String", # required
          port: 1, # required
        },
        status: "created", # accepts created, creating, deleted, deleting, failed
        mtu: 1,
      },
      aws_ground_station_agent_endpoint: {
        name: "SafeName", # required
        egress_address: { # required
          socket_address: { # required
            name: "String", # required
            port: 1, # required
          },
          mtu: 1,
        },
        ingress_address: { # required
          socket_address: { # required
            name: "IpV4Address", # required
            port_range: { # required
              minimum: 1, # required
              maximum: 1, # required
            },
          },
          mtu: 1,
        },
        agent_status: "SUCCESS", # accepts SUCCESS, FAILED, ACTIVE, INACTIVE
        audit_results: "HEALTHY", # accepts HEALTHY, UNHEALTHY
      },
      uplink_aws_ground_station_agent_endpoint: {
        name: "SafeName", # required
        dataflow_details: { # required
          agent_connection_details: {
            ingress_address_and_port: { # required
              socket_address: { # required
                name: "String", # required
                port: 1, # required
              },
              mtu: 1,
            },
            agent_ip_and_port_address: { # required
              socket_address: { # required
                name: "IpV4Address", # required
                port_range: { # required
                  minimum: 1, # required
                  maximum: 1, # required
                },
              },
              mtu: 1,
            },
          },
        },
        agent_status: "SUCCESS", # accepts SUCCESS, FAILED, ACTIVE, INACTIVE
        audit_results: "HEALTHY", # accepts HEALTHY, UNHEALTHY
      },
      downlink_aws_ground_station_agent_endpoint: {
        name: "SafeName", # required
        dataflow_details: { # required
          agent_connection_details: {
            agent_ip_and_port_address: { # required
              socket_address: { # required
                name: "IpV4Address", # required
                port_range: { # required
                  minimum: 1, # required
                  maximum: 1, # required
                },
              },
              mtu: 1,
            },
            egress_address_and_port: { # required
              socket_address: { # required
                name: "String", # required
                port: 1, # required
              },
              mtu: 1,
            },
          },
        },
        agent_status: "SUCCESS", # accepts SUCCESS, FAILED, ACTIVE, INACTIVE
        audit_results: "HEALTHY", # accepts HEALTHY, UNHEALTHY
      },
      health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY
      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
    },
  ],
  tags: {
    "String" => "String",
  },
  contact_pre_pass_duration_seconds: 1,
  contact_post_pass_duration_seconds: 1,
})

Response structure


resp.dataflow_endpoint_group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :endpoint_details (required, Array<Types::EndpointDetails>) —

    Endpoint details of each endpoint in the dataflow endpoint group. All dataflow endpoints within a single dataflow endpoint group must be of the same type. You cannot mix AWS Ground Station Agent endpoints with Dataflow endpoints in the same group. If your use case requires both types of endpoints, you must create separate dataflow endpoint groups for each type.

  • :tags (Hash<String,String>) —

    Tags of a dataflow endpoint group.

  • :contact_pre_pass_duration_seconds (Integer) —

    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.

  • :contact_post_pass_duration_seconds (Integer) —

    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.

Returns:

See Also:



805
806
807
808
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 805

def create_dataflow_endpoint_group(params = {}, options = {})
  req = build_request(:create_dataflow_endpoint_group, params)
  req.send_request(options)
end

#create_dataflow_endpoint_group_v2(params = {}) ⇒ Types::CreateDataflowEndpointGroupV2Response

Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints.

The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.

When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

Examples:

Request syntax with placeholder values


resp = client.create_dataflow_endpoint_group_v2({
  endpoints: [ # required
    {
      uplink_aws_ground_station_agent_endpoint: {
        name: "SafeName", # required
        dataflow_details: { # required
          agent_connection_details: {
            ingress_address_and_port: { # required
              socket_address: { # required
                name: "String", # required
                port: 1, # required
              },
              mtu: 1,
            },
            agent_ip_and_port_address: { # required
              socket_address: { # required
                name: "IpV4Address", # required
                port_range: { # required
                  minimum: 1, # required
                  maximum: 1, # required
                },
              },
              mtu: 1,
            },
          },
        },
      },
      downlink_aws_ground_station_agent_endpoint: {
        name: "SafeName", # required
        dataflow_details: { # required
          agent_connection_details: {
            agent_ip_and_port_address: { # required
              socket_address: { # required
                name: "IpV4Address", # required
                port_range: { # required
                  minimum: 1, # required
                  maximum: 1, # required
                },
              },
              mtu: 1,
            },
            egress_address_and_port: { # required
              socket_address: { # required
                name: "String", # required
                port: 1, # required
              },
              mtu: 1,
            },
          },
        },
      },
    },
  ],
  contact_pre_pass_duration_seconds: 1,
  contact_post_pass_duration_seconds: 1,
  tags: {
    "String" => "String",
  },
})

Response structure


resp.dataflow_endpoint_group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :endpoints (required, Array<Types::CreateEndpointDetails>) —

    Dataflow endpoint group's endpoint definitions

  • :contact_pre_pass_duration_seconds (Integer) —

    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.

  • :contact_post_pass_duration_seconds (Integer) —

    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.

  • :tags (Hash<String,String>) —

    Tags of a V2 dataflow endpoint group.

Returns:

See Also:



922
923
924
925
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 922

def create_dataflow_endpoint_group_v2(params = {}, options = {})
  req = build_request(:create_dataflow_endpoint_group_v2, params)
  req.send_request(options)
end

#create_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse

Create an ephemeris with your specified EphemerisData.

Examples:

Request syntax with placeholder values


resp = client.create_ephemeris({
  satellite_id: "Uuid",
  enabled: false,
  priority: 1,
  expiration_time: Time.now,
  name: "SafeName", # required
  kms_key_arn: "KeyArn",
  ephemeris: {
    tle: {
      s3_object: {
        bucket: "S3BucketName",
        key: "S3ObjectKey",
        version: "S3VersionId",
      },
      tle_data: [
        {
          tle_line_1: "TleLineOne", # required
          tle_line_2: "TleLineTwo", # required
          valid_time_range: { # required
            start_time: Time.now, # required
            end_time: Time.now, # required
          },
        },
      ],
    },
    oem: {
      s3_object: {
        bucket: "S3BucketName",
        key: "S3ObjectKey",
        version: "S3VersionId",
      },
      oem_data: "UnboundedString",
    },
    az_el: {
      ground_station: "GroundStationName", # required
      data: { # required
        s3_object: {
          bucket: "S3BucketName",
          key: "S3ObjectKey",
          version: "S3VersionId",
        },
        az_el_data: {
          angle_unit: "DEGREE_ANGLE", # required, accepts DEGREE_ANGLE, RADIAN
          az_el_segment_list: [ # required
            {
              reference_epoch: Time.now, # required
              valid_time_range: { # required
                start_time: Time.now, # required
                end_time: Time.now, # required
              },
              az_el_list: [ # required
                {
                  dt: 1.0, # required
                  az: 1.0, # required
                  el: 1.0, # required
                },
              ],
            },
          ],
        },
      },
    },
  },
  tags: {
    "String" => "String",
  },
})

Response structure


resp.ephemeris_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :satellite_id (String) —

    The satellite ID that associates this ephemeris with a satellite in AWS Ground Station.

  • :enabled (Boolean) —

    Set to true to enable the ephemeris after validation. Set to false to keep it disabled.

  • :priority (Integer) —

    A priority score that determines which ephemeris to use when multiple ephemerides overlap.

    Higher numbers take precedence. The default is 1. Must be 1 or greater.

  • :expiration_time (Time, DateTime, Date, Integer, String) —

    An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.

  • :name (required, String) —

    A name that you can use to identify the ephemeris.

  • :kms_key_arn (String) —

    The ARN of the KMS key to use for encrypting the ephemeris.

  • :ephemeris (Types::EphemerisData) —

    Ephemeris data.

  • :tags (Hash<String,String>) —

    Tags assigned to an ephemeris.

Returns:

See Also:



1042
1043
1044
1045
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1042

def create_ephemeris(params = {}, options = {})
  req = build_request(:create_ephemeris, params)
  req.send_request(options)
end

#create_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse

Creates a mission profile.

dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.

Examples:

Request syntax with placeholder values


resp = client.create_mission_profile({
  name: "SafeName", # required
  contact_pre_pass_duration_seconds: 1,
  contact_post_pass_duration_seconds: 1,
  minimum_viable_contact_duration_seconds: 1, # required
  dataflow_edges: [ # required
    ["ConfigArn"],
  ],
  tracking_config_arn: "ConfigArn", # required
  telemetry_sink_config_arn: "ConfigArn",
  tags: {
    "String" => "String",
  },
  streams_kms_key: {
    kms_key_arn: "KeyArn",
    kms_alias_arn: "KeyAliasArn",
    kms_alias_name: "KeyAliasName",
  },
  streams_kms_role: "RoleArn",
})

Response structure


resp.mission_profile_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    Name of a mission profile.

  • :contact_pre_pass_duration_seconds (Integer) —

    Amount of time prior to contact start you'd like to receive a Ground Station Contact State Change event indicating an upcoming pass.

  • :contact_post_pass_duration_seconds (Integer) —

    Amount of time after a contact ends that you'd like to receive a Ground Station Contact State Change event indicating the pass has finished.

  • :minimum_viable_contact_duration_seconds (required, Integer) —

    Smallest amount of time in seconds that you'd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

  • :dataflow_edges (required, Array<Array>) —

    A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

  • :tracking_config_arn (required, String) —

    ARN of a tracking Config.

  • :telemetry_sink_config_arn (String) —

    ARN of a telemetry sink Config.

  • :tags (Hash<String,String>) —

    Tags assigned to a mission profile.

  • :streams_kms_key (Types::KmsKey) —

    KMS key to use for encrypting streams.

  • :streams_kms_role (String) —

    Role to use for encrypting streams with KMS key.

Returns:

See Also:



1123
1124
1125
1126
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1123

def create_mission_profile(params = {}, options = {})
  req = build_request(:create_mission_profile, params)
  req.send_request(options)
end

#delete_config(params = {}) ⇒ Types::ConfigIdResponse

Deletes a Config.

Examples:

Request syntax with placeholder values


resp = client.delete_config({
  config_id: "Uuid", # required
  config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, tracking, dataflow-endpoint, antenna-uplink, uplink-echo, s3-recording, telemetry-sink
})

Response structure


resp.config_id #=> String
resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.config_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_id (required, String) —

    UUID of a Config.

  • :config_type (required, String) —

    Type of a Config.

Returns:

See Also:



1159
1160
1161
1162
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1159

def delete_config(params = {}, options = {})
  req = build_request(:delete_config, params)
  req.send_request(options)
end

#delete_dataflow_endpoint_group(params = {}) ⇒ Types::DataflowEndpointGroupIdResponse

Deletes a dataflow endpoint group.

Examples:

Request syntax with placeholder values


resp = client.delete_dataflow_endpoint_group({
  dataflow_endpoint_group_id: "Uuid", # required
})

Response structure


resp.dataflow_endpoint_group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataflow_endpoint_group_id (required, String) —

    UUID of a dataflow endpoint group.

Returns:

See Also:



1187
1188
1189
1190
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1187

def delete_dataflow_endpoint_group(params = {}, options = {})
  req = build_request(:delete_dataflow_endpoint_group, params)
  req.send_request(options)
end

#delete_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse

Delete an ephemeris.

Examples:

Request syntax with placeholder values


resp = client.delete_ephemeris({
  ephemeris_id: "Uuid", # required
})

Response structure


resp.ephemeris_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ephemeris_id (required, String) —

    The AWS Ground Station ephemeris ID.

Returns:

See Also:



1215
1216
1217
1218
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1215

def delete_ephemeris(params = {}, options = {})
  req = build_request(:delete_ephemeris, params)
  req.send_request(options)
end

#delete_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse

Deletes a mission profile.

Examples:

Request syntax with placeholder values


resp = client.delete_mission_profile({
  mission_profile_id: "Uuid", # required
})

Response structure


resp.mission_profile_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mission_profile_id (required, String) —

    UUID of a mission profile.

Returns:

See Also:



1243
1244
1245
1246
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1243

def delete_mission_profile(params = {}, options = {})
  req = build_request(:delete_mission_profile, params)
  req.send_request(options)
end

#describe_contact(params = {}) ⇒ Types::DescribeContactResponse

Describes an existing contact.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • contact_scheduled

Examples:

Request syntax with placeholder values


resp = client.describe_contact({
  contact_id: "Uuid", # required
})

Response structure


resp.contact_id #=> String
resp.mission_profile_arn #=> String
resp.satellite_arn #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.pre_pass_start_time #=> Time
resp.post_pass_end_time #=> Time
resp.ground_station #=> String
resp.contact_status #=> String, one of "SCHEDULING", "FAILED_TO_SCHEDULE", "SCHEDULED", "CANCELLED", "AWS_CANCELLED", "PREPASS", "PASS", "POSTPASS", "COMPLETED", "FAILED", "AVAILABLE", "CANCELLING", "AWS_FAILED"
resp.error_message #=> String
resp.maximum_elevation.value #=> Float
resp.maximum_elevation.unit #=> String, one of "DEGREE_ANGLE", "RADIAN"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.region #=> String
resp.dataflow_list #=> Array
resp.dataflow_list[0].source.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.dataflow_list[0].source.config_id #=> 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
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.role_arn #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.name #=> String
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.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.port #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].source.config_details.endpoint_details.health_status #=> String, one of "HEALTHY", "UNHEALTHY"
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.antenna_demod_decode_details.output_node #=> String
resp.dataflow_list[0].source.config_details.s3_recording_details.bucket_arn #=> String
resp.dataflow_list[0].source.config_details.s3_recording_details.key_template #=> String
resp.dataflow_list[0].source.dataflow_source_region #=> String
resp.dataflow_list[0].destination.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.dataflow_list[0].destination.config_id #=> 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
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.role_arn #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.name #=> String
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.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.port #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].destination.config_details.endpoint_details.health_status #=> String, one of "HEALTHY", "UNHEALTHY"
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.antenna_demod_decode_details.output_node #=> String
resp.dataflow_list[0].destination.config_details.s3_recording_details.bucket_arn #=> String
resp.dataflow_list[0].destination.config_details.s3_recording_details.key_template #=> String
resp.dataflow_list[0].destination.dataflow_destination_region #=> String
resp.dataflow_list[0].error_message #=> String
resp.visibility_start_time #=> Time
resp.visibility_end_time #=> Time
resp.tracking_overrides.program_track_settings.az_el.ephemeris_id #=> String
resp.tracking_overrides.program_track_settings.oem.ephemeris_id #=> String
resp.tracking_overrides.program_track_settings.tle.ephemeris_id #=> String
resp.ephemeris.ephemeris_id #=> String
resp.ephemeris.ephemeris_type #=> String, one of "TLE", "OEM", "AZ_EL", "SERVICE_MANAGED"
resp.version.version_id #=> Integer
resp.version.created #=> Time
resp.version.activated #=> Time
resp.version.superseded #=> Time
resp.version.last_updated #=> Time
resp.version.status #=> String, one of "UPDATING", "ACTIVE", "SUPERSEDED", "FAILED_TO_UPDATE"
resp.version.failure_codes #=> Array
resp.version.failure_codes[0] #=> String, one of "INTERNAL_ERROR", "INVALID_SATELLITE_ARN", "INVALID_UPDATE_CONTACT_REQUEST", "EPHEMERIS_NOT_FOUND", "EPHEMERIS_TIME_RANGE_INVALID", "EPHEMERIS_NOT_ENABLED", "SATELLITE_DOES_NOT_MATCH_EPHEMERIS", "NOT_ONBOARDED_TO_AZEL_EPHEMERIS", "AZEL_EPHEMERIS_NOT_FOUND", "AZEL_EPHEMERIS_WRONG_GROUND_STATION", "AZEL_EPHEMERIS_INVALID_STATUS", "AZEL_EPHEMERIS_TIME_RANGE_INVALID"
resp.version.failure_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    UUID of a contact.

Returns:

See Also:



1424
1425
1426
1427
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1424

def describe_contact(params = {}, options = {})
  req = build_request(:describe_contact, params)
  req.send_request(options)
end

#describe_contact_version(params = {}) ⇒ Types::DescribeContactVersionResponse

Describes a specific version of a contact.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • contact_updated

Examples:

Request syntax with placeholder values


resp = client.describe_contact_version({
  contact_id: "Uuid", # required
  version_id: 1, # required
})

Response structure


resp.contact_id #=> String
resp.mission_profile_arn #=> String
resp.satellite_arn #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.pre_pass_start_time #=> Time
resp.post_pass_end_time #=> Time
resp.ground_station #=> String
resp.contact_status #=> String, one of "SCHEDULING", "FAILED_TO_SCHEDULE", "SCHEDULED", "CANCELLED", "AWS_CANCELLED", "PREPASS", "PASS", "POSTPASS", "COMPLETED", "FAILED", "AVAILABLE", "CANCELLING", "AWS_FAILED"
resp.error_message #=> String
resp.maximum_elevation.value #=> Float
resp.maximum_elevation.unit #=> String, one of "DEGREE_ANGLE", "RADIAN"
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.region #=> String
resp.dataflow_list #=> Array
resp.dataflow_list[0].source.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.dataflow_list[0].source.config_id #=> 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
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.role_arn #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.name #=> String
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.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.port #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].source.config_details.endpoint_details.aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].source.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].source.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].source.config_details.endpoint_details.health_status #=> String, one of "HEALTHY", "UNHEALTHY"
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.antenna_demod_decode_details.output_node #=> String
resp.dataflow_list[0].source.config_details.s3_recording_details.bucket_arn #=> String
resp.dataflow_list[0].source.config_details.s3_recording_details.key_template #=> String
resp.dataflow_list[0].source.dataflow_source_region #=> String
resp.dataflow_list[0].destination.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.dataflow_list[0].destination.config_id #=> 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
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.role_arn #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.name #=> String
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.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.socket_address.port #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.ingress_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].destination.config_details.endpoint_details.aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].destination.config_details.endpoint_details.uplink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.port #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.dataflow_list[0].destination.config_details.endpoint_details.downlink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.dataflow_list[0].destination.config_details.endpoint_details.health_status #=> String, one of "HEALTHY", "UNHEALTHY"
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.antenna_demod_decode_details.output_node #=> String
resp.dataflow_list[0].destination.config_details.s3_recording_details.bucket_arn #=> String
resp.dataflow_list[0].destination.config_details.s3_recording_details.key_template #=> String
resp.dataflow_list[0].destination.dataflow_destination_region #=> String
resp.dataflow_list[0].error_message #=> String
resp.visibility_start_time #=> Time
resp.visibility_end_time #=> Time
resp.tracking_overrides.program_track_settings.az_el.ephemeris_id #=> String
resp.tracking_overrides.program_track_settings.oem.ephemeris_id #=> String
resp.tracking_overrides.program_track_settings.tle.ephemeris_id #=> String
resp.ephemeris.ephemeris_id #=> String
resp.ephemeris.ephemeris_type #=> String, one of "TLE", "OEM", "AZ_EL", "SERVICE_MANAGED"
resp.version.version_id #=> Integer
resp.version.created #=> Time
resp.version.activated #=> Time
resp.version.superseded #=> Time
resp.version.last_updated #=> Time
resp.version.status #=> String, one of "UPDATING", "ACTIVE", "SUPERSEDED", "FAILED_TO_UPDATE"
resp.version.failure_codes #=> Array
resp.version.failure_codes[0] #=> String, one of "INTERNAL_ERROR", "INVALID_SATELLITE_ARN", "INVALID_UPDATE_CONTACT_REQUEST", "EPHEMERIS_NOT_FOUND", "EPHEMERIS_TIME_RANGE_INVALID", "EPHEMERIS_NOT_ENABLED", "SATELLITE_DOES_NOT_MATCH_EPHEMERIS", "NOT_ONBOARDED_TO_AZEL_EPHEMERIS", "AZEL_EPHEMERIS_NOT_FOUND", "AZEL_EPHEMERIS_WRONG_GROUND_STATION", "AZEL_EPHEMERIS_INVALID_STATUS", "AZEL_EPHEMERIS_TIME_RANGE_INVALID"
resp.version.failure_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    UUID of a contact.

  • :version_id (required, Integer) —

    Version ID of a contact.

Returns:

See Also:



1609
1610
1611
1612
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1609

def describe_contact_version(params = {}, options = {})
  req = build_request(:describe_contact_version, params)
  req.send_request(options)
end

#describe_ephemeris(params = {}) ⇒ Types::DescribeEphemerisResponse

Retrieve information about an existing ephemeris.

Examples:

Request syntax with placeholder values


resp = client.describe_ephemeris({
  ephemeris_id: "Uuid", # required
})

Response structure


resp.ephemeris_id #=> String
resp.satellite_id #=> String
resp.status #=> String, one of "VALIDATING", "INVALID", "ERROR", "ENABLED", "DISABLED", "EXPIRED"
resp.priority #=> Integer
resp.creation_time #=> Time
resp.enabled #=> Boolean
resp.name #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.supplied_data.tle.source_s3_object.bucket #=> String
resp.supplied_data.tle.source_s3_object.key #=> String
resp.supplied_data.tle.source_s3_object.version #=> String
resp.supplied_data.tle.ephemeris_data #=> String
resp.supplied_data.oem.source_s3_object.bucket #=> String
resp.supplied_data.oem.source_s3_object.key #=> String
resp.supplied_data.oem.source_s3_object.version #=> String
resp.supplied_data.oem.ephemeris_data #=> String
resp.supplied_data.az_el.source_s3_object.bucket #=> String
resp.supplied_data.az_el.source_s3_object.key #=> String
resp.supplied_data.az_el.source_s3_object.version #=> String
resp.supplied_data.az_el.ephemeris_data #=> String
resp.invalid_reason #=> String, one of "METADATA_INVALID", "TIME_RANGE_INVALID", "TRAJECTORY_INVALID", "KMS_KEY_INVALID", "VALIDATION_ERROR"
resp.error_reasons #=> Array
resp.error_reasons[0].error_code #=> String, one of "INTERNAL_ERROR", "MISMATCHED_SATCAT_ID", "OEM_VERSION_UNSUPPORTED", "ORIGINATOR_MISSING", "CREATION_DATE_MISSING", "OBJECT_NAME_MISSING", "OBJECT_ID_MISSING", "REF_FRAME_UNSUPPORTED", "REF_FRAME_EPOCH_UNSUPPORTED", "TIME_SYSTEM_UNSUPPORTED", "CENTER_BODY_UNSUPPORTED", "INTERPOLATION_MISSING", "INTERPOLATION_DEGREE_INVALID", "AZ_EL_SEGMENT_LIST_MISSING", "INSUFFICIENT_TIME_AZ_EL", "START_TIME_IN_FUTURE", "END_TIME_IN_PAST", "EXPIRATION_TIME_TOO_EARLY", "START_TIME_METADATA_TOO_EARLY", "STOP_TIME_METADATA_TOO_LATE", "AZ_EL_SEGMENT_END_TIME_BEFORE_START_TIME", "AZ_EL_SEGMENT_TIMES_OVERLAP", "AZ_EL_SEGMENTS_OUT_OF_ORDER", "TIME_AZ_EL_ITEMS_OUT_OF_ORDER", "MEAN_MOTION_INVALID", "TIME_AZ_EL_AZ_RADIAN_RANGE_INVALID", "TIME_AZ_EL_EL_RADIAN_RANGE_INVALID", "TIME_AZ_EL_AZ_DEGREE_RANGE_INVALID", "TIME_AZ_EL_EL_DEGREE_RANGE_INVALID", "TIME_AZ_EL_ANGLE_UNITS_INVALID", "INSUFFICIENT_KMS_PERMISSIONS", "FILE_FORMAT_INVALID", "AZ_EL_SEGMENT_REFERENCE_EPOCH_INVALID", "AZ_EL_SEGMENT_START_TIME_INVALID", "AZ_EL_SEGMENT_END_TIME_INVALID", "AZ_EL_SEGMENT_VALID_TIME_RANGE_INVALID", "AZ_EL_SEGMENT_END_TIME_TOO_LATE", "AZ_EL_TOTAL_DURATION_EXCEEDED"
resp.error_reasons[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ephemeris_id (required, String) —

    The AWS Ground Station ephemeris ID.

Returns:

See Also:



1671
1672
1673
1674
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1671

def describe_ephemeris(params = {}, options = {})
  req = build_request(:describe_ephemeris, params)
  req.send_request(options)
end

#get_agent_configuration(params = {}) ⇒ Types::GetAgentConfigurationResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

Gets the latest configuration information for a registered agent.

Examples:

Request syntax with placeholder values


resp = client.get_agent_configuration({
  agent_id: "Uuid", # required
})

Response structure


resp.agent_id #=> String
resp.tasking_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    UUID of agent to get configuration information for.

Returns:

See Also:



1706
1707
1708
1709
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1706

def get_agent_configuration(params = {}, options = {})
  req = build_request(:get_agent_configuration, params)
  req.send_request(options)
end

#get_agent_task_response_url(params = {}) ⇒ Types::GetAgentTaskResponseUrlResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

Gets a presigned URL for uploading agent task response logs.

Examples:

Request syntax with placeholder values


resp = client.get_agent_task_response_url({
  agent_id: "Uuid", # required
  task_id: "Uuid", # required
})

Response structure


resp.agent_id #=> String
resp.task_id #=> String
resp.presigned_log_url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    UUID of agent requesting the response URL.

  • :task_id (required, String) —

    GUID of the agent task for which the response URL is being requested.

Returns:

See Also:



1747
1748
1749
1750
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1747

def get_agent_task_response_url(params = {}, options = {})
  req = build_request(:get_agent_task_response_url, params)
  req.send_request(options)
end

#get_config(params = {}) ⇒ Types::GetConfigResponse

Returns Config information.

Only one Config response can be returned.

Examples:

Request syntax with placeholder values


resp = client.get_config({
  config_id: "Uuid", # required
  config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, tracking, dataflow-endpoint, antenna-uplink, uplink-echo, s3-recording, telemetry-sink
})

Response structure


resp.config_id #=> String
resp.config_arn #=> String
resp.name #=> String
resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.config_data.antenna_downlink_config.spectrum_config.center_frequency.value #=> Float
resp.config_data.antenna_downlink_config.spectrum_config.center_frequency.units #=> String, one of "GHz", "MHz", "kHz"
resp.config_data.antenna_downlink_config.spectrum_config.bandwidth.value #=> Float
resp.config_data.antenna_downlink_config.spectrum_config.bandwidth.units #=> String, one of "GHz", "MHz", "kHz"
resp.config_data.antenna_downlink_config.spectrum_config.polarization #=> String, one of "RIGHT_HAND", "LEFT_HAND", "NONE"
resp.config_data.tracking_config.autotrack #=> String, one of "REQUIRED", "PREFERRED", "REMOVED"
resp.config_data.dataflow_endpoint_config.dataflow_endpoint_name #=> String
resp.config_data.dataflow_endpoint_config.dataflow_endpoint_region #=> String
resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.center_frequency.value #=> Float
resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.center_frequency.units #=> String, one of "GHz", "MHz", "kHz"
resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.bandwidth.value #=> Float
resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.bandwidth.units #=> String, one of "GHz", "MHz", "kHz"
resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.polarization #=> String, one of "RIGHT_HAND", "LEFT_HAND", "NONE"
resp.config_data.antenna_downlink_demod_decode_config.demodulation_config.unvalidated_json #=> String
resp.config_data.antenna_downlink_demod_decode_config.decode_config.unvalidated_json #=> String
resp.config_data.antenna_uplink_config.transmit_disabled #=> Boolean
resp.config_data.antenna_uplink_config.spectrum_config.center_frequency.value #=> Float
resp.config_data.antenna_uplink_config.spectrum_config.center_frequency.units #=> String, one of "GHz", "MHz", "kHz"
resp.config_data.antenna_uplink_config.spectrum_config.polarization #=> String, one of "RIGHT_HAND", "LEFT_HAND", "NONE"
resp.config_data.antenna_uplink_config.target_eirp.value #=> Float
resp.config_data.antenna_uplink_config.target_eirp.units #=> String, one of "dBW"
resp.config_data.uplink_echo_config.enabled #=> Boolean
resp.config_data.uplink_echo_config.antenna_uplink_config_arn #=> String
resp.config_data.s3_recording_config.bucket_arn #=> String
resp.config_data.s3_recording_config.role_arn #=> String
resp.config_data.s3_recording_config.prefix #=> String
resp.config_data.telemetry_sink_config.telemetry_sink_type #=> String, one of "KINESIS_DATA_STREAM"
resp.config_data.telemetry_sink_config.telemetry_sink_data.kinesis_data_stream_data.kinesis_role_arn #=> String
resp.config_data.telemetry_sink_config.telemetry_sink_data.kinesis_data_stream_data.kinesis_data_stream_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_id (required, String) —

    UUID of a Config.

  • :config_type (required, String) —

    Type of a Config.

Returns:

See Also:



1820
1821
1822
1823
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1820

def get_config(params = {}, options = {})
  req = build_request(:get_config, params)
  req.send_request(options)
end

#get_dataflow_endpoint_group(params = {}) ⇒ Types::GetDataflowEndpointGroupResponse

Returns the dataflow endpoint group.

Examples:

Request syntax with placeholder values


resp = client.get_dataflow_endpoint_group({
  dataflow_endpoint_group_id: "Uuid", # required
})

Response structure


resp.dataflow_endpoint_group_id #=> String
resp.dataflow_endpoint_group_arn #=> String
resp.endpoints_details #=> Array
resp.endpoints_details[0].security_details.subnet_ids #=> Array
resp.endpoints_details[0].security_details.subnet_ids[0] #=> 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.role_arn #=> String
resp.endpoints_details[0].endpoint.name #=> String
resp.endpoints_details[0].endpoint.address.name #=> String
resp.endpoints_details[0].endpoint.address.port #=> Integer
resp.endpoints_details[0].endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.endpoints_details[0].endpoint.mtu #=> Integer
resp.endpoints_details[0].aws_ground_station_agent_endpoint.name #=> String
resp.endpoints_details[0].aws_ground_station_agent_endpoint.egress_address.socket_address.name #=> String
resp.endpoints_details[0].aws_ground_station_agent_endpoint.egress_address.socket_address.port #=> Integer
resp.endpoints_details[0].aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
resp.endpoints_details[0].aws_ground_station_agent_endpoint.ingress_address.socket_address.name #=> String
resp.endpoints_details[0].aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.minimum #=> Integer
resp.endpoints_details[0].aws_ground_station_agent_endpoint.ingress_address.socket_address.port_range.maximum #=> Integer
resp.endpoints_details[0].aws_ground_station_agent_endpoint.ingress_address.mtu #=> Integer
resp.endpoints_details[0].aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.endpoints_details[0].aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.name #=> String
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.name #=> String
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.socket_address.port #=> Integer
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.ingress_address_and_port.mtu #=> Integer
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.endpoints_details[0].uplink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.name #=> String
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.name #=> String
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.minimum #=> Integer
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.socket_address.port_range.maximum #=> Integer
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.agent_ip_and_port_address.mtu #=> Integer
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.name #=> String
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.socket_address.port #=> Integer
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.dataflow_details.agent_connection_details.egress_address_and_port.mtu #=> Integer
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.agent_status #=> String, one of "SUCCESS", "FAILED", "ACTIVE", "INACTIVE"
resp.endpoints_details[0].downlink_aws_ground_station_agent_endpoint.audit_results #=> String, one of "HEALTHY", "UNHEALTHY"
resp.endpoints_details[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY"
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.tags #=> Hash
resp.tags["String"] #=> String
resp.contact_pre_pass_duration_seconds #=> Integer
resp.contact_post_pass_duration_seconds #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataflow_endpoint_group_id (required, String) —

    UUID of a dataflow endpoint group.

Returns:

See Also:



1902
1903
1904
1905
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1902

def get_dataflow_endpoint_group(params = {}, options = {})
  req = build_request(:get_dataflow_endpoint_group, params)
  req.send_request(options)
end

#get_minute_usage(params = {}) ⇒ Types::GetMinuteUsageResponse

Returns the number of reserved minutes used by account.

Examples:

Request syntax with placeholder values


resp = client.get_minute_usage({
  month: 1, # required
  year: 1, # required
})

Response structure


resp.is_reserved_minutes_customer #=> Boolean
resp.total_reserved_minute_allocation #=> Integer
resp.upcoming_minutes_scheduled #=> Integer
resp.total_scheduled_minutes #=> Integer
resp.estimated_minutes_remaining #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :month (required, Integer) —

    The month being requested, with a value of 1-12.

  • :year (required, Integer) —

    The year being requested, in the format of YYYY.

Returns:

See Also:



1942
1943
1944
1945
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1942

def get_minute_usage(params = {}, options = {})
  req = build_request(:get_minute_usage, params)
  req.send_request(options)
end

#get_mission_profile(params = {}) ⇒ Types::GetMissionProfileResponse

Returns a mission profile.

Examples:

Request syntax with placeholder values


resp = client.get_mission_profile({
  mission_profile_id: "Uuid", # required
})

Response structure


resp.mission_profile_id #=> String
resp.mission_profile_arn #=> String
resp.name #=> String
resp.region #=> String
resp.contact_pre_pass_duration_seconds #=> Integer
resp.contact_post_pass_duration_seconds #=> Integer
resp.minimum_viable_contact_duration_seconds #=> Integer
resp.dataflow_edges #=> Array
resp.dataflow_edges[0] #=> Array
resp.dataflow_edges[0][0] #=> String
resp.tracking_config_arn #=> String
resp.telemetry_sink_config_arn #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.streams_kms_key.kms_key_arn #=> String
resp.streams_kms_key.kms_alias_arn #=> String
resp.streams_kms_key.kms_alias_name #=> String
resp.streams_kms_role #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mission_profile_id (required, String) —

    UUID of a mission profile.

Returns:

See Also:



1999
2000
2001
2002
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1999

def get_mission_profile(params = {}, options = {})
  req = build_request(:get_mission_profile, params)
  req.send_request(options)
end

#get_satellite(params = {}) ⇒ Types::GetSatelliteResponse

Returns a satellite.

Examples:

Request syntax with placeholder values


resp = client.get_satellite({
  satellite_id: "Uuid", # required
})

Response structure


resp.satellite_id #=> String
resp.satellite_arn #=> String
resp.norad_satellite_id #=> Integer
resp.ground_stations #=> Array
resp.ground_stations[0] #=> String
resp.current_ephemeris.source #=> String, one of "CUSTOMER_PROVIDED", "SPACE_TRACK"
resp.current_ephemeris.ephemeris_id #=> String
resp.current_ephemeris.epoch #=> Time
resp.current_ephemeris.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :satellite_id (required, String) —

    UUID of a satellite.

Returns:

See Also:



2039
2040
2041
2042
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2039

def get_satellite(params = {}, options = {})
  req = build_request(:get_satellite, params)
  req.send_request(options)
end

#list_antennas(params = {}) ⇒ Types::ListAntennasResponse

Returns a list of antennas at a specified ground station.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_antennas({
  ground_station_id: "GroundStationName", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.antenna_list #=> Array
resp.antenna_list[0].ground_station_name #=> String
resp.antenna_list[0].antenna_name #=> String
resp.antenna_list[0].region #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ground_station_id (required, String) —

    ID of a ground station.

  • :max_results (Integer) —

    Maximum number of antennas returned.

  • :next_token (String) —

    Next token returned in the request of a previous ListAntennas call. Used to get the next page of results.

Returns:

See Also:



2083
2084
2085
2086
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2083

def list_antennas(params = {}, options = {})
  req = build_request(:list_antennas, params)
  req.send_request(options)
end

#list_configs(params = {}) ⇒ Types::ListConfigsResponse

Returns a list of Config objects.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_configs({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.config_list #=> Array
resp.config_list[0].config_id #=> String
resp.config_list[0].config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.config_list[0].config_arn #=> String
resp.config_list[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of Configs returned.

  • :next_token (String) —

    Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.

Returns:

See Also:



2124
2125
2126
2127
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2124

def list_configs(params = {}, options = {})
  req = build_request(:list_configs, params)
  req.send_request(options)
end

#list_contact_versions(params = {}) ⇒ Types::ListContactVersionsResponse

Returns a list of versions for a specified contact.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_contact_versions({
  contact_id: "Uuid", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.contact_versions_list #=> Array
resp.contact_versions_list[0].version_id #=> Integer
resp.contact_versions_list[0].created #=> Time
resp.contact_versions_list[0].activated #=> Time
resp.contact_versions_list[0].superseded #=> Time
resp.contact_versions_list[0].last_updated #=> Time
resp.contact_versions_list[0].status #=> String, one of "UPDATING", "ACTIVE", "SUPERSEDED", "FAILED_TO_UPDATE"
resp.contact_versions_list[0].failure_codes #=> Array
resp.contact_versions_list[0].failure_codes[0] #=> String, one of "INTERNAL_ERROR", "INVALID_SATELLITE_ARN", "INVALID_UPDATE_CONTACT_REQUEST", "EPHEMERIS_NOT_FOUND", "EPHEMERIS_TIME_RANGE_INVALID", "EPHEMERIS_NOT_ENABLED", "SATELLITE_DOES_NOT_MATCH_EPHEMERIS", "NOT_ONBOARDED_TO_AZEL_EPHEMERIS", "AZEL_EPHEMERIS_NOT_FOUND", "AZEL_EPHEMERIS_WRONG_GROUND_STATION", "AZEL_EPHEMERIS_INVALID_STATUS", "AZEL_EPHEMERIS_TIME_RANGE_INVALID"
resp.contact_versions_list[0].failure_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    UUID of a contact.

  • :max_results (Integer) —

    Maximum number of contact versions returned.

  • :next_token (String) —

    Next token returned in the request of a previous ListContactVersions call. Used to get the next page of results.

Returns:

See Also:



2174
2175
2176
2177
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2174

def list_contact_versions(params = {}, options = {})
  req = build_request(:list_contact_versions, params)
  req.send_request(options)
end

#list_contacts(params = {}) ⇒ Types::ListContactsResponse

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_contacts({
  max_results: 1,
  next_token: "PaginationToken",
  status_list: ["SCHEDULING"], # required, accepts SCHEDULING, FAILED_TO_SCHEDULE, SCHEDULED, CANCELLED, AWS_CANCELLED, PREPASS, PASS, POSTPASS, COMPLETED, FAILED, AVAILABLE, CANCELLING, AWS_FAILED
  start_time: Time.now, # required
  end_time: Time.now, # required
  ground_station: "GroundStationName",
  satellite_arn: "satelliteArn",
  mission_profile_arn: "MissionProfileArn",
  ephemeris: {
    az_el: {
      id: "Uuid", # required
    },
  },
})

Response structure


resp.next_token #=> String
resp.contact_list #=> Array
resp.contact_list[0].contact_id #=> String
resp.contact_list[0].mission_profile_arn #=> String
resp.contact_list[0].satellite_arn #=> String
resp.contact_list[0].start_time #=> Time
resp.contact_list[0].end_time #=> Time
resp.contact_list[0].pre_pass_start_time #=> Time
resp.contact_list[0].post_pass_end_time #=> Time
resp.contact_list[0].ground_station #=> String
resp.contact_list[0].contact_status #=> String, one of "SCHEDULING", "FAILED_TO_SCHEDULE", "SCHEDULED", "CANCELLED", "AWS_CANCELLED", "PREPASS", "PASS", "POSTPASS", "COMPLETED", "FAILED", "AVAILABLE", "CANCELLING", "AWS_FAILED"
resp.contact_list[0].error_message #=> String
resp.contact_list[0].maximum_elevation.value #=> Float
resp.contact_list[0].maximum_elevation.unit #=> String, one of "DEGREE_ANGLE", "RADIAN"
resp.contact_list[0].region #=> String
resp.contact_list[0].tags #=> Hash
resp.contact_list[0].tags["String"] #=> String
resp.contact_list[0].visibility_start_time #=> Time
resp.contact_list[0].visibility_end_time #=> Time
resp.contact_list[0].ephemeris.ephemeris_id #=> String
resp.contact_list[0].ephemeris.ephemeris_type #=> String, one of "TLE", "OEM", "AZ_EL", "SERVICE_MANAGED"
resp.contact_list[0].version.version_id #=> Integer
resp.contact_list[0].version.created #=> Time
resp.contact_list[0].version.activated #=> Time
resp.contact_list[0].version.superseded #=> Time
resp.contact_list[0].version.last_updated #=> Time
resp.contact_list[0].version.status #=> String, one of "UPDATING", "ACTIVE", "SUPERSEDED", "FAILED_TO_UPDATE"
resp.contact_list[0].version.failure_codes #=> Array
resp.contact_list[0].version.failure_codes[0] #=> String, one of "INTERNAL_ERROR", "INVALID_SATELLITE_ARN", "INVALID_UPDATE_CONTACT_REQUEST", "EPHEMERIS_NOT_FOUND", "EPHEMERIS_TIME_RANGE_INVALID", "EPHEMERIS_NOT_ENABLED", "SATELLITE_DOES_NOT_MATCH_EPHEMERIS", "NOT_ONBOARDED_TO_AZEL_EPHEMERIS", "AZEL_EPHEMERIS_NOT_FOUND", "AZEL_EPHEMERIS_WRONG_GROUND_STATION", "AZEL_EPHEMERIS_INVALID_STATUS", "AZEL_EPHEMERIS_TIME_RANGE_INVALID"
resp.contact_list[0].version.failure_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of contacts returned.

  • :next_token (String) —

    Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

  • :status_list (required, Array<String>) —

    Status of a contact reservation.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    Start time of a contact in UTC.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    End time of a contact in UTC.

  • :ground_station (String) —

    Name of a ground station.

  • :satellite_arn (String) —

    ARN of a satellite.

  • :mission_profile_arn (String) —

    ARN of a mission profile.

  • :ephemeris (Types::EphemerisFilter) —

    Filter for selecting contacts that use a specific ephemeris".

Returns:

See Also:



2274
2275
2276
2277
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2274

def list_contacts(params = {}, options = {})
  req = build_request(:list_contacts, params)
  req.send_request(options)
end

#list_dataflow_endpoint_groups(params = {}) ⇒ Types::ListDataflowEndpointGroupsResponse

Returns a list of DataflowEndpoint groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataflow_endpoint_groups({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.dataflow_endpoint_group_list #=> Array
resp.dataflow_endpoint_group_list[0].dataflow_endpoint_group_id #=> String
resp.dataflow_endpoint_group_list[0].dataflow_endpoint_group_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of dataflow endpoint groups returned.

  • :next_token (String) —

    Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

Returns:

See Also:



2314
2315
2316
2317
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2314

def list_dataflow_endpoint_groups(params = {}, options = {})
  req = build_request(:list_dataflow_endpoint_groups, params)
  req.send_request(options)
end

#list_ephemerides(params = {}) ⇒ Types::ListEphemeridesResponse

List your existing ephemerides.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ephemerides({
  satellite_id: "Uuid",
  ephemeris_type: "TLE", # accepts TLE, OEM, AZ_EL, SERVICE_MANAGED
  start_time: Time.now, # required
  end_time: Time.now, # required
  status_list: ["VALIDATING"], # accepts VALIDATING, INVALID, ERROR, ENABLED, DISABLED, EXPIRED
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.ephemerides #=> Array
resp.ephemerides[0].ephemeris_id #=> String
resp.ephemerides[0].ephemeris_type #=> String, one of "TLE", "OEM", "AZ_EL", "SERVICE_MANAGED"
resp.ephemerides[0].status #=> String, one of "VALIDATING", "INVALID", "ERROR", "ENABLED", "DISABLED", "EXPIRED"
resp.ephemerides[0].priority #=> Integer
resp.ephemerides[0].enabled #=> Boolean
resp.ephemerides[0].creation_time #=> Time
resp.ephemerides[0].name #=> String
resp.ephemerides[0].source_s3_object.bucket #=> String
resp.ephemerides[0].source_s3_object.key #=> String
resp.ephemerides[0].source_s3_object.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :satellite_id (String) —

    The AWS Ground Station satellite ID to list ephemeris for.

  • :ephemeris_type (String) —

    Filter ephemerides by type. If not specified, all ephemeris types will be returned.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The start time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The end time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.

  • :status_list (Array<String>) —

    The list of ephemeris status to return.

  • :max_results (Integer) —

    Maximum number of ephemerides to return.

  • :next_token (String) —

    Pagination token.

Returns:

See Also:



2383
2384
2385
2386
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2383

def list_ephemerides(params = {}, options = {})
  req = build_request(:list_ephemerides, params)
  req.send_request(options)
end

#list_ground_station_reservations(params = {}) ⇒ Types::ListGroundStationReservationsResponse

Returns a list of reservations for a specified ground station.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ground_station_reservations({
  ground_station_id: "GroundStationName", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  reservation_types: ["MAINTENANCE"], # accepts MAINTENANCE, CONTACT
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.reservation_list #=> Array
resp.reservation_list[0].reservation_type #=> String, one of "MAINTENANCE", "CONTACT"
resp.reservation_list[0].ground_station_id #=> String
resp.reservation_list[0].antenna_name #=> String
resp.reservation_list[0].start_time #=> Time
resp.reservation_list[0].end_time #=> Time
resp.reservation_list[0].reservation_details.maintenance.maintenance_type #=> String, one of "PLANNED", "UNPLANNED"
resp.reservation_list[0].reservation_details.contact.contact_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ground_station_id (required, String) —

    ID of a ground station.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    Start time of the reservation window in UTC.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    End time of the reservation window in UTC.

  • :reservation_types (Array<String>) —

    Types of reservations to filter by.

  • :max_results (Integer) —

    Maximum number of ground station reservations returned.

  • :next_token (String) —

    Next token returned in the request of a previous ListGroundStationReservations call. Used to get the next page of results.

Returns:

See Also:



2444
2445
2446
2447
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2444

def list_ground_station_reservations(params = {}, options = {})
  req = build_request(:list_ground_station_reservations, params)
  req.send_request(options)
end

#list_ground_stations(params = {}) ⇒ Types::ListGroundStationsResponse

Returns a list of ground stations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ground_stations({
  satellite_id: "Uuid",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.ground_station_list #=> Array
resp.ground_station_list[0].ground_station_id #=> String
resp.ground_station_list[0].ground_station_name #=> String
resp.ground_station_list[0].region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :satellite_id (String) —

    Satellite ID to retrieve on-boarded ground stations.

  • :max_results (Integer) —

    Maximum number of ground stations returned.

  • :next_token (String) —

    Next token that can be supplied in the next call to get the next page of ground stations.

Returns:

See Also:



2488
2489
2490
2491
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2488

def list_ground_stations(params = {}, options = {})
  req = build_request(:list_ground_stations, params)
  req.send_request(options)
end

#list_mission_profiles(params = {}) ⇒ Types::ListMissionProfilesResponse

Returns a list of mission profiles.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_mission_profiles({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.mission_profile_list #=> Array
resp.mission_profile_list[0].mission_profile_id #=> String
resp.mission_profile_list[0].mission_profile_arn #=> String
resp.mission_profile_list[0].region #=> String
resp.mission_profile_list[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of mission profiles returned.

  • :next_token (String) —

    Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.

Returns:

See Also:



2529
2530
2531
2532
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2529

def list_mission_profiles(params = {}, options = {})
  req = build_request(:list_mission_profiles, params)
  req.send_request(options)
end

#list_satellites(params = {}) ⇒ Types::ListSatellitesResponse

Returns a list of satellites.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_satellites({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.satellites #=> Array
resp.satellites[0].satellite_id #=> String
resp.satellites[0].satellite_arn #=> String
resp.satellites[0].norad_satellite_id #=> Integer
resp.satellites[0].ground_stations #=> Array
resp.satellites[0].ground_stations[0] #=> String
resp.satellites[0].current_ephemeris.source #=> String, one of "CUSTOMER_PROVIDED", "SPACE_TRACK"
resp.satellites[0].current_ephemeris.ephemeris_id #=> String
resp.satellites[0].current_ephemeris.epoch #=> Time
resp.satellites[0].current_ephemeris.name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of satellites returned.

  • :next_token (String) —

    Next token that can be supplied in the next call to get the next page of satellites.

Returns:

See Also:



2575
2576
2577
2578
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2575

def list_satellites(params = {}, options = {})
  req = build_request(:list_satellites, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags for a specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AnyArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of a resource.

Returns:

See Also:



2604
2605
2606
2607
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2604

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#register_agent(params = {}) ⇒ Types::RegisterAgentResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

Registers a new agent with AWS Ground Station.

Examples:

Request syntax with placeholder values


resp = client.register_agent({
  discovery_data: { # required
    public_ip_addresses: ["IpV4Address"], # required
    private_ip_addresses: ["IpV4Address"], # required
    capability_arns: ["CapabilityArn"], # required
  },
  agent_details: { # required
    agent_version: "VersionString", # required
    instance_id: "InstanceId", # required
    instance_type: "InstanceType", # required
    reserved_cpu_cores: [1],
    agent_cpu_cores: [1],
    component_versions: [ # required
      {
        component_type: "ComponentTypeString", # required
        versions: ["VersionString"], # required
      },
    ],
  },
  tags: {
    "String" => "String",
  },
})

Response structure


resp.agent_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :discovery_data (required, Types::DiscoveryData) —

    Data for associating an agent with the capabilities it is managing.

  • :agent_details (required, Types::AgentDetails) —

    Detailed information about the agent being registered.

  • :tags (Hash<String,String>) —

    Tags assigned to an Agent.

Returns:

See Also:



2663
2664
2665
2666
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2663

def register_agent(params = {}, options = {})
  req = build_request(:register_agent, params)
  req.send_request(options)
end

#reserve_contact(params = {}) ⇒ Types::ContactIdResponse

Reserves a contact using specified parameters.

Examples:

Request syntax with placeholder values


resp = client.reserve_contact({
  mission_profile_arn: "MissionProfileArn", # required
  satellite_arn: "satelliteArn",
  start_time: Time.now, # required
  end_time: Time.now, # required
  ground_station: "GroundStationName", # required
  tags: {
    "String" => "String",
  },
  tracking_overrides: {
    program_track_settings: {
      az_el: {
        ephemeris_id: "Uuid", # required
      },
      oem: {
        ephemeris_id: "Uuid", # required
      },
      tle: {
        ephemeris_id: "Uuid", # required
      },
    },
  },
})

Response structure


resp.contact_id #=> String
resp.version_id #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mission_profile_arn (required, String) —

    ARN of a mission profile.

  • :satellite_arn (String) —

    ARN of a satellite

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    Start time of a contact in UTC.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    End time of a contact in UTC.

  • :ground_station (required, String) —

    Name of a ground station.

  • :tags (Hash<String,String>) —

    Tags assigned to a contact.

  • :tracking_overrides (Types::TrackingOverrides) —

    Tracking configuration overrides for the contact.

Returns:

See Also:



2731
2732
2733
2734
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2731

def reserve_contact(params = {}, options = {})
  req = build_request(:reserve_contact, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns a tag to a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AnyArn", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of a resource tag.

  • :tags (required, Hash<String,String>) —

    Tags assigned to a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2759
2760
2761
2762
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2759

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deassigns a resource tag.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AnyArn", # required
  tag_keys: ["UnboundedString"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    ARN of a resource.

  • :tag_keys (required, Array<String>) —

    Keys of a resource tag.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2785
2786
2787
2788
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2785

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_agent_status(params = {}) ⇒ Types::UpdateAgentStatusResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

Update the status of the agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent_status({
  agent_id: "Uuid", # required
  task_id: "Uuid", # required
  aggregate_status: { # required
    status: "SUCCESS", # required, accepts SUCCESS, FAILED, ACTIVE, INACTIVE
    signature_map: {
      "String" => false,
    },
  },
  component_statuses: [ # required
    {
      component_type: "ComponentTypeString", # required
      capability_arn: "CapabilityArn", # required
      status: "SUCCESS", # required, accepts SUCCESS, FAILED, ACTIVE, INACTIVE
      bytes_sent: 1,
      bytes_received: 1,
      packets_dropped: 1,
      dataflow_id: "Uuid", # required
    },
  ],
})

Response structure


resp.agent_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    UUID of agent to update.

  • :task_id (required, String) —

    GUID of agent task.

  • :aggregate_status (required, Types::AggregateStatus) —

    Aggregate status for agent.

  • :component_statuses (required, Array<Types::ComponentStatusData>) —

    List of component statuses for agent.

Returns:

See Also:



2845
2846
2847
2848
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2845

def update_agent_status(params = {}, options = {})
  req = build_request(:update_agent_status, params)
  req.send_request(options)
end

#update_config(params = {}) ⇒ Types::ConfigIdResponse

Updates the Config used when scheduling contacts.

Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.

Examples:

Request syntax with placeholder values


resp = client.update_config({
  config_id: "Uuid", # required
  name: "SafeName", # required
  config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, tracking, dataflow-endpoint, antenna-uplink, uplink-echo, s3-recording, telemetry-sink
  config_data: { # required
    antenna_downlink_config: {
      spectrum_config: { # required
        center_frequency: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        bandwidth: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        polarization: "RIGHT_HAND", # accepts RIGHT_HAND, LEFT_HAND, NONE
      },
    },
    tracking_config: {
      autotrack: "REQUIRED", # required, accepts REQUIRED, PREFERRED, REMOVED
    },
    dataflow_endpoint_config: {
      dataflow_endpoint_name: "String", # required
      dataflow_endpoint_region: "String",
    },
    antenna_downlink_demod_decode_config: {
      spectrum_config: { # required
        center_frequency: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        bandwidth: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        polarization: "RIGHT_HAND", # accepts RIGHT_HAND, LEFT_HAND, NONE
      },
      demodulation_config: { # required
        unvalidated_json: "JsonString", # required
      },
      decode_config: { # required
        unvalidated_json: "JsonString", # required
      },
    },
    antenna_uplink_config: {
      transmit_disabled: false,
      spectrum_config: { # required
        center_frequency: { # required
          value: 1.0, # required
          units: "GHz", # required, accepts GHz, MHz, kHz
        },
        polarization: "RIGHT_HAND", # accepts RIGHT_HAND, LEFT_HAND, NONE
      },
      target_eirp: { # required
        value: 1.0, # required
        units: "dBW", # required, accepts dBW
      },
    },
    uplink_echo_config: {
      enabled: false, # required
      antenna_uplink_config_arn: "ConfigArn", # required
    },
    s3_recording_config: {
      bucket_arn: "BucketArn", # required
      role_arn: "RoleArn", # required
      prefix: "S3KeyPrefix",
    },
    telemetry_sink_config: {
      telemetry_sink_type: "KINESIS_DATA_STREAM", # required, accepts KINESIS_DATA_STREAM
      telemetry_sink_data: { # required
        kinesis_data_stream_data: {
          kinesis_role_arn: "RoleArn", # required
          kinesis_data_stream_arn: "KinesisDataStreamArn", # required
        },
      },
    },
  },
})

Response structure


resp.config_id #=> String
resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "tracking", "dataflow-endpoint", "antenna-uplink", "uplink-echo", "s3-recording", "telemetry-sink"
resp.config_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :config_id (required, String) —

    UUID of a Config.

  • :name (required, String) —

    Name of a Config.

  • :config_type (required, String) —

    Type of a Config.

  • :config_data (required, Types::ConfigTypeData) —

    Parameters of a Config.

Returns:

See Also:



2964
2965
2966
2967
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2964

def update_config(params = {}, options = {})
  req = build_request(:update_config, params)
  req.send_request(options)
end

#update_contact(params = {}) ⇒ Types::UpdateContactResponse

Updates a specific contact.

Examples:

Request syntax with placeholder values


resp = client.update_contact({
  contact_id: "Uuid", # required
  client_token: "ClientToken",
  tracking_overrides: {
    program_track_settings: {
      az_el: {
        ephemeris_id: "Uuid", # required
      },
      oem: {
        ephemeris_id: "Uuid", # required
      },
      tle: {
        ephemeris_id: "Uuid", # required
      },
    },
  },
  satellite_arn: "satelliteArn",
})

Response structure


resp.contact_id #=> String
resp.version_id #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    UUID of a contact.

  • :client_token (String) —

    A client token is a unique, case-sensitive string of up to 64 ASCII characters. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tracking_overrides (Types::TrackingOverrides) —

    Overrides the default tracking configuration on an antenna during a contact.

  • :satellite_arn (String) —

    ARN of a satellite.

Returns:

See Also:



3024
3025
3026
3027
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 3024

def update_contact(params = {}, options = {})
  req = build_request(:update_contact, params)
  req.send_request(options)
end

#update_ephemeris(params = {}) ⇒ Types::EphemerisIdResponse

Update an existing ephemeris.

Examples:

Request syntax with placeholder values


resp = client.update_ephemeris({
  ephemeris_id: "Uuid", # required
  enabled: false, # required
  name: "SafeName",
  priority: 1,
})

Response structure


resp.ephemeris_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :ephemeris_id (required, String) —

    The AWS Ground Station ephemeris ID.

  • :enabled (required, Boolean) —

    Enable or disable the ephemeris. Changing this value doesn't require re-validation.

  • :name (String) —

    A name that you can use to identify the ephemeris.

  • :priority (Integer) —

    A priority score that determines which ephemeris to use when multiple ephemerides overlap.

    Higher numbers take precedence. The default is 1. Must be 1 or greater.

Returns:

See Also:



3069
3070
3071
3072
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 3069

def update_ephemeris(params = {}, options = {})
  req = build_request(:update_ephemeris, params)
  req.send_request(options)
end

#update_mission_profile(params = {}) ⇒ Types::MissionProfileIdResponse

Updates a mission profile.

Updating a mission profile will not update the execution parameters for existing future contacts.

Examples:

Request syntax with placeholder values


resp = client.update_mission_profile({
  mission_profile_id: "Uuid", # required
  name: "SafeName",
  contact_pre_pass_duration_seconds: 1,
  contact_post_pass_duration_seconds: 1,
  minimum_viable_contact_duration_seconds: 1,
  dataflow_edges: [
    ["ConfigArn"],
  ],
  tracking_config_arn: "ConfigArn",
  telemetry_sink_config_arn: "ConfigArn",
  streams_kms_key: {
    kms_key_arn: "KeyArn",
    kms_alias_arn: "KeyAliasArn",
    kms_alias_name: "KeyAliasName",
  },
  streams_kms_role: "RoleArn",
})

Response structure


resp.mission_profile_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mission_profile_id (required, String) —

    UUID of a mission profile.

  • :name (String) —

    Name of a mission profile.

  • :contact_pre_pass_duration_seconds (Integer) —

    Amount of time after a contact ends that you'd like to receive a Ground Station Contact State Change event indicating the pass has finished.

  • :contact_post_pass_duration_seconds (Integer) —

    Amount of time after a contact ends that you'd like to receive a Ground Station Contact State Change event indicating the pass has finished.

  • :minimum_viable_contact_duration_seconds (Integer) —

    Smallest amount of time in seconds that you'd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

  • :dataflow_edges (Array<Array>) —

    A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

  • :tracking_config_arn (String) —

    ARN of a tracking Config.

  • :telemetry_sink_config_arn (String) —

    ARN of a telemetry sink Config.

  • :streams_kms_key (Types::KmsKey) —

    KMS key to use for encrypting streams.

  • :streams_kms_role (String) —

    Role to use for encrypting streams with KMS key.

Returns:

See Also:



3149
3150
3151
3152
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 3149

def update_mission_profile(params = {}, options = {})
  req = build_request(:update_mission_profile, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

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 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 #describe_contact 5 180
contact_updated #describe_contact_version 5 180

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



3265
3266
3267
3268
3269
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 3265

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end