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

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

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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)
  • :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.

  • :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.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be a valid HTTP(S) URI.

  • :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.

  • :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.

  • :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 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. 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_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_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :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.



305
306
307
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 305

def initialize(*args)
  super
end

Instance Method Details

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

Cancels a contact with a specified contact ID.

Examples:

Request syntax with placeholder values


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

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    UUID of a contact.

Returns:

See Also:



334
335
336
337
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 334

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({
  config_data: { # required
    antenna_downlink_config: {
      spectrum_config: { # required
        bandwidth: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        center_frequency: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
      },
    },
    antenna_downlink_demod_decode_config: {
      decode_config: { # required
        unvalidated_json: "JsonString", # required
      },
      demodulation_config: { # required
        unvalidated_json: "JsonString", # required
      },
      spectrum_config: { # required
        bandwidth: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        center_frequency: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
      },
    },
    antenna_uplink_config: {
      spectrum_config: { # required
        center_frequency: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
      },
      target_eirp: { # required
        units: "dBW", # required, accepts dBW
        value: 1.0, # required
      },
    },
    dataflow_endpoint_config: {
      dataflow_endpoint_name: "String", # required
      dataflow_endpoint_region: "String",
    },
    tracking_config: {
      autotrack: "PREFERRED", # required, accepts PREFERRED, REMOVED, REQUIRED
    },
    uplink_echo_config: {
      antenna_uplink_config_arn: "ConfigArn", # required
      enabled: false, # required
    },
  },
  name: "SafeName", # required
  tags: {
    "String" => "String",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    Parameters of a Config.

  • :name (required, String) —

    Name of a Config.

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

    Tags assigned to a Config.

Returns:

See Also:



435
436
437
438
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 435

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
    {
      endpoint: {
        address: {
          name: "String", # required
          port: 1, # required
        },
        name: "SafeName",
        status: "created", # accepts created, creating, deleted, deleting, failed
      },
      security_details: {
        role_arn: "RoleArn", # required
        security_group_ids: ["String"], # required
        subnet_ids: ["String"], # required
      },
    },
  ],
  tags: {
    "String" => "String",
  },
})

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.

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

    Tags of a dataflow endpoint group.

Returns:

See Also:



493
494
495
496
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 493

def create_dataflow_endpoint_group(params = {}, options = {})
  req = build_request(:create_dataflow_endpoint_group, 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({
  contact_post_pass_duration_seconds: 1,
  contact_pre_pass_duration_seconds: 1,
  dataflow_edges: [ # required
    ["ConfigArn"],
  ],
  minimum_viable_contact_duration_seconds: 1, # required
  name: "SafeName", # required
  tags: {
    "String" => "String",
  },
  tracking_config_arn: "ConfigArn", # required
})

Response structure


resp.mission_profile_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_post_pass_duration_seconds (Integer) —

    Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

  • :contact_pre_pass_duration_seconds (Integer) —

    Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

  • :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.

  • :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.

  • :name (required, String) —

    Name of a mission profile.

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

    Tags assigned to a mission profile.

  • :tracking_config_arn (required, String) —

    ARN of a tracking Config.

Returns:

See Also:



557
558
559
560
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 557

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: "String", # required
  config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo
})

Response structure


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

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:



593
594
595
596
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 593

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: "String", # 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:



621
622
623
624
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 621

def delete_dataflow_endpoint_group(params = {}, options = {})
  req = build_request(:delete_dataflow_endpoint_group, 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: "String", # 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:



649
650
651
652
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 649

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.contact_id #=> String
resp.contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
resp.end_time #=> Time
resp.error_message #=> String
resp.ground_station #=> String
resp.maximum_elevation.unit #=> String, one of "DEGREE_ANGLE", "RADIAN"
resp.maximum_elevation.value #=> Float
resp.mission_profile_arn #=> String
resp.post_pass_end_time #=> Time
resp.pre_pass_start_time #=> Time
resp.region #=> String
resp.satellite_arn #=> String
resp.start_time #=> Time
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_id (required, String) —

    UUID of a contact.

Returns:

See Also:



703
704
705
706
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 703

def describe_contact(params = {}, options = {})
  req = build_request(:describe_contact, 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: "String", # required
  config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo
})

Response structure


resp.config_arn #=> String
resp.config_data.antenna_downlink_config.spectrum_config.bandwidth.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.center_frequency.units #=> String, one of "GHz", "MHz", "kHz"
resp.config_data.antenna_downlink_config.spectrum_config.center_frequency.value #=> Float
resp.config_data.antenna_downlink_config.spectrum_config.polarization #=> String, one of "LEFT_HAND", "NONE", "RIGHT_HAND"
resp.config_data.antenna_downlink_demod_decode_config.decode_config.unvalidated_json #=> String
resp.config_data.antenna_downlink_demod_decode_config.demodulation_config.unvalidated_json #=> String
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.bandwidth.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.center_frequency.value #=> Float
resp.config_data.antenna_downlink_demod_decode_config.spectrum_config.polarization #=> String, one of "LEFT_HAND", "NONE", "RIGHT_HAND"
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.center_frequency.value #=> Float
resp.config_data.antenna_uplink_config.spectrum_config.polarization #=> String, one of "LEFT_HAND", "NONE", "RIGHT_HAND"
resp.config_data.antenna_uplink_config.target_eirp.units #=> String, one of "dBW"
resp.config_data.antenna_uplink_config.target_eirp.value #=> Float
resp.config_data.dataflow_endpoint_config.dataflow_endpoint_name #=> String
resp.config_data.dataflow_endpoint_config.dataflow_endpoint_region #=> String
resp.config_data.tracking_config.autotrack #=> String, one of "PREFERRED", "REMOVED", "REQUIRED"
resp.config_data.uplink_echo_config.antenna_uplink_config_arn #=> String
resp.config_data.uplink_echo_config.enabled #=> Boolean
resp.config_id #=> String
resp.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo"
resp.name #=> 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:



