Skip to content

Type definitions#

Index > GroundStation > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

EndpointDetailsUnionTypeDef#

# EndpointDetailsUnionTypeDef definition

EndpointDetailsUnionTypeDef = Union[
    EndpointDetailsTypeDef,  # (1)
    EndpointDetailsOutputTypeDef,  # (2)
]
  1. See EndpointDetailsTypeDef
  2. See EndpointDetailsOutputTypeDef

ComponentVersionTypeDef#

# ComponentVersionTypeDef definition

class ComponentVersionTypeDef(TypedDict):
    componentType: str,
    versions: Sequence[str],

AggregateStatusTypeDef#

# AggregateStatusTypeDef definition

class AggregateStatusTypeDef(TypedDict):
    status: AgentStatusType,  # (1)
    signatureMap: NotRequired[Mapping[str, bool]],
  1. See AgentStatusType

AntennaDemodDecodeDetailsTypeDef#

# AntennaDemodDecodeDetailsTypeDef definition

class AntennaDemodDecodeDetailsTypeDef(TypedDict):
    outputNode: NotRequired[str],

DecodeConfigTypeDef#

# DecodeConfigTypeDef definition

class DecodeConfigTypeDef(TypedDict):
    unvalidatedJSON: str,

DemodulationConfigTypeDef#

# DemodulationConfigTypeDef definition

class DemodulationConfigTypeDef(TypedDict):
    unvalidatedJSON: str,

EirpTypeDef#

# EirpTypeDef definition

class EirpTypeDef(TypedDict):
    units: EirpUnitsType,  # (1)
    value: float,
  1. See EirpUnitsType

CancelContactRequestRequestTypeDef#

# CancelContactRequestRequestTypeDef definition

class CancelContactRequestRequestTypeDef(TypedDict):
    contactId: str,

ComponentStatusDataTypeDef#

# ComponentStatusDataTypeDef definition

class ComponentStatusDataTypeDef(TypedDict):
    capabilityArn: str,
    componentType: str,
    dataflowId: str,
    status: AgentStatusType,  # (1)
    bytesReceived: NotRequired[int],
    bytesSent: NotRequired[int],
    packetsDropped: NotRequired[int],
  1. See AgentStatusType

S3RecordingDetailsTypeDef#

# S3RecordingDetailsTypeDef definition

class S3RecordingDetailsTypeDef(TypedDict):
    bucketArn: NotRequired[str],
    keyTemplate: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ConfigListItemTypeDef#

# ConfigListItemTypeDef definition

class ConfigListItemTypeDef(TypedDict):
    configArn: NotRequired[str],
    configId: NotRequired[str],
    configType: NotRequired[ConfigCapabilityTypeType],  # (1)
    name: NotRequired[str],
  1. See ConfigCapabilityTypeType

DataflowEndpointConfigTypeDef#

# DataflowEndpointConfigTypeDef definition

class DataflowEndpointConfigTypeDef(TypedDict):
    dataflowEndpointName: str,
    dataflowEndpointRegion: NotRequired[str],

S3RecordingConfigTypeDef#

# S3RecordingConfigTypeDef definition

class S3RecordingConfigTypeDef(TypedDict):
    bucketArn: str,
    roleArn: str,
    prefix: NotRequired[str],

TrackingConfigTypeDef#

# TrackingConfigTypeDef definition

class TrackingConfigTypeDef(TypedDict):
    autotrack: CriticalityType,  # (1)
  1. See CriticalityType

UplinkEchoConfigTypeDef#

# UplinkEchoConfigTypeDef definition

class UplinkEchoConfigTypeDef(TypedDict):
    antennaUplinkConfigArn: str,
    enabled: bool,

SocketAddressTypeDef#

# SocketAddressTypeDef definition

class SocketAddressTypeDef(TypedDict):
    name: str,
    port: int,

ElevationTypeDef#

# ElevationTypeDef definition

class ElevationTypeDef(TypedDict):
    unit: AngleUnitsType,  # (1)
    value: float,
  1. See AngleUnitsType

KmsKeyTypeDef#

# KmsKeyTypeDef definition

class KmsKeyTypeDef(TypedDict):
    kmsAliasArn: NotRequired[str],
    kmsAliasName: NotRequired[str],
    kmsKeyArn: NotRequired[str],

DataflowEndpointListItemTypeDef#

# DataflowEndpointListItemTypeDef definition

class DataflowEndpointListItemTypeDef(TypedDict):
    dataflowEndpointGroupArn: NotRequired[str],
    dataflowEndpointGroupId: NotRequired[str],

DeleteConfigRequestRequestTypeDef#

# DeleteConfigRequestRequestTypeDef definition

class DeleteConfigRequestRequestTypeDef(TypedDict):
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
  1. See ConfigCapabilityTypeType

DeleteDataflowEndpointGroupRequestRequestTypeDef#

# DeleteDataflowEndpointGroupRequestRequestTypeDef definition

class DeleteDataflowEndpointGroupRequestRequestTypeDef(TypedDict):
    dataflowEndpointGroupId: str,

DeleteEphemerisRequestRequestTypeDef#

