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::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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :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.

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

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

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

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an 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_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 (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_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.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

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



365
366
367
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 365

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



394
395
396
397
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 394

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
      },
      transmit_disabled: false,
    },
    dataflow_endpoint_config: {
      dataflow_endpoint_name: "String", # required
      dataflow_endpoint_region: "String",
    },
    s3_recording_config: {
      bucket_arn: "BucketArn", # required
      prefix: "S3KeyPrefix",
      role_arn: "RoleArn", # required
    },
    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", "s3-recording"

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:



501
502
503
504
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 501

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({
  contact_post_pass_duration_seconds: 1,
  contact_pre_pass_duration_seconds: 1,
  endpoint_details: [ # required
    {
      aws_ground_station_agent_endpoint: {
        agent_status: "SUCCESS", # accepts SUCCESS, FAILED, ACTIVE, INACTIVE
        audit_results: "HEALTHY", # accepts HEALTHY, UNHEALTHY
        egress_address: { # required
          mtu: 1,
          socket_address: { # required
            name: "String", # required
            port: 1, # required
          },
        },
        ingress_address: { # required
          mtu: 1,
          socket_address: { # required
            name: "IpV4Address", # required
            port_range: { # required
              maximum: 1, # required
              minimum: 1, # required
            },
          },
        },
        name: "SafeName", # required
      },
      endpoint: {
        address: {
          name: "String", # required
          port: 1, # required
        },
        mtu: 1,
        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):

  • :contact_post_pass_duration_seconds (Integer) —

    Amount of time, in seconds, after a contact ends for the contact to remain in a POSTPASS state. A CloudWatch event is emitted when the contact enters and exits the POSTPASS state.

  • :contact_pre_pass_duration_seconds (Integer) —

    Amount of time, in seconds, prior to contact start for the contact to remain in a PREPASS state. A CloudWatch event is emitted when the contact enters and exits the PREPASS state.

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



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

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

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

Creates an Ephemeris with the specified EphemerisData.

Examples:

Request syntax with placeholder values


resp = client.create_ephemeris({
  enabled: false,
  ephemeris: {
    oem: {
      oem_data: "UnboundedString",
      s3_object: {
        bucket: "S3BucketName",
        key: "S3ObjectKey",
        version: "S3VersionId",
      },
    },
    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
            end_time: Time.now, # required
            start_time: Time.now, # required
          },
        },
      ],
    },
  },
  expiration_time: Time.now,
  kms_key_arn: "KeyArn",
  name: "SafeName", # required
  priority: 1,
  satellite_id: "Uuid", # required
  tags: {
    "String" => "String",
  },
})

Response structure


resp.ephemeris_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :enabled (Boolean) —

    Whether to set the ephemeris status to ENABLED after validation.

    Setting this to false will set the ephemeris status to DISABLED after validation.

  • :ephemeris (Types::EphemerisData) —

    Ephemeris data.

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

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

  • :kms_key_arn (String) —

    The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

  • :name (required, String) —

    A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

  • :priority (Integer) —

    Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

    The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

    Priority must be 1 or greater

  • :satellite_id (required, String) —

    AWS Ground Station satellite ID for this ephemeris.

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

    Tags assigned to an ephemeris.

Returns:

See Also:



689
690
691
692
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 689

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({
  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
  streams_kms_key: {
    kms_alias_arn: "KeyAliasArn",
    kms_key_arn: "KeyArn",
  },
  streams_kms_role: "RoleArn",
  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.

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

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

    Tags assigned to a mission profile.

  • :tracking_config_arn (required, String) —

    ARN of a tracking Config.

Returns:

See Also:



764
765
766
767
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 764

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, antenna-uplink, dataflow-endpoint, tracking, uplink-echo, s3-recording
})

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", "s3-recording"

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:



800
801
802
803
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 800

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:



828
829
830
831
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 828

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

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



856
857
858
859
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 856

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:



884
885
886
887
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 884

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.contact_status #=> String, one of "AVAILABLE", "AWS_CANCELLED", "AWS_FAILED", "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING"
resp.dataflow_list #=> Array
resp.dataflow_list[0].destination.config_details.antenna_demod_decode_details.output_node #=> String
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.aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
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.ingress_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.maximum #=> Integer
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.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.mtu #=> Integer
resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.name #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.role_arn #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.security_group_ids #=> Array
resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.security_group_ids[0] #=> String
resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.subnet_ids #=> Array
resp.dataflow_list[0].destination.config_details.endpoint_details.security_details.subnet_ids[0] #=> String
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.config_id #=> String
resp.dataflow_list[0].destination.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo", "s3-recording"
resp.dataflow_list[0].destination.dataflow_destination_region #=> String
resp.dataflow_list[0].error_message #=> String
resp.dataflow_list[0].source.config_details.antenna_demod_decode_details.output_node #=> String
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.aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
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.ingress_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.maximum #=> Integer
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.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.mtu #=> Integer
resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.name #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.dataflow_list[0].source.config_details.endpoint_details.security_details.role_arn #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.security_details.security_group_ids #=> Array
resp.dataflow_list[0].source.config_details.endpoint_details.security_details.security_group_ids[0] #=> String
resp.dataflow_list[0].source.config_details.endpoint_details.security_details.subnet_ids #=> Array
resp.dataflow_list[0].source.config_details.endpoint_details.security_details.subnet_ids[0] #=> String
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.config_id #=> String
resp.dataflow_list[0].source.config_type #=> String, one of "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo", "s3-recording"
resp.dataflow_list[0].source.dataflow_source_region #=> String
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:



