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,
]

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,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

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],

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],
    region: NotRequired[str],

ListSatellitesRequestRequestTypeDef#

# ListSatellitesRequestRequestTypeDef definition

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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateEphemerisRequestRequestTypeDef#

# UpdateEphemerisRequestRequestTypeDef definition

class UpdateEphemerisRequestRequestTypeDef(TypedDict):
    enabled: bool,
    ephemerisId: str,
    name: NotRequired[str],
    priority: NotRequired[int],

AgentDetailsTypeDef#

# AgentDetailsTypeDef definition

class AgentDetailsTypeDef(TypedDict):
    agentVersion: str,
    componentVersions: Sequence[ComponentVersionTypeDef],  # (1)
    instanceId: str,
    instanceType: str,
    agentCpuCores: NotRequired[Sequence[int]],
    reservedCpuCores: NotRequired[Sequence[int]],
  1. See ComponentVersionTypeDef

UpdateAgentStatusRequestRequestTypeDef#

# UpdateAgentStatusRequestRequestTypeDef definition

class UpdateAgentStatusRequestRequestTypeDef(TypedDict):
    agentId: str,
    aggregateStatus: AggregateStatusTypeDef,  # (1)
    componentStatuses: Sequence[ComponentStatusDataTypeDef],  # (2)
    taskId: str,
  1. See AggregateStatusTypeDef
  2. See ComponentStatusDataTypeDef

ConfigIdResponseTypeDef#

# ConfigIdResponseTypeDef definition

class ConfigIdResponseTypeDef(TypedDict):
    configArn: str,
    configId: str,
    configType: ConfigCapabilityTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfigCapabilityTypeType
  2. See ResponseMetadataTypeDef

ContactIdResponseTypeDef#

# ContactIdResponseTypeDef definition

class ContactIdResponseTypeDef(TypedDict):
    contactId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DataflowEndpointGroupIdResponseTypeDef#

# DataflowEndpointGroupIdResponseTypeDef definition

class DataflowEndpointGroupIdResponseTypeDef(TypedDict):
    dataflowEndpointGroupId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EphemerisIdResponseTypeDef#

# EphemerisIdResponseTypeDef definition

class EphemerisIdResponseTypeDef(TypedDict):
    ephemerisId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAgentConfigurationResponseTypeDef#

# GetAgentConfigurationResponseTypeDef definition

class GetAgentConfigurationResponseTypeDef(TypedDict):
    agentId: str,
    taskingDocument: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMinuteUsageResponseTypeDef#

# GetMinuteUsageResponseTypeDef definition

class GetMinuteUsageResponseTypeDef(TypedDict):
    estimatedMinutesRemaining: int,
    isReservedMinutesCustomer: bool,
    totalReservedMinuteAllocation: int,
    totalScheduledMinutes: int,
    upcomingMinutesScheduled: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

MissionProfileIdResponseTypeDef#

# MissionProfileIdResponseTypeDef definition

class MissionProfileIdResponseTypeDef(TypedDict):
    missionProfileId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterAgentResponseTypeDef#

# RegisterAgentResponseTypeDef definition

class RegisterAgentResponseTypeDef(TypedDict):
    agentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateAgentStatusResponseTypeDef#

# UpdateAgentStatusResponseTypeDef definition

class UpdateAgentStatusResponseTypeDef(TypedDict):
    agentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListConfigsResponseTypeDef#

# ListConfigsResponseTypeDef definition

