SDK for PHP 3.x

Client: Aws\GroundStation\GroundStationClient
Service ID: groundstation
Version: 2019-05-23

This page describes the parameters and results for the operations of the AWS Ground Station (2019-05-23), and shows how to use the Aws\GroundStation\GroundStationClient object to call the described operations. This documentation is specific to the 2019-05-23 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelContact ( array $params = [] )
Cancels a contact with a specified contact ID.
CreateConfig ( array $params = [] )
Creates a Config with the specified configData parameters.
CreateDataflowEndpointGroup ( array $params = [] )
Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.
CreateEphemeris ( array $params = [] )
Creates an Ephemeris with the specified EphemerisData.
CreateMissionProfile ( array $params = [] )
Creates a mission profile.
DeleteConfig ( array $params = [] )
Deletes a Config.
DeleteDataflowEndpointGroup ( array $params = [] )
Deletes a dataflow endpoint group.
DeleteEphemeris ( array $params = [] )
Deletes an ephemeris
DeleteMissionProfile ( array $params = [] )
Deletes a mission profile.
DescribeContact ( array $params = [] )
Describes an existing contact.
DescribeEphemeris ( array $params = [] )
Describes an existing ephemeris.
GetAgentConfiguration ( array $params = [] )
For use by AWS Ground Station Agent and shouldn't be called directly.
GetDataflowEndpointGroup ( array $params = [] )
Returns the dataflow endpoint group.
GetMinuteUsage ( array $params = [] )
Returns the number of reserved minutes used by account.
GetMissionProfile ( array $params = [] )
Returns a mission profile.
GetMissionProfileConfig ( array $params = [] )
Returns Config information.
GetSatellite ( array $params = [] )
Returns a satellite.
ListConfigs ( array $params = [] )
Returns a list of Config objects.
ListContacts ( array $params = [] )
Returns a list of contacts.
ListDataflowEndpointGroups ( array $params = [] )
Returns a list of DataflowEndpoint groups.
ListEphemerides ( array $params = [] )
List existing ephemerides.
ListGroundStations ( array $params = [] )
Returns a list of ground stations.
ListMissionProfiles ( array $params = [] )
Returns a list of mission profiles.
ListSatellites ( array $params = [] )
Returns a list of satellites.
ListTagsForResource ( array $params = [] )
Returns a list of tags for a specified resource.
RegisterAgent ( array $params = [] )
For use by AWS Ground Station Agent and shouldn't be called directly.
ReserveContact ( array $params = [] )
Reserves a contact using specified parameters.
TagResource ( array $params = [] )
Assigns a tag to a resource.
UntagResource ( array $params = [] )
Deassigns a resource tag.
UpdateAgentStatus ( array $params = [] )
For use by AWS Ground Station Agent and shouldn't be called directly.
UpdateConfig ( array $params = [] )
Updates the Config used when scheduling contacts.
UpdateEphemeris ( array $params = [] )
Updates an existing ephemeris
UpdateMissionProfile ( array $params = [] )
Updates a mission profile.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListConfigs
ListContacts
ListDataflowEndpointGroups
ListEphemerides
ListGroundStations
ListMissionProfiles
ListSatellites

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
ContactScheduled DescribeContact 5 180

Operations

CancelContact

$result = $client->cancelContact([/* ... */]);
$promise = $client->cancelContactAsync([/* ... */]);

Cancels a contact with a specified contact ID.

Parameter Syntax

$result = $client->cancelContact([
    'contactId' => '<string>', // REQUIRED
]);

Parameter Details

Members
contactId
Required: Yes
Type: string

UUID of a contact.

Result Syntax

[
    'contactId' => '<string>',
]

Result Details

Members
contactId
Type: string

UUID of a contact.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

CreateConfig

$result = $client->createConfig([/* ... */]);
$promise = $client->createConfigAsync([/* ... */]);

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

Parameter Syntax