998
999
1000
1001
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 998

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

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

Describes an existing ephemeris.

Examples:

Request syntax with placeholder values


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

Response structure


resp.creation_time #=> Time
resp.enabled #=> Boolean
resp.ephemeris_id #=> String
resp.invalid_reason #=> String, one of "METADATA_INVALID", "TIME_RANGE_INVALID", "TRAJECTORY_INVALID", "KMS_KEY_INVALID", "VALIDATION_ERROR"
resp.name #=> String
resp.priority #=> Integer
resp.satellite_id #=> String
resp.status #=> String, one of "VALIDATING", "INVALID", "ERROR", "ENABLED", "DISABLED", "EXPIRED"
resp.supplied_data.oem.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.tle.ephemeris_data #=> 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.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :ephemeris_id (required, String) —

    The AWS Ground Station ephemeris ID.

Returns:

See Also:



1052
1053
1054
1055
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1052

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

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

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:



1082
1083
1084
1085
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1082

def get_agent_configuration(params = {}, options = {})
  req = build_request(:get_agent_configuration, 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, antenna-uplink, dataflow-endpoint, tracking, uplink-echo, s3-recording
})

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.antenna_uplink_config.transmit_disabled #=> Boolean
resp.config_data.dataflow_endpoint_config.dataflow_endpoint_name #=> String
resp.config_data.dataflow_endpoint_config.dataflow_endpoint_region #=> String
resp.config_data.s3_recording_config.bucket_arn #=> String
resp.config_data.s3_recording_config.prefix #=> String
resp.config_data.s3_recording_config.role_arn #=> 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", "s3-recording"
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:



1152
1153
1154
1155
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1152

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.contact_post_pass_duration_seconds #=> Integer
resp.contact_pre_pass_duration_seconds #=> Integer
resp.dataflow_endpoint_group_arn #=> String
resp.dataflow_endpoint_group_id #=> String
resp.endpoints_details #=> Array
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].aws_ground_station_agent_endpoint.egress_address.mtu #=> Integer
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.ingress_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.maximum #=> Integer
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.name #=> String
resp.endpoints_details[0].endpoint.address.name #=> String
resp.endpoints_details[0].endpoint.address.port #=> Integer
resp.endpoints_details[0].endpoint.mtu #=> Integer
resp.endpoints_details[0].endpoint.name #=> String
resp.endpoints_details[0].endpoint.status #=> String, one of "created", "creating", "deleted", "deleting", "failed"
resp.endpoints_details[0].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:



1211
1212
1213
1214
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1211

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:



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

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.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.streams_kms_key.kms_alias_arn #=> String
resp.streams_kms_key.kms_key_arn #=> String
resp.streams_kms_role #=> 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:



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

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.current_ephemeris.ephemeris_id #=> String
resp.current_ephemeris.epoch #=> Time
resp.current_ephemeris.name #=> String
resp.current_ephemeris.source #=> String, one of "CUSTOMER_PROVIDED", "SPACE_TRACK"
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:



1345
1346
1347
1348
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1345

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

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", "s3-recording"
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:



1386
1387
1388
1389
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1386

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: "GroundStationName",
  max_results: 1,
  mission_profile_arn: "MissionProfileArn",
  next_token: "PaginationToken",
  satellite_arn: "satelliteArn",
  start_time: Time.now, # required
  status_list: ["AVAILABLE"], # required, accepts AVAILABLE, AWS_CANCELLED, AWS_FAILED, 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", "AWS_FAILED", "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 in UTC.

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

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

    Status of a contact reservation.

Returns:

See Also:



1465
1466
1467
1468
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1465

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



1505
1506
1507
1508
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1505

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 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({
  end_time: Time.now, # required
  max_results: 1,
  next_token: "PaginationToken",
  satellite_id: "Uuid", # required
  start_time: Time.now, # required
  status_list: ["VALIDATING"], # accepts VALIDATING, INVALID, ERROR, ENABLED, DISABLED, EXPIRED
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

  • :max_results (Integer) —

    Maximum number of ephemerides to return.

  • :next_token (String) —

    Pagination token.

  • :satellite_id (required, String) —

    The AWS Ground Station satellite ID to list ephemeris for.

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

    The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

  • :status_list (Array<String>) —

    The list of ephemeris status to return.

Returns:

See Also:



1570
1571
1572
1573
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1570

def list_ephemerides(params = {}, options = {})
  req = build_request(:list_ephemerides, 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: "PaginationToken",
  satellite_id: "Uuid",
})

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:



1614
1615
1616
1617
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1614

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



1655
1656
1657
1658
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1655

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].current_ephemeris.ephemeris_id #=> String
resp.satellites[0].current_ephemeris.epoch #=> Time
resp.satellites[0].current_ephemeris.name #=> String
resp.satellites[0].current_ephemeris.source #=> String, one of "CUSTOMER_PROVIDED", "SPACE_TRACK"
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:



