GroundStationClient#
Index > GroundStation > GroundStationClient
Auto-generated documentation for GroundStation type annotations stubs module types-boto3-groundstation.
GroundStationClient#
Type annotations and code completion for boto3.client("groundstation").
 boto3 documentation
# GroundStationClient usage example
from boto3.session import Session
from types_boto3_groundstation.client import GroundStationClient
def get_groundstation_client() -> GroundStationClient:
    return Session().client("groundstation")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("groundstation").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("groundstation")
try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DependencyException,
    client.exceptions.InvalidParameterException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)# Exceptions.exceptions type checking example
from types_boto3_groundstation.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
    ...Methods#
can_paginate#
Type annotations and code completion for boto3.client("groundstation").can_paginate method.
 boto3 documentation
# can_paginate method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...generate_presigned_url#
Type annotations and code completion for boto3.client("groundstation").generate_presigned_url method.
 boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...cancel_contact#
Cancels a contact with a specified contact ID.
Type annotations and code completion for boto3.client("groundstation").cancel_contact method.
 boto3 documentation
# cancel_contact method definition
def cancel_contact(
    self,
    *,
    contactId: str,
) -> ContactIdResponseTypeDef:  # (1)
    ...# cancel_contact method usage example with argument unpacking
kwargs: CancelContactRequestTypeDef = {  # (1)
    "contactId": ...,
}
parent.cancel_contact(**kwargs)create_config#
Creates a Config with the specified configData
parameters.
Type annotations and code completion for boto3.client("groundstation").create_config method.
 boto3 documentation
# create_config method definition
def create_config(
    self,
    *,
    name: str,
    configData: ConfigTypeDataTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
) -> ConfigIdResponseTypeDef:  # (2)
    ...# create_config method usage example with argument unpacking
kwargs: CreateConfigRequestTypeDef = {  # (1)
    "name": ...,
    "configData": ...,
}
parent.create_config(**kwargs)create_dataflow_endpoint_group#
Creates a DataflowEndpoint group containing the specified list of
DataflowEndpoint objects.
Type annotations and code completion for boto3.client("groundstation").create_dataflow_endpoint_group method.
 boto3 documentation
# create_dataflow_endpoint_group method definition
def create_dataflow_endpoint_group(
    self,
    *,
    endpointDetails: Sequence[EndpointDetailsUnionTypeDef],  # (1)
    tags: Mapping[str, str] = ...,
    contactPrePassDurationSeconds: int = ...,
    contactPostPassDurationSeconds: int = ...,
) -> DataflowEndpointGroupIdResponseTypeDef:  # (2)
    ...- See Sequence[EndpointDetailsUnionTypeDef]
- See DataflowEndpointGroupIdResponseTypeDef
# create_dataflow_endpoint_group method usage example with argument unpacking
kwargs: CreateDataflowEndpointGroupRequestTypeDef = {  # (1)
    "endpointDetails": ...,
}
parent.create_dataflow_endpoint_group(**kwargs)create_ephemeris#
Create an ephemeris with your specified EphemerisData.
Type annotations and code completion for boto3.client("groundstation").create_ephemeris method.
 boto3 documentation
