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

# GroundStationClient 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.

# Exceptions.exceptions usage example

client = boto3.client("groundstation")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DependencyException,
    client.exceptions.InvalidParameterException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions 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

# can_paginate 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

# cancel_contact method definition

def cancel_contact(
    self,
    *,
    contactId: str,
) -> ContactIdResponseTypeDef:  # (1)
    ...
  1. See ContactIdResponseTypeDef 
# cancel_contact method usage example with argument unpacking

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

# close 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

# create_config method definition

def create_config(
    self,
    *,
    configData: ConfigTypeDataTypeDef,  # (1)
    name: str,
    tags: Mapping[str, str] = ...,
) -> ConfigIdResponseTypeDef:  # (2)
    ...
  1. See ConfigTypeDataTypeDef
  2. See ConfigIdResponseTypeDef 
# create_config method usage example with argument unpacking

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

# create_dataflow_endpoint_group method definition

def create_dataflow_endpoint_group(
    self,
    *,
    endpointDetails: Sequence[EndpointDetailsTypeDef],  # (1)
    contactPostPassDurationSeconds: int = ...,
    contactPrePassDurationSeconds: int = ...,
    tags: Mapping[str, str] = ...,
) -> DataflowEndpointGroupIdResponseTypeDef:  # (2)
    ...
  1. See EndpointDetailsTypeDef
  2. See DataflowEndpointGroupIdResponseTypeDef 
# create_dataflow_endpoint_group method usage example with argument unpacking

kwargs: CreateDataflowEndpointGroupRequestRequestTypeDef = {  # (1)
    "endpointDetails": ...,
}

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

create_ephemeris#

Creates an Ephemeris with the 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 = ...,
    ephemeris: EphemerisDataTypeDef = ...,  # (1)
    expirationTime: Union[datetime, str] = ...,
    kmsKeyArn: str = ...,
    priority: int = ...,
    tags: Mapping[str, str] = ...,
) -> EphemerisIdResponseTypeDef:  # (2)
    ...
  1. See EphemerisDataTypeDef
  2. See EphemerisIdResponseTypeDef 
# create_ephemeris method usage example with argument unpacking

kwargs: CreateEphemerisRequestRequestTypeDef = {  # (1)
    "name": ...,
    "satelliteId": ...,
}

parent.create_ephemeris(**kwargs)
  1. See CreateEphemerisRequestRequestTypeDef

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,
    *,
    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)
    ...
  1. See KmsKeyTypeDef
  2. See MissionProfileIdResponseTypeDef 
# create_mission_profile method usage example with argument unpacking

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

# delete_config method definition

def delete_config(
    self,
    *,
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
) -> ConfigIdResponseTypeDef:  # (2)
    ...
  1. See ConfigCapabilityTypeType
  2. See ConfigIdResponseTypeDef 
# delete_config method usage example with argument unpacking

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

# delete_dataflow_endpoint_group method definition

def delete_dataflow_endpoint_group(
    self,
    *,
    dataflowEndpointGroupId: str,
) -> DataflowEndpointGroupIdResponseTypeDef:  # (1)
    ...
  1. See DataflowEndpointGroupIdResponseTypeDef 
# delete_dataflow_endpoint_group method usage example with argument unpacking

kwargs: DeleteDataflowEndpointGroupRequestRequestTypeDef = {  # (1)
    "dataflowEndpointGroupId": ...,
}

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

delete_ephemeris#

Deletes an ephemeris See also: AWS API Documentation.

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)
    ...
  1. See EphemerisIdResponseTypeDef 
# delete_ephemeris method usage example with argument unpacking

kwargs: DeleteEphemerisRequestRequestTypeDef = {  # (1)
    "ephemerisId": ...,
}

parent.delete_ephemeris(**kwargs)
  1. See DeleteEphemerisRequestRequestTypeDef

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)
    ...
  1. See MissionProfileIdResponseTypeDef 
# delete_mission_profile method usage example with argument unpacking

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

# describe_contact method definition

def describe_contact(
    self,
    *,
    contactId: str,
) -> DescribeContactResponseTypeDef:  # (1)
    ...
  1. See DescribeContactResponseTypeDef 
# describe_contact method usage example with argument unpacking

kwargs: DescribeContactRequestRequestTypeDef = {  # (1)
    "contactId": ...,
}

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

describe_ephemeris#

Describes 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)
    ...
  1. See DescribeEphemerisResponseTypeDef 
# describe_ephemeris method usage example with argument unpacking

kwargs: DescribeEphemerisRequestRequestTypeDef = {  # (1)
    "ephemerisId": ...,
}

parent.describe_ephemeris(**kwargs)
  1. See DescribeEphemerisRequestRequestTypeDef

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

# generate_presigned_url method definition

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

get_agent_configuration#

.

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)
    ...
  1. See GetAgentConfigurationResponseTypeDef 
# get_agent_configuration method usage example with argument unpacking

kwargs: GetAgentConfigurationRequestRequestTypeDef = {  # (1)
    "agentId": ...,
}

parent.get_agent_configuration(**kwargs)
  1. See GetAgentConfigurationRequestRequestTypeDef

get_config#

Returns Config information.

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

# get_config method definition

def get_config(
    self,
    *,
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
) -> GetConfigResponseTypeDef:  # (2)
    ...
  1. See ConfigCapabilityTypeType
  2. See GetConfigResponseTypeDef 
# get_config method usage example with argument unpacking

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.