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
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.
client = boto3.client("groundstation")
try:
do_something(client)
except (
client.ClientError,
client.DependencyException,
client.InvalidParameterException,
client.ResourceLimitExceededException,
client.ResourceNotFoundException,
) as e:
print(e)
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
cancel_contact
Cancels a contact with a specified contact ID.
Type annotations and code completion for boto3.client("groundstation").cancel_contact
method.
boto3 documentation
def cancel_contact(
self,
*,
contactId: str,
) -> ContactIdResponseTypeDef: # (1)
...
kwargs: CancelContactRequestRequestTypeDef = { # (1)
"contactId": ...,
}
parent.cancel_contact(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("groundstation").close
method.
boto3 documentation
create_config
Creates a Config
with the specified configData
parameters.
Type annotations and code completion for boto3.client("groundstation").create_config
method.
boto3 documentation
def create_config(
self,
*,
configData: ConfigTypeDataTypeDef, # (1)
name: str,
tags: Mapping[str, str] = ...,
) -> ConfigIdResponseTypeDef: # (2)
...
kwargs: CreateConfigRequestRequestTypeDef = { # (1)
"configData": ...,
"name": ...,
}
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
def create_dataflow_endpoint_group(
self,
*,
endpointDetails: Sequence[EndpointDetailsTypeDef], # (1)
contactPostPassDurationSeconds: int = ...,
contactPrePassDurationSeconds: int = ...,
tags: Mapping[str, str] = ...,
) -> DataflowEndpointGroupIdResponseTypeDef: # (2)
...
kwargs: CreateDataflowEndpointGroupRequestRequestTypeDef = { # (1)
"endpointDetails": ...,
}
parent.create_dataflow_endpoint_group(**kwargs)
create_ephemeris
Creates an Ephemeris with the specified EphemerisData
.
Type annotations and code completion for boto3.client("groundstation").create_ephemeris
method.
boto3 documentation
def create_ephemeris(
self,
*,
name: str,
satelliteId: str,
enabled: bool = ...,
ephemeris: EphemerisDataTypeDef = ..., # (1)
expirationTime: Union[datetime, str] = ...,
kmsKeyArn: str = ...,
priority: int = ...,
tags: Mapping[str, str] = ...,
) -> EphemerisIdResponseTypeDef: # (2)
...
kwargs: CreateEphemerisRequestRequestTypeDef = { # (1)
"name": ...,
"satelliteId": ...,
}
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
def create_mission_profile(
self,
*,
dataflowEdges: Sequence[Sequence[str]],
minimumViableContactDurationSeconds: int,
name: str,
trackingConfigArn: str,
contactPostPassDurationSeconds: int = ...,
contactPrePassDurationSeconds: int = ...,
streamsKmsKey: KmsKeyTypeDef = ..., # (1)
streamsKmsRole: str = ...,
tags: Mapping[str, str] = ...,
) -> MissionProfileIdResponseTypeDef: # (2)
...
kwargs: CreateMissionProfileRequestRequestTypeDef = { # (1)
"dataflowEdges": ...,
"minimumViableContactDurationSeconds": ...,
"name": ...,
"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
def delete_config(
self,
*,
configId: str,
configType: ConfigCapabilityTypeType, # (1)
) -> ConfigIdResponseTypeDef: # (2)
...
kwargs: DeleteConfigRequestRequestTypeDef = { # (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
def delete_dataflow_endpoint_group(
self,
*,
dataflowEndpointGroupId: str,
) -> DataflowEndpointGroupIdResponseTypeDef: # (1)
...
kwargs: DeleteDataflowEndpointGroupRequestRequestTypeDef = { # (1)
"dataflowEndpointGroupId": ...,
}
parent.delete_dataflow_endpoint_group(**kwargs)
delete_ephemeris
Deletes an ephemeris See also: AWS API Documentation.
Type annotations and code completion for boto3.client("groundstation").delete_ephemeris
method.
boto3 documentation
def delete_ephemeris(
self,
*,
ephemerisId: str,
) -> EphemerisIdResponseTypeDef: # (1)
...
kwargs: DeleteEphemerisRequestRequestTypeDef = { # (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
def delete_mission_profile(
self,
*,
missionProfileId: str,
) -> MissionProfileIdResponseTypeDef: # (1)
...
kwargs: DeleteMissionProfileRequestRequestTypeDef = { # (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
def describe_contact(
self,
*,
contactId: str,
) -> DescribeContactResponseTypeDef: # (1)
...
kwargs: DescribeContactRequestRequestTypeDef = { # (1)
"contactId": ...,
}
parent.describe_contact(**kwargs)
describe_ephemeris
Describes an existing ephemeris.
Type annotations and code completion for boto3.client("groundstation").describe_ephemeris
method.
boto3 documentation
def describe_ephemeris(
self,
*,
ephemerisId: str,
) -> DescribeEphemerisResponseTypeDef: # (1)
...
kwargs: DescribeEphemerisRequestRequestTypeDef = { # (1)
"ephemerisId": ...,
}
parent.describe_ephemeris(**kwargs)
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
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_agent_configuration
Gets the latest configuration information for a registered agent.
Type annotations and code completion for boto3.client("groundstation").get_agent_configuration
method.
boto3 documentation
def get_agent_configuration(
self,
*,
agentId: str,
) -> GetAgentConfigurationResponseTypeDef: # (1)
...
kwargs: GetAgentConfigurationRequestRequestTypeDef = { # (1)
"agentId": ...,
}
parent.get_agent_configuration(**kwargs)
get_config
Returns Config
information.
Type annotations and code completion for boto3.client("groundstation").get_config
method.
boto3 documentation
def get_config(
self,
*,
configId: str,
configType: ConfigCapabilityTypeType, # (1)
) -> GetConfigResponseTypeDef: # (2)
...
kwargs: GetConfigRequestRequestTypeDef = { # (1)
"configId": ...,
"configType": ...,
}
parent.get_config(**kwargs)
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
def get_dataflow_endpoint_group(
self,
*,
dataflowEndpointGroupId: str,
) -> GetDataflowEndpointGroupResponseTypeDef: # (1)
...
kwargs: GetDataflowEndpointGroupRequestRequestTypeDef = { # (1)
"dataflowEndpointGroupId": ...,
}
parent.get_dataflow_endpoint_group(**kwargs)
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
def get_minute_usage(
self,
*,
month: int,
year: int,
) -> GetMinuteUsageResponseTypeDef: # (1)
...
kwargs: GetMinuteUsageRequestRequestTypeDef = { # (1)
"month": ...,
"year": ...,
}
parent.get_minute_usage(**kwargs)
get_mission_profile
Returns a mission profile.
Type annotations and code completion for boto3.client("groundstation").get_mission_profile
method.
boto3 documentation
def get_mission_profile(
self,
*,
missionProfileId: str,
) -> GetMissionProfileResponseTypeDef: # (1)
...
kwargs: GetMissionProfileRequestRequestTypeDef = { # (1)
"missionProfileId": ...,
}
parent.get_mission_profile(**kwargs)
get_satellite
Returns a satellite.
Type annotations and code completion for boto3.client("groundstation").get_satellite
method.
boto3 documentation
def get_satellite(
self,
*,
satelliteId: str,
) -> GetSatelliteResponseTypeDef: # (1)
...
kwargs: GetSatelliteRequestRequestTypeDef = { # (1)
"satelliteId": ...,
}
parent.get_satellite(**kwargs)
list_configs
Returns a list of Config
objects.
Type annotations and code completion for boto3.client("groundstation").list_configs
method.
boto3 documentation
def list_configs(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListConfigsResponseTypeDef: # (1)
...
kwargs: ListConfigsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_configs(**kwargs)
list_contacts
Returns a list of contacts.
Type annotations and code completion for boto3.client("groundstation").list_contacts
method.
boto3 documentation
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)
...
kwargs: ListContactsRequestRequestTypeDef = { # (1)
"endTime": ...,
"startTime": ...,
"statusList": ...,
}
parent.list_contacts(**kwargs)
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
def list_dataflow_endpoint_groups(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDataflowEndpointGroupsResponseTypeDef: # (1)
...
kwargs: ListDataflowEndpointGroupsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_dataflow_endpoint_groups(**kwargs)
list_ephemerides
List existing ephemerides.
Type annotations and code completion for boto3.client("groundstation").list_ephemerides
method.
boto3 documentation
def list_ephemerides(
self,
*,
endTime: Union[datetime, str],
satelliteId: str,
startTime: Union[datetime, str],
maxResults: int = ...,
nextToken: str = ...,
statusList: Sequence[EphemerisStatusType] = ..., # (1)
) -> ListEphemeridesResponseTypeDef: # (2)
...
kwargs: ListEphemeridesRequestRequestTypeDef = { # (1)
"endTime": ...,
"satelliteId": ...,
"startTime": ...,
}
parent.list_ephemerides(**kwargs)
list_ground_stations
Returns a list of ground stations.
Type annotations and code completion for boto3.client("groundstation").list_ground_stations
method.
boto3 documentation
def list_ground_stations(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
satelliteId: str = ...,
) -> ListGroundStationsResponseTypeDef: # (1)
...
kwargs: ListGroundStationsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_ground_stations(**kwargs)
list_mission_profiles
Returns a list of mission profiles.
Type annotations and code completion for boto3.client("groundstation").list_mission_profiles
method.
boto3 documentation
def list_mission_profiles(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListMissionProfilesResponseTypeDef: # (1)
...
kwargs: ListMissionProfilesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_mission_profiles(**kwargs)
list_satellites
Returns a list of satellites.
Type annotations and code completion for boto3.client("groundstation").list_satellites
method.
boto3 documentation
def list_satellites(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSatellitesResponseTypeDef: # (1)
...
kwargs: ListSatellitesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_satellites(**kwargs)
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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
register_agent
Registers a new agent with AWS Groundstation.
Type annotations and code completion for boto3.client("groundstation").register_agent
method.
boto3 documentation
def register_agent(
self,
*,
agentDetails: AgentDetailsTypeDef, # (1)
discoveryData: DiscoveryDataTypeDef, # (2)
) -> RegisterAgentResponseTypeDef: # (3)
...
kwargs: RegisterAgentRequestRequestTypeDef = { # (1)
"agentDetails": ...,
"discoveryData": ...,
}
parent.register_agent(**kwargs)
reserve_contact
Reserves a contact using specified parameters.
Type annotations and code completion for boto3.client("groundstation").reserve_contact
method.
boto3 documentation
def reserve_contact(
self,
*,
endTime: Union[datetime, str],
groundStation: str,
missionProfileArn: str,
satelliteArn: str,
startTime: Union[datetime, str],
tags: Mapping[str, str] = ...,
) -> ContactIdResponseTypeDef: # (1)
...
kwargs: ReserveContactRequestRequestTypeDef = { # (1)
"endTime": ...,
"groundStation": ...,
"missionProfileArn": ...,
"satelliteArn": ...,
"startTime": ...,
}
parent.reserve_contact(**kwargs)
tag_resource
Assigns a tag to a resource.
Type annotations and code completion for boto3.client("groundstation").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Deassigns a resource tag.
Type annotations and code completion for boto3.client("groundstation").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_agent_status
Update the status of the agent.
Type annotations and code completion for boto3.client("groundstation").update_agent_status
method.
boto3 documentation
def update_agent_status(
self,
*,
agentId: str,
aggregateStatus: AggregateStatusTypeDef, # (1)
componentStatuses: Sequence[ComponentStatusDataTypeDef], # (2)
taskId: str,
) -> UpdateAgentStatusResponseTypeDef: # (3)
...
kwargs: UpdateAgentStatusRequestRequestTypeDef = { # (1)
"agentId": ...,
"aggregateStatus": ...,
"componentStatuses": ...,
"taskId": ...,
}
parent.update_agent_status(**kwargs)
update_config
Updates the Config
used when scheduling contacts.
Type annotations and code completion for boto3.client("groundstation").update_config
method.
boto3 documentation
def update_config(
self,
*,
configData: ConfigTypeDataTypeDef, # (1)
configId: str,
configType: ConfigCapabilityTypeType, # (2)
name: str,
) -> ConfigIdResponseTypeDef: # (3)
...
kwargs: UpdateConfigRequestRequestTypeDef = { # (1)
"configData": ...,
"configId": ...,
"configType": ...,
"name": ...,
}
parent.update_config(**kwargs)
update_ephemeris
Updates an existing ephemeris See also: AWS API Documentation.
Type annotations and code completion for boto3.client("groundstation").update_ephemeris
method.
boto3 documentation
def update_ephemeris(
self,
*,
enabled: bool,
ephemerisId: str,
name: str = ...,
priority: int = ...,
) -> EphemerisIdResponseTypeDef: # (1)
...
kwargs: UpdateEphemerisRequestRequestTypeDef = { # (1)
"enabled": ...,
"ephemerisId": ...,
}
parent.update_ephemeris(**kwargs)
update_mission_profile
Updates a mission profile.
Type annotations and code completion for boto3.client("groundstation").update_mission_profile
method.
boto3 documentation
def update_mission_profile(
self,
*,
missionProfileId: str,
contactPostPassDurationSeconds: int = ...,
contactPrePassDurationSeconds: int = ...,
dataflowEdges: Sequence[Sequence[str]] = ...,
minimumViableContactDurationSeconds: int = ...,
name: str = ...,
streamsKmsKey: KmsKeyTypeDef = ..., # (1)
streamsKmsRole: str = ...,
trackingConfigArn: str = ...,
) -> MissionProfileIdResponseTypeDef: # (2)
...
kwargs: UpdateMissionProfileRequestRequestTypeDef = { # (1)
"missionProfileId": ...,
}
parent.update_mission_profile(**kwargs)
get_paginator
Type annotations and code completion for 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")
-> ListSatellitesPaginator
get_waiter
Type annotations and code completion for boto3.client("groundstation").get_waiter
method with overloads.
client.get_waiter("contact_scheduled")
-> ContactScheduledWaiter