769
770
771
772
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 769

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: "String", # required
})

Response structure


resp.dataflow_endpoint_group_arn #=> String
resp.dataflow_endpoint_group_id #=> String
resp.endpoints_details #=> Array
resp.endpoints_details[0].endpoint.address.name #=> String
resp.endpoints_details[0].endpoint.address.port #=> Integer
resp.endpoints_details[0].endpoint.name #=> String
resp.endpoints_details[0].endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.endpoints_details[0].security_details.role_arn #=> String
resp.endpoints_details[0].security_details.security_group_ids #=> Array
resp.endpoints_details[0].security_details.security_group_ids[0] #=> String
resp.endpoints_details[0].security_details.subnet_ids #=> Array
resp.endpoints_details[0].security_details.subnet_ids[0] #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :dataflow_endpoint_group_id (required, String) —

    UUID of a dataflow endpoint group.

Returns:

See Also:



813
814
815
816
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 813

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 minutes used by account.

Examples:

Request syntax with placeholder values


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

Response structure


resp.estimated_minutes_remaining #=> Integer
resp.is_reserved_minutes_customer #=> Boolean
resp.total_reserved_minute_allocation #=> Integer
resp.total_scheduled_minutes #=> Integer
resp.upcoming_minutes_scheduled #=> 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:



853
854
855
856
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 853

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: "String", # required
})

Response structure


resp.contact_post_pass_duration_seconds #=> Integer
resp.contact_pre_pass_duration_seconds #=> Integer
resp.dataflow_edges #=> Array
resp.dataflow_edges[0] #=> Array
resp.dataflow_edges[0][0] #=> String
resp.minimum_viable_contact_duration_seconds #=> Integer
resp.mission_profile_arn #=> String
resp.mission_profile_id #=> String
resp.name #=> String
resp.region #=> String
resp.tags #=> Hash
resp.tags["String"] #=> String
resp.tracking_config_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :mission_profile_id (required, String) —

    UUID of a mission profile.

Returns:

See Also:



902
903
904
905
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 902

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: "String", # required
})

Response structure


resp.ground_stations #=> Array
resp.ground_stations[0] #=> String
resp.norad_satellite_id #=> Integer
resp.satellite_arn #=> String
resp.satellite_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :satellite_id (required, String) —

    UUID of a satellite.

Returns:

See Also:



937
938
939
940
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 937

def get_satellite(params = {}, options = {})
  req = build_request(:get_satellite, 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: "String",
})

Response structure


resp.config_list #=> Array
resp.config_list[0].config_arn #=> String
resp.config_list[0].config_id #=> String
resp.config_list[0].config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo"
resp.config_list[0].name #=> String
resp.next_token #=> 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:



978
979
980
981
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 978

def list_configs(params = {}, options = {})
  req = build_request(:list_configs, 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({
  end_time: Time.now, # required
  ground_station: "String",
  max_results: 1,
  mission_profile_arn: "MissionProfileArn",
  next_token: "String",
  satellite_arn: "satelliteArn",
  start_time: Time.now, # required
  status_list: ["AVAILABLE"], # required, accepts AVAILABLE, AWS_CANCELLED, CANCELLED, CANCELLING, COMPLETED, FAILED, FAILED_TO_SCHEDULE, PASS, POSTPASS, PREPASS, SCHEDULED, SCHEDULING
})

Response structure


resp.contact_list #=> Array
resp.contact_list[0].contact_id #=> String
resp.contact_list[0].contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
resp.contact_list[0].end_time #=> Time
resp.contact_list[0].error_message #=> String
resp.contact_list[0].ground_station #=> String
resp.contact_list[0].maximum_elevation.unit #=> String, one of "DEGREE_ANGLE", "RADIAN"
resp.contact_list[0].maximum_elevation.value #=> Float
resp.contact_list[0].mission_profile_arn #=> String
resp.contact_list[0].post_pass_end_time #=> Time
resp.contact_list[0].pre_pass_start_time #=> Time
resp.contact_list[0].region #=> String
resp.contact_list[0].satellite_arn #=> String
resp.contact_list[0].start_time #=> Time
resp.contact_list[0].tags #=> Hash
resp.contact_list[0].tags["String"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    End time of a contact.

  • :ground_station (String) —

    Name of a ground station.

  • :max_results (Integer) —

    Maximum number of contacts returned.

  • :mission_profile_arn (String) —

    ARN of a mission profile.

  • :next_token (String) —

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

  • :satellite_arn (String) —

    ARN of a satellite.

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

    Start time of a contact.

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

    Status of a contact reservation.

Returns:

See Also:



1057
1058
1059
1060
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1057

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: "String",
})

