/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the groundstation-2019-05-23.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.GroundStation.Model;
namespace Amazon.GroundStation
{
///
/// Interface for accessing GroundStation
///
/// Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed
/// service that enables you to control satellite communications, downlink and process
/// satellite data, and scale your satellite operations efficiently and cost-effectively
/// without having to build or manage your own ground station infrastructure.
///
public partial interface IAmazonGroundStation : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IGroundStationPaginatorFactory Paginators { get; }
#endif
#region CancelContact
///
/// Cancels a contact with a specified contact ID.
///
/// Container for the necessary parameters to execute the CancelContact service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CancelContact service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for CancelContact Operation
Task CancelContactAsync(CancelContactRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateConfig
///
/// Creates a Config with the specified configData parameters.
///
///
///
/// Only one type of configData can be specified.
///
///
/// Container for the necessary parameters to execute the CreateConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateConfig service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Account limits for this resource have been exceeded.
///
///
/// Resource was not found.
///
/// REST API Reference for CreateConfig Operation
Task CreateConfigAsync(CreateConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateDataflowEndpointGroup
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateDataflowEndpointGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDataflowEndpointGroup service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for CreateDataflowEndpointGroup Operation
Task CreateDataflowEndpointGroupAsync(CreateDataflowEndpointGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateEphemeris
///
/// Creates an Ephemeris with the specified EphemerisData.
///
/// Container for the necessary parameters to execute the CreateEphemeris service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateEphemeris service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for CreateEphemeris Operation
Task CreateEphemerisAsync(CreateEphemerisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateMissionProfile
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateMissionProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateMissionProfile service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for CreateMissionProfile Operation
Task CreateMissionProfileAsync(CreateMissionProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteConfig
///
/// Deletes a Config.
///
/// Container for the necessary parameters to execute the DeleteConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteConfig service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for DeleteConfig Operation
Task DeleteConfigAsync(DeleteConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteDataflowEndpointGroup
///
/// Deletes a dataflow endpoint group.
///
/// Container for the necessary parameters to execute the DeleteDataflowEndpointGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDataflowEndpointGroup service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for DeleteDataflowEndpointGroup Operation
Task DeleteDataflowEndpointGroupAsync(DeleteDataflowEndpointGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteEphemeris
///
/// Deletes an ephemeris
///
/// Container for the necessary parameters to execute the DeleteEphemeris service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteEphemeris service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for DeleteEphemeris Operation
Task DeleteEphemerisAsync(DeleteEphemerisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteMissionProfile
///
/// Deletes a mission profile.
///
/// Container for the necessary parameters to execute the DeleteMissionProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteMissionProfile service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for DeleteMissionProfile Operation
Task DeleteMissionProfileAsync(DeleteMissionProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeContact
///
/// Describes an existing contact.
///
/// Container for the necessary parameters to execute the DescribeContact service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeContact service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for DescribeContact Operation
Task DescribeContactAsync(DescribeContactRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeEphemeris
///
/// Describes an existing ephemeris.
///
/// Container for the necessary parameters to execute the DescribeEphemeris service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeEphemeris service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for DescribeEphemeris Operation
Task DescribeEphemerisAsync(DescribeEphemerisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetAgentConfiguration
///
///
///
/// For use by AWS Ground Station Agent and shouldn't be called directly.
///
///
///
/// Gets the latest configuration information for a registered agent.
///
///
/// Container for the necessary parameters to execute the GetAgentConfiguration service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetAgentConfiguration service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for GetAgentConfiguration Operation
Task GetAgentConfigurationAsync(GetAgentConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetConfig
///
/// Returns Config information.
///
///
///
/// Only one Config response can be returned.
///
///
/// Container for the necessary parameters to execute the GetConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetConfig service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for GetConfig Operation
Task GetConfigAsync(GetConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetDataflowEndpointGroup
///
/// Returns the dataflow endpoint group.
///
/// Container for the necessary parameters to execute the GetDataflowEndpointGroup service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetDataflowEndpointGroup service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for GetDataflowEndpointGroup Operation
Task GetDataflowEndpointGroupAsync(GetDataflowEndpointGroupRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetMinuteUsage
///
/// Returns the number of reserved minutes used by account.
///
/// Container for the necessary parameters to execute the GetMinuteUsage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMinuteUsage service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for GetMinuteUsage Operation
Task GetMinuteUsageAsync(GetMinuteUsageRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetMissionProfile
///
/// Returns a mission profile.
///
/// Container for the necessary parameters to execute the GetMissionProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetMissionProfile service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for GetMissionProfile Operation
Task GetMissionProfileAsync(GetMissionProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetSatellite
///
/// Returns a satellite.
///
/// Container for the necessary parameters to execute the GetSatellite service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetSatellite service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for GetSatellite Operation
Task GetSatelliteAsync(GetSatelliteRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListConfigs
///
/// Returns a list of Config objects.
///
/// Container for the necessary parameters to execute the ListConfigs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListConfigs service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListConfigs Operation
Task ListConfigsAsync(ListConfigsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListContacts
///
/// Returns a list of contacts.
///
///
///
/// If statusList contains AVAILABLE, the request must include groundStation,
/// missionprofileArn, and satelliteArn.
///
///
/// Container for the necessary parameters to execute the ListContacts service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListContacts service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListContacts Operation
Task ListContactsAsync(ListContactsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDataflowEndpointGroups
///
/// Returns a list of DataflowEndpoint groups.
///
/// Container for the necessary parameters to execute the ListDataflowEndpointGroups service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDataflowEndpointGroups service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListDataflowEndpointGroups Operation
Task ListDataflowEndpointGroupsAsync(ListDataflowEndpointGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListEphemerides
///
/// List existing ephemerides.
///
/// Container for the necessary parameters to execute the ListEphemerides service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListEphemerides service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListEphemerides Operation
Task ListEphemeridesAsync(ListEphemeridesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListGroundStations
///
/// Returns a list of ground stations.
///
/// Container for the necessary parameters to execute the ListGroundStations service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListGroundStations service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListGroundStations Operation
Task ListGroundStationsAsync(ListGroundStationsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListMissionProfiles
///
/// Returns a list of mission profiles.
///
/// Container for the necessary parameters to execute the ListMissionProfiles service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListMissionProfiles service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListMissionProfiles Operation
Task ListMissionProfilesAsync(ListMissionProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSatellites
///
/// Returns a list of satellites.
///
/// Container for the necessary parameters to execute the ListSatellites service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSatellites service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListSatellites Operation
Task ListSatellitesAsync(ListSatellitesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Returns a list of tags for a specified resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RegisterAgent
///
///
///
/// For use by AWS Ground Station Agent and shouldn't be called directly.
///
///
///
/// Registers a new agent with AWS Ground Station.
///
///
/// Container for the necessary parameters to execute the RegisterAgent service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RegisterAgent service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for RegisterAgent Operation
Task RegisterAgentAsync(RegisterAgentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ReserveContact
///
/// Reserves a contact using specified parameters.
///
/// Container for the necessary parameters to execute the ReserveContact service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ReserveContact service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for ReserveContact Operation
Task ReserveContactAsync(ReserveContactRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Assigns a tag to a resource.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Deassigns a resource tag.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateAgentStatus
///
///
///
/// For use by AWS Ground Station Agent and shouldn't be called directly.
///
///
///
/// Update the status of the agent.
///
///
/// Container for the necessary parameters to execute the UpdateAgentStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateAgentStatus service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for UpdateAgentStatus Operation
Task UpdateAgentStatusAsync(UpdateAgentStatusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateConfig
///
/// Updates the Config used when scheduling contacts.
///
///
///
/// Updating a Config will not update the execution parameters for existing
/// future contacts scheduled with this Config.
///
///
/// Container for the necessary parameters to execute the UpdateConfig service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateConfig service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for UpdateConfig Operation
Task UpdateConfigAsync(UpdateConfigRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateEphemeris
///
/// Updates an existing ephemeris
///
/// Container for the necessary parameters to execute the UpdateEphemeris service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateEphemeris service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for UpdateEphemeris Operation
Task UpdateEphemerisAsync(UpdateEphemerisRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateMissionProfile
///
/// Updates a mission profile.
///
///
///
/// Updating a mission profile will not update the execution parameters for existing future
/// contacts.
///
///
/// Container for the necessary parameters to execute the UpdateMissionProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateMissionProfile service method, as returned by GroundStation.
///
/// Dependency encountered an error.
///
///
/// One or more parameters are not valid.
///
///
/// Resource was not found.
///
/// REST API Reference for UpdateMissionProfile Operation
Task UpdateMissionProfileAsync(UpdateMissionProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}