Skip to content

GroundStation module#

Index > GroundStation

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

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and GroundStation.

From PyPI with pip#

Install boto3-stubs for GroundStation service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[groundstation]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[groundstation]'


# standalone installation
python -m pip install mypy-boto3-groundstation

How to uninstall#

python -m pip uninstall -y mypy-boto3-groundstation

Usage#

Code samples can be found in Examples.

GroundStationClient#

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

# GroundStationClient usage example

from boto3.session import Session

from mypy_boto3_groundstation.client import GroundStationClient

def get_client() -> GroundStationClient:
    return Session().client("groundstation")

Paginators#

Type annotations and code completion for paginators from boto3.client("groundstation").get_paginator("...").

# ListConfigsPaginator usage example

from boto3.session import Session

from mypy_boto3_groundstation.paginator import ListConfigsPaginator

def get_list_configs_paginator() -> ListConfigsPaginator:
    return Session().client("groundstation").get_paginator("list_configs"))

Waiters#

Type annotations and code completion for waiters from boto3.client("groundstation").get_waiter("...").

# ContactScheduledWaiter usage example

from boto3.session import Session

from mypy_boto3_groundstation.waiter import ContactScheduledWaiter

def get_contact_scheduled_waiter() -> ContactScheduledWaiter:
    return Session().client("groundstation").get_waiter("contact_scheduled")

Literals#

Type annotations for literals used in methods and schemas.

# AgentStatusType usage example

from mypy_boto3_groundstation.literals import AgentStatusType

def get_value() -> AgentStatusType:
    return "ACTIVE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# ComponentVersionTypeDef usage example

from mypy_boto3_groundstation.type_defs import ComponentVersionTypeDef

def get_value() -> ComponentVersionTypeDef:
    return {
        "componentType": ...,
        "versions": ...,
    }