Response structure


resp.dataflow_endpoint_group_list #=> Array
resp.dataflow_endpoint_group_list[0].dataflow_endpoint_group_arn #=> String
resp.dataflow_endpoint_group_list[0].dataflow_endpoint_group_id #=> String
resp.next_token #=> 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:



1097
1098
1099
1100
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1097

def list_dataflow_endpoint_groups(params = {}, options = {})
  req = build_request(:list_dataflow_endpoint_groups, 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({
  max_results: 1,
  next_token: "String",
  satellite_id: "String",
})

Response structure


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
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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.

  • :satellite_id (String) —

    Satellite ID to retrieve on-boarded ground stations.

Returns:

See Also:



1141
1142
1143
1144
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1141

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: "String",
})

Response structure


resp.mission_profile_list #=> Array
resp.mission_profile_list[0].mission_profile_arn #=> String
resp.mission_profile_list[0].mission_profile_id #=> String
resp.mission_profile_list[0].name #=> String
resp.mission_profile_list[0].region #=> String
resp.next_token #=> 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:



1182
1183
1184
1185
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1182

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: "String",
})

Response structure


resp.next_token #=> String
resp.satellites #=> Array
resp.satellites[0].ground_stations #=> Array
resp.satellites[0].ground_stations[0] #=> String
resp.satellites[0].norad_satellite_id #=> Integer
resp.satellites[0].satellite_arn #=> String
resp.satellites[0].satellite_id #=> 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:



1224
1225
1226
1227
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1224

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: "String", # 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:



1253
1254
1255
1256
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1253

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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({
  end_time: Time.now, # required
  ground_station: "String", # required
  mission_profile_arn: "MissionProfileArn", # required
  satellite_arn: "satelliteArn", # required
  start_time: Time.now, # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.contact_id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    End time of a contact.

  • :ground_station (required, String) —

    Name of a ground station.

  • :mission_profile_arn (required, String) —

    ARN of a mission profile.

  • :satellite_arn (required, String) —

    ARN of a satellite

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

    Start time of a contact.

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

    Tags assigned to a contact.

Returns:

See Also:



1303
1304
1305
1306
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1303

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: "String", # 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:



1331
1332
1333
1334
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1331

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: "String", # required
  tag_keys: ["String"], # 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:



1357
1358
1359
1360
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1357

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, 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_data: { # required
    antenna_downlink_config: {
      spectrum_config: { # required
        bandwidth: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        center_frequency: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
      },
    },
    antenna_downlink_demod_decode_config: {
      decode_config: { # required
        unvalidated_json: "JsonString", # required
      },
      demodulation_config: { # required
        unvalidated_json: "JsonString", # required
      },
      spectrum_config: { # required
        bandwidth: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        center_frequency: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
      },
    },
    antenna_uplink_config: {
      spectrum_config: { # required
        center_frequency: { # required
          units: "GHz", # required, accepts GHz, MHz, kHz
          value: 1.0, # required
        },
        polarization: "LEFT_HAND", # accepts LEFT_HAND, NONE, RIGHT_HAND
      },
      target_eirp: { # required
        units: "dBW", # required, accepts dBW
        value: 1.0, # required
      },
    },
    dataflow_endpoint_config: {
      dataflow_endpoint_name: "String", # required
      dataflow_endpoint_region: "String",
    },
    tracking_config: {
      autotrack: "PREFERRED", # required, accepts PREFERRED, REMOVED, REQUIRED
    },
    uplink_echo_config: {
      antenna_uplink_config_arn: "ConfigArn", # required
      enabled: false, # required
    },
  },
  config_id: "String", # required
  config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo
  name: "SafeName", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    Parameters of a Config.

  • :config_id (required, String) —

    UUID of a Config.

  • :config_type (required, String) —

    Type of a Config.

  • :name (required, String) —

    Name of a Config.

Returns:

See Also:



1461
1462
1463
1464
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1461

def update_config(params = {}, options = {})
  req = build_request(:update_config, 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({
  contact_post_pass_duration_seconds: 1,
  contact_pre_pass_duration_seconds: 1,
  dataflow_edges: [
    ["ConfigArn"],
  ],
  minimum_viable_contact_duration_seconds: 1,
  mission_profile_id: "String", # required
  name: "SafeName",
  tracking_config_arn: "ConfigArn",
})

Response structure


resp.mission_profile_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :contact_post_pass_duration_seconds (Integer) —

    Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

  • :contact_pre_pass_duration_seconds (Integer) —

    Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

  • :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.

  • :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.

  • :mission_profile_id (required, String) —

    UUID of a mission profile.

  • :name (String) —

    Name of a mission profile.

  • :tracking_config_arn (String) —

    ARN of a tracking Config.

Returns:

See Also:



1523
1524
1525
1526
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1523

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