Struct aws_sdk_groundstation::client::Client

pub struct Client { /* private fields */ }

Client for AWS Ground Station

Client for invoking operations on AWS Ground Station. Each operation on AWS Ground Station is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_groundstation::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_groundstation::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ListTagsForResource operation has a Client::list_tags_for_resource, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.list_tags_for_resource()
    .resource_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn cancel_contact(&self) -> CancelContactFluentBuilder

Constructs a fluent builder for the CancelContact operation.

• The fluent builder is configurable:
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    UUID of a contact.

    
    
• On success, responds with CancelContactOutput with field(s):
  • contact_id(Option<String>):

    UUID of a contact.

• On failure, responds with SdkError<CancelContactError>

impl Client

pub fn create_config(&self) -> CreateConfigFluentBuilder

Constructs a fluent builder for the CreateConfig operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of a Config.

    
    
  • config_data(ConfigTypeData) / set_config_data(Option<ConfigTypeData>):
    required: true
    

    Parameters of a Config.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags assigned to a Config.

    
    
• On success, responds with CreateConfigOutput with field(s):
  • config_id(Option<String>):

    UUID of a Config.

  • config_type(Option<ConfigCapabilityType>):

    Type of a Config.

  • config_arn(Option<String>):

    ARN of a Config.

• On failure, responds with SdkError<CreateConfigError>

impl Client

pub fn create_dataflow_endpoint_group( &self ) -> CreateDataflowEndpointGroupFluentBuilder

Constructs a fluent builder for the CreateDataflowEndpointGroup operation.

• The fluent builder is configurable:
  • endpoint_details(EndpointDetails) / set_endpoint_details(Option<Vec::<EndpointDetails>>):
    required: true
    

    Endpoint details of each endpoint in the dataflow endpoint group.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags of a dataflow endpoint group.

    
    
  • contact_pre_pass_duration_seconds(i32) / set_contact_pre_pass_duration_seconds(Option<i32>):
    required: false
    

    Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.

    
    
  • contact_post_pass_duration_seconds(i32) / set_contact_post_pass_duration_seconds(Option<i32>):
    required: false
    

    Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.

    
    
• On success, responds with CreateDataflowEndpointGroupOutput with field(s):
  • dataflow_endpoint_group_id(Option<String>):

    UUID of a dataflow endpoint group.

• On failure, responds with SdkError<CreateDataflowEndpointGroupError>

impl Client

pub fn create_ephemeris(&self) -> CreateEphemerisFluentBuilder

Constructs a fluent builder for the CreateEphemeris operation.

• The fluent builder is configurable:
  • satellite_id(impl Into<String>) / set_satellite_id(Option<String>):
    required: true
    

    AWS Ground Station satellite ID for this ephemeris.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    Whether to set the ephemeris status to ENABLED after validation.

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

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    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

    
    
  • expiration_time(DateTime) / set_expiration_time(Option<DateTime>):
    required: false
    

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

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

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

    
    
  • kms_key_arn(impl Into<String>) / set_kms_key_arn(Option<String>):
    required: false
    

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

    
    
  • ephemeris(EphemerisData) / set_ephemeris(Option<EphemerisData>):
    required: false
    

    Ephemeris data.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags assigned to an ephemeris.

    
    
• On success, responds with CreateEphemerisOutput with field(s):
  • ephemeris_id(Option<String>):

    The AWS Ground Station ephemeris ID.

• On failure, responds with SdkError<CreateEphemerisError>

impl Client

pub fn create_mission_profile(&self) -> CreateMissionProfileFluentBuilder

Constructs a fluent builder for the CreateMissionProfile operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of a mission profile.

    
    
  • contact_pre_pass_duration_seconds(i32) / set_contact_pre_pass_duration_seconds(Option<i32>):
    required: false
    

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

    
    
  • contact_post_pass_duration_seconds(i32) / set_contact_post_pass_duration_seconds(Option<i32>):
    required: false
    

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

    
    
  • minimum_viable_contact_duration_seconds(i32) / set_minimum_viable_contact_duration_seconds(Option<i32>):
    required: true
    

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

    
    
  • dataflow_edges(Vec::<String>) / set_dataflow_edges(Option<Vec::<Vec::<String>>>):
    required: true
    

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

    
    
  • tracking_config_arn(impl Into<String>) / set_tracking_config_arn(Option<String>):
    required: true
    

    ARN of a tracking Config.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags assigned to a mission profile.

    
    
  • streams_kms_key(KmsKey) / set_streams_kms_key(Option<KmsKey>):
    required: false
    

    KMS key to use for encrypting streams.

    
    
  • streams_kms_role(impl Into<String>) / set_streams_kms_role(Option<String>):
    required: false
    

    Role to use for encrypting streams with KMS key.

    
    