# DeleteEphemerisRequestRequestTypeDef definition

class DeleteEphemerisRequestRequestTypeDef(TypedDict):
    ephemerisId: str,

DeleteMissionProfileRequestRequestTypeDef#

# DeleteMissionProfileRequestRequestTypeDef definition

class DeleteMissionProfileRequestRequestTypeDef(TypedDict):
    missionProfileId: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeContactRequestRequestTypeDef#

# DescribeContactRequestRequestTypeDef definition

class DescribeContactRequestRequestTypeDef(TypedDict):
    contactId: str,

DescribeEphemerisRequestRequestTypeDef#

# DescribeEphemerisRequestRequestTypeDef definition

class DescribeEphemerisRequestRequestTypeDef(TypedDict):
    ephemerisId: str,

DiscoveryDataTypeDef#

# DiscoveryDataTypeDef definition

class DiscoveryDataTypeDef(TypedDict):
    capabilityArns: Sequence[str],
    privateIpAddresses: Sequence[str],
    publicIpAddresses: Sequence[str],

SecurityDetailsOutputTypeDef#

# SecurityDetailsOutputTypeDef definition

class SecurityDetailsOutputTypeDef(TypedDict):
    roleArn: str,
    securityGroupIds: List[str],
    subnetIds: List[str],

SecurityDetailsTypeDef#

# SecurityDetailsTypeDef definition

class SecurityDetailsTypeDef(TypedDict):
    roleArn: str,
    securityGroupIds: Sequence[str],
    subnetIds: Sequence[str],

S3ObjectTypeDef#

# S3ObjectTypeDef definition

class S3ObjectTypeDef(TypedDict):
    bucket: NotRequired[str],
    key: NotRequired[str],
    version: NotRequired[str],

EphemerisMetaDataTypeDef#

# EphemerisMetaDataTypeDef definition

class EphemerisMetaDataTypeDef(TypedDict):
    source: EphemerisSourceType,  # (1)
    ephemerisId: NotRequired[str],
    epoch: NotRequired[datetime],
    name: NotRequired[str],
  1. See EphemerisSourceType

FrequencyBandwidthTypeDef#

# FrequencyBandwidthTypeDef definition

class FrequencyBandwidthTypeDef(TypedDict):
    units: BandwidthUnitsType,  # (1)
    value: float,
  1. See BandwidthUnitsType

FrequencyTypeDef#

# FrequencyTypeDef definition

class FrequencyTypeDef(TypedDict):
    units: FrequencyUnitsType,  # (1)
    value: float,
  1. See FrequencyUnitsType

GetAgentConfigurationRequestRequestTypeDef#

# GetAgentConfigurationRequestRequestTypeDef definition

class GetAgentConfigurationRequestRequestTypeDef(TypedDict):
    agentId: str,

GetConfigRequestRequestTypeDef#

# GetConfigRequestRequestTypeDef definition

class GetConfigRequestRequestTypeDef(TypedDict):
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
  1. See ConfigCapabilityTypeType

GetDataflowEndpointGroupRequestRequestTypeDef#

# GetDataflowEndpointGroupRequestRequestTypeDef definition

class GetDataflowEndpointGroupRequestRequestTypeDef(TypedDict):
    dataflowEndpointGroupId: str,

GetMinuteUsageRequestRequestTypeDef#

# GetMinuteUsageRequestRequestTypeDef definition

class GetMinuteUsageRequestRequestTypeDef(TypedDict):
    month: int,
    year: int,

GetMissionProfileRequestRequestTypeDef#

# GetMissionProfileRequestRequestTypeDef definition

class GetMissionProfileRequestRequestTypeDef(TypedDict):
    missionProfileId: str,

GetSatelliteRequestRequestTypeDef#

# GetSatelliteRequestRequestTypeDef definition

class GetSatelliteRequestRequestTypeDef(TypedDict):
    satelliteId: str,

GroundStationDataTypeDef#

# GroundStationDataTypeDef definition

class GroundStationDataTypeDef(TypedDict):
    groundStationId: NotRequired[str],
    groundStationName: NotRequired[str],
    region: NotRequired[str],

IntegerRangeTypeDef#

# IntegerRangeTypeDef definition

class IntegerRangeTypeDef(TypedDict):
    maximum: int,
    minimum: int,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListConfigsRequestRequestTypeDef#

# ListConfigsRequestRequestTypeDef definition

class ListConfigsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListDataflowEndpointGroupsRequestRequestTypeDef#

# ListDataflowEndpointGroupsRequestRequestTypeDef definition

class ListDataflowEndpointGroupsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListGroundStationsRequestRequestTypeDef#

# ListGroundStationsRequestRequestTypeDef definition

class ListGroundStationsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    satelliteId: NotRequired[str],

ListMissionProfilesRequestRequestTypeDef#

# ListMissionProfilesRequestRequestTypeDef definition

class ListMissionProfilesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

MissionProfileListItemTypeDef#

# MissionProfileListItemTypeDef definition

class MissionProfileListItemTypeDef(TypedDict):
    missionProfileArn: NotRequired[str],
    missionProfileId: NotRequired[str],
    name: NotRequired[str],