$result = $client->createConfig([
    'configData' => [ // REQUIRED
        'antennaDownlinkConfig' => [
            'spectrumConfig' => [ // REQUIRED
                'bandwidth' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'centerFrequency' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
        ],
        'antennaDownlinkDemodDecodeConfig' => [
            'decodeConfig' => [ // REQUIRED
                'unvalidatedJSON' => '<string>', // REQUIRED
            ],
            'demodulationConfig' => [ // REQUIRED
                'unvalidatedJSON' => '<string>', // REQUIRED
            ],
            'spectrumConfig' => [ // REQUIRED
                'bandwidth' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'centerFrequency' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
        ],
        'antennaUplinkConfig' => [
            'spectrumConfig' => [ // REQUIRED
                'centerFrequency' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
            'targetEirp' => [ // REQUIRED
                'units' => 'dBW', // REQUIRED
                'value' => <float>, // REQUIRED
            ],
            'transmitDisabled' => true || false,
        ],
        'dataflowEndpointConfig' => [
            'dataflowEndpointName' => '<string>', // REQUIRED
            'dataflowEndpointRegion' => '<string>',
        ],
        's3RecordingConfig' => [
            'bucketArn' => '<string>', // REQUIRED
            'prefix' => '<string>',
            'roleArn' => '<string>', // REQUIRED
        ],
        'trackingConfig' => [
            'autotrack' => 'PREFERRED|REMOVED|REQUIRED', // REQUIRED
        ],
        'uplinkEchoConfig' => [
            'antennaUplinkConfigArn' => '<string>', // REQUIRED
            'enabled' => true || false, // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
configData
Required: Yes
Type: ConfigTypeData structure

Parameters of a Config.

name
Required: Yes
Type: string

Name of a Config.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a Config.

Result Syntax

[
    'configArn' => '<string>',
    'configId' => '<string>',
    'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording',
]

Result Details

Members
configArn
Type: string

ARN of a Config.

configId
Type: string

UUID of a Config.

configType
Type: string

Type of a Config.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceLimitExceededException:

Account limits for this resource have been exceeded.

ResourceNotFoundException:

Resource was not found.

CreateDataflowEndpointGroup

$result = $client->createDataflowEndpointGroup([/* ... */]);
$promise = $client->createDataflowEndpointGroupAsync([/* ... */]);

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.

When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

Parameter Syntax

$result = $client->createDataflowEndpointGroup([
    'contactPostPassDurationSeconds' => <integer>,
    'contactPrePassDurationSeconds' => <integer>,
    'endpointDetails' => [ // REQUIRED
        [
            'awsGroundStationAgentEndpoint' => [
                'agentStatus' => 'SUCCESS|FAILED|ACTIVE|INACTIVE',
                'auditResults' => 'HEALTHY|UNHEALTHY',
                'egressAddress' => [ // REQUIRED
                    'mtu' => <integer>,
                    'socketAddress' => [ // REQUIRED
                        'name' => '<string>', // REQUIRED
                        'port' => <integer>, // REQUIRED
                    ],
                ],
                'ingressAddress' => [ // REQUIRED
                    'mtu' => <integer>,
                    'socketAddress' => [ // REQUIRED
                        'name' => '<string>', // REQUIRED
                        'portRange' => [ // REQUIRED
                            'maximum' => <integer>, // REQUIRED
                            'minimum' => <integer>, // REQUIRED
                        ],
                    ],
                ],
                'name' => '<string>', // REQUIRED
            ],
            'endpoint' => [
                'address' => [
                    'name' => '<string>', // REQUIRED
                    'port' => <integer>, // REQUIRED
                ],
                'mtu' => <integer>,
                'name' => '<string>',
                'status' => 'created|creating|deleted|deleting|failed',
            ],
            'healthReasons' => ['<string>', ...],
            'healthStatus' => 'UNHEALTHY|HEALTHY',
            'securityDetails' => [
                'roleArn' => '<string>', // REQUIRED
                'securityGroupIds' => ['<string>', ...], // REQUIRED
                'subnetIds' => ['<string>', ...], // REQUIRED
            ],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
contactPostPassDurationSeconds
Type: int

Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.

contactPrePassDurationSeconds
Type: int

Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.

endpointDetails
Required: Yes
Type: Array of EndpointDetails structures

Endpoint details of each endpoint in the dataflow endpoint group.

tags
Type: Associative array of custom strings keys (String) to strings

Tags of a dataflow endpoint group.

Result Syntax

[
    'dataflowEndpointGroupId' => '<string>',
]

Result Details

Members
dataflowEndpointGroupId
Type: string

UUID of a dataflow endpoint group.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

CreateEphemeris

$result = $client->createEphemeris([/* ... */]);
$promise = $client->createEphemerisAsync([/* ... */]);

Creates an Ephemeris with the specified EphemerisData.

Parameter Syntax

$result = $client->createEphemeris([
    'enabled' => true || false,
    'ephemeris' => [
        'oem' => [
            'oemData' => '<string>',
            's3Object' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
        ],
        'tle' => [
            's3Object' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
            'tleData' => [
                [
                    'tleLine1' => '<string>', // REQUIRED
                    'tleLine2' => '<string>', // REQUIRED
                    'validTimeRange' => [ // REQUIRED
                        'endTime' => <integer || string || DateTime>, // REQUIRED
                        'startTime' => <integer || string || DateTime>, // REQUIRED
                    ],
                ],
                // ...
            ],
        ],
    ],
    'expirationTime' => <integer || string || DateTime>,
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'priority' => <integer>,
    'satelliteId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
enabled
Type: boolean

Whether to set the ephemeris status to ENABLED after validation.

Setting this to false will set the ephemeris status to DISABLED after validation.

ephemeris
Type: EphemerisData structure

Ephemeris data.

expirationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.

kmsKeyArn
Type: string

The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

name
Required: Yes
Type: string

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

priority
Type: int

Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

Priority must be 1 or greater

satelliteId
Required: Yes
Type: string

AWS Ground Station satellite ID for this ephemeris.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to an ephemeris.

Result Syntax

[
    'ephemerisId' => '<string>',
]

Result Details

Members
ephemerisId
Type: string

The AWS Ground Station ephemeris ID.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

CreateMissionProfile

$result = $client->createMissionProfile([/* ... */]);
$promise = $client->createMissionProfileAsync([/* ... */]);

Creates a mission profile.

dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.

Parameter Syntax

$result = $client->createMissionProfile([
    'contactPostPassDurationSeconds' => <integer>,
    'contactPrePassDurationSeconds' => <integer>,
    'dataflowEdges' => [ // REQUIRED
        ['<string>', ...],
        // ...
    ],
    'minimumViableContactDurationSeconds' => <integer>, // REQUIRED
    'name' => '<string>', // REQUIRED
    'streamsKmsKey' => [
        'kmsAliasArn' => '<string>',
        'kmsAliasName' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'streamsKmsRole' => '<string>',
    'tags' => ['<string>', ...],
    'trackingConfigArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
contactPostPassDurationSeconds
Type: int

Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.

contactPrePassDurationSeconds
Type: int

Amount of time prior to contact start you’d like to receive a Ground Station Contact State Change event indicating an upcoming pass.

dataflowEdges
Required: Yes
Type: Array of stringss

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

minimumViableContactDurationSeconds
Required: Yes
Type: int

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

name
Required: Yes
Type: string

Name of a mission profile.

streamsKmsKey
Type: KmsKey structure

KMS key to use for encrypting streams.

streamsKmsRole
Type: string

Role to use for encrypting streams with KMS key.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a mission profile.

trackingConfigArn
Required: Yes
Type: string

ARN of a tracking Config.

Result Syntax

[
    'missionProfileId' => '<string>',
]

Result Details

Members
missionProfileId
Type: string

UUID of a mission profile.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

DeleteConfig

$result = $client->deleteConfig([/* ... */]);
$promise = $client->deleteConfigAsync([/* ... */]);

Deletes a Config.

Parameter Syntax

$result = $client->deleteConfig([
    'configId' => '<string>', // REQUIRED
    'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording', // REQUIRED
]);

Parameter Details

Members
configId
Required: Yes
Type: string

UUID of a Config.

configType
Required: Yes
Type: string

Type of a Config.

Result Syntax

[
    'configArn' => '<string>',
    'configId' => '<string>',
    'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording',
]

Result Details

Members
configArn
Type: string

ARN of a Config.

configId
Type: string

UUID of a Config.

configType
Type: string

Type of a Config.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

DeleteDataflowEndpointGroup

$result = $client->deleteDataflowEndpointGroup([/* ... */]);
$promise = $client->deleteDataflowEndpointGroupAsync([/* ... */]);

Deletes a dataflow endpoint group.

Parameter Syntax

$result = $client->deleteDataflowEndpointGroup([
    'dataflowEndpointGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members
dataflowEndpointGroupId
Required: Yes
Type: string

UUID of a dataflow endpoint group.

Result Syntax

[
    'dataflowEndpointGroupId' => '<string>',
]

Result Details

Members
dataflowEndpointGroupId
Type: string

UUID of a dataflow endpoint group.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

DeleteEphemeris

$result = $client->deleteEphemeris([/* ... */]);
$promise = $client->deleteEphemerisAsync([/* ... */]);

Deletes an ephemeris

Parameter Syntax

$result = $client->deleteEphemeris([
    'ephemerisId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ephemerisId
Required: Yes
Type: string

The AWS Ground Station ephemeris ID.

Result Syntax

[
    'ephemerisId' => '<string>',
]

Result Details

Members
ephemerisId
Type: string

The AWS Ground Station ephemeris ID.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

DeleteMissionProfile

$result = $client->deleteMissionProfile([/* ... */]);
$promise = $client->deleteMissionProfileAsync([/* ... */]);

Deletes a mission profile.

Parameter Syntax

$result = $client->deleteMissionProfile([
    'missionProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
missionProfileId
Required: Yes
Type: string

UUID of a mission profile.

Result Syntax

[
    'missionProfileId' => '<string>',
]

Result Details

Members
missionProfileId
Type: string

UUID of a mission profile.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

DescribeContact

$result = $client->describeContact([/* ... */]);
$promise = $client->describeContactAsync([/* ... */]);

Describes an existing contact.

Parameter Syntax

$result = $client->describeContact([
    'contactId' => '<string>', // REQUIRED
]);

Parameter Details

Members
contactId
Required: Yes
Type: string

UUID of a contact.

Result Syntax

[
    'contactId' => '<string>',
    'contactStatus' => 'AVAILABLE|AWS_CANCELLED|AWS_FAILED|CANCELLED|CANCELLING|COMPLETED|FAILED|FAILED_TO_SCHEDULE|PASS|POSTPASS|PREPASS|SCHEDULED|SCHEDULING',
    'dataflowList' => [
        [
            'destination' => [
                'configDetails' => [
                    'antennaDemodDecodeDetails' => [
                        'outputNode' => '<string>',
                    ],
                    'endpointDetails' => [
                        'awsGroundStationAgentEndpoint' => [
                            'agentStatus' => 'SUCCESS|FAILED|ACTIVE|INACTIVE',
                            'auditResults' => 'HEALTHY|UNHEALTHY',
                            'egressAddress' => [
                                'mtu' => <integer>,
                                'socketAddress' => [
                                    'name' => '<string>',
                                    'port' => <integer>,
                                ],
                            ],
                            'ingressAddress' => [
                                'mtu' => <integer>,
                                'socketAddress' => [
                                    'name' => '<string>',
                                    'portRange' => [
                                        'maximum' => <integer>,
                                        'minimum' => <integer>,
                                    ],
                                ],
                            ],
                            'name' => '<string>',
                        ],
                        'endpoint' => [
                            'address' => [
                                'name' => '<string>',
                                'port' => <integer>,
                            ],
                            'mtu' => <integer>,
                            'name' => '<string>',
                            'status' => 'created|creating|deleted|deleting|failed',
                        ],
                        'healthReasons' => ['<string>', ...],
                        'healthStatus' => 'UNHEALTHY|HEALTHY',
                        'securityDetails' => [
                            'roleArn' => '<string>',
                            'securityGroupIds' => ['<string>', ...],
                            'subnetIds' => ['<string>', ...],
                        ],
                    ],
                    's3RecordingDetails' => [
                        'bucketArn' => '<string>',
                        'keyTemplate' => '<string>',
                    ],
                ],
                'configId' => '<string>',
                'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording',
                'dataflowDestinationRegion' => '<string>',
            ],
            'errorMessage' => '<string>',
            'source' => [
                'configDetails' => [
                    'antennaDemodDecodeDetails' => [
                        'outputNode' => '<string>',
                    ],
                    'endpointDetails' => [
                        'awsGroundStationAgentEndpoint' => [
                            'agentStatus' => 'SUCCESS|FAILED|ACTIVE|INACTIVE',
                            'auditResults' => 'HEALTHY|UNHEALTHY',
                            'egressAddress' => [
                                'mtu' => <integer>,
                                'socketAddress' => [
                                    'name' => '<string>',
                                    'port' => <integer>,
                                ],
                            ],
                            'ingressAddress' => [
                                'mtu' => <integer>,
                                'socketAddress' => [
                                    'name' => '<string>',
                                    'portRange' => [
                                        'maximum' => <integer>,
                                        'minimum' => <integer>,
                                    ],
                                ],
                            ],
                            'name' => '<string>',
                        ],
                        'endpoint' => [
                            'address' => [
                                'name' => '<string>',
                                'port' => <integer>,
                            ],
                            'mtu' => <integer>,
                            'name' => '<string>',
                            'status' => 'created|creating|deleted|deleting|failed',
                        ],
                        'healthReasons' => ['<string>', ...],
                        'healthStatus' => 'UNHEALTHY|HEALTHY',
                        'securityDetails' => [
                            'roleArn' => '<string>',
                            'securityGroupIds' => ['<string>', ...],
                            'subnetIds' => ['<string>', ...],
                        ],
                    ],
                    's3RecordingDetails' => [
                        'bucketArn' => '<string>',
                        'keyTemplate' => '<string>',
                    ],
                ],
                'configId' => '<string>',
                'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording',
                'dataflowSourceRegion' => '<string>',
            ],
        ],
        // ...
    ],
    'endTime' => <DateTime>,
    'errorMessage' => '<string>',
    'groundStation' => '<string>',
    'maximumElevation' => [
        'unit' => 'DEGREE_ANGLE|RADIAN',
        'value' => <float>,
    ],
    'missionProfileArn' => '<string>',
    'postPassEndTime' => <DateTime>,
    'prePassStartTime' => <DateTime>,
    'region' => '<string>',
    'satelliteArn' => '<string>',
    'startTime' => <DateTime>,
    'tags' => ['<string>', ...],
    'visibilityEndTime' => <DateTime>,
    'visibilityStartTime' => <DateTime>,
]

Result Details

Members
contactId
Type: string

UUID of a contact.

contactStatus
Type: string

Status of a contact.

dataflowList
Type: Array of DataflowDetail structures

List describing source and destination details for each dataflow edge.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

End time of a contact in UTC.

errorMessage
Type: string

Error message for a contact.

groundStation
Type: string

Ground station for a contact.

maximumElevation
Type: Elevation structure

Maximum elevation angle of a contact.

missionProfileArn
Type: string

ARN of a mission profile.

postPassEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

prePassStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

region
Type: string

Region of a contact.

satelliteArn
Type: string

ARN of a satellite.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of a contact in UTC.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a contact.

visibilityEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

visibilityStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

DescribeEphemeris

$result = $client->describeEphemeris([/* ... */]);
$promise = $client->describeEphemerisAsync([/* ... */]);

Describes an existing ephemeris.

Parameter Syntax

$result = $client->describeEphemeris([
    'ephemerisId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ephemerisId
Required: Yes
Type: string

The AWS Ground Station ephemeris ID.

Result Syntax

[
    'creationTime' => <DateTime>,
    'enabled' => true || false,
    'ephemerisId' => '<string>',
    'invalidReason' => 'METADATA_INVALID|TIME_RANGE_INVALID|TRAJECTORY_INVALID|KMS_KEY_INVALID|VALIDATION_ERROR',
    'name' => '<string>',
    'priority' => <integer>,
    'satelliteId' => '<string>',
    'status' => 'VALIDATING|INVALID|ERROR|ENABLED|DISABLED|EXPIRED',
    'suppliedData' => [
        'oem' => [
            'ephemerisData' => '<string>',
            'sourceS3Object' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
        ],
        'tle' => [
            'ephemerisData' => '<string>',
            'sourceS3Object' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
        ],
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the ephemeris was uploaded in UTC.

enabled
Type: boolean

Whether or not the ephemeris is enabled.

ephemerisId
Type: string

The AWS Ground Station ephemeris ID.

invalidReason
Type: string

Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.

name
Type: string

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

priority
Type: int

Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

Priority must be 1 or greater

satelliteId
Type: string

The AWS Ground Station satellite ID associated with ephemeris.

status
Type: string

The status of the ephemeris.

suppliedData
Type: EphemerisTypeDescription structure

Supplied ephemeris data.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to an ephemeris.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

GetAgentConfiguration

$result = $client->getAgentConfiguration([/* ... */]);
$promise = $client->getAgentConfigurationAsync([/* ... */]);

For use by AWS Ground Station Agent and shouldn't be called directly.

Gets the latest configuration information for a registered agent.

Parameter Syntax

$result = $client->getAgentConfiguration([
    'agentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
agentId
Required: Yes
Type: string

UUID of agent to get configuration information for.

Result Syntax

[
    'agentId' => '<string>',
    'taskingDocument' => '<string>',
]

Result Details

Members
agentId
Type: string

UUID of agent.

taskingDocument
Type: string

Tasking document for agent.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

GetDataflowEndpointGroup

$result = $client->getDataflowEndpointGroup([/* ... */]);
$promise = $client->getDataflowEndpointGroupAsync([/* ... */]);

Returns the dataflow endpoint group.

Parameter Syntax

$result = $client->getDataflowEndpointGroup([
    'dataflowEndpointGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members
dataflowEndpointGroupId
Required: Yes
Type: string

UUID of a dataflow endpoint group.

Result Syntax

[
    'contactPostPassDurationSeconds' => <integer>,
    'contactPrePassDurationSeconds' => <integer>,
    'dataflowEndpointGroupArn' => '<string>',
    'dataflowEndpointGroupId' => '<string>',
    'endpointsDetails' => [
        [
            'awsGroundStationAgentEndpoint' => [
                'agentStatus' => 'SUCCESS|FAILED|ACTIVE|INACTIVE',
                'auditResults' => 'HEALTHY|UNHEALTHY',
                'egressAddress' => [
                    'mtu' => <integer>,
                    'socketAddress' => [
                        'name' => '<string>',
                        'port' => <integer>,
                    ],
                ],
                'ingressAddress' => [
                    'mtu' => <integer>,
                    'socketAddress' => [
                        'name' => '<string>',
                        'portRange' => [
                            'maximum' => <integer>,
                            'minimum' => <integer>,
                        ],
                    ],
                ],
                'name' => '<string>',
            ],
            'endpoint' => [
                'address' => [
                    'name' => '<string>',
                    'port' => <integer>,
                ],
                'mtu' => <integer>,
                'name' => '<string>',
                'status' => 'created|creating|deleted|deleting|failed',
            ],
            'healthReasons' => ['<string>', ...],
            'healthStatus' => 'UNHEALTHY|HEALTHY',
            'securityDetails' => [
                'roleArn' => '<string>',
                'securityGroupIds' => ['<string>', ...],
                'subnetIds' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
contactPostPassDurationSeconds
Type: int

Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.

contactPrePassDurationSeconds
Type: int

Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.

dataflowEndpointGroupArn
Type: string

ARN of a dataflow endpoint group.

dataflowEndpointGroupId
Type: string

UUID of a dataflow endpoint group.

endpointsDetails
Type: Array of EndpointDetails structures

Details of a dataflow endpoint.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a dataflow endpoint group.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

GetMinuteUsage

$result = $client->getMinuteUsage([/* ... */]);
$promise = $client->getMinuteUsageAsync([/* ... */]);

Returns the number of reserved minutes used by account.

Parameter Syntax

$result = $client->getMinuteUsage([
    'month' => <integer>, // REQUIRED
    'year' => <integer>, // REQUIRED
]);

Parameter Details

Members
month
Required: Yes
Type: int

The month being requested, with a value of 1-12.

year
Required: Yes
Type: int

The year being requested, in the format of YYYY.

Result Syntax

[
    'estimatedMinutesRemaining' => <integer>,
    'isReservedMinutesCustomer' => true || false,
    'totalReservedMinuteAllocation' => <integer>,
    'totalScheduledMinutes' => <integer>,
    'upcomingMinutesScheduled' => <integer>,
]

Result Details

Members
estimatedMinutesRemaining
Type: int

Estimated number of minutes remaining for an account, specific to the month being requested.

isReservedMinutesCustomer
Type: boolean

Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.

totalReservedMinuteAllocation
Type: int

Total number of reserved minutes allocated, specific to the month being requested.

totalScheduledMinutes
Type: int

Total scheduled minutes for an account, specific to the month being requested.

upcomingMinutesScheduled
Type: int

Upcoming minutes scheduled for an account, specific to the month being requested.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

GetMissionProfile

$result = $client->getMissionProfile([/* ... */]);
$promise = $client->getMissionProfileAsync([/* ... */]);

Returns a mission profile.

Parameter Syntax

$result = $client->getMissionProfile([
    'missionProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
missionProfileId
Required: Yes
Type: string

UUID of a mission profile.

Result Syntax

[
    'contactPostPassDurationSeconds' => <integer>,
    'contactPrePassDurationSeconds' => <integer>,
    'dataflowEdges' => [
        ['<string>', ...],
        // ...
    ],
    'minimumViableContactDurationSeconds' => <integer>,
    'missionProfileArn' => '<string>',
    'missionProfileId' => '<string>',
    'name' => '<string>',
    'region' => '<string>',
    'streamsKmsKey' => [
        'kmsAliasArn' => '<string>',
        'kmsAliasName' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'streamsKmsRole' => '<string>',
    'tags' => ['<string>', ...],
    'trackingConfigArn' => '<string>',
]

Result Details

Members
contactPostPassDurationSeconds
Type: int

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

contactPrePassDurationSeconds
Type: int

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

dataflowEdges
Type: Array of stringss

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

minimumViableContactDurationSeconds
Type: int

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

missionProfileArn
Type: string

ARN of a mission profile.

missionProfileId
Type: string

UUID of a mission profile.

name
Type: string

Name of a mission profile.

region
Type: string

Region of a mission profile.

streamsKmsKey
Type: KmsKey structure

KMS key to use for encrypting streams.

streamsKmsRole
Type: string

Role to use for encrypting streams with KMS key.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a mission profile.

trackingConfigArn
Type: string

ARN of a tracking Config.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

GetMissionProfileConfig

$result = $client->getMissionProfileConfig([/* ... */]);
$promise = $client->getMissionProfileConfigAsync([/* ... */]);

Returns Config information.

Only one Config response can be returned.

Parameter Syntax

$result = $client->getMissionProfileConfig([
    'configId' => '<string>', // REQUIRED
    'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording', // REQUIRED
]);

Parameter Details

Members
configId
Required: Yes
Type: string

UUID of a Config.

configType
Required: Yes
Type: string

Type of a Config.

Result Syntax

[
    'configArn' => '<string>',
    'configData' => [
        'antennaDownlinkConfig' => [
            'spectrumConfig' => [
                'bandwidth' => [
                    'units' => 'GHz|MHz|kHz',
                    'value' => <float>,
                ],
                'centerFrequency' => [
                    'units' => 'GHz|MHz|kHz',
                    'value' => <float>,
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
        ],
        'antennaDownlinkDemodDecodeConfig' => [
            'decodeConfig' => [
                'unvalidatedJSON' => '<string>',
            ],
            'demodulationConfig' => [
                'unvalidatedJSON' => '<string>',
            ],
            'spectrumConfig' => [
                'bandwidth' => [
                    'units' => 'GHz|MHz|kHz',
                    'value' => <float>,
                ],
                'centerFrequency' => [
                    'units' => 'GHz|MHz|kHz',
                    'value' => <float>,
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
        ],
        'antennaUplinkConfig' => [
            'spectrumConfig' => [
                'centerFrequency' => [
                    'units' => 'GHz|MHz|kHz',
                    'value' => <float>,
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
            'targetEirp' => [
                'units' => 'dBW',
                'value' => <float>,
            ],
            'transmitDisabled' => true || false,
        ],
        'dataflowEndpointConfig' => [
            'dataflowEndpointName' => '<string>',
            'dataflowEndpointRegion' => '<string>',
        ],
        's3RecordingConfig' => [
            'bucketArn' => '<string>',
            'prefix' => '<string>',
            'roleArn' => '<string>',
        ],
        'trackingConfig' => [
            'autotrack' => 'PREFERRED|REMOVED|REQUIRED',
        ],
        'uplinkEchoConfig' => [
            'antennaUplinkConfigArn' => '<string>',
            'enabled' => true || false,
        ],
    ],
    'configId' => '<string>',
    'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording',
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members
configArn
Required: Yes
Type: string

ARN of a Config

configData
Required: Yes
Type: ConfigTypeData structure

Data elements in a Config.

configId
Required: Yes
Type: string

UUID of a Config.

configType
Type: string

Type of a Config.

name
Required: Yes
Type: string

Name of a Config.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a Config.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

GetSatellite

$result = $client->getSatellite([/* ... */]);
$promise = $client->getSatelliteAsync([/* ... */]);

Returns a satellite.

Parameter Syntax

$result = $client->getSatellite([
    'satelliteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
satelliteId
Required: Yes
Type: string

UUID of a satellite.

Result Syntax

[
    'currentEphemeris' => [
        'ephemerisId' => '<string>',
        'epoch' => <DateTime>,
        'name' => '<string>',
        'source' => 'CUSTOMER_PROVIDED|SPACE_TRACK',
    ],
    'groundStations' => ['<string>', ...],
    'noradSatelliteID' => <integer>,
    'satelliteArn' => '<string>',
    'satelliteId' => '<string>',
]

Result Details

Members
currentEphemeris
Type: EphemerisMetaData structure

The current ephemeris being used to compute the trajectory of the satellite.

groundStations
Type: Array of strings

A list of ground stations to which the satellite is on-boarded.

noradSatelliteID
Type: int

NORAD satellite ID number.

satelliteArn
Type: string

ARN of a satellite.

satelliteId
Type: string

UUID of a satellite.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListConfigs

$result = $client->listConfigs([/* ... */]);
$promise = $client->listConfigsAsync([/* ... */]);

Returns a list of Config objects.

Parameter Syntax

$result = $client->listConfigs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

Maximum number of Configs returned.

nextToken
Type: string

Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.

Result Syntax

[
    'configList' => [
        [
            'configArn' => '<string>',
            'configId' => '<string>',
            'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
configList
Type: Array of ConfigListItem structures

List of Config items.

nextToken
Type: string

Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListContacts

$result = $client->listContacts([/* ... */]);
$promise = $client->listContactsAsync([/* ... */]);

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

Parameter Syntax

$result = $client->listContacts([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'groundStation' => '<string>',
    'maxResults' => <integer>,
    'missionProfileArn' => '<string>',
    'nextToken' => '<string>',
    'satelliteArn' => '<string>',
    'startTime' => <integer || string || DateTime>, // REQUIRED
    'statusList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

End time of a contact in UTC.

groundStation
Type: string

Name of a ground station.

maxResults
Type: int

Maximum number of contacts returned.

missionProfileArn
Type: string

ARN of a mission profile.

nextToken
Type: string

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

satelliteArn
Type: string

ARN of a satellite.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of a contact in UTC.

statusList
Required: Yes
Type: Array of strings

Status of a contact reservation.

Result Syntax

[
    'contactList' => [
        [
            'contactId' => '<string>',
            'contactStatus' => 'AVAILABLE|AWS_CANCELLED|AWS_FAILED|CANCELLED|CANCELLING|COMPLETED|FAILED|FAILED_TO_SCHEDULE|PASS|POSTPASS|PREPASS|SCHEDULED|SCHEDULING',
            'endTime' => <DateTime>,
            'errorMessage' => '<string>',
            'groundStation' => '<string>',
            'maximumElevation' => [
                'unit' => 'DEGREE_ANGLE|RADIAN',
                'value' => <float>,
            ],
            'missionProfileArn' => '<string>',
            'postPassEndTime' => <DateTime>,
            'prePassStartTime' => <DateTime>,
            'region' => '<string>',
            'satelliteArn' => '<string>',
            'startTime' => <DateTime>,
            'tags' => ['<string>', ...],
            'visibilityEndTime' => <DateTime>,
            'visibilityStartTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
contactList
Type: Array of ContactData structures

List of contacts.

nextToken
Type: string

Next token returned in the response of a previous ListContacts call. Used to get the next page of results.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListDataflowEndpointGroups

$result = $client->listDataflowEndpointGroups([/* ... */]);
$promise = $client->listDataflowEndpointGroupsAsync([/* ... */]);

Returns a list of DataflowEndpoint groups.

Parameter Syntax

$result = $client->listDataflowEndpointGroups([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

Maximum number of dataflow endpoint groups returned.

nextToken
Type: string

Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

Result Syntax

[
    'dataflowEndpointGroupList' => [
        [
            'dataflowEndpointGroupArn' => '<string>',
            'dataflowEndpointGroupId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
dataflowEndpointGroupList
Type: Array of DataflowEndpointListItem structures

A list of dataflow endpoint groups.

nextToken
Type: string

Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListEphemerides

$result = $client->listEphemerides([/* ... */]);
$promise = $client->listEphemeridesAsync([/* ... */]);

List existing ephemerides.

Parameter Syntax

$result = $client->listEphemerides([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'satelliteId' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
    'statusList' => ['<string>', ...],
]);

Parameter Details

Members
endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

maxResults
Type: int

Maximum number of ephemerides to return.

nextToken
Type: string

Pagination token.

satelliteId
Required: Yes
Type: string

The AWS Ground Station satellite ID to list ephemeris for.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

statusList
Type: Array of strings

The list of ephemeris status to return.

Result Syntax

[
    'ephemerides' => [
        [
            'creationTime' => <DateTime>,
            'enabled' => true || false,
            'ephemerisId' => '<string>',
            'name' => '<string>',
            'priority' => <integer>,
            'sourceS3Object' => [
                'bucket' => '<string>',
                'key' => '<string>',
                'version' => '<string>',
            ],
            'status' => 'VALIDATING|INVALID|ERROR|ENABLED|DISABLED|EXPIRED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
ephemerides
Type: Array of EphemerisItem structures

List of ephemerides.

nextToken
Type: string

Pagination token.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListGroundStations

$result = $client->listGroundStations([/* ... */]);
$promise = $client->listGroundStationsAsync([/* ... */]);

Returns a list of ground stations.

Parameter Syntax

$result = $client->listGroundStations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'satelliteId' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

Maximum number of ground stations returned.

nextToken
Type: string

Next token that can be supplied in the next call to get the next page of ground stations.

satelliteId
Type: string

Satellite ID to retrieve on-boarded ground stations.

Result Syntax

[
    'groundStationList' => [
        [
            'groundStationId' => '<string>',
            'groundStationName' => '<string>',
            'region' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
groundStationList
Type: Array of GroundStationData structures

List of ground stations.

nextToken
Type: string

Next token that can be supplied in the next call to get the next page of ground stations.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListMissionProfiles

$result = $client->listMissionProfiles([/* ... */]);
$promise = $client->listMissionProfilesAsync([/* ... */]);

Returns a list of mission profiles.

Parameter Syntax

$result = $client->listMissionProfiles([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

Maximum number of mission profiles returned.

nextToken
Type: string

Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.

Result Syntax

[
    'missionProfileList' => [
        [
            'missionProfileArn' => '<string>',
            'missionProfileId' => '<string>',
            'name' => '<string>',
            'region' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
missionProfileList
Type: Array of MissionProfileListItem structures

List of mission profiles.

nextToken
Type: string

Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListSatellites

$result = $client->listSatellites([/* ... */]);
$promise = $client->listSatellitesAsync([/* ... */]);

Returns a list of satellites.

Parameter Syntax

$result = $client->listSatellites([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

Maximum number of satellites returned.

nextToken
Type: string

Next token that can be supplied in the next call to get the next page of satellites.

Result Syntax

[
    'nextToken' => '<string>',
    'satellites' => [
        [
            'currentEphemeris' => [
                'ephemerisId' => '<string>',
                'epoch' => <DateTime>,
                'name' => '<string>',
                'source' => 'CUSTOMER_PROVIDED|SPACE_TRACK',
            ],
            'groundStations' => ['<string>', ...],
            'noradSatelliteID' => <integer>,
            'satelliteArn' => '<string>',
            'satelliteId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

Next token that can be supplied in the next call to get the next page of satellites.

satellites
Type: Array of SatelliteListItem structures

List of satellites.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for a specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

ARN of a resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a resource.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

RegisterAgent

$result = $client->registerAgent([/* ... */]);
$promise = $client->registerAgentAsync([/* ... */]);

For use by AWS Ground Station Agent and shouldn't be called directly.

Registers a new agent with AWS Ground Station.

Parameter Syntax

$result = $client->registerAgent([
    'agentDetails' => [ // REQUIRED
        'agentCpuCores' => [<integer>, ...],
        'agentVersion' => '<string>', // REQUIRED
        'componentVersions' => [ // REQUIRED
            [
                'componentType' => '<string>', // REQUIRED
                'versions' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'instanceId' => '<string>', // REQUIRED
        'instanceType' => '<string>', // REQUIRED
        'reservedCpuCores' => [<integer>, ...],
    ],
    'discoveryData' => [ // REQUIRED
        'capabilityArns' => ['<string>', ...], // REQUIRED
        'privateIpAddresses' => ['<string>', ...], // REQUIRED
        'publicIpAddresses' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Members
agentDetails
Required: Yes
Type: AgentDetails structure

Detailed information about the agent being registered.

discoveryData
Required: Yes
Type: DiscoveryData structure

Data for associating an agent with the capabilities it is managing.

Result Syntax

[
    'agentId' => '<string>',
]

Result Details

Members
agentId
Type: string

UUID of registered agent.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

ReserveContact

$result = $client->reserveContact([/* ... */]);
$promise = $client->reserveContactAsync([/* ... */]);

Reserves a contact using specified parameters.

Parameter Syntax

$result = $client->reserveContact([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'groundStation' => '<string>', // REQUIRED
    'missionProfileArn' => '<string>', // REQUIRED
    'satelliteArn' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

End time of a contact in UTC.

groundStation
Required: Yes
Type: string

Name of a ground station.

missionProfileArn
Required: Yes
Type: string

ARN of a mission profile.

satelliteArn
Required: Yes
Type: string

ARN of a satellite

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of a contact in UTC.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a contact.

Result Syntax

[
    'contactId' => '<string>',
]

Result Details

Members
contactId
Type: string

UUID of a contact.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Assigns a tag to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

ARN of a resource tag.

tags
Required: Yes
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deassigns a resource tag.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

ARN of a resource.

tagKeys
Required: Yes
Type: Array of strings

Keys of a resource tag.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

UpdateAgentStatus

$result = $client->updateAgentStatus([/* ... */]);
$promise = $client->updateAgentStatusAsync([/* ... */]);

For use by AWS Ground Station Agent and shouldn't be called directly.

Update the status of the agent.

Parameter Syntax

$result = $client->updateAgentStatus([
    'agentId' => '<string>', // REQUIRED
    'aggregateStatus' => [ // REQUIRED
        'signatureMap' => [true || false, ...],
        'status' => 'SUCCESS|FAILED|ACTIVE|INACTIVE', // REQUIRED
    ],
    'componentStatuses' => [ // REQUIRED
        [
            'bytesReceived' => <integer>,
            'bytesSent' => <integer>,
            'capabilityArn' => '<string>', // REQUIRED
            'componentType' => '<string>', // REQUIRED
            'dataflowId' => '<string>', // REQUIRED
            'packetsDropped' => <integer>,
            'status' => 'SUCCESS|FAILED|ACTIVE|INACTIVE', // REQUIRED
        ],
        // ...
    ],
    'taskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
agentId
Required: Yes
Type: string

UUID of agent to update.

aggregateStatus
Required: Yes
Type: AggregateStatus structure

Aggregate status for agent.

componentStatuses
Required: Yes
Type: Array of ComponentStatusData structures

List of component statuses for agent.

taskId
Required: Yes
Type: string

GUID of agent task.

Result Syntax

[
    'agentId' => '<string>',
]

Result Details

Members
agentId
Required: Yes
Type: string

UUID of updated agent.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

UpdateConfig

$result = $client->updateConfig([/* ... */]);
$promise = $client->updateConfigAsync([/* ... */]);

Updates the Config used when scheduling contacts.

Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.

Parameter Syntax

$result = $client->updateConfig([
    'configData' => [ // REQUIRED
        'antennaDownlinkConfig' => [
            'spectrumConfig' => [ // REQUIRED
                'bandwidth' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'centerFrequency' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
        ],
        'antennaDownlinkDemodDecodeConfig' => [
            'decodeConfig' => [ // REQUIRED
                'unvalidatedJSON' => '<string>', // REQUIRED
            ],
            'demodulationConfig' => [ // REQUIRED
                'unvalidatedJSON' => '<string>', // REQUIRED
            ],
            'spectrumConfig' => [ // REQUIRED
                'bandwidth' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'centerFrequency' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
        ],
        'antennaUplinkConfig' => [
            'spectrumConfig' => [ // REQUIRED
                'centerFrequency' => [ // REQUIRED
                    'units' => 'GHz|MHz|kHz', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
                'polarization' => 'LEFT_HAND|NONE|RIGHT_HAND',
            ],
            'targetEirp' => [ // REQUIRED
                'units' => 'dBW', // REQUIRED
                'value' => <float>, // REQUIRED
            ],
            'transmitDisabled' => true || false,
        ],
        'dataflowEndpointConfig' => [
            'dataflowEndpointName' => '<string>', // REQUIRED
            'dataflowEndpointRegion' => '<string>',
        ],
        's3RecordingConfig' => [
            'bucketArn' => '<string>', // REQUIRED
            'prefix' => '<string>',
            'roleArn' => '<string>', // REQUIRED
        ],
        'trackingConfig' => [
            'autotrack' => 'PREFERRED|REMOVED|REQUIRED', // REQUIRED
        ],
        'uplinkEchoConfig' => [
            'antennaUplinkConfigArn' => '<string>', // REQUIRED
            'enabled' => true || false, // REQUIRED
        ],
    ],
    'configId' => '<string>', // REQUIRED
    'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
configData
Required: Yes
Type: ConfigTypeData structure

Parameters of a Config.

configId
Required: Yes
Type: string

UUID of a Config.

configType
Required: Yes
Type: string

Type of a Config.

name
Required: Yes
Type: string

Name of a Config.

Result Syntax

[
    'configArn' => '<string>',
    'configId' => '<string>',
    'configType' => 'antenna-downlink|antenna-downlink-demod-decode|antenna-uplink|dataflow-endpoint|tracking|uplink-echo|s3-recording',
]

Result Details

Members
configArn
Type: string

ARN of a Config.

configId
Type: string

UUID of a Config.

configType
Type: string

Type of a Config.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

UpdateEphemeris

$result = $client->updateEphemeris([/* ... */]);
$promise = $client->updateEphemerisAsync([/* ... */]);

Updates an existing ephemeris

Parameter Syntax

$result = $client->updateEphemeris([
    'enabled' => true || false, // REQUIRED
    'ephemerisId' => '<string>', // REQUIRED
    'name' => '<string>',
    'priority' => <integer>,
]);

Parameter Details

Members
enabled
Required: Yes
Type: boolean

Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.

ephemerisId
Required: Yes
Type: string

The AWS Ground Station ephemeris ID.

name
Type: string

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

priority
Type: int

Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

Priority must be 1 or greater

Result Syntax

[
    'ephemerisId' => '<string>',
]

Result Details

Members
ephemerisId
Type: string

The AWS Ground Station ephemeris ID.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

UpdateMissionProfile

$result = $client->updateMissionProfile([/* ... */]);
$promise = $client->updateMissionProfileAsync([/* ... */]);

Updates a mission profile.

Updating a mission profile will not update the execution parameters for existing future contacts.

Parameter Syntax

$result = $client->updateMissionProfile([
    'contactPostPassDurationSeconds' => <integer>,
    'contactPrePassDurationSeconds' => <integer>,
    'dataflowEdges' => [
        ['<string>', ...],
        // ...
    ],
    'minimumViableContactDurationSeconds' => <integer>,
    'missionProfileId' => '<string>', // REQUIRED
    'name' => '<string>',
    'streamsKmsKey' => [
        'kmsAliasArn' => '<string>',
        'kmsAliasName' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'streamsKmsRole' => '<string>',
    'trackingConfigArn' => '<string>',
]);

Parameter Details

Members
contactPostPassDurationSeconds
Type: int

Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.

contactPrePassDurationSeconds
Type: int

Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.

dataflowEdges
Type: Array of stringss

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

minimumViableContactDurationSeconds
Type: int

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

missionProfileId
Required: Yes
Type: string

UUID of a mission profile.

name
Type: string

Name of a mission profile.

streamsKmsKey
Type: KmsKey structure

KMS key to use for encrypting streams.

streamsKmsRole
Type: string

Role to use for encrypting streams with KMS key.

trackingConfigArn
Type: string

ARN of a tracking Config.

Result Syntax

[
    'missionProfileId' => '<string>',
]

Result Details

Members
missionProfileId
Type: string

UUID of a mission profile.

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.

Shapes

AgentDetails

Description

Detailed information about the agent.

Members
agentCpuCores
Type: Array of ints

List of CPU cores reserved for the agent.

agentVersion
Required: Yes
Type: string

Current agent version.

componentVersions
Required: Yes
Type: Array of ComponentVersion structures

List of versions being used by agent components.

instanceId
Required: Yes
Type: string

ID of EC2 instance agent is running on.

instanceType
Required: Yes
Type: string

Type of EC2 instance agent is running on.

reservedCpuCores
Type: Array of ints

This field should not be used. Use agentCpuCores instead.

List of CPU cores reserved for processes other than the agent running on the EC2 instance.

AggregateStatus

Description

Aggregate status of Agent components.

Members
signatureMap
Type: Associative array of custom strings keys (String) to booleans

Sparse map of failure signatures.

status
Required: Yes
Type: string

Aggregate status.

AntennaDemodDecodeDetails

Description

Details about an antenna demod decode Config used in a contact.

Members
outputNode
Type: string

Name of an antenna demod decode output node used in a contact.

AntennaDownlinkConfig

Description

Information about how AWS Ground Station should configure an antenna for downlink during a contact.

Members
spectrumConfig
Required: Yes
Type: SpectrumConfig structure

Object that describes a spectral Config.

AntennaDownlinkDemodDecodeConfig

Description

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

Members
decodeConfig
Required: Yes
Type: DecodeConfig structure

Information about the decode Config.

demodulationConfig
Required: Yes
Type: DemodulationConfig structure

Information about the demodulation Config.

spectrumConfig
Required: Yes
Type: SpectrumConfig structure

Information about the spectral Config.

AntennaUplinkConfig

Description

Information about the uplink Config of an antenna.

Members
spectrumConfig
Required: Yes
Type: UplinkSpectrumConfig structure

Information about the uplink spectral Config.

targetEirp
Required: Yes
Type: Eirp structure

EIRP of the target.

transmitDisabled
Type: boolean

Whether or not uplink transmit is disabled.

AwsGroundStationAgentEndpoint

Description

Information about AwsGroundStationAgentEndpoint.

Members
agentStatus
Type: string

The status of AgentEndpoint.

auditResults
Type: string

The results of the audit.

egressAddress
Required: Yes
Type: ConnectionDetails structure

The egress address of AgentEndpoint.

ingressAddress
Required: Yes
Type: RangedConnectionDetails structure

The ingress address of AgentEndpoint.

name
Required: Yes
Type: string

Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.

ComponentStatusData

Description

Data on the status of agent components.

Members
bytesReceived
Type: long (int|float)

Bytes received by the component.

bytesSent
Type: long (int|float)

Bytes sent by the component.

capabilityArn
Required: Yes
Type: string

Capability ARN of the component.

componentType
Required: Yes
Type: string

The Component type.

dataflowId
Required: Yes
Type: string

Dataflow UUID associated with the component.

packetsDropped
Type: long (int|float)

Packets dropped by component.

status
Required: Yes
Type: string

Component status.

ComponentVersion

Description

Version information for agent components.

Members
componentType
Required: Yes
Type: string

Component type.

versions
Required: Yes
Type: Array of strings

List of versions.

ConfigDetails

Description

Details for certain Config object types in a contact.

Members
antennaDemodDecodeDetails
Type: AntennaDemodDecodeDetails structure

Details for antenna demod decode Config in a contact.

endpointDetails
Type: EndpointDetails structure

Information about the endpoint details.

s3RecordingDetails
Type: S3RecordingDetails structure

Details for an S3 recording Config in a contact.

ConfigListItem

Description

An item in a list of Config objects.

Members
configArn
Type: string

ARN of a Config.

configId
Type: string

UUID of a Config.

configType
Type: string

Type of a Config.

name
Type: string

Name of a Config.

ConfigTypeData

Description

Object containing the parameters of a Config.

See the subtype definitions for what each type of Config contains.

Members
antennaDownlinkConfig
Type: AntennaDownlinkConfig structure

Information about how AWS Ground Station should configure an antenna for downlink during a contact.

antennaDownlinkDemodDecodeConfig

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

antennaUplinkConfig
Type: AntennaUplinkConfig structure

Information about how AWS Ground Station should configure an antenna for uplink during a contact.

dataflowEndpointConfig
Type: DataflowEndpointConfig structure

Information about the dataflow endpoint Config.

s3RecordingConfig
Type: S3RecordingConfig structure

Information about an S3 recording Config.

trackingConfig
Type: TrackingConfig structure

Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.

uplinkEchoConfig
Type: UplinkEchoConfig structure

Information about an uplink echo Config.

Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.

ConnectionDetails

Description

Egress address of AgentEndpoint with an optional mtu.

Members
mtu
Type: int

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

socketAddress
Required: Yes
Type: SocketAddress structure

A socket address.

ContactData

Description

Data describing a contact.

Members
contactId
Type: string

UUID of a contact.

contactStatus
Type: string

Status of a contact.

endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

End time of a contact in UTC.

errorMessage
Type: string

Error message of a contact.

groundStation
Type: string

Name of a ground station.

maximumElevation
Type: Elevation structure

Maximum elevation angle of a contact.

missionProfileArn
Type: string

ARN of a mission profile.

postPassEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

prePassStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

region
Type: string

Region of a contact.

satelliteArn
Type: string

ARN of a satellite.

startTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Start time of a contact in UTC.

tags
Type: Associative array of custom strings keys (String) to strings

Tags assigned to a contact.

visibilityEndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts. This field is not present for contacts with a SCHEDULING or SCHEDULED status.

visibilityStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts. This field is not present for contacts with a SCHEDULING or SCHEDULED status.

DataflowDetail

Description

Information about a dataflow edge used in a contact.

Members
destination
Type: Destination structure

Dataflow details for the destination side.

errorMessage
Type: string

Error message for a dataflow.

source
Type: Source structure

Dataflow details for the source side.

DataflowEndpoint

Description

Information about a dataflow endpoint.

Members
address
Type: SocketAddress structure

Socket address of a dataflow endpoint.

mtu
Type: int

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

name
Type: string

Name of a dataflow endpoint.

status
Type: string

Status of a dataflow endpoint.

DataflowEndpointConfig

Description

Information about the dataflow endpoint Config.

Members
dataflowEndpointName
Required: Yes
Type: string

Name of a dataflow endpoint.

dataflowEndpointRegion
Type: string

Region of a dataflow endpoint.

DataflowEndpointListItem

Description

Item in a list of DataflowEndpoint groups.

Members
dataflowEndpointGroupArn
Type: string

ARN of a dataflow endpoint group.

dataflowEndpointGroupId
Type: string

UUID of a dataflow endpoint group.

DecodeConfig

Description

Information about the decode Config.

Members
unvalidatedJSON
Required: Yes
Type: string

Unvalidated JSON of a decode Config.

DemodulationConfig

Description

Information about the demodulation Config.

Members
unvalidatedJSON
Required: Yes
Type: string

Unvalidated JSON of a demodulation Config.

DependencyException

Description

Dependency encountered an error.

Members
message
Type: string
parameterName
Type: string

Destination

Description

Dataflow details for the destination side.

Members
configDetails
Type: ConfigDetails structure

Additional details for a Config, if type is dataflow endpoint or antenna demod decode.

configId
Type: string

UUID of a Config.

configType
Type: string

Type of a Config.

dataflowDestinationRegion
Type: string

Region of a dataflow destination.

DiscoveryData

Description

Data for agent discovery.

Members
capabilityArns
Required: Yes
Type: Array of strings

List of capabilities to associate with agent.

privateIpAddresses
Required: Yes
Type: Array of strings

List of private IP addresses to associate with agent.

publicIpAddresses
Required: Yes
Type: Array of strings

List of public IP addresses to associate with agent.

Eirp

Description

Object that represents EIRP.

Members
units
Required: Yes
Type: string

Units of an EIRP.

value
Required: Yes
Type: double

Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.

Elevation

Description

Elevation angle of the satellite in the sky during a contact.

Members
unit
Required: Yes
Type: string

Elevation angle units.

value
Required: Yes
Type: double

Elevation angle value.

EndpointDetails

Description

Information about the endpoint details.

Members
awsGroundStationAgentEndpoint

An agent endpoint.

endpoint
Type: DataflowEndpoint structure

A dataflow endpoint.

healthReasons
Type: Array of strings

Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

healthStatus
Type: string

A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

securityDetails
Type: SecurityDetails structure

Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

EphemerisData

Description

Ephemeris data.

Members
oem
Type: OEMEphemeris structure

Ephemeris data in Orbit Ephemeris Message (OEM) format.

AWS Ground Station processes OEM Customer Provided Ephemerides according to the CCSDS standard with some extra restrictions. OEM files should be in KVN format. For more detail about the OEM format that AWS Ground Station supports, see OEM ephemeris format in the AWS Ground Station user guide.

tle
Type: TLEEphemeris structure

Two-line element set (TLE) ephemeris.

EphemerisDescription

Description

Description of ephemeris.

Members
ephemerisData
Type: string

Supplied ephemeris data.

sourceS3Object
Type: S3Object structure

Source S3 object used for the ephemeris.

EphemerisItem

Description

Ephemeris item.

Members
creationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the ephemeris was uploaded in UTC.

enabled
Type: boolean

Whether or not the ephemeris is enabled.

ephemerisId
Type: string

The AWS Ground Station ephemeris ID.

name
Type: string

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

priority
Type: int

Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

Priority must be 1 or greater

sourceS3Object
Type: S3Object structure

Source S3 object used for the ephemeris.

status
Type: string

The status of the ephemeris.

EphemerisMetaData

Description

Metadata describing a particular ephemeris.

Members
ephemerisId
Type: string

UUID of a customer-provided ephemeris.

This field is not populated for default ephemerides from Space Track.

epoch
Type: timestamp (string|DateTime or anything parsable by strtotime)

The epoch of a default, ephemeris from Space Track in UTC.

This field is not populated for customer-provided ephemerides.

name
Type: string

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

A name is only returned for customer-provider ephemerides that have a name associated.

source
Required: Yes
Type: string

The EphemerisSource that generated a given ephemeris.

Frequency

Description

Object that describes the frequency.

Members
units
Required: Yes
Type: string

Frequency units.

value
Required: Yes
Type: double

Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

FrequencyBandwidth

Description

Object that describes the frequency bandwidth.

Members
units
Required: Yes
Type: string

Frequency bandwidth units.

value
Required: Yes
Type: double

Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

  • For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.

  • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.

  • For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.

GroundStationData

Description

Information about the ground station data.

Members
groundStationId
Type: string

UUID of a ground station.

groundStationName
Type: string

Name of a ground station.

region
Type: string

Ground station Region.

IntegerRange

Description

An integer range that has a minimum and maximum value.

Members
maximum
Required: Yes
Type: int

A maximum value.

minimum
Required: Yes
Type: int

A minimum value.

InvalidParameterException

Description

One or more parameters are not valid.

Members
message
Type: string
parameterName
Type: string

KmsKey

Description

AWS Key Management Service (KMS) Key.

Members
kmsAliasArn
Type: string

KMS Alias Arn.

kmsAliasName
Type: string

KMS Alias Name.

kmsKeyArn
Type: string

KMS Key Arn.

MissionProfileListItem

Description

Item in a list of mission profiles.

Members
missionProfileArn
Type: string

ARN of a mission profile.

missionProfileId
Type: string

UUID of a mission profile.

name
Type: string

Name of a mission profile.

region
Type: string

Region of a mission profile.

OEMEphemeris

Description

Ephemeris data in Orbit Ephemeris Message (OEM) format.

AWS Ground Station processes OEM Customer Provided Ephemerides according to the CCSDS standard with some extra restrictions. OEM files should be in KVN format. For more detail about the OEM format that AWS Ground Station supports, see OEM ephemeris format in the AWS Ground Station user guide.

Members
oemData
Type: string

The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.

s3Object
Type: S3Object structure

Identifies the S3 object to be used as the ephemeris.

RangedConnectionDetails

Description

Ingress address of AgentEndpoint with a port range and an optional mtu.

Members
mtu
Type: int

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

socketAddress
Required: Yes
Type: RangedSocketAddress structure

A ranged socket address.

RangedSocketAddress

Description

A socket address with a port range.

Members
name
Required: Yes
Type: string

IPv4 socket address.

portRange
Required: Yes
Type: IntegerRange structure

Port range of a socket address.

ResourceLimitExceededException

Description

Account limits for this resource have been exceeded.

Members
message
Type: string
parameterName
Type: string

ResourceNotFoundException

Description

Resource was not found.

Members
message
Type: string

S3Object

Description

Object stored in S3 containing ephemeris data.

Members
bucket
Type: string

An Amazon S3 Bucket name.

key
Type: string

An Amazon S3 key for the ephemeris.

version
Type: string

For versioned S3 objects, the version to use for the ephemeris.

S3RecordingConfig

Description

Information about an S3 recording Config.

Members
bucketArn
Required: Yes
Type: string

ARN of the bucket to record to.

prefix
Type: string

S3 Key prefix to prefice data files.

roleArn
Required: Yes
Type: string

ARN of the role Ground Station assumes to write data to the bucket.

S3RecordingDetails

Description

Details about an S3 recording Config used in a contact.

Members
bucketArn
Type: string

ARN of the bucket used.

keyTemplate
Type: string

Key template used for the S3 Recording Configuration

SatelliteListItem

Description

Item in a list of satellites.

Members
currentEphemeris
Type: EphemerisMetaData structure

The current ephemeris being used to compute the trajectory of the satellite.

groundStations
Type: Array of strings

A list of ground stations to which the satellite is on-boarded.

noradSatelliteID
Type: int

NORAD satellite ID number.

satelliteArn
Type: string

ARN of a satellite.

satelliteId
Type: string

UUID of a satellite.

SecurityDetails

Description

Information about endpoints.

Members
roleArn
Required: Yes
Type: string

ARN to a role needed for connecting streams to your instances.

securityGroupIds
Required: Yes
Type: Array of strings

The security groups to attach to the elastic network interfaces.

subnetIds
Required: Yes
Type: Array of strings

A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.

SocketAddress

Description

Information about the socket address.

Members
name
Required: Yes
Type: string

Name of a socket address.

port
Required: Yes
Type: int

Port of a socket address.

Source

Description

Dataflow details for the source side.

Members
configDetails
Type: ConfigDetails structure

Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode

configId
Type: string

UUID of a Config.

configType
Type: string

Type of a Config.

dataflowSourceRegion
Type: string

Region of a dataflow source.

SpectrumConfig

Description

Object that describes a spectral Config.

Members
bandwidth
Required: Yes
Type: FrequencyBandwidth structure

Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:

  • For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.

  • For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.

  • For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.

centerFrequency
Required: Yes
Type: Frequency structure

Center frequency of a spectral Config. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

polarization
Type: string

Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.

TLEData

Description

Two-line element set (TLE) data.

Members
tleLine1
Required: Yes
Type: string

First line of two-line element set (TLE) data.

tleLine2
Required: Yes
Type: string

Second line of two-line element set (TLE) data.

validTimeRange
Required: Yes
Type: TimeRange structure

The valid time range for the TLE. Gaps or overlap are not permitted.

TLEEphemeris

Description

Two-line element set (TLE) ephemeris.

Members
s3Object
Type: S3Object structure

Identifies the S3 object to be used as the ephemeris.

tleData
Type: Array of TLEData structures

The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.

TimeRange

Description

A time range with a start and end time.

Members
endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time in UTC at which the time range ends.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Time in UTC at which the time range starts.

TrackingConfig

Description

Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.

Members
autotrack
Required: Yes
Type: string

Current setting for autotrack.

UplinkEchoConfig

Description

Information about an uplink echo Config.

Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.

Members
antennaUplinkConfigArn
Required: Yes
Type: string

ARN of an uplink Config.

enabled
Required: Yes
Type: boolean

Whether or not an uplink Config is enabled.

UplinkSpectrumConfig

Description

Information about the uplink spectral Config.

Members
centerFrequency
Required: Yes
Type: Frequency structure

Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.

polarization
Type: string

Polarization of an uplink spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.