• On success, responds with CreateMissionProfileOutput with field(s):
  • mission_profile_id(Option<String>):

    UUID of a mission profile.

• On failure, responds with SdkError<CreateMissionProfileError>

impl Client

pub fn delete_config(&self) -> DeleteConfigFluentBuilder

Constructs a fluent builder for the DeleteConfig operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    UUID of a Config.

    
    
  • config_type(ConfigCapabilityType) / set_config_type(Option<ConfigCapabilityType>):
    required: true
    

    Type of a Config.

    
    
• On success, responds with DeleteConfigOutput with field(s):
  • config_id(Option<String>):

    UUID of a Config.

  • config_type(Option<ConfigCapabilityType>):

    Type of a Config.

  • config_arn(Option<String>):

    ARN of a Config.

• On failure, responds with SdkError<DeleteConfigError>

impl Client

pub fn delete_dataflow_endpoint_group( &self ) -> DeleteDataflowEndpointGroupFluentBuilder

Constructs a fluent builder for the DeleteDataflowEndpointGroup operation.

• The fluent builder is configurable:
  • dataflow_endpoint_group_id(impl Into<String>) / set_dataflow_endpoint_group_id(Option<String>):
    required: true
    

    UUID of a dataflow endpoint group.

    
    
• On success, responds with DeleteDataflowEndpointGroupOutput with field(s):
  • dataflow_endpoint_group_id(Option<String>):

    UUID of a dataflow endpoint group.

• On failure, responds with SdkError<DeleteDataflowEndpointGroupError>

impl Client

pub fn delete_ephemeris(&self) -> DeleteEphemerisFluentBuilder

Constructs a fluent builder for the DeleteEphemeris operation.

• The fluent builder is configurable:
  • ephemeris_id(impl Into<String>) / set_ephemeris_id(Option<String>):
    required: true
    

    The AWS Ground Station ephemeris ID.

    
    
• On success, responds with DeleteEphemerisOutput with field(s):
  • ephemeris_id(Option<String>):

    The AWS Ground Station ephemeris ID.

• On failure, responds with SdkError<DeleteEphemerisError>

impl Client

pub fn delete_mission_profile(&self) -> DeleteMissionProfileFluentBuilder

Constructs a fluent builder for the DeleteMissionProfile operation.

• The fluent builder is configurable:
  • mission_profile_id(impl Into<String>) / set_mission_profile_id(Option<String>):
    required: true
    

    UUID of a mission profile.

    
    
• On success, responds with DeleteMissionProfileOutput with field(s):
  • mission_profile_id(Option<String>):

    UUID of a mission profile.

• On failure, responds with SdkError<DeleteMissionProfileError>

impl Client

pub fn describe_contact(&self) -> DescribeContactFluentBuilder

Constructs a fluent builder for the DescribeContact operation.

• The fluent builder is configurable:
  • contact_id(impl Into<String>) / set_contact_id(Option<String>):
    required: true
    

    UUID of a contact.

    
    
• On success, responds with DescribeContactOutput with field(s):
  • contact_id(Option<String>):

    UUID of a contact.

  • mission_profile_arn(Option<String>):

    ARN of a mission profile.

  • satellite_arn(Option<String>):

    ARN of a satellite.

  • start_time(Option<DateTime>):

    Start time of a contact in UTC.

  • end_time(Option<DateTime>):

    End time of a contact in UTC.

  • pre_pass_start_time(Option<DateTime>):

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

  • post_pass_end_time(Option<DateTime>):

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

  • ground_station(Option<String>):

    Ground station for a contact.

  • contact_status(Option<ContactStatus>):

    Status of a contact.

  • error_message(Option<String>):

    Error message for a contact.

  • maximum_elevation(Option<Elevation>):

    Maximum elevation angle of a contact.

  • tags(Option<HashMap::<String, String>>):

    Tags assigned to a contact.

  • region(Option<String>):

    Region of a contact.

  • dataflow_list(Option<Vec::<DataflowDetail>>):

    List describing source and destination details for each dataflow edge.

  • visibility_start_time(Option<DateTime>):

    Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite’s current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

  • visibility_end_time(Option<DateTime>):

    Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite’s current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