1701
1702
1703
1704
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1701

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:



1730
1731
1732
1733
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1730

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

Registers a new agent with AWS Groundstation.

Examples:

Request syntax with placeholder values


resp = client.register_agent({
  agent_details: { # required
    agent_version: "VersionString", # required
    component_versions: [ # required
      {
        component_type: "LAMINAR_FLOW", # required, accepts LAMINAR_FLOW, PRISM, DIGITIZER
        versions: ["VersionString"], # required
      },
    ],
    instance_id: "InstanceId", # required
    instance_type: "InstanceType", # required
    reserved_cpu_cores: [1], # required
  },
  discovery_data: { # required
    capability_arns: ["CapabilityArn"], # required
    private_ip_addresses: ["IpV4Address"], # required
    public_ip_addresses: ["IpV4Address"], # required
  },
})

Response structure


resp.agent_id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    Detailed information about the agent being registered.

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

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

Returns:

See Also:



1777
1778
1779
1780
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1777

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({
  end_time: Time.now, # required
  ground_station: "GroundStationName", # 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 in UTC.

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

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

    Tags assigned to a contact.

Returns:

See Also:



1827
1828
1829
1830
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1827

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:



1855
1856
1857
1858
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1855

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:



1881
1882
1883
1884
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1881

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

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

Update the status of the agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent_status({
  agent_id: "Uuid", # required
  aggregate_status: { # required
    signature_map: {
      "String" => false,
    },
    status: "SUCCESS", # required, accepts SUCCESS, FAILED, ACTIVE, INACTIVE
  },
  component_statuses: [ # required
    {
      bytes_received: 1,
      bytes_sent: 1,
      capability_arn: "CapabilityArn", # required
      component_type: "LAMINAR_FLOW", # required, accepts LAMINAR_FLOW, PRISM, DIGITIZER
      dataflow_id: "Uuid", # required
      packets_dropped: 1,
      status: "SUCCESS", # required, accepts SUCCESS, FAILED, ACTIVE, INACTIVE
    },
  ],
  task_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.

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

    Aggregate status for agent.

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

    List of component statuses for agent.

  • :task_id (required, String) —

    GUID of agent task.

Returns:

See Also:



1936
1937
1938
1939
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 1936

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_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
      },
      transmit_disabled: false,
    },
    dataflow_endpoint_config: {
      dataflow_endpoint_name: "String", # required
      dataflow_endpoint_region: "String",
    },
    s3_recording_config: {
      bucket_arn: "BucketArn", # required
      prefix: "S3KeyPrefix",
      role_arn: "RoleArn", # required
    },
    tracking_config: {
      autotrack: "PREFERRED", # required, accepts PREFERRED, REMOVED, REQUIRED
    },
    uplink_echo_config: {
      antenna_uplink_config_arn: "ConfigArn", # required
      enabled: false, # required
    },
  },
  config_id: "Uuid", # required
  config_type: "antenna-downlink", # required, accepts antenna-downlink, antenna-downlink-demod-decode, antenna-uplink, dataflow-endpoint, tracking, uplink-echo, s3-recording
  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", "s3-recording"

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:



2046
2047
2048
2049
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2046

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

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

Updates an existing ephemeris

Examples:

Request syntax with placeholder values


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

Response structure


resp.ephemeris_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :enabled (required, Boolean) —

    Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.

  • :ephemeris_id (required, String) —

    The AWS Ground Station ephemeris ID.

  • :name (String) —

    A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

  • :priority (Integer) —

    Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

    The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

    Priority must be 1 or greater

Returns:

See Also:



2094
2095
2096
2097
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2094

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({
  contact_post_pass_duration_seconds: 1,
  contact_pre_pass_duration_seconds: 1,
  dataflow_edges: [
    ["ConfigArn"],
  ],
  minimum_viable_contact_duration_seconds: 1,
  mission_profile_id: "Uuid", # required
  name: "SafeName",
  streams_kms_key: {
    kms_alias_arn: "KeyAliasArn",
    kms_key_arn: "KeyArn",
  },
  streams_kms_role: "RoleArn",
  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.

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

  • :tracking_config_arn (String) —

    ARN of a tracking Config.

Returns:

See Also:



2167
2168
2169
2170
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2167

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

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.



2277
2278
2279
2280
2281
 
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/client.rb', line 2277

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