AWS Ground Station 2019-05-23
- 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.
- CreateMissionProfile ( array $params = [] )
Creates a mission profile.
- DeleteConfig ( array $params = [] )
Deletes a Config.
- DeleteDataflowEndpointGroup ( array $params = [] )
Deletes a dataflow endpoint group.
- DeleteMissionProfile ( array $params = [] )
Deletes a mission profile.
- DescribeContact ( array $params = [] )
Describes an existing contact.
- GetDataflowEndpointGroup ( array $params = [] )
Returns the dataflow endpoint group.
- GetMinuteUsage ( array $params = [] )
Returns the number of 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.
- 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.
- 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.
- UpdateConfig ( array $params = [] )
Updates the Config used when scheduling contacts.
- 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:
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
Result Syntax
[
'contactId' => '<string>',
]
Result Details
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
ResourceLimitExceededException:
Account limits for this resource have been exceeded.
-
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([
'endpointDetails' => [ // REQUIRED
[
'endpoint' => [
'address' => [
'name' => '<string>', // REQUIRED
'port' => <integer>, // REQUIRED
],
'mtu' => <integer>,
'name' => '<string>',
'status' => 'created|creating|deleted|deleting|failed',
],
'securityDetails' => [
'roleArn' => '<string>', // REQUIRED
'securityGroupIds' => ['<string>', ...], // REQUIRED
'subnetIds' => ['<string>', ...], // REQUIRED
],
],
// ...
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- 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
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
'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 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
-
- Required: Yes
- Type: Array of stringss
A list of lists of ARNs. Each list of ARNs is an edge, with a from
Configand a toConfig. - 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.
- 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
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
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
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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' => [
'endpoint' => [
'address' => [
'name' => '<string>',
'port' => <integer>,
],
'mtu' => <integer>,
'name' => '<string>',
'status' => 'created|creating|deleted|deleting|failed',
],
'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' => [
'endpoint' => [
'address' => [
'name' => '<string>',
'port' => <integer>,
],
'mtu' => <integer>,
'name' => '<string>',
'status' => 'created|creating|deleted|deleting|failed',
],
'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>', ...],
]
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.
- 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.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
Tags assigned to a contact.
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
[
'dataflowEndpointGroupArn' => '<string>',
'dataflowEndpointGroupId' => '<string>',
'endpointsDetails' => [
[
'endpoint' => [
'address' => [
'name' => '<string>',
'port' => <integer>,
],
'mtu' => <integer>,
'name' => '<string>',
'status' => 'created|creating|deleted|deleting|failed',
],
'securityDetails' => [
'roleArn' => '<string>',
'securityGroupIds' => ['<string>', ...],
'subnetIds' => ['<string>', ...],
],
],
// ...
],
'tags' => ['<string>', ...],
]
Result Details
Members
- 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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
Resource was not found.
GetMinuteUsage
$result = $client->getMinuteUsage([/* ... */]); $promise = $client->getMinuteUsageAsync([/* ... */]);
Returns the number of minutes used by account.
Parameter Syntax
$result = $client->getMinuteUsage([
'month' => <integer>, // REQUIRED
'year' => <integer>, // REQUIRED
]);
Parameter Details
Members
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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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>',
'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
Configand a toConfig. - 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.
- 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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
[
'groundStations' => ['<string>', ...],
'noradSatelliteID' => <integer>,
'satelliteArn' => '<string>',
'satelliteId' => '<string>',
]
Result Details
Members
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
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
Configitems. - nextToken
-
- Type: string
Next token returned in the response of a previous
ListConfigscall. Used to get the next page of results.
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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.
- 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
ListContactscall. 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.
- 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>', ...],
],
// ...
],
'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
ListContactscall. Used to get the next page of results.
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
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
ListDataflowEndpointGroupscall. Used to get the next page of results.
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
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
ListMissionProfilescall. Used to get the next page of results.
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
Result Syntax
[
'nextToken' => '<string>',
'satellites' => [
[
'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
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
Members
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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.
- 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.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
Tags assigned to a contact.
Result Syntax
[
'contactId' => '<string>',
]
Result Details
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
Result Syntax
[]
Result Details
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
Result Syntax
[]
Result Details
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
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>',
'trackingConfigArn' => '<string>',
]);
Parameter 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 after a contact ends that you’d like to receive a CloudWatch 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
Configand a toConfig. - 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.
- trackingConfigArn
-
- Type: string
ARN of a tracking
Config.
Result Syntax
[
'missionProfileId' => '<string>',
]
Result Details
Errors
-
One or more parameters are not valid.
-
Dependency encountered an error.
-
Resource was not found.
Shapes
AntennaDemodDecodeDetails
Description
Details about an antenna demod decode Config used in a contact.
Members
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.
ConfigDetails
Description
Details for certain Config object types in a contact.
Members
- antennaDemodDecodeDetails
-
- Type: AntennaDemodDecodeDetails structure
Details for antenna demod decode
Configin a contact. - endpointDetails
-
- Type: EndpointDetails structure
Information about the endpoint details.
- s3RecordingDetails
-
- Type: S3RecordingDetails structure
Details for an S3 recording
Configin a contact.
ConfigListItem
Description
An item in a list of Config objects.
Members
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
-
- Type: AntennaDownlinkDemodDecodeConfig structure
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
Configin the mission profile. - uplinkEchoConfig
-
- Type: UplinkEchoConfig structure
Information about an uplink echo
Config.Parameters from the
AntennaUplinkConfig, corresponding to the specifiedAntennaUplinkConfigArn, are used when thisUplinkEchoConfigis used in a contact.
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.
- 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.
- tags
-
- Type: Associative array of custom strings keys (String) to strings
Tags assigned to a contact.
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
DataflowEndpointListItem
Description
Item in a list of DataflowEndpoint groups.
Members
DecodeConfig
Description
Information about the decode Config.
Members
DemodulationConfig
Description
Information about the demodulation Config.
Members
DependencyException
Description
Dependency encountered an error.
Members
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.
Eirp
Description
Object that represents EIRP.
Members
Elevation
Description
Elevation angle of the satellite in the sky during a contact.
Members
EndpointDetails
Description
Information about the endpoint details.
Members
- endpoint
-
- Type: DataflowEndpoint structure
A dataflow endpoint.
- securityDetails
-
- Type: SecurityDetails structure
Endpoint security details.
Frequency
Description
Object that describes the frequency.
Members
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
InvalidParameterException
Description
One or more parameters are not valid.
Members
MissionProfileListItem
Description
Item in a list of mission profiles.
Members
ResourceLimitExceededException
Description
Account limits for this resource have been exceeded.
Members
ResourceNotFoundException
S3RecordingConfig
Description
Information about an S3 recording Config.
Members
S3RecordingDetails
Description
Details about an S3 recording Config used in a contact.
Members
SatelliteListItem
Description
Item in a list of satellites.
Members
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
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 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
AntennaDownlinkconfigvalid 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.
TrackingConfig
Description
Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
Members
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
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.