• On failure, responds with SdkError<DescribeContactError>

impl Client

pub fn describe_ephemeris(&self) -> DescribeEphemerisFluentBuilder

Constructs a fluent builder for the DescribeEphemeris operation.

• The fluent builder is configurable:
  • ephemeris_id(impl Into<String>) / set_ephemeris_id(Option<String>):
    required: true
    

    The AWS Ground Station ephemeris ID.

    
    
• On success, responds with DescribeEphemerisOutput with field(s):
  • ephemeris_id(Option<String>):

    The AWS Ground Station ephemeris ID.

  • satellite_id(Option<String>):

    The AWS Ground Station satellite ID associated with ephemeris.

  • status(Option<EphemerisStatus>):

    The status of the ephemeris.

  • priority(Option<i32>):

    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

  • creation_time(Option<DateTime>):

    The time the ephemeris was uploaded in UTC.

  • enabled(Option<bool>):

    Whether or not the ephemeris is enabled.

  • name(Option<String>):

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

  • tags(Option<HashMap::<String, String>>):

    Tags assigned to an ephemeris.

  • supplied_data(Option<EphemerisTypeDescription>):

    Supplied ephemeris data.

  • invalid_reason(Option<EphemerisInvalidReason>):

    Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.

• On failure, responds with SdkError<DescribeEphemerisError>

impl Client

pub fn get_agent_configuration(&self) -> GetAgentConfigurationFluentBuilder

Constructs a fluent builder for the GetAgentConfiguration operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    UUID of agent to get configuration information for.

    
    
• On success, responds with GetAgentConfigurationOutput with field(s):
  • agent_id(Option<String>):

    UUID of agent.

  • tasking_document(Option<String>):

    Tasking document for agent.

• On failure, responds with SdkError<GetAgentConfigurationError>

impl Client

pub fn get_config(&self) -> GetConfigFluentBuilder

Constructs a fluent builder for the GetConfig operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    UUID of a Config.

    
    
  • config_type(ConfigCapabilityType) / set_config_type(Option<ConfigCapabilityType>):
    required: true
    

    Type of a Config.

    
    
• On success, responds with GetConfigOutput with field(s):
  • config_id(String):

    UUID of a Config.

  • config_arn(String):

    ARN of a Config

  • name(String):

    Name of a Config.

  • config_type(Option<ConfigCapabilityType>):

    Type of a Config.

  • config_data(Option<ConfigTypeData>):

    Data elements in a Config.

  • tags(Option<HashMap::<String, String>>):

    Tags assigned to a Config.

• On failure, responds with SdkError<GetConfigError>

impl Client

pub fn get_dataflow_endpoint_group( &self ) -> GetDataflowEndpointGroupFluentBuilder

Constructs a fluent builder for the GetDataflowEndpointGroup operation.

• The fluent builder is configurable:
  • dataflow_endpoint_group_id(impl Into<String>) / set_dataflow_endpoint_group_id(Option<String>):
    required: true
    

    UUID of a dataflow endpoint group.

    
    
• On success, responds with GetDataflowEndpointGroupOutput with field(s):
  • dataflow_endpoint_group_id(Option<String>):

    UUID of a dataflow endpoint group.

  • dataflow_endpoint_group_arn(Option<String>):

    ARN of a dataflow endpoint group.

  • endpoints_details(Option<Vec::<EndpointDetails>>):

    Details of a dataflow endpoint.

  • tags(Option<HashMap::<String, String>>):

    Tags assigned to a dataflow endpoint group.

  • contact_pre_pass_duration_seconds(Option<i32>):

    Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.

  • contact_post_pass_duration_seconds(Option<i32>):

    Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.

• On failure, responds with SdkError<GetDataflowEndpointGroupError>

impl Client

pub fn get_minute_usage(&self) -> GetMinuteUsageFluentBuilder

Constructs a fluent builder for the GetMinuteUsage operation.