# create_ephemeris method definition
def create_ephemeris(
    self,
    *,
    name: str,
    satelliteId: str = ...,
    enabled: bool = ...,
    priority: int = ...,
    expirationTime: TimestampTypeDef = ...,
    kmsKeyArn: str = ...,
    ephemeris: EphemerisDataTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> EphemerisIdResponseTypeDef:  # (2)
    ...# create_ephemeris method usage example with argument unpacking
kwargs: CreateEphemerisRequestTypeDef = {  # (1)
    "name": ...,
}
parent.create_ephemeris(**kwargs)create_mission_profile#
Creates a mission profile.
Type annotations and code completion for boto3.client("groundstation").create_mission_profile method.
 boto3 documentation
# create_mission_profile method definition
def create_mission_profile(
    self,
    *,
    name: str,
    minimumViableContactDurationSeconds: int,
    dataflowEdges: Sequence[Sequence[str]],
    trackingConfigArn: str,
    contactPrePassDurationSeconds: int = ...,
    contactPostPassDurationSeconds: int = ...,
    tags: Mapping[str, str] = ...,
    streamsKmsKey: KmsKeyTypeDef = ...,  # (1)
    streamsKmsRole: str = ...,
) -> MissionProfileIdResponseTypeDef:  # (2)
    ...# create_mission_profile method usage example with argument unpacking
kwargs: CreateMissionProfileRequestTypeDef = {  # (1)
    "name": ...,
    "minimumViableContactDurationSeconds": ...,
    "dataflowEdges": ...,
    "trackingConfigArn": ...,
}
parent.create_mission_profile(**kwargs)delete_config#
Deletes a Config.
Type annotations and code completion for boto3.client("groundstation").delete_config method.
 boto3 documentation
# delete_config method definition
def delete_config(
    self,
    *,
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
) -> ConfigIdResponseTypeDef:  # (2)
    ...# delete_config method usage example with argument unpacking
kwargs: DeleteConfigRequestTypeDef = {  # (1)
    "configId": ...,
    "configType": ...,
}
parent.delete_config(**kwargs)delete_dataflow_endpoint_group#
Deletes a dataflow endpoint group.
Type annotations and code completion for boto3.client("groundstation").delete_dataflow_endpoint_group method.
 boto3 documentation
# delete_dataflow_endpoint_group method definition
def delete_dataflow_endpoint_group(
    self,
    *,
    dataflowEndpointGroupId: str,
) -> DataflowEndpointGroupIdResponseTypeDef:  # (1)
    ...# delete_dataflow_endpoint_group method usage example with argument unpacking
kwargs: DeleteDataflowEndpointGroupRequestTypeDef = {  # (1)
    "dataflowEndpointGroupId": ...,
}
parent.delete_dataflow_endpoint_group(**kwargs)delete_ephemeris#
Delete an ephemeris.
Type annotations and code completion for boto3.client("groundstation").delete_ephemeris method.
 boto3 documentation
# delete_ephemeris method definition
def delete_ephemeris(
    self,
    *,
    ephemerisId: str,
) -> EphemerisIdResponseTypeDef:  # (1)
    ...# delete_ephemeris method usage example with argument unpacking
kwargs: DeleteEphemerisRequestTypeDef = {  # (1)
    "ephemerisId": ...,
}
parent.delete_ephemeris(**kwargs)delete_mission_profile#
Deletes a mission profile.
Type annotations and code completion for boto3.client("groundstation").delete_mission_profile method.
 boto3 documentation
# delete_mission_profile method definition
def delete_mission_profile(
    self,
    *,
    missionProfileId: str,
) -> MissionProfileIdResponseTypeDef:  # (1)
    ...# delete_mission_profile method usage example with argument unpacking
kwargs: DeleteMissionProfileRequestTypeDef = {  # (1)
    "missionProfileId": ...,
}
parent.delete_mission_profile(**kwargs)describe_contact#
Describes an existing contact.
Type annotations and code completion for boto3.client("groundstation").describe_contact method.
 boto3 documentation
# describe_contact method definition
def describe_contact(
    self,
    *,
    contactId: str,
) -> DescribeContactResponseTypeDef:  # (1)
    ...# describe_contact method usage example with argument unpacking
kwargs: DescribeContactRequestTypeDef = {  # (1)
    "contactId": ...,
}
parent.describe_contact(**kwargs)describe_ephemeris#
Retrieve information about an existing ephemeris.
Type annotations and code completion for boto3.client("groundstation").describe_ephemeris method.
 boto3 documentation
# describe_ephemeris method definition
def describe_ephemeris(
    self,
    *,
    ephemerisId: str,
) -> DescribeEphemerisResponseTypeDef:  # (1)
    ...# describe_ephemeris method usage example with argument unpacking
kwargs: DescribeEphemerisRequestTypeDef = {  # (1)
    "ephemerisId": ...,
}
parent.describe_ephemeris(**kwargs)get_agent_configuration#
 For use by AWS Ground Station Agent and shouldn't be called directly. Type annotations and code completion for  Returns  Type annotations and code completion for  Returns the dataflow endpoint group. Type annotations and code completion for  Returns the number of reserved minutes used by account. Type annotations and code completion for  Returns a mission profile. Type annotations and code completion for  Returns a satellite. Type annotations and code completion for  Returns a list of  Type annotations and code completion for  Returns a list of contacts. Type annotations and code completion for  Returns a list of  Type annotations and code completion for  List your existing ephemerides. Type annotations and code completion for  Returns a list of ground stations. Type annotations and code completion for  Returns a list of mission profiles. Type annotations and code completion for  Returns a list of satellites. Type annotations and code completion for  Returns a list of tags for a specified resource. Type annotations and code completion for   For use by AWS Ground Station Agent and shouldn't be called directly. Type annotations and code completion for  Reserves a contact using specified parameters. Type annotations and code completion for  Assigns a tag to a resource. Type annotations and code completion for  Deassigns a resource tag. Type annotations and code completion for   For use by AWS Ground Station Agent and shouldn't be called directly. Type annotations and code completion for  Updates the  Type annotations and code completion for  Update an existing ephemeris. Type annotations and code completion for  Updates a mission profile. Type annotations and code completion for  Type annotations and code completion for  Type annotations and code completion for boto3.client("groundstation").get_agent_configuration method.
 boto3 documentation# get_agent_configuration method definition
def get_agent_configuration(
    self,
    *,
    agentId: str,
) -> GetAgentConfigurationResponseTypeDef:  # (1)
    ...# get_agent_configuration method usage example with argument unpacking
kwargs: GetAgentConfigurationRequestTypeDef = {  # (1)
    "agentId": ...,
}
parent.get_agent_configuration(**kwargs)get_config#
Config information.boto3.client("groundstation").get_config method.
 boto3 documentation# get_config method definition
def get_config(
    self,
    *,
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
) -> GetConfigResponseTypeDef:  # (2)
    ...# get_config method usage example with argument unpacking
kwargs: GetConfigRequestTypeDef = {  # (1)
    "configId": ...,
    "configType": ...,
}
parent.get_config(**kwargs)get_dataflow_endpoint_group#
boto3.client("groundstation").get_dataflow_endpoint_group method.
 boto3 documentation# get_dataflow_endpoint_group method definition
def get_dataflow_endpoint_group(
    self,
    *,
    dataflowEndpointGroupId: str,
) -> GetDataflowEndpointGroupResponseTypeDef:  # (1)
    ...# get_dataflow_endpoint_group method usage example with argument unpacking
kwargs: GetDataflowEndpointGroupRequestTypeDef = {  # (1)
    "dataflowEndpointGroupId": ...,
}
parent.get_dataflow_endpoint_group(**kwargs)get_minute_usage#
boto3.client("groundstation").get_minute_usage method.
 boto3 documentation# get_minute_usage method definition
def get_minute_usage(
    self,
    *,
    month: int,
    year: int,
) -> GetMinuteUsageResponseTypeDef:  # (1)
    ...# get_minute_usage method usage example with argument unpacking
kwargs: GetMinuteUsageRequestTypeDef = {  # (1)
    "month": ...,
    "year": ...,
}
parent.get_minute_usage(**kwargs)get_mission_profile#
boto3.client("groundstation").get_mission_profile method.
 boto3 documentation# get_mission_profile method definition
def get_mission_profile(
    self,
    *,
    missionProfileId: str,
) -> GetMissionProfileResponseTypeDef:  # (1)
    ...# get_mission_profile method usage example with argument unpacking
kwargs: GetMissionProfileRequestTypeDef = {  # (1)
    "missionProfileId": ...,
}
parent.get_mission_profile(**kwargs)get_satellite#
boto3.client("groundstation").get_satellite method.
 boto3 documentation# get_satellite method definition
def get_satellite(
    self,
    *,
    satelliteId: str,
) -> GetSatelliteResponseTypeDef:  # (1)
    ...# get_satellite method usage example with argument unpacking
kwargs: GetSatelliteRequestTypeDef = {  # (1)
    "satelliteId": ...,
}
parent.get_satellite(**kwargs)list_configs#
Config objects.boto3.client("groundstation").list_configs method.
 boto3 documentation# list_configs method definition
def list_configs(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConfigsResponseTypeDef:  # (1)
    ...# list_configs method usage example with argument unpacking
kwargs: ListConfigsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_configs(**kwargs)list_contacts#
boto3.client("groundstation").list_contacts method.
 boto3 documentation# list_contacts method definition
def list_contacts(
    self,
    *,
    statusList: Sequence[ContactStatusType],  # (1)
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    maxResults: int = ...,
    nextToken: str = ...,
    groundStation: str = ...,
    satelliteArn: str = ...,
    missionProfileArn: str = ...,
    ephemeris: EphemerisFilterTypeDef = ...,  # (2)
) -> ListContactsResponseTypeDef:  # (3)
    ...
Sequence[ContactStatusType]# list_contacts method usage example with argument unpacking
kwargs: ListContactsRequestTypeDef = {  # (1)
    "statusList": ...,
    "startTime": ...,
    "endTime": ...,
}
parent.list_contacts(**kwargs)list_dataflow_endpoint_groups#
DataflowEndpoint groups.boto3.client("groundstation").list_dataflow_endpoint_groups method.
 boto3 documentation# list_dataflow_endpoint_groups method definition
def list_dataflow_endpoint_groups(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDataflowEndpointGroupsResponseTypeDef:  # (1)
    ...# list_dataflow_endpoint_groups method usage example with argument unpacking
kwargs: ListDataflowEndpointGroupsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_dataflow_endpoint_groups(**kwargs)list_ephemerides#
boto3.client("groundstation").list_ephemerides method.
 boto3 documentation# list_ephemerides method definition
def list_ephemerides(
    self,
    *,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    satelliteId: str = ...,
    ephemerisType: EphemerisTypeType = ...,  # (1)
    statusList: Sequence[EphemerisStatusType] = ...,  # (2)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEphemeridesResponseTypeDef:  # (3)
    ...
Sequence[EphemerisStatusType]# list_ephemerides method usage example with argument unpacking
kwargs: ListEphemeridesRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}
parent.list_ephemerides(**kwargs)list_ground_stations#
boto3.client("groundstation").list_ground_stations method.
 boto3 documentation# list_ground_stations method definition
def list_ground_stations(
    self,
    *,
    satelliteId: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListGroundStationsResponseTypeDef:  # (1)
    ...# list_ground_stations method usage example with argument unpacking
kwargs: ListGroundStationsRequestTypeDef = {  # (1)
    "satelliteId": ...,
}
parent.list_ground_stations(**kwargs)list_mission_profiles#
boto3.client("groundstation").list_mission_profiles method.
 boto3 documentation# list_mission_profiles method definition
def list_mission_profiles(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMissionProfilesResponseTypeDef:  # (1)
    ...# list_mission_profiles method usage example with argument unpacking
kwargs: ListMissionProfilesRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_mission_profiles(**kwargs)list_satellites#
boto3.client("groundstation").list_satellites method.
 boto3 documentation# list_satellites method definition
def list_satellites(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSatellitesResponseTypeDef:  # (1)
    ...# list_satellites method usage example with argument unpacking
kwargs: ListSatellitesRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_satellites(**kwargs)list_tags_for_resource#
boto3.client("groundstation").list_tags_for_resource method.
 boto3 documentation# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)register_agent#
boto3.client("groundstation").register_agent method.
 boto3 documentation# register_agent method definition
def register_agent(
    self,
    *,
    discoveryData: DiscoveryDataTypeDef,  # (1)
    agentDetails: AgentDetailsTypeDef,  # (2)
    tags: Mapping[str, str] = ...,
) -> RegisterAgentResponseTypeDef:  # (3)
    ...# register_agent method usage example with argument unpacking
kwargs: RegisterAgentRequestTypeDef = {  # (1)
    "discoveryData": ...,
    "agentDetails": ...,
}
parent.register_agent(**kwargs)reserve_contact#
boto3.client("groundstation").reserve_contact method.
 boto3 documentation# reserve_contact method definition
def reserve_contact(
    self,
    *,
    missionProfileArn: str,
    startTime: TimestampTypeDef,
    endTime: TimestampTypeDef,
    groundStation: str,
    satelliteArn: str = ...,
    tags: Mapping[str, str] = ...,
    trackingOverrides: TrackingOverridesTypeDef = ...,  # (1)
) -> ContactIdResponseTypeDef:  # (2)
    ...# reserve_contact method usage example with argument unpacking
kwargs: ReserveContactRequestTypeDef = {  # (1)
    "missionProfileArn": ...,
    "startTime": ...,
    "endTime": ...,
    "groundStation": ...,
}
parent.reserve_contact(**kwargs)tag_resource#
boto3.client("groundstation").tag_resource method.
 boto3 documentation# tag_resource method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
boto3.client("groundstation").untag_resource method.
 boto3 documentation# untag_resource method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}
parent.untag_resource(**kwargs)update_agent_status#
boto3.client("groundstation").update_agent_status method.
 boto3 documentation# update_agent_status method definition
def update_agent_status(
    self,
    *,
    agentId: str,
    taskId: str,
    aggregateStatus: AggregateStatusTypeDef,  # (1)
    componentStatuses: Sequence[ComponentStatusDataTypeDef],  # (2)
) -> UpdateAgentStatusResponseTypeDef:  # (3)
    ...
Sequence[ComponentStatusDataTypeDef]# update_agent_status method usage example with argument unpacking
kwargs: UpdateAgentStatusRequestTypeDef = {  # (1)
    "agentId": ...,
    "taskId": ...,
    "aggregateStatus": ...,
    "componentStatuses": ...,
}
parent.update_agent_status(**kwargs)update_config#
Config used when scheduling contacts.boto3.client("groundstation").update_config method.
 boto3 documentation# update_config method definition
def update_config(
    self,
    *,
    configId: str,
    name: str,
    configType: ConfigCapabilityTypeType,  # (1)
    configData: ConfigTypeDataTypeDef,  # (2)
) -> ConfigIdResponseTypeDef:  # (3)
    ...# update_config method usage example with argument unpacking
kwargs: UpdateConfigRequestTypeDef = {  # (1)
    "configId": ...,
    "name": ...,
    "configType": ...,
    "configData": ...,
}
parent.update_config(**kwargs)update_ephemeris#
boto3.client("groundstation").update_ephemeris method.
 boto3 documentation# update_ephemeris method definition
def update_ephemeris(
    self,
    *,
    ephemerisId: str,
    enabled: bool,
    name: str = ...,
    priority: int = ...,
) -> EphemerisIdResponseTypeDef:  # (1)
    ...# update_ephemeris method usage example with argument unpacking
kwargs: UpdateEphemerisRequestTypeDef = {  # (1)
    "ephemerisId": ...,
    "enabled": ...,
}
parent.update_ephemeris(**kwargs)update_mission_profile#
boto3.client("groundstation").update_mission_profile method.
 boto3 documentation# update_mission_profile method definition
def update_mission_profile(
    self,
    *,
    missionProfileId: str,
    name: str = ...,
    contactPrePassDurationSeconds: int = ...,
    contactPostPassDurationSeconds: int = ...,
    minimumViableContactDurationSeconds: int = ...,
    dataflowEdges: Sequence[Sequence[str]] = ...,
    trackingConfigArn: str = ...,
    streamsKmsKey: KmsKeyTypeDef = ...,  # (1)
    streamsKmsRole: str = ...,
) -> MissionProfileIdResponseTypeDef:  # (2)
    ...# update_mission_profile method usage example with argument unpacking
kwargs: UpdateMissionProfileRequestTypeDef = {  # (1)
    "missionProfileId": ...,
}
parent.update_mission_profile(**kwargs)get_paginator#
boto3.client("groundstation").get_paginator method with overloads.
client.get_paginator("list_configs") -> ListConfigsPaginatorclient.get_paginator("list_contacts") -> ListContactsPaginatorclient.get_paginator("list_dataflow_endpoint_groups") -> ListDataflowEndpointGroupsPaginatorclient.get_paginator("list_ephemerides") -> ListEphemeridesPaginatorclient.get_paginator("list_ground_stations") -> ListGroundStationsPaginatorclient.get_paginator("list_mission_profiles") -> ListMissionProfilesPaginatorclient.get_paginator("list_satellites") -> ListSatellitesPaginatorget_waiter#
boto3.client("groundstation").get_waiter method with overloads.
client.get_waiter("contact_scheduled") -> ContactScheduledWaiter