class ListConfigsResponseTypeDef(TypedDict):
    configList: List[ConfigListItemTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfigListItemTypeDef
  2. See ResponseMetadataTypeDef

ConnectionDetailsTypeDef#

# ConnectionDetailsTypeDef definition

class ConnectionDetailsTypeDef(TypedDict):
    socketAddress: SocketAddressTypeDef,  # (1)
    mtu: NotRequired[int],
  1. See SocketAddressTypeDef

DataflowEndpointTypeDef#

# DataflowEndpointTypeDef definition

class DataflowEndpointTypeDef(TypedDict):
    address: NotRequired[SocketAddressTypeDef],  # (1)
    mtu: NotRequired[int],
    name: NotRequired[str],
    status: NotRequired[EndpointStatusType],  # (2)
  1. See SocketAddressTypeDef
  2. See EndpointStatusType

ContactDataTypeDef#

# ContactDataTypeDef definition

class ContactDataTypeDef(TypedDict):
    contactId: NotRequired[str],
    contactStatus: NotRequired[ContactStatusType],  # (1)
    endTime: NotRequired[datetime],
    errorMessage: NotRequired[str],
    groundStation: NotRequired[str],
    maximumElevation: NotRequired[ElevationTypeDef],  # (2)
    missionProfileArn: NotRequired[str],
    postPassEndTime: NotRequired[datetime],
    prePassStartTime: NotRequired[datetime],
    region: NotRequired[str],
    satelliteArn: NotRequired[str],
    startTime: NotRequired[datetime],
    tags: NotRequired[Dict[str, str]],
  1. See ContactStatusType
  2. See ElevationTypeDef

ListContactsRequestRequestTypeDef#

# ListContactsRequestRequestTypeDef definition

class ListContactsRequestRequestTypeDef(TypedDict):
    endTime: Union[datetime, str],
    startTime: Union[datetime, str],
    statusList: Sequence[ContactStatusType],  # (1)
    groundStation: NotRequired[str],
    maxResults: NotRequired[int],
    missionProfileArn: NotRequired[str],
    nextToken: NotRequired[str],
    satelliteArn: NotRequired[str],
  1. See ContactStatusType

ListEphemeridesRequestRequestTypeDef#

# ListEphemeridesRequestRequestTypeDef definition

class ListEphemeridesRequestRequestTypeDef(TypedDict):
    endTime: Union[datetime, str],
    satelliteId: str,
    startTime: Union[datetime, str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    statusList: NotRequired[Sequence[EphemerisStatusType]],  # (1)
  1. See EphemerisStatusType

ReserveContactRequestRequestTypeDef#

# ReserveContactRequestRequestTypeDef definition

class ReserveContactRequestRequestTypeDef(TypedDict):
    endTime: Union[datetime, str],
    groundStation: str,
    missionProfileArn: str,
    satelliteArn: str,
    startTime: Union[datetime, str],
    tags: NotRequired[Mapping[str, str]],

TimeRangeTypeDef#

# TimeRangeTypeDef definition

class TimeRangeTypeDef(TypedDict):
    endTime: Union[datetime, str],
    startTime: Union[datetime, str],

CreateMissionProfileRequestRequestTypeDef#

# CreateMissionProfileRequestRequestTypeDef definition

class CreateMissionProfileRequestRequestTypeDef(TypedDict):
    dataflowEdges: Sequence[Sequence[str]],
    minimumViableContactDurationSeconds: int,
    name: str,
    trackingConfigArn: str,
    contactPostPassDurationSeconds: NotRequired[int],
    contactPrePassDurationSeconds: NotRequired[int],
    streamsKmsKey: NotRequired[KmsKeyTypeDef],  # (1)
    streamsKmsRole: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See KmsKeyTypeDef

GetMissionProfileResponseTypeDef#

# GetMissionProfileResponseTypeDef definition

class GetMissionProfileResponseTypeDef(TypedDict):
    contactPostPassDurationSeconds: int,
    contactPrePassDurationSeconds: int,
    dataflowEdges: List[List[str]],
    minimumViableContactDurationSeconds: int,
    missionProfileArn: str,
    missionProfileId: str,
    name: str,
    region: str,
    streamsKmsKey: KmsKeyTypeDef,  # (1)
    streamsKmsRole: str,
    tags: Dict[str, str],
    trackingConfigArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KmsKeyTypeDef
  2. See