• The fluent builder is configurable:
  • month(i32) / set_month(Option<i32>):
    required: true
    

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

    
    
  • year(i32) / set_year(Option<i32>):
    required: true
    

    The year being requested, in the format of YYYY.

    
    
• On success, responds with GetMinuteUsageOutput with field(s):
  • is_reserved_minutes_customer(Option<bool>):

    Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.

  • total_reserved_minute_allocation(Option<i32>):

    Total number of reserved minutes allocated, specific to the month being requested.

  • upcoming_minutes_scheduled(Option<i32>):

    Upcoming minutes scheduled for an account, specific to the month being requested.

  • total_scheduled_minutes(Option<i32>):

    Total scheduled minutes for an account, specific to the month being requested.

  • estimated_minutes_remaining(Option<i32>):

    Estimated number of minutes remaining for an account, specific to the month being requested.

• On failure, responds with SdkError<GetMinuteUsageError>

impl Client

pub fn get_mission_profile(&self) -> GetMissionProfileFluentBuilder

Constructs a fluent builder for the GetMissionProfile operation.

• The fluent builder is configurable:
  • mission_profile_id(impl Into<String>) / set_mission_profile_id(Option<String>):
    required: true
    

    UUID of a mission profile.

    
    
• On success, responds with GetMissionProfileOutput with field(s):
  • mission_profile_id(Option<String>):

    UUID of a mission profile.

  • mission_profile_arn(Option<String>):

    ARN of a mission profile.

  • name(Option<String>):

    Name of a mission profile.

  • region(Option<String>):

    Region of a mission profile.

  • contact_pre_pass_duration_seconds(Option<i32>):

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

  • contact_post_pass_duration_seconds(Option<i32>):

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

  • minimum_viable_contact_duration_seconds(Option<i32>):

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

  • dataflow_edges(Option<Vec::<Vec::<String>>>):

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

  • tracking_config_arn(Option<String>):

    ARN of a tracking Config.

  • tags(Option<HashMap::<String, String>>):

    Tags assigned to a mission profile.

  • streams_kms_key(Option<KmsKey>):

    KMS key to use for encrypting streams.

  • streams_kms_role(Option<String>):

    Role to use for encrypting streams with KMS key.

• On failure, responds with SdkError<GetMissionProfileError>

impl Client

pub fn get_satellite(&self) -> GetSatelliteFluentBuilder

Constructs a fluent builder for the GetSatellite operation.

• The fluent builder is configurable:
  • satellite_id(impl Into<String>) / set_satellite_id(Option<String>):
    required: true
    

    UUID of a satellite.

    
    
• On success, responds with GetSatelliteOutput with field(s):
  • satellite_id(Option<String>):

    UUID of a satellite.

  • satellite_arn(Option<String>):

    ARN of a satellite.

  • norad_satellite_id(i32):

    NORAD satellite ID number.

  • ground_stations(Option<Vec::<String>>):

    A list of ground stations to which the satellite is on-boarded.

  • current_ephemeris(Option<EphemerisMetaData>):

    The current ephemeris being used to compute the trajectory of the satellite.

• On failure, responds with SdkError<GetSatelliteError>

impl Client

pub fn list_configs(&self) -> ListConfigsFluentBuilder

Constructs a fluent builder for the ListConfigs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of Configs returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListConfigsOutput with field(s):
  • next_token(Option<String>):

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

  • config_list(Option<Vec::<ConfigListItem>>):

    List of Config items.

• On failure, responds with SdkError<ListConfigsError>

impl Client

pub fn list_contacts(&self) -> ListContactsFluentBuilder

Constructs a fluent builder for the ListContacts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of contacts returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • status_list(ContactStatus) / set_status_list(Option<Vec::<ContactStatus>>):
    required: true
    

    Status of a contact reservation.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    Start time of a contact in UTC.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    End time of a contact in UTC.

    
    
  • ground_station(impl Into<String>) / set_ground_station(Option<String>):
    required: false
    

    Name of a ground station.

    
    
  • satellite_arn(impl Into<String>) / set_satellite_arn(Option<String>):
    required: false
    

    ARN of a satellite.

    
    
  • mission_profile_arn(impl Into<String>) / set_mission_profile_arn(Option<String>):
    required: false
    

    ARN of a mission profile.

    
    
