Struct aws_sdk_groundstation::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_groundstation::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_groundstation::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_groundstation::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn cancel_contact(&self) -> CancelContact

Constructs a fluent builder for the CancelContact operation.

The fluent builder is configurable:
- contact_id(impl Into<String>) / set_contact_id(Option<String>):
 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>

source

pub fn create_config(&self) -> CreateConfig

Constructs a fluent builder for the CreateConfig operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 Name of a Config.
- config_data(ConfigTypeData) / set_config_data(Option<ConfigTypeData>):
 Parameters of a Config.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 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>

source

pub fn create_dataflow_endpoint_group(&self) -> CreateDataflowEndpointGroup

Constructs a fluent builder for the CreateDataflowEndpointGroup operation.

The fluent builder is configurable:
- endpoint_details(Vec<EndpointDetails>) / set_endpoint_details(Option<Vec<EndpointDetails>>):
 Endpoint details of each endpoint in the dataflow endpoint group.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 Tags of a dataflow endpoint group.
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>

source

pub fn create_mission_profile(&self) -> CreateMissionProfile

Constructs a fluent builder for the CreateMissionProfile operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 Name of a mission profile.
- contact_pre_pass_duration_seconds(i32) / set_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(i32) / set_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(i32) / set_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(Vec<Vec<String>>) / set_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(impl Into<String>) / set_tracking_config_arn(Option<String>):
 ARN of a tracking Config.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 Tags assigned to a mission profile.
On success, responds with CreateMissionProfileOutput with field(s):
- mission_profile_id(Option<String>):
 UUID of a mission profile.
On failure, responds with SdkError<CreateMissionProfileError>

source

pub fn delete_config(&self) -> DeleteConfig

Constructs a fluent builder for the DeleteConfig operation.

The fluent builder is configurable:
- config_id(impl Into<String>) / set_config_id(Option<String>):
 UUID of a Config.
- config_type(ConfigCapabilityType) / set_config_type(Option<ConfigCapabilityType>):
 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>

source

pub fn delete_dataflow_endpoint_group(&self) -> DeleteDataflowEndpointGroup

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

source

pub fn delete_mission_profile(&self) -> DeleteMissionProfile

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

source

pub fn describe_contact(&self) -> DescribeContact

Constructs a fluent builder for the DescribeContact operation.

The fluent builder is configurable:
- contact_id(impl Into<String>) / set_contact_id(Option<String>):
 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.
- end_time(Option<DateTime>):
 End time of a contact.
- 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.
On failure, responds with SdkError<DescribeContactError>

source

pub fn get_config(&self) -> GetConfig

Constructs a fluent builder for the GetConfig operation.

The fluent builder is configurable:
- config_id(impl Into<String>) / set_config_id(Option<String>):
 UUID of a Config.
- config_type(ConfigCapabilityType) / set_config_type(Option<ConfigCapabilityType>):
 Type of a Config.
On success, responds with GetConfigOutput with field(s):
- config_id(Option<String>):
 UUID of a Config.
- config_arn(Option<String>):
 ARN of a Config
- name(Option<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>

source

pub fn get_dataflow_endpoint_group(&self) -> GetDataflowEndpointGroup

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>):
 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.
On failure, responds with SdkError<GetDataflowEndpointGroupError>

source

pub fn get_minute_usage(&self) -> GetMinuteUsage

Constructs a fluent builder for the GetMinuteUsage operation.

The fluent builder is configurable:
- month(i32) / set_month(Option<i32>):
 The month being requested, with a value of 1-12.
- year(i32) / set_year(Option<i32>):
 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>

source

pub fn get_mission_profile(&self) -> GetMissionProfile

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>):
 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.
On failure, responds with SdkError<GetMissionProfileError>

source

pub fn get_satellite(&self) -> GetSatellite

Constructs a fluent builder for the GetSatellite operation.

The fluent builder is configurable:
- satellite_id(impl Into<String>) / set_satellite_id(Option<String>):
 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.
On failure, responds with SdkError<GetSatelliteError>

source

pub fn list_configs(&self) -> ListConfigs

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>):
 Maximum number of Configs returned.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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>

source

pub fn list_contacts(&self) -> ListContacts

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>):
 Maximum number of contacts returned.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
- status_list(Vec<ContactStatus>) / set_status_list(Option<Vec<ContactStatus>>):
 Status of a contact reservation.
- start_time(DateTime) / set_start_time(Option<DateTime>):
 Start time of a contact.
- end_time(DateTime) / set_end_time(Option<DateTime>):
 End time of a contact.
- ground_station(impl Into<String>) / set_ground_station(Option<String>):
 Name of a ground station.
- satellite_arn(impl Into<String>) / set_satellite_arn(Option<String>):
 ARN of a satellite.
- mission_profile_arn(impl Into<String>) / set_mission_profile_arn(Option<String>):
 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>

source

pub fn list_dataflow_endpoint_groups(&self) -> ListDataflowEndpointGroups

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>):
 Maximum number of dataflow endpoint groups returned.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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>

source

pub fn list_ground_stations(&self) -> ListGroundStations

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>):
 Satellite ID to retrieve on-boarded ground stations.
- max_results(i32) / set_max_results(Option<i32>):
 Maximum number of ground stations returned.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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>

source

pub fn list_mission_profiles(&self) -> ListMissionProfiles

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>):
 Maximum number of mission profiles returned.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 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>