groundstation/aws.sdk.kotlin.services.groundstation

Package-level declarations

Types

interface GroundStationClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

cancelContact

inline suspend fun GroundStationClient.cancelContact(crossinline block: CancelContactRequest.Builder.() -> Unit): CancelContactResponse

Cancels a contact with a specified contact ID.

createConfig

inline suspend fun GroundStationClient.createConfig(crossinline block: CreateConfigRequest.Builder.() -> Unit): CreateConfigResponse

Creates a Config with the specified configData parameters.

createDataflowEndpointGroup

inline suspend fun GroundStationClient.createDataflowEndpointGroup(crossinline block: CreateDataflowEndpointGroupRequest.Builder.() -> Unit): CreateDataflowEndpointGroupResponse

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

createEphemeris

inline suspend fun GroundStationClient.createEphemeris(crossinline block: CreateEphemerisRequest.Builder.() -> Unit): CreateEphemerisResponse

Creates an Ephemeris with the specified EphemerisData.

createMissionProfile

inline suspend fun GroundStationClient.createMissionProfile(crossinline block: CreateMissionProfileRequest.Builder.() -> Unit): CreateMissionProfileResponse

Creates a mission profile.

deleteConfig

inline suspend fun GroundStationClient.deleteConfig(crossinline block: DeleteConfigRequest.Builder.() -> Unit): DeleteConfigResponse

Deletes a Config.

deleteDataflowEndpointGroup

inline suspend fun GroundStationClient.deleteDataflowEndpointGroup(crossinline block: DeleteDataflowEndpointGroupRequest.Builder.() -> Unit): DeleteDataflowEndpointGroupResponse

Deletes a dataflow endpoint group.

deleteEphemeris

inline suspend fun GroundStationClient.deleteEphemeris(crossinline block: DeleteEphemerisRequest.Builder.() -> Unit): DeleteEphemerisResponse

Deletes an ephemeris

deleteMissionProfile

inline suspend fun GroundStationClient.deleteMissionProfile(crossinline block: DeleteMissionProfileRequest.Builder.() -> Unit): DeleteMissionProfileResponse

Deletes a mission profile.

describeContact

inline suspend fun GroundStationClient.describeContact(crossinline block: DescribeContactRequest.Builder.() -> Unit): DescribeContactResponse

Describes an existing contact.

describeEphemeris

inline suspend fun GroundStationClient.describeEphemeris(crossinline block: DescribeEphemerisRequest.Builder.() -> Unit): DescribeEphemerisResponse

Describes an existing ephemeris.

getAgentConfiguration

inline suspend fun GroundStationClient.getAgentConfiguration(crossinline block: GetAgentConfigurationRequest.Builder.() -> Unit): GetAgentConfigurationResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

getConfig

inline suspend fun GroundStationClient.getConfig(crossinline block: GetConfigRequest.Builder.() -> Unit): GetConfigResponse

Returns Config information.

getDataflowEndpointGroup

inline suspend fun GroundStationClient.getDataflowEndpointGroup(crossinline block: GetDataflowEndpointGroupRequest.Builder.() -> Unit): GetDataflowEndpointGroupResponse

Returns the dataflow endpoint group.

getMinuteUsage

inline suspend fun GroundStationClient.getMinuteUsage(crossinline block: GetMinuteUsageRequest.Builder.() -> Unit): GetMinuteUsageResponse

Returns the number of reserved minutes used by account.

getMissionProfile

inline suspend fun GroundStationClient.getMissionProfile(crossinline block: GetMissionProfileRequest.Builder.() -> Unit): GetMissionProfileResponse

Returns a mission profile.

getSatellite

inline suspend fun GroundStationClient.getSatellite(crossinline block: GetSatelliteRequest.Builder.() -> Unit): GetSatelliteResponse

Returns a satellite.

listConfigs

inline suspend fun GroundStationClient.listConfigs(crossinline block: ListConfigsRequest.Builder.() -> Unit): ListConfigsResponse

Returns a list of Config objects.

listContacts

inline suspend fun GroundStationClient.listContacts(crossinline block: ListContactsRequest.Builder.() -> Unit): ListContactsResponse

Returns a list of contacts.

listDataflowEndpointGroups

inline suspend fun GroundStationClient.listDataflowEndpointGroups(crossinline block: ListDataflowEndpointGroupsRequest.Builder.() -> Unit): ListDataflowEndpointGroupsResponse

Returns a list of DataflowEndpoint groups.

listEphemerides

inline suspend fun GroundStationClient.listEphemerides(crossinline block: ListEphemeridesRequest.Builder.() -> Unit): ListEphemeridesResponse

List existing ephemerides.

listGroundStations

inline suspend fun GroundStationClient.listGroundStations(crossinline block: ListGroundStationsRequest.Builder.() -> Unit): ListGroundStationsResponse

Returns a list of ground stations.

listMissionProfiles

inline suspend fun GroundStationClient.listMissionProfiles(crossinline block: ListMissionProfilesRequest.Builder.() -> Unit): ListMissionProfilesResponse

Returns a list of mission profiles.

listSatellites

inline suspend fun GroundStationClient.listSatellites(crossinline block: ListSatellitesRequest.Builder.() -> Unit): ListSatellitesResponse

Returns a list of satellites.

listTagsForResource

inline suspend fun GroundStationClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of tags for a specified resource.

registerAgent

inline suspend fun GroundStationClient.registerAgent(crossinline block: RegisterAgentRequest.Builder.() -> Unit): RegisterAgentResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

reserveContact

inline suspend fun GroundStationClient.reserveContact(crossinline block: ReserveContactRequest.Builder.() -> Unit): ReserveContactResponse

Reserves a contact using specified parameters.

tagResource

inline suspend fun GroundStationClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Assigns a tag to a resource.

untagResource

inline suspend fun GroundStationClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deassigns a resource tag.

updateAgentStatus

inline suspend fun GroundStationClient.updateAgentStatus(crossinline block: UpdateAgentStatusRequest.Builder.() -> Unit): UpdateAgentStatusResponse

For use by AWS Ground Station Agent and shouldn't be called directly.

updateConfig

inline suspend fun GroundStationClient.updateConfig(crossinline block: UpdateConfigRequest.Builder.() -> Unit): UpdateConfigResponse

Updates the Config used when scheduling contacts.

updateEphemeris

inline suspend fun GroundStationClient.updateEphemeris(crossinline block: UpdateEphemerisRequest.Builder.() -> Unit): UpdateEphemerisResponse

Updates an existing ephemeris

updateMissionProfile

inline suspend fun GroundStationClient.updateMissionProfile(crossinline block: UpdateMissionProfileRequest.Builder.() -> Unit): UpdateMissionProfileResponse

Updates a mission profile.

withConfig

fun GroundStationClient.withConfig(block: GroundStationClient.Config.Builder.() -> Unit): GroundStationClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.