• On success, responds with ListContactsOutput with field(s):
  • next_token(Option<String>):

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

  • contact_list(Option<Vec::<ContactData>>):

    List of contacts.

• On failure, responds with SdkError<ListContactsError>

impl Client

pub fn list_dataflow_endpoint_groups( &self ) -> ListDataflowEndpointGroupsFluentBuilder

Constructs a fluent builder for the ListDataflowEndpointGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of dataflow endpoint groups returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListDataflowEndpointGroupsOutput with field(s):
  • next_token(Option<String>):

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

  • dataflow_endpoint_group_list(Option<Vec::<DataflowEndpointListItem>>):

    A list of dataflow endpoint groups.

• On failure, responds with SdkError<ListDataflowEndpointGroupsError>

impl Client

pub fn list_ephemerides(&self) -> ListEphemeridesFluentBuilder

Constructs a fluent builder for the ListEphemerides operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • satellite_id(impl Into<String>) / set_satellite_id(Option<String>):
    required: true
    

    The AWS Ground Station satellite ID to list ephemeris for.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    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.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    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.

    
    
  • status_list(EphemerisStatus) / set_status_list(Option<Vec::<EphemerisStatus>>):
    required: false
    

    The list of ephemeris status to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of ephemerides to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token.

    
    
• On success, responds with ListEphemeridesOutput with field(s):
  • next_token(Option<String>):

    Pagination token.

  • ephemerides(Option<Vec::<EphemerisItem>>):

    List of ephemerides.

• On failure, responds with SdkError<ListEphemeridesError>

impl Client

pub fn list_ground_stations(&self) -> ListGroundStationsFluentBuilder

Constructs a fluent builder for the ListGroundStations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • satellite_id(impl Into<String>) / set_satellite_id(Option<String>):
    required: false
    

    Satellite ID to retrieve on-boarded ground stations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of ground stations returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListGroundStationsOutput with field(s):
  • next_token(Option<String>):

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

  • ground_station_list(Option<Vec::<GroundStationData>>):

    List of ground stations.

• On failure, responds with SdkError<ListGroundStationsError>

impl Client

pub fn list_mission_profiles(&self) -> ListMissionProfilesFluentBuilder

Constructs a fluent builder for the ListMissionProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of mission profiles returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListMissionProfilesOutput with field(s):
  • next_token(Option<String>):

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

  • mission_profile_list(Option<Vec::<MissionProfileListItem>>):

    List of mission profiles.

• On failure, responds with SdkError<ListMissionProfilesError>

impl Client

pub fn list_satellites(&self) -> ListSatellitesFluentBuilder

Constructs a fluent builder for the ListSatellites operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of satellites returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with ListSatellitesOutput with field(s):
  • next_token(Option<String>):

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

  • satellites(Option<Vec::<SatelliteListItem>>):

    List of satellites.

• On failure, responds with SdkError<ListSatellitesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    ARN of a resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    Tags assigned to a resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn register_agent(&self) -> RegisterAgentFluentBuilder

Constructs a fluent builder for the RegisterAgent operation.

• The fluent builder is configurable:
  • discovery_data(DiscoveryData) / set_discovery_data(Option<DiscoveryData>):
    required: true
    

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

    
    
  • agent_details(AgentDetails) / set_agent_details(Option<AgentDetails>):
    required: true
    

    Detailed information about the agent being registered.

    
    
• On success, responds with RegisterAgentOutput with field(s):
  • agent_id(Option<String>):

    UUID of registered agent.

• On failure, responds with SdkError<RegisterAgentError>

impl Client

pub fn reserve_contact(&self) -> ReserveContactFluentBuilder

Constructs a fluent builder for the ReserveContact operation.

• The fluent builder is configurable:
  • mission_profile_arn(impl Into<String>) / set_mission_profile_arn(Option<String>):
    required: true
    

    ARN of a mission profile.

    
    
  • satellite_arn(impl Into<String>) / set_satellite_arn(Option<String>):
    required: true
    

    ARN of a satellite

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    Start time of a contact in UTC.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    End time of a contact in UTC.

    
    
  • ground_station(impl Into<String>) / set_ground_station(Option<String>):
    required: true
    

    Name of a ground station.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags assigned to a contact.

    
    
• On success, responds with ReserveContactOutput with field(s):
  • contact_id(Option<String>):

    UUID of a contact.

