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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

Errors

InvalidParameterException:

One or more parameters are not valid.

DependencyException:

Dependency encountered an error.

ResourceNotFoundException:

Resource was not found.