Skip to content

GroundStationClient

Index > GroundStation > GroundStationClient

Auto-generated documentation for GroundStation type annotations stubs module mypy-boto3-groundstation.

GroundStationClient

Type annotations and code completion for boto3.client("groundstation"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_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.

Usage example
client = boto3.client("groundstation")

try:
    do_something(client)
except (
    client.ClientError,
    client.DependencyException,
    client.InvalidParameterException,
    client.ResourceLimitExceededException,
    client.ResourceNotFoundException,
) as e:
    print(e)
Type checking example
from mypy_boto3_groundstation.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("groundstation").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_contact

Cancels a contact with a specified contact ID.

Type annotations and code completion for boto3.client("groundstation").cancel_contact method. boto3 documentation

Method definition
def cancel_contact(
    self,
    *,
    contactId: str,
) -> ContactIdResponseTypeDef:  # (1)
    ...
  1. See ContactIdResponseTypeDef
Usage example with kwargs
kwargs: CancelContactRequestRequestTypeDef = {  # (1)
    "contactId": ...,
}

parent.cancel_contact(**kwargs)
  1. See CancelContactRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("groundstation").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_config

Creates a Config with the specified configData parameters.

Type annotations and code completion for boto3.client("groundstation").create_config method. boto3 documentation

Method definition
def create_config(
    self,
    *,
    configData: ConfigTypeDataTypeDef,  # (1)
    name: str,
    tags: Mapping[str, str] = ...,
) -> ConfigIdResponseTypeDef:  # (2)
    ...
  1. See ConfigTypeDataTypeDef
  2. See ConfigIdResponseTypeDef
Usage example with kwargs
kwargs: CreateConfigRequestRequestTypeDef = {  # (1)
    "configData": ...,
    "name": ...,
}

parent.create_config(**kwargs)
  1. See CreateConfigRequestRequestTypeDef

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

Method definition
def create_dataflow_endpoint_group(
    self,
    *,
    endpointDetails: Sequence[EndpointDetailsTypeDef],  # (1)
    tags: Mapping[str, str] = ...,
) -> DataflowEndpointGroupIdResponseTypeDef:  # (2)
    ...
  1. See EndpointDetailsTypeDef
  2. See DataflowEndpointGroupIdResponseTypeDef
Usage example with kwargs
kwargs: CreateDataflowEndpointGroupRequestRequestTypeDef = {  # (1)
    "endpointDetails": ...,
}

parent.create_dataflow_endpoint_group(**kwargs)
  1. See CreateDataflowEndpointGroupRequestRequestTypeDef

create_mission_profile

Creates a mission profile.

Type annotations and code completion for boto3.client("groundstation").create_mission_profile method. boto3 documentation

Method definition
def create_mission_profile(
    self,
    *,
    dataflowEdges: Sequence[Sequence[str]],
    minimumViableContactDurationSeconds: int,
    name: str,
    trackingConfigArn: str,
    contactPostPassDurationSeconds: int = ...,
    contactPrePassDurationSeconds: int = ...,
    tags: Mapping[str, str] = ...,
) -> MissionProfileIdResponseTypeDef:  # (1)
    ...
  1. See MissionProfileIdResponseTypeDef
Usage example with kwargs
kwargs: CreateMissionProfileRequestRequestTypeDef = {  # (1)
    "dataflowEdges": ...,
    "minimumViableContactDurationSeconds": ...,
    "name": ...,
    "trackingConfigArn": ...,
}

parent.create_mission_profile(**kwargs)
  1. See CreateMissionProfileRequestRequestTypeDef

delete_config

Deletes a Config .

Type annotations and code completion for boto3.client("groundstation").delete_config method. boto3 documentation

Method definition
def delete_config(
    self,
    *,
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
) -> ConfigIdResponseTypeDef:  # (2)
    ...
  1. See ConfigCapabilityTypeType
  2. See ConfigIdResponseTypeDef
Usage example with kwargs
kwargs: DeleteConfigRequestRequestTypeDef = {  # (1)
    "configId": ...,
    "configType": ...,
}

parent.delete_config(**kwargs)
  1. See DeleteConfigRequestRequestTypeDef

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

Method definition
def delete_dataflow_endpoint_group(
    self,
    *,
    dataflowEndpointGroupId: str,
) -> DataflowEndpointGroupIdResponseTypeDef:  # (1)
    ...
  1. See DataflowEndpointGroupIdResponseTypeDef
Usage example with kwargs
kwargs: DeleteDataflowEndpointGroupRequestRequestTypeDef = {  # (1)
    "dataflowEndpointGroupId": ...,
}

parent.delete_dataflow_endpoint_group(**kwargs)
  1. See DeleteDataflowEndpointGroupRequestRequestTypeDef

delete_mission_profile

Deletes a mission profile.

Type annotations and code completion for boto3.client("groundstation").delete_mission_profile method. boto3 documentation

Method definition
def delete_mission_profile(
    self,
    *,
    missionProfileId: str,
) -> MissionProfileIdResponseTypeDef:  # (1)
    ...
  1. See MissionProfileIdResponseTypeDef
Usage example with kwargs
kwargs: DeleteMissionProfileRequestRequestTypeDef = {  # (1)
    "missionProfileId": ...,
}

parent.delete_mission_profile(**kwargs)
  1. See DeleteMissionProfileRequestRequestTypeDef

describe_contact

Describes an existing contact.

Type annotations and code completion for boto3.client("groundstation").describe_contact method. boto3 documentation

Method definition
def describe_contact(
    self,
    *,
    contactId: str,
) -> DescribeContactResponseTypeDef:  # (1)
    ...
  1. See DescribeContactResponseTypeDef
Usage example with kwargs
kwargs: DescribeContactRequestRequestTypeDef = {  # (1)
    "contactId": ...,
}

parent.describe_contact(**kwargs)
  1. See DescribeContactRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("groundstation").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_config

Returns Config information.

Type annotations and code completion for boto3.client("groundstation").get_config method. boto3 documentation

Method definition
def get_config(
    self,
    *,
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
) -> GetConfigResponseTypeDef:  # (2)
    ...
  1. See ConfigCapabilityTypeType
  2. See GetConfigResponseTypeDef
Usage example with kwargs
kwargs: GetConfigRequestRequestTypeDef = {  # (1)
    "configId": ...,
    "configType": ...,
}

parent.get_config(**kwargs)
  1. See GetConfigRequestRequestTypeDef

get_dataflow_endpoint_group

Returns the dataflow endpoint group.

Type annotations and code completion for boto3.client("groundstation").get_dataflow_endpoint_group method. boto3 documentation

Method definition
def get_dataflow_endpoint_group(
    self,
    *,
    dataflowEndpointGroupId: str,
) -> GetDataflowEndpointGroupResponseTypeDef:  # (1)
    ...
  1. See GetDataflowEndpointGroupResponseTypeDef
Usage example with kwargs
kwargs: GetDataflowEndpointGroupRequestRequestTypeDef = {  # (1)
    "dataflowEndpointGroupId": ...,
}

parent.get_dataflow_endpoint_group(**kwargs)
  1. See GetDataflowEndpointGroupRequestRequestTypeDef

get_minute_usage

Returns the number of minutes used by account.

Type annotations and code completion for boto3.client("groundstation").get_minute_usage method. boto3 documentation

Method definition
def get_minute_usage(
    self,
    *,
    month: int,
    year: int,
) -> GetMinuteUsageResponseTypeDef:  # (1)
    ...
  1. See GetMinuteUsageResponseTypeDef
Usage example with kwargs
kwargs: GetMinuteUsageRequestRequestTypeDef = {  # (1)
    "month": ...,
    "year": ...,
}

parent.get_minute_usage(**kwargs)
  1. See GetMinuteUsageRequestRequestTypeDef

get_mission_profile

Returns a mission profile.

Type annotations and code completion for boto3.client("groundstation").get_mission_profile method. boto3 documentation

Method definition
def get_mission_profile(
    self,
    *,
    missionProfileId: str,
) -> GetMissionProfileResponseTypeDef:  # (1)
    ...
  1. See GetMissionProfileResponseTypeDef
Usage example with kwargs
kwargs: GetMissionProfileRequestRequestTypeDef = {  # (1)
    "missionProfileId": ...,
}

parent.get_mission_profile(**kwargs)
  1. See GetMissionProfileRequestRequestTypeDef

get_satellite

Returns a satellite.

Type annotations and code completion for boto3.client("groundstation").get_satellite method. boto3 documentation

Method definition
def get_satellite(
    self,
    *,
    satelliteId: str,
) -> GetSatelliteResponseTypeDef:  # (1)
    ...
  1. See GetSatelliteResponseTypeDef
Usage example with kwargs
kwargs: GetSatelliteRequestRequestTypeDef = {  # (1)
    "satelliteId": ...,
}

parent.get_satellite(**kwargs)
  1. See GetSatelliteRequestRequestTypeDef

list_configs

Returns a list of Config objects.

Type annotations and code completion for boto3.client("groundstation").list_configs method. boto3 documentation

Method definition
def list_configs(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConfigsResponseTypeDef:  # (1)
    ...
  1. See ListConfigsResponseTypeDef
Usage example with kwargs
kwargs: ListConfigsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_configs(**kwargs)
  1. See ListConfigsRequestRequestTypeDef

list_contacts

Returns a list of contacts.

Type annotations and code completion for boto3.client("groundstation").list_contacts method. boto3 documentation

Method definition
def list_contacts(
    self,
    *,
    endTime: Union[datetime, str],
    startTime: Union[datetime, str],
    statusList: Sequence[ContactStatusType],  # (1)
    groundStation: str = ...,
    maxResults: int = ...,
    missionProfileArn: str = ...,
    nextToken: str = ...,
    satelliteArn: str = ...,
) -> ListContactsResponseTypeDef:  # (2)
    ...
  1. See ContactStatusType
  2. See ListContactsResponseTypeDef
Usage example with kwargs
kwargs: ListContactsRequestRequestTypeDef = {  # (1)
    "endTime": ...,
    "startTime": ...,
    "statusList": ...,
}

parent.list_contacts(**kwargs)
  1. See ListContactsRequestRequestTypeDef

list_dataflow_endpoint_groups

Returns a list of DataflowEndpoint groups.

Type annotations and code completion for boto3.client("groundstation").list_dataflow_endpoint_groups method. boto3 documentation

Method definition
def list_dataflow_endpoint_groups(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDataflowEndpointGroupsResponseTypeDef:  # (1)
    ...
  1. See ListDataflowEndpointGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListDataflowEndpointGroupsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_dataflow_endpoint_groups(**kwargs)
  1. See ListDataflowEndpointGroupsRequestRequestTypeDef

list_ground_stations

Returns a list of ground stations.

Type annotations and code completion for boto3.client("groundstation").list_ground_stations method. boto3 documentation

Method definition
def list_ground_stations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    satelliteId: str = ...,
) -> ListGroundStationsResponseTypeDef:  # (1)
    ...
  1. See ListGroundStationsResponseTypeDef
Usage example with kwargs
kwargs: ListGroundStationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_ground_stations(**kwargs)
  1. See ListGroundStationsRequestRequestTypeDef

list_mission_profiles

Returns a list of mission profiles.

Type annotations and code completion for boto3.client("groundstation").list_mission_profiles method. boto3 documentation

Method definition
def list_mission_profiles(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMissionProfilesResponseTypeDef:  # (1)
    ...
  1. See ListMissionProfilesResponseTypeDef
Usage example with kwargs
kwargs: ListMissionProfilesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_mission_profiles(**kwargs)
  1. See ListMissionProfilesRequestRequestTypeDef

list_satellites

Returns a list of satellites.

Type annotations and code completion for boto3.client("groundstation").list_satellites method. boto3 documentation

Method definition
def list_satellites(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSatellitesResponseTypeDef:  # (1)
    ...
  1. See ListSatellitesResponseTypeDef
Usage example with kwargs
kwargs: ListSatellitesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_satellites(**kwargs)
  1. See ListSatellitesRequestRequestTypeDef

list_tags_for_resource

Returns a list of tags for a specified resource.

Type annotations and code completion for boto3.client("groundstation").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

reserve_contact

Reserves a contact using specified parameters.

Type annotations and code completion for boto3.client("groundstation").reserve_contact method. boto3 documentation

Method definition
def reserve_contact(
    self,
    *,
    endTime: Union[datetime, str],
    groundStation: str,
    missionProfileArn: str,
    satelliteArn: str,
    startTime: Union[datetime, str],
    tags: Mapping[str, str] = ...,
) -> ContactIdResponseTypeDef:  # (1)
    ...
  1. See ContactIdResponseTypeDef
Usage example with kwargs
kwargs: ReserveContactRequestRequestTypeDef = {  # (1)
    "endTime": ...,
    "groundStation": ...,
    "missionProfileArn": ...,
    "satelliteArn": ...,
    "startTime": ...,
}

parent.reserve_contact(**kwargs)
  1. See ReserveContactRequestRequestTypeDef

tag_resource

Assigns a tag to a resource.

Type annotations and code completion for boto3.client("groundstation").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Deassigns a resource tag.

Type annotations and code completion for boto3.client("groundstation").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_config

Updates the Config used when scheduling contacts.

Type annotations and code completion for boto3.client("groundstation").update_config method. boto3 documentation

Method definition
def update_config(
    self,
    *,
    configData: ConfigTypeDataTypeDef,  # (1)
    configId: str,
    configType: ConfigCapabilityTypeType,  # (2)
    name: str,
) -> ConfigIdResponseTypeDef:  # (3)
    ...
  1. See ConfigTypeDataTypeDef
  2. See ConfigCapabilityTypeType
  3. See ConfigIdResponseTypeDef
Usage example with kwargs
kwargs: UpdateConfigRequestRequestTypeDef = {  # (1)
    "configData": ...,
    "configId": ...,
    "configType": ...,
    "name": ...,
}

parent.update_config(**kwargs)
  1. See UpdateConfigRequestRequestTypeDef

update_mission_profile

Updates a mission profile.

Type annotations and code completion for boto3.client("groundstation").update_mission_profile method. boto3 documentation

Method definition
def update_mission_profile(
    self,
    *,
    missionProfileId: str,
    contactPostPassDurationSeconds: int = ...,
    contactPrePassDurationSeconds: int = ...,
    dataflowEdges: Sequence[Sequence[str]] = ...,
    minimumViableContactDurationSeconds: int = ...,
    name: str = ...,
    trackingConfigArn: str = ...,
) -> MissionProfileIdResponseTypeDef:  # (1)
    ...
  1. See MissionProfileIdResponseTypeDef
Usage example with kwargs
kwargs: UpdateMissionProfileRequestRequestTypeDef = {  # (1)
    "missionProfileId": ...,
}

parent.update_mission_profile(**kwargs)
  1. See UpdateMissionProfileRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("groundstation").get_paginator method with overloads.