• On failure, responds with SdkError<ReserveContactError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    ARN of a resource tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    Tags assigned to a resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    ARN of a resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    Keys of a resource tag.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_agent_status(&self) -> UpdateAgentStatusFluentBuilder

Constructs a fluent builder for the UpdateAgentStatus operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    UUID of agent to update.

    
    
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    GUID of agent task.

    
    
  • aggregate_status(AggregateStatus) / set_aggregate_status(Option<AggregateStatus>):
    required: true
    

    Aggregate status for agent.

    
    
  • component_statuses(ComponentStatusData) / set_component_statuses(Option<Vec::<ComponentStatusData>>):
    required: true
    

    List of component statuses for agent.

    
    
• On success, responds with UpdateAgentStatusOutput with field(s):
  • agent_id(String):

    UUID of updated agent.

• On failure, responds with SdkError<UpdateAgentStatusError>

impl Client

pub fn update_config(&self) -> UpdateConfigFluentBuilder

Constructs a fluent builder for the UpdateConfig operation.

• The fluent builder is configurable:
  • config_id(impl Into<String>) / set_config_id(Option<String>):
    required: true
    

    UUID of a Config.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of a Config.

    
    
  • config_type(ConfigCapabilityType) / set_config_type(Option<ConfigCapabilityType>):
    required: true
    

    Type of a Config.

    
    
  • config_data(ConfigTypeData) / set_config_data(Option<ConfigTypeData>):
    required: true
    

    Parameters of a Config.

    
    
• On success, responds with UpdateConfigOutput with field(s):
  • config_id(Option<String>):

    UUID of a Config.

  • config_type(Option<ConfigCapabilityType>):

    Type of a Config.

  • config_arn(Option<String>):

    ARN of a Config.

• On failure, responds with SdkError<UpdateConfigError>

impl Client

pub fn update_ephemeris(&self) -> UpdateEphemerisFluentBuilder

Constructs a fluent builder for the UpdateEphemeris operation.

• The fluent builder is configurable:
  • ephemeris_id(impl Into<String>) / set_ephemeris_id(Option<String>):
    required: true
    

    The AWS Ground Station ephemeris ID.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: true
    

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

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

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

    
    
  • priority(i32) / set_priority(Option<i32>):
    required: false
    

    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

    
    
• On success, responds with UpdateEphemerisOutput with field(s):
  • ephemeris_id(Option<String>):

    The AWS Ground Station ephemeris ID.

• On failure, responds with SdkError<UpdateEphemerisError>

impl Client

pub fn update_mission_profile(&self) -> UpdateMissionProfileFluentBuilder

Constructs a fluent builder for the UpdateMissionProfile operation.

• The fluent builder is configurable:
  • mission_profile_id(impl Into<String>) / set_mission_profile_id(Option<String>):
    required: true
    

    UUID of a mission profile.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Name of a mission profile.

    
    
  • contact_pre_pass_duration_seconds(i32) / set_contact_pre_pass_duration_seconds(Option<i32>):
    required: false
    

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

    
    
  • contact_post_pass_duration_seconds(i32) / set_contact_post_pass_duration_seconds(Option<i32>):
    required: false
    

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

    
    
  • minimum_viable_contact_duration_seconds(i32) / set_minimum_viable_contact_duration_seconds(Option<i32>):
    required: false
    

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

    
    
  • dataflow_edges(Vec::<String>) / set_dataflow_edges(Option<Vec::<Vec::<String>>>):
    required: false
    

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

    
    
  • tracking_config_arn(impl Into<String>) / set_tracking_config_arn(Option<String>):
    required: false
    

    ARN of a tracking Config.

    
    
  • streams_kms_key(KmsKey) / set_streams_kms_key(Option<KmsKey>):
    required: false
    

    KMS key to use for encrypting streams.

    
    
  • streams_kms_role(impl Into<String>) / set_streams_kms_role(Option<String>):
    required: false
    

    Role to use for encrypting streams with KMS key.

    
    
• On success, responds with UpdateMissionProfileOutput with field(s):
  • mission_profile_id(Option<String>):

    UUID of a mission profile.

• On failure, responds with SdkError<UpdateMissionProfileError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_contact_scheduled(&self) -> ContactScheduledFluentBuilder

Waits until a contact has been scheduled