Creates a Config with the specified configData parameters.
Only one type of configData can be specified.
Object containing the parameters of a Config.
See the subtype definitions for what each type of Config contains.
Config.
s3RecordingConfig:
allOf:
- $ref: "#/components/schemas/S3RecordingConfig"
- description: Information about an S3 recording Config.
trackingConfig:
allOf:
- $ref: "#/components/schemas/TrackingConfig"
- description: "Object that determines whether tracking should be used during a contact executed with this Config in the mission profile. "
uplinkEchoConfig:
allOf:
- $ref: "#/components/schemas/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.
Config.
type: string
pattern: ^[ a-zA-Z0-9_:-]{1,256}$
minLength: 1
maxLength: 256
tags:
description: Tags assigned to a Config.
type: object
additionalProperties:
$ref: "#/components/schemas/String"
summary: Amazon Ground Station Create Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: ListConfigs
description: Returns a list of Config objects.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListConfigsResponse"
examples:
ListConfigs200Example:
summary: Default ListConfigs 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
ListConfigs480Example:
summary: Default ListConfigs 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
ListConfigs481Example:
summary: Default ListConfigs 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ListConfigs482Example:
summary: Default ListConfigs 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: maxResults
in: query
required: false
description: Maximum number of Configs returned.
schema:
type: integer
minimum: 0
maximum: 100
- name: nextToken
in: query
required: false
description: Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.
schema:
type: string
pattern: ^[A-Za-z0-9-/+_.=]+$
minLength: 3
maxLength: 1000
summary: Amazon Ground Station List Configs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/dataflowEndpointGroup:
post:
operationId: CreateDataflowEndpointGroup
description: 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.
POSTPASS state. A Ground Station Dataflow
Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
type: integer
minimum: 120
maximum: 480
contactPrePassDurationSeconds:
description: Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow
Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
type: integer
minimum: 120
maximum: 480
endpointDetails:
description: Endpoint details of each endpoint in the dataflow endpoint group.
type: array
items:
$ref: "#/components/schemas/EndpointDetails"
minItems: 0
maxItems: 500
tags:
description: Tags of a dataflow endpoint group.
type: object
additionalProperties:
$ref: "#/components/schemas/String"
summary: Amazon Ground Station Create Dataflow Endpoint Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: ListDataflowEndpointGroups
description: Returns a list of DataflowEndpoint groups.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListDataflowEndpointGroupsResponse"
examples:
ListDataflowEndpointGroups200Example:
summary: Default ListDataflowEndpointGroups 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
ListDataflowEndpointGroups480Example:
summary: Default ListDataflowEndpointGroups 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
ListDataflowEndpointGroups481Example:
summary: Default ListDataflowEndpointGroups 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ListDataflowEndpointGroups482Example:
summary: Default ListDataflowEndpointGroups 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: maxResults
in: query
required: false
description: Maximum number of dataflow endpoint groups returned.
schema:
type: integer
minimum: 0
maximum: 100
- name: nextToken
in: query
required: false
description: Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
schema:
type: string
pattern: ^[A-Za-z0-9-/+_.=]+$
minLength: 3
maxLength: 1000
summary: Amazon Ground Station List Dataflow Endpoint Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/ephemeris:
post:
operationId: CreateEphemeris
description: Creates an Ephemeris with the specified EphemerisData.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/EphemerisIdResponse"
examples:
CreateEphemeris200Example:
summary: Default CreateEphemeris 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
CreateEphemeris480Example:
summary: Default CreateEphemeris 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
CreateEphemeris481Example:
summary: Default CreateEphemeris 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
CreateEphemeris482Example:
summary: Default CreateEphemeris 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- satelliteId
properties:
enabled:
description: Whether to set the ephemeris status to ENABLED after validation.
Setting this to false will set the ephemeris status to DISABLED
after validation.
EXPIRED.
type: string
format: date-time
kmsKeyArn:
description: The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
type: string
name:
description: A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
type: string
pattern: ^[ a-zA-Z0-9_:-]{1,256}$
minLength: 1
maxLength: 256
priority:
description: Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
type: integer minimum: 1 maximum: 99999 satelliteId: description: AWS Ground Station satellite ID for this ephemeris. type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 tags: description: Tags assigned to an ephemeris. type: object additionalProperties: $ref: "#/components/schemas/String" summary: Amazon Ground Station Create Ephemeris x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /missionprofile: post: operationId: CreateMissionProfile description: "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.
Config and a to Config.
type: array
items:
$ref: "#/components/schemas/DataflowEdge"
minItems: 0
maxItems: 500
minimumViableContactDurationSeconds:
description: 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.
type: integer
minimum: 1
maximum: 21600
name:
description: Name of a mission profile.
type: string
pattern: ^[ a-zA-Z0-9_:-]{1,256}$
minLength: 1
maxLength: 256
streamsKmsKey:
description: AWS Key Management Service (KMS) Key.
type: object
properties:
kmsAliasArn:
allOf:
- $ref: "#/components/schemas/KeyAliasArn"
- description: KMS Alias Arn.
kmsKeyArn:
allOf:
- $ref: "#/components/schemas/KeyArn"
- description: KMS Key Arn.
streamsKmsRole:
description: Role to use for encrypting streams with KMS key.
type: string
tags:
description: Tags assigned to a mission profile.
type: object
additionalProperties:
$ref: "#/components/schemas/String"
trackingConfigArn:
description: ARN of a tracking Config.
type: string
summary: Amazon Ground Station Create Mission Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: ListMissionProfiles
description: Returns a list of mission profiles.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListMissionProfilesResponse"
examples:
ListMissionProfiles200Example:
summary: Default ListMissionProfiles 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
ListMissionProfiles480Example:
summary: Default ListMissionProfiles 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
ListMissionProfiles481Example:
summary: Default ListMissionProfiles 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ListMissionProfiles482Example:
summary: Default ListMissionProfiles 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: maxResults
in: query
required: false
description: Maximum number of mission profiles returned.
schema:
type: integer
minimum: 0
maximum: 100
- name: nextToken
in: query
required: false
description: Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.
schema:
type: string
pattern: ^[A-Za-z0-9-/+_.=]+$
minLength: 3
maxLength: 1000
summary: Amazon Ground Station List Mission Profiles
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/config/{configType}/{configId}":
delete:
operationId: DeleteConfig
description: Deletes a Config.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigIdResponse"
examples:
DeleteConfig200Example:
summary: Default DeleteConfig 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
DeleteConfig480Example:
summary: Default DeleteConfig 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
DeleteConfig481Example:
summary: Default DeleteConfig 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
DeleteConfig482Example:
summary: Default DeleteConfig 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: configId
in: path
required: true
description: UUID of a Config.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
- name: configType
in: path
required: true
description: Type of a Config.
schema:
type: string
enum:
- antenna-downlink
- antenna-downlink-demod-decode
- antenna-uplink
- dataflow-endpoint
- tracking
- uplink-echo
- s3-recording
summary: Amazon Ground Station Delete Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: GetConfig
description: Returns Config information.
Only one Config response can be returned.
Config.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
- name: configType
in: path
required: true
description: Type of a Config.
schema:
type: string
enum:
- antenna-downlink
- antenna-downlink-demod-decode
- antenna-uplink
- dataflow-endpoint
- tracking
- uplink-echo
- s3-recording
summary: Amazon Ground Station Get Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: UpdateConfig
description: Updates the Config used when scheduling contacts.
Updating a Config will not update the execution parameters for existing future contacts
scheduled with this Config.
Config.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
- name: configType
in: path
required: true
description: Type of a Config.
schema:
type: string
enum:
- antenna-downlink
- antenna-downlink-demod-decode
- antenna-uplink
- dataflow-endpoint
- tracking
- uplink-echo
- s3-recording
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- configData
- name
properties:
configData:
description: Object containing the parameters of a Config.
See the subtype definitions for what each type of Config contains.
Config.
s3RecordingConfig:
allOf:
- $ref: "#/components/schemas/S3RecordingConfig"
- description: Information about an S3 recording Config.
trackingConfig:
allOf:
- $ref: "#/components/schemas/TrackingConfig"
- description: "Object that determines whether tracking should be used during a contact executed with this Config in the mission profile. "
uplinkEchoConfig:
allOf:
- $ref: "#/components/schemas/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.
Config.
type: string
pattern: ^[ a-zA-Z0-9_:-]{1,256}$
minLength: 1
maxLength: 256
summary: Amazon Ground Station Update Config
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/dataflowEndpointGroup/{dataflowEndpointGroupId}":
delete:
operationId: DeleteDataflowEndpointGroup
description: Deletes a dataflow endpoint group.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DataflowEndpointGroupIdResponse"
examples:
DeleteDataflowEndpointGroup200Example:
summary: Default DeleteDataflowEndpointGroup 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
DeleteDataflowEndpointGroup480Example:
summary: Default DeleteDataflowEndpointGroup 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
DeleteDataflowEndpointGroup481Example:
summary: Default DeleteDataflowEndpointGroup 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
DeleteDataflowEndpointGroup482Example:
summary: Default DeleteDataflowEndpointGroup 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: dataflowEndpointGroupId
in: path
required: true
description: UUID of a dataflow endpoint group.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
summary: Amazon Ground Station Delete Dataflow Endpoint Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: GetDataflowEndpointGroup
description: Returns the dataflow endpoint group.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetDataflowEndpointGroupResponse"
examples:
GetDataflowEndpointGroup200Example:
summary: Default GetDataflowEndpointGroup 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
GetDataflowEndpointGroup480Example:
summary: Default GetDataflowEndpointGroup 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
GetDataflowEndpointGroup481Example:
summary: Default GetDataflowEndpointGroup 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
GetDataflowEndpointGroup482Example:
summary: Default GetDataflowEndpointGroup 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: dataflowEndpointGroupId
in: path
required: true
description: UUID of a dataflow endpoint group.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
summary: Amazon Ground Station Get Dataflow Endpoint Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/ephemeris/{ephemerisId}":
delete:
operationId: DeleteEphemeris
description: Deletes an ephemeris
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/EphemerisIdResponse"
examples:
DeleteEphemeris200Example:
summary: Default DeleteEphemeris 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
DeleteEphemeris480Example:
summary: Default DeleteEphemeris 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
DeleteEphemeris481Example:
summary: Default DeleteEphemeris 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
DeleteEphemeris482Example:
summary: Default DeleteEphemeris 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: ephemerisId
in: path
required: true
description: The AWS Ground Station ephemeris ID.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
summary: Amazon Ground Station Delete Ephemeris
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
get:
operationId: DescribeEphemeris
description: Describes an existing ephemeris.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEphemerisResponse"
examples:
DescribeEphemeris200Example:
summary: Default DescribeEphemeris 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
DescribeEphemeris480Example:
summary: Default DescribeEphemeris 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
DescribeEphemeris481Example:
summary: Default DescribeEphemeris 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
DescribeEphemeris482Example:
summary: Default DescribeEphemeris 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: ephemerisId
in: path
required: true
description: The AWS Ground Station ephemeris ID.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
summary: Amazon Ground Station Describe Ephemeris
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: UpdateEphemeris
description: Updates an existing ephemeris
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/EphemerisIdResponse"
examples:
UpdateEphemeris200Example:
summary: Default UpdateEphemeris 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
UpdateEphemeris480Example:
summary: Default UpdateEphemeris 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
UpdateEphemeris481Example:
summary: Default UpdateEphemeris 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
UpdateEphemeris482Example:
summary: Default UpdateEphemeris 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: ephemerisId
in: path
required: true
description: The AWS Ground Station ephemeris ID.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- enabled
properties:
enabled:
description: Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.
type: boolean
name:
description: A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
type: string
pattern: ^[ a-zA-Z0-9_:-]{1,256}$
minLength: 1
maxLength: 256
priority:
description: Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
type: integer minimum: 0 maximum: 99999 summary: Amazon Ground Station Update Ephemeris x-microcks-operation: delay: 0 dispatcher: FALLBACK "/missionprofile/{missionProfileId}": delete: operationId: DeleteMissionProfile description: Deletes a mission profile. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/MissionProfileIdResponse" examples: DeleteMissionProfile200Example: summary: Default DeleteMissionProfile 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: DeleteMissionProfile480Example: summary: Default DeleteMissionProfile 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: DeleteMissionProfile481Example: summary: Default DeleteMissionProfile 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: DeleteMissionProfile482Example: summary: Default DeleteMissionProfile 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: - name: missionProfileId in: path required: true description: UUID of a mission profile. schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 summary: Amazon Ground Station Delete Mission Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" get: operationId: GetMissionProfile description: Returns a mission profile. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetMissionProfileResponse" examples: GetMissionProfile200Example: summary: Default GetMissionProfile 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: GetMissionProfile480Example: summary: Default GetMissionProfile 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: GetMissionProfile481Example: summary: Default GetMissionProfile 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: GetMissionProfile482Example: summary: Default GetMissionProfile 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: - name: missionProfileId in: path required: true description: UUID of a mission profile. schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 summary: Amazon Ground Station Get Mission Profile x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateMissionProfile description:Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/MissionProfileIdResponse" examples: UpdateMissionProfile200Example: summary: Default UpdateMissionProfile 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateMissionProfile480Example: summary: Default UpdateMissionProfile 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: UpdateMissionProfile481Example: summary: Default UpdateMissionProfile 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateMissionProfile482Example: summary: Default UpdateMissionProfile 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: - name: missionProfileId in: path required: true description: UUID of a mission profile. schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: contactPostPassDurationSeconds: description: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished. type: integer minimum: 0 maximum: 21600 contactPrePassDurationSeconds: description: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished. type: integer minimum: 0 maximum: 21600 dataflowEdges: description: A list of lists of ARNs. Each list of ARNs is an edge, with a fromConfig and a to Config.
type: array
items:
$ref: "#/components/schemas/DataflowEdge"
minItems: 0
maxItems: 500
minimumViableContactDurationSeconds:
description: 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.
type: integer
minimum: 1
maximum: 21600
name:
description: Name of a mission profile.
type: string
pattern: ^[ a-zA-Z0-9_:-]{1,256}$
minLength: 1
maxLength: 256
streamsKmsKey:
description: AWS Key Management Service (KMS) Key.
type: object
properties:
kmsAliasArn:
allOf:
- $ref: "#/components/schemas/KeyAliasArn"
- description: KMS Alias Arn.
kmsKeyArn:
allOf:
- $ref: "#/components/schemas/KeyArn"
- description: KMS Key Arn.
streamsKmsRole:
description: Role to use for encrypting streams with KMS key.
type: string
trackingConfigArn:
description: ARN of a tracking Config.
type: string
summary: Amazon Ground Station Update Mission Profile
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/agent/{agentId}/configuration":
get:
operationId: GetAgentConfiguration
description: For use by AWS Ground Station Agent and shouldn't be called directly.
Gets the latest configuration information for a registered agent.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetAgentConfigurationResponse" examples: GetAgentConfiguration200Example: summary: Default GetAgentConfiguration 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: GetAgentConfiguration480Example: summary: Default GetAgentConfiguration 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: GetAgentConfiguration481Example: summary: Default GetAgentConfiguration 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: GetAgentConfiguration482Example: summary: Default GetAgentConfiguration 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: - name: agentId in: path required: true description: UUID of agent to get configuration information for. schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 summary: Amazon Ground Station Get Agent Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /minute-usage: post: operationId: GetMinuteUsage description: Returns the number of minutes used by account. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetMinuteUsageResponse" examples: GetMinuteUsage200Example: summary: Default GetMinuteUsage 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: GetMinuteUsage480Example: summary: Default GetMinuteUsage 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: GetMinuteUsage481Example: summary: Default GetMinuteUsage 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: GetMinuteUsage482Example: summary: Default GetMinuteUsage 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - month - year properties: month: description: The month being requested, with a value of 1-12. type: integer minimum: 1 maximum: 12 year: description: The year being requested, in the format of YYYY. type: integer minimum: 2018 maximum: 3000 summary: Amazon Ground Station Get Minute Usage x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/satellite/{satelliteId}": get: operationId: GetSatellite description: Returns a satellite. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetSatelliteResponse" examples: GetSatellite200Example: summary: Default GetSatellite 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: GetSatellite480Example: summary: Default GetSatellite 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: GetSatellite481Example: summary: Default GetSatellite 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: GetSatellite482Example: summary: Default GetSatellite 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: - name: satelliteId in: path required: true description: UUID of a satellite. schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 summary: Amazon Ground Station Get Satellite x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /contacts: post: operationId: ListContacts description:Returns a list of contacts.
If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and
satelliteArn.
ListContacts call. Used to get the next page of results.
type: string
pattern: ^[A-Za-z0-9-/+_.=]+$
minLength: 3
maxLength: 1000
satelliteArn:
description: ARN of a satellite.
type: string
startTime:
description: Start time of a contact in UTC.
type: string
format: date-time
statusList:
description: Status of a contact reservation.
type: array
items:
$ref: "#/components/schemas/ContactStatus"
minItems: 0
maxItems: 500
summary: Amazon Ground Station List Contacts
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/ephemerides:
post:
operationId: ListEphemerides
description: List existing ephemerides.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListEphemeridesResponse"
examples:
ListEphemerides200Example:
summary: Default ListEphemerides 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
ListEphemerides480Example:
summary: Default ListEphemerides 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
ListEphemerides481Example:
summary: Default ListEphemerides 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ListEphemerides482Example:
summary: Default ListEphemerides 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: maxResults
in: query
required: false
description: Maximum number of ephemerides to return.
schema:
type: integer
minimum: 0
maximum: 100
- name: nextToken
in: query
required: false
description: Pagination token.
schema:
type: string
pattern: ^[A-Za-z0-9-/+_.=]+$
minLength: 3
maxLength: 1000
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- endTime
- satelliteId
- startTime
properties:
endTime:
description: The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and
endTime.
type: string
format: date-time
satelliteId:
description: The AWS Ground Station satellite ID to list ephemeris for.
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
startTime:
description: The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and
endTime.
type: string
format: date-time
statusList:
description: The list of ephemeris status to return.
type: array
items:
$ref: "#/components/schemas/EphemerisStatus"
minItems: 0
maxItems: 500
summary: Amazon Ground Station List Ephemerides
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/groundstation:
get:
operationId: ListGroundStations
description: "Returns a list of ground stations. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListGroundStationsResponse"
examples:
ListGroundStations200Example:
summary: Default ListGroundStations 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
ListGroundStations480Example:
summary: Default ListGroundStations 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
ListGroundStations481Example:
summary: Default ListGroundStations 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ListGroundStations482Example:
summary: Default ListGroundStations 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: maxResults
in: query
required: false
description: Maximum number of ground stations returned.
schema:
type: integer
minimum: 0
maximum: 100
- name: nextToken
in: query
required: false
description: Next token that can be supplied in the next call to get the next page of ground stations.
schema:
type: string
pattern: ^[A-Za-z0-9-/+_.=]+$
minLength: 3
maxLength: 1000
- name: satelliteId
in: query
required: false
description: Satellite ID to retrieve on-boarded ground stations.
schema:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
summary: Amazon Ground Station List Ground Stations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/satellite:
get:
operationId: ListSatellites
description: Returns a list of satellites.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListSatellitesResponse"
examples:
ListSatellites200Example:
summary: Default ListSatellites 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
ListSatellites480Example:
summary: Default ListSatellites 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
ListSatellites481Example:
summary: Default ListSatellites 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ListSatellites482Example:
summary: Default ListSatellites 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: maxResults
in: query
required: false
description: Maximum number of satellites returned.
schema:
type: integer
minimum: 0
maximum: 100
- name: nextToken
in: query
required: false
description: Next token that can be supplied in the next call to get the next page of satellites.
schema:
type: string
pattern: ^[A-Za-z0-9-/+_.=]+$
minLength: 3
maxLength: 1000
summary: Amazon Ground Station List Satellites
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/tags/{resourceArn}":
get:
operationId: ListTagsForResource
description: Returns a list of tags for a specified resource.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListTagsForResourceResponse"
examples:
ListTagsForResource200Example:
summary: Default ListTagsForResource 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
ListTagsForResource480Example:
summary: Default ListTagsForResource 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
ListTagsForResource481Example:
summary: Default ListTagsForResource 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
ListTagsForResource482Example:
summary: Default ListTagsForResource 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: resourceArn
in: path
required: true
description: ARN of a resource.
schema:
type: string
pattern: ^(arn:aws:)[\s\S]{0,1024}$
minLength: 5
maxLength: 1024
summary: Amazon Ground Station List Tags for Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
post:
operationId: TagResource
description: Assigns a tag to a resource.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/TagResourceResponse"
examples:
TagResource200Example:
summary: Default TagResource 200 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"480":
description: InvalidParameterException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidParameterException"
examples:
TagResource480Example:
summary: Default TagResource 480 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"481":
description: DependencyException
content:
application/json:
schema:
$ref: "#/components/schemas/DependencyException"
examples:
TagResource481Example:
summary: Default TagResource 481 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
"482":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
examples:
TagResource482Example:
summary: Default TagResource 482 response
x-microcks-default: true
value:
contactId: abc-123
contactStatus: COMPLETED
parameters:
- name: resourceArn
in: path
required: true
description: ARN of a resource tag.
schema:
type: string
pattern: ^(arn:aws:)[\s\S]{0,1024}$
minLength: 5
maxLength: 1024
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- tags
properties:
tags:
description: Tags assigned to a resource.
type: object
additionalProperties:
$ref: "#/components/schemas/String"
summary: Amazon Ground Station Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/agent:
post:
operationId: RegisterAgent
description: For use by AWS Ground Station Agent and shouldn't be called directly.
Registers a new agent with AWS Ground Station.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/RegisterAgentResponse" examples: RegisterAgent200Example: summary: Default RegisterAgent 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: RegisterAgent480Example: summary: Default RegisterAgent 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: RegisterAgent481Example: summary: Default RegisterAgent 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: RegisterAgent482Example: summary: Default RegisterAgent 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - agentDetails - discoveryData properties: agentDetails: description: Detailed information about the agent. type: object properties: agentCpuCores: allOf: - $ref: "#/components/schemas/AgentCpuCoresList" - description: List of CPU cores reserved for the agent. agentVersion: allOf: - $ref: "#/components/schemas/VersionString" - description: Current agent version. componentVersions: allOf: - $ref: "#/components/schemas/ComponentVersionList" - description: List of versions being used by agent components. instanceId: allOf: - $ref: "#/components/schemas/InstanceId" - description: ID of EC2 instance agent is running on. instanceType: allOf: - $ref: "#/components/schemas/InstanceType" - description: Type of EC2 instance agent is running on. reservedCpuCores: allOf: - $ref: "#/components/schemas/AgentCpuCoresList" - description:This field should not be used. Use agentCpuCores instead.
List of CPU cores reserved for processes other than the agent running on the EC2 instance.
discoveryData: description: Data for agent discovery. type: object properties: capabilityArns: allOf: - $ref: "#/components/schemas/CapabilityArnList" - description: List of capabilities to associate with agent. privateIpAddresses: allOf: - $ref: "#/components/schemas/IpAddressList" - description: List of private IP addresses to associate with agent. publicIpAddresses: allOf: - $ref: "#/components/schemas/IpAddressList" - description: List of public IP addresses to associate with agent. summary: Amazon Ground Station Register Agent x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /contact: post: operationId: ReserveContact description: Reserves a contact using specified parameters. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ContactIdResponse" examples: ReserveContact200Example: summary: Default ReserveContact 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: ReserveContact480Example: summary: Default ReserveContact 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: ReserveContact481Example: summary: Default ReserveContact 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: ReserveContact482Example: summary: Default ReserveContact 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: [] requestBody: required: true content: application/json: schema: type: object required: - endTime - groundStation - missionProfileArn - satelliteArn - startTime properties: endTime: description: End time of a contact in UTC. type: string format: date-time groundStation: description: Name of a ground station. type: string pattern: ^[ a-zA-Z0-9-._:=]{4,256}$ minLength: 4 maxLength: 500 missionProfileArn: description: ARN of a mission profile. type: string satelliteArn: description: ARN of a satellite type: string startTime: description: Start time of a contact in UTC. type: string format: date-time tags: description: Tags assigned to a contact. type: object additionalProperties: $ref: "#/components/schemas/String" summary: Amazon Ground Station Reserve Contact x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/tags/{resourceArn}#tagKeys": delete: operationId: UntagResource description: Deassigns a resource tag. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" examples: UntagResource200Example: summary: Default UntagResource 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UntagResource480Example: summary: Default UntagResource 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: UntagResource481Example: summary: Default UntagResource 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UntagResource482Example: summary: Default UntagResource 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: - name: resourceArn in: path required: true description: ARN of a resource. schema: type: string pattern: ^(arn:aws:)[\s\S]{0,1024}$ minLength: 5 maxLength: 1024 - name: tagKeys in: query required: true description: Keys of a resource tag. schema: type: array items: $ref: "#/components/schemas/UnboundedString" minItems: 0 maxItems: 500 summary: Amazon Ground Station Untag Resource x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/agent/{agentId}": put: operationId: UpdateAgentStatus description:For use by AWS Ground Station Agent and shouldn't be called directly.
Update the status of the agent.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateAgentStatusResponse" examples: UpdateAgentStatus200Example: summary: Default UpdateAgentStatus 200 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "480": description: InvalidParameterException content: application/json: schema: $ref: "#/components/schemas/InvalidParameterException" examples: UpdateAgentStatus480Example: summary: Default UpdateAgentStatus 480 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "481": description: DependencyException content: application/json: schema: $ref: "#/components/schemas/DependencyException" examples: UpdateAgentStatus481Example: summary: Default UpdateAgentStatus 481 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" examples: UpdateAgentStatus482Example: summary: Default UpdateAgentStatus 482 response x-microcks-default: true value: contactId: abc-123 contactStatus: COMPLETED parameters: - name: agentId in: path required: true description: UUID of agent to update. schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - aggregateStatus - componentStatuses - taskId properties: aggregateStatus: description: Aggregate status of Agent components. type: object properties: signatureMap: allOf: - $ref: "#/components/schemas/SignatureMap" - description: Sparse map of failure signatures. status: allOf: - $ref: "#/components/schemas/AgentStatus" - description: Aggregate status. componentStatuses: description: List of component statuses for agent. type: array items: $ref: "#/components/schemas/ComponentStatusData" minItems: 0 maxItems: 20 taskId: description: GUID of agent task. type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ minLength: 1 maxLength: 128 summary: Amazon Ground Station Update Agent Status x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: ContactIdResponse: type: object properties: contactId: allOf: - $ref: "#/components/schemas/Uuid" - description: UUID of a contact. description: InvalidParameterException: {} DependencyException: {} ResourceNotFoundException: {} ConfigIdResponse: type: object properties: configArn: allOf: - $ref: "#/components/schemas/ConfigArn" - description: ARN of aConfig.
configId:
allOf:
- $ref: "#/components/schemas/String"
- description: UUID of a Config.
configType:
allOf:
- $ref: "#/components/schemas/ConfigCapabilityType"
- description: Type of a Config.
description:
AntennaDownlinkConfig:
type: object
required:
- spectrumConfig
properties:
spectrumConfig:
allOf:
- $ref: "#/components/schemas/SpectrumConfig"
- description: Object that describes a spectral Config.
description: Information about how AWS Ground Station should configure an antenna for downlink during a contact.
AntennaDownlinkDemodDecodeConfig:
type: object
required:
- decodeConfig
- demodulationConfig
- spectrumConfig
properties:
decodeConfig:
allOf:
- $ref: "#/components/schemas/DecodeConfig"
- description: Information about the decode Config.
demodulationConfig:
allOf:
- $ref: "#/components/schemas/DemodulationConfig"
- description: Information about the demodulation Config.
spectrumConfig:
allOf:
- $ref: "#/components/schemas/SpectrumConfig"
- description: Information about the spectral Config.
description: Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
AntennaUplinkConfig:
type: object
required:
- spectrumConfig
- targetEirp
properties:
spectrumConfig:
allOf:
- $ref: "#/components/schemas/UplinkSpectrumConfig"
- description: Information about the uplink spectral Config.
targetEirp:
allOf:
- $ref: "#/components/schemas/Eirp"
- description: EIRP of the target.
transmitDisabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether or not uplink transmit is disabled.
description: Information about the uplink Config of an antenna.
DataflowEndpointConfig:
type: object
required:
- dataflowEndpointName
properties:
dataflowEndpointName:
allOf:
- $ref: "#/components/schemas/String"
- description: Name of a dataflow endpoint.
dataflowEndpointRegion:
allOf:
- $ref: "#/components/schemas/String"
- description: Region of a dataflow endpoint.
description: Information about the dataflow endpoint Config.
S3RecordingConfig:
type: object
required:
- bucketArn
- roleArn
properties:
bucketArn:
allOf:
- $ref: "#/components/schemas/BucketArn"
- description: ARN of the bucket to record to.
prefix:
allOf:
- $ref: "#/components/schemas/S3KeyPrefix"
- description: S3 Key prefix to prefice data files.
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: ARN of the role Ground Station assumes to write data to the bucket.
description: Information about an S3 recording Config.
TrackingConfig:
type: object
required:
- autotrack
properties:
autotrack:
allOf:
- $ref: "#/components/schemas/Criticality"
- description: Current setting for autotrack.
description: Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
UplinkEchoConfig:
type: object
required:
- antennaUplinkConfigArn
- enabled
properties:
antennaUplinkConfigArn:
allOf:
- $ref: "#/components/schemas/ConfigArn"
- description: ARN of an uplink Config.
enabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether or not an uplink Config is enabled.
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.
CreateDataflowEndpointGroup.
healthStatus:
allOf:
- $ref: "#/components/schemas/CapabilityHealth"
- description: A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
securityDetails:
allOf:
- $ref: "#/components/schemas/SecurityDetails"
- description: Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
description: Information about the endpoint details.
EphemerisIdResponse:
type: object
properties:
ephemerisId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: The AWS Ground Station ephemeris ID.
OEMEphemeris:
type: object
properties:
oemData:
allOf:
- $ref: "#/components/schemas/UnboundedString"
- description: The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.
s3Object:
allOf:
- $ref: "#/components/schemas/S3Object"
- description: Identifies the S3 object to be used as the ephemeris.
description: Ephemeris data in Orbit Ephemeris Message (OEM) format.
TLEEphemeris:
type: object
properties:
s3Object:
allOf:
- $ref: "#/components/schemas/S3Object"
- description: Identifies the S3 object to be used as the ephemeris.
tleData:
allOf:
- $ref: "#/components/schemas/TLEDataList"
- description: The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.
description: Two-line element set (TLE) ephemeris.
MissionProfileIdResponse:
type: object
properties:
missionProfileId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a mission profile.
description:
DataflowEdge:
type: array
items:
$ref: "#/components/schemas/ConfigArn"
minItems: 2
maxItems: 2
KeyAliasArn:
type: string
pattern: ^arn:aws[a-zA-Z-]{0,16}:kms:[a-z]{2}(-[a-z]{1,16}){1,3}-\d{1}:\d{12}:((alias/[a-zA-Z0-9:/_-]{1,256}))$
minLength: 1
maxLength: 512
KeyArn:
type: string
DescribeContactResponse:
type: object
properties:
contactId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a contact.
contactStatus:
allOf:
- $ref: "#/components/schemas/ContactStatus"
- description: Status of a contact.
dataflowList:
allOf:
- $ref: "#/components/schemas/DataflowList"
- description: List describing source and destination details for each dataflow edge.
endTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: End time of a contact in UTC.
errorMessage:
allOf:
- $ref: "#/components/schemas/String"
- description: Error message for a contact.
groundStation:
allOf:
- $ref: "#/components/schemas/String"
- description: Ground station for a contact.
maximumElevation:
allOf:
- $ref: "#/components/schemas/Elevation"
- description: Maximum elevation angle of a contact.
missionProfileArn:
allOf:
- $ref: "#/components/schemas/MissionProfileArn"
- description: ARN of a mission profile.
postPassEndTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
prePassStartTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
region:
allOf:
- $ref: "#/components/schemas/String"
- description: Region of a contact.
satelliteArn:
allOf:
- $ref: "#/components/schemas/satelliteArn"
- description: ARN of a satellite.
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: Start time of a contact in UTC.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a contact.
description:
DescribeEphemerisResponse:
type: object
properties:
creationTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time the ephemeris was uploaded in UTC.
enabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether or not the ephemeris is enabled.
ephemerisId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: The AWS Ground Station ephemeris ID.
invalidReason:
allOf:
- $ref: "#/components/schemas/EphemerisInvalidReason"
- description: Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority:
allOf:
- $ref: "#/components/schemas/EphemerisPriority"
- description: Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
satelliteId: allOf: - $ref: "#/components/schemas/Uuid" - description: The AWS Ground Station satellite ID associated with ephemeris. status: allOf: - $ref: "#/components/schemas/EphemerisStatus" - description: The status of the ephemeris. suppliedData: allOf: - $ref: "#/components/schemas/EphemerisTypeDescription" - description: Supplied ephemeris data. tags: allOf: - $ref: "#/components/schemas/TagsMap" - description: Tags assigned to an ephemeris. GetAgentConfigurationResponse: type: object properties: agentId: allOf: - $ref: "#/components/schemas/Uuid" - description: UUID of agent. taskingDocument: allOf: - $ref: "#/components/schemas/String" - description: Tasking document for agent. GetConfigResponse: type: object required: - configArn - configData - configId - name properties: configArn: allOf: - $ref: "#/components/schemas/ConfigArn" - description: "ARN of aConfig "
configData:
allOf:
- $ref: "#/components/schemas/ConfigTypeData"
- description: Data elements in a Config.
configId:
allOf:
- $ref: "#/components/schemas/String"
- description: UUID of a Config.
configType:
allOf:
- $ref: "#/components/schemas/ConfigCapabilityType"
- description: Type of a Config.
name:
allOf:
- $ref: "#/components/schemas/String"
- description: Name of a Config.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a Config.
description:
GetDataflowEndpointGroupResponse:
type: object
properties:
contactPostPassDurationSeconds:
allOf:
- $ref: "#/components/schemas/DataflowEndpointGroupDurationInSeconds"
- description: Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint
Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
contactPrePassDurationSeconds:
allOf:
- $ref: "#/components/schemas/DataflowEndpointGroupDurationInSeconds"
- description: Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint
Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
dataflowEndpointGroupArn:
allOf:
- $ref: "#/components/schemas/DataflowEndpointGroupArn"
- description: ARN of a dataflow endpoint group.
dataflowEndpointGroupId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a dataflow endpoint group.
endpointsDetails:
allOf:
- $ref: "#/components/schemas/EndpointDetailsList"
- description: Details of a dataflow endpoint.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a dataflow endpoint group.
description:
GetMinuteUsageResponse:
type: object
properties:
estimatedMinutesRemaining:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Estimated number of minutes remaining for an account, specific to the month being requested.
isReservedMinutesCustomer:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.
totalReservedMinuteAllocation:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Total number of reserved minutes allocated, specific to the month being requested.
totalScheduledMinutes:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Total scheduled minutes for an account, specific to the month being requested.
upcomingMinutesScheduled:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Upcoming minutes scheduled for an account, specific to the month being requested.
description:
GetMissionProfileResponse:
type: object
properties:
contactPostPassDurationSeconds:
allOf:
- $ref: "#/components/schemas/DurationInSeconds"
- description: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
contactPrePassDurationSeconds:
allOf:
- $ref: "#/components/schemas/DurationInSeconds"
- description: Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
dataflowEdges:
allOf:
- $ref: "#/components/schemas/DataflowEdgeList"
- description: A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
minimumViableContactDurationSeconds:
allOf:
- $ref: "#/components/schemas/PositiveDurationInSeconds"
- description: 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:
allOf:
- $ref: "#/components/schemas/MissionProfileArn"
- description: ARN of a mission profile.
missionProfileId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a mission profile.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name of a mission profile.
region:
allOf:
- $ref: "#/components/schemas/AWSRegion"
- description: Region of a mission profile.
streamsKmsKey:
allOf:
- $ref: "#/components/schemas/KmsKey"
- description: KMS key to use for encrypting streams.
streamsKmsRole:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: Role to use for encrypting streams with KMS key.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a mission profile.
trackingConfigArn:
allOf:
- $ref: "#/components/schemas/ConfigArn"
- description: ARN of a tracking Config.
description:
GetSatelliteResponse:
type: object
properties:
currentEphemeris:
allOf:
- $ref: "#/components/schemas/EphemerisMetaData"
- description: The current ephemeris being used to compute the trajectory of the satellite.
groundStations:
allOf:
- $ref: "#/components/schemas/GroundStationIdList"
- description: A list of ground stations to which the satellite is on-boarded.
noradSatelliteID:
allOf:
- $ref: "#/components/schemas/noradSatelliteID"
- description: NORAD satellite ID number.
satelliteArn:
allOf:
- $ref: "#/components/schemas/satelliteArn"
- description: ARN of a satellite.
satelliteId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a satellite.
description:
ListConfigsResponse:
type: object
properties:
configList:
allOf:
- $ref: "#/components/schemas/ConfigList"
- description: List of Config items.
nextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
description:
ListContactsResponse:
type: object
properties:
contactList:
allOf:
- $ref: "#/components/schemas/ContactList"
- description: List of contacts.
nextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
description:
ContactStatus:
type: string
enum:
- AVAILABLE
- AWS_CANCELLED
- AWS_FAILED
- CANCELLED
- CANCELLING
- COMPLETED
- FAILED
- FAILED_TO_SCHEDULE
- PASS
- POSTPASS
- PREPASS
- SCHEDULED
- SCHEDULING
ListDataflowEndpointGroupsResponse:
type: object
properties:
dataflowEndpointGroupList:
allOf:
- $ref: "#/components/schemas/DataflowEndpointGroupList"
- description: A list of dataflow endpoint groups.
nextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
description:
ListEphemeridesResponse:
type: object
properties:
ephemerides:
allOf:
- $ref: "#/components/schemas/EphemeridesList"
- description: List of ephemerides.
nextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: Pagination token.
EphemerisStatus:
type: string
enum:
- VALIDATING
- INVALID
- ERROR
- ENABLED
- DISABLED
- EXPIRED
ListGroundStationsResponse:
type: object
properties:
groundStationList:
allOf:
- $ref: "#/components/schemas/GroundStationList"
- description: List of ground stations.
nextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: Next token that can be supplied in the next call to get the next page of ground stations.
description:
ListMissionProfilesResponse:
type: object
properties:
missionProfileList:
allOf:
- $ref: "#/components/schemas/MissionProfileList"
- description: List of mission profiles.
nextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.
description:
ListSatellitesResponse:
type: object
properties:
nextToken:
allOf:
- $ref: "#/components/schemas/PaginationToken"
- description: Next token that can be supplied in the next call to get the next page of satellites.
satellites:
allOf:
- $ref: "#/components/schemas/SatelliteList"
- description: List of satellites.
description:
ListTagsForResourceResponse:
type: object
properties:
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a resource.
description:
RegisterAgentResponse:
type: object
properties:
agentId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of registered agent.
AgentCpuCoresList:
type: array
items:
$ref: "#/components/schemas/Integer"
minItems: 0
maxItems: 256
VersionString:
type: string
pattern: ^(0|[1-9]\d*)(\.(0|[1-9]\d*))*$
minLength: 1
maxLength: 64
ComponentVersionList:
type: array
items:
$ref: "#/components/schemas/ComponentVersion"
minItems: 1
maxItems: 20
InstanceId:
type: string
pattern: ^[a-z0-9-]{10,64}$
minLength: 10
maxLength: 64
InstanceType:
type: string
pattern: ^[a-z0-9.-]{1,64}$
minLength: 1
maxLength: 64
CapabilityArnList:
type: array
items:
$ref: "#/components/schemas/CapabilityArn"
minItems: 1
maxItems: 20
IpAddressList:
type: array
items:
$ref: "#/components/schemas/IpV4Address"
minItems: 1
maxItems: 20
TagResourceResponse:
type: object
properties: {}
description:
UntagResourceResponse:
type: object
properties: {}
description:
UnboundedString:
type: string
pattern: ^[\s\S]+$
minLength: 1
UpdateAgentStatusResponse:
type: object
required:
- agentId
properties:
agentId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of updated agent.
SignatureMap:
type: object
additionalProperties:
$ref: "#/components/schemas/Boolean"
AgentStatus:
type: string
enum:
- SUCCESS
- FAILED
- ACTIVE
- INACTIVE
ComponentStatusData:
type: object
required:
- capabilityArn
- componentType
- dataflowId
- status
properties:
bytesReceived:
allOf:
- $ref: "#/components/schemas/Long"
- description: Bytes received by the component.
bytesSent:
allOf:
- $ref: "#/components/schemas/Long"
- description: Bytes sent by the component.
capabilityArn:
allOf:
- $ref: "#/components/schemas/CapabilityArn"
- description: Capability ARN of the component.
componentType:
allOf:
- $ref: "#/components/schemas/ComponentTypeString"
- description: The Component type.
dataflowId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: Dataflow UUID associated with the component.
packetsDropped:
allOf:
- $ref: "#/components/schemas/Long"
- description: Packets dropped by component.
status:
allOf:
- $ref: "#/components/schemas/AgentStatus"
- description: Component status.
description: Data on the status of agent components.
AWSRegion:
type: string
pattern: ^[\w-]+$
minLength: 1
maxLength: 128
Integer:
type: integer
AgentDetails:
type: object
required:
- agentVersion
- componentVersions
- instanceId
- instanceType
properties:
agentCpuCores:
allOf:
- $ref: "#/components/schemas/AgentCpuCoresList"
- description: List of CPU cores reserved for the agent.
agentVersion:
allOf:
- $ref: "#/components/schemas/VersionString"
- description: Current agent version.
componentVersions:
allOf:
- $ref: "#/components/schemas/ComponentVersionList"
- description: List of versions being used by agent components.
instanceId:
allOf:
- $ref: "#/components/schemas/InstanceId"
- description: ID of EC2 instance agent is running on.
instanceType:
allOf:
- $ref: "#/components/schemas/InstanceType"
- description: Type of EC2 instance agent is running on.
reservedCpuCores:
allOf:
- $ref: "#/components/schemas/AgentCpuCoresList"
- description: This field should not be used. Use agentCpuCores instead.
List of CPU cores reserved for processes other than the agent running on the EC2 instance.
description: Detailed information about the agent. AggregateStatus: type: object required: - status properties: signatureMap: allOf: - $ref: "#/components/schemas/SignatureMap" - description: Sparse map of failure signatures. status: allOf: - $ref: "#/components/schemas/AgentStatus" - description: Aggregate status. description: Aggregate status of Agent components. AngleUnits: type: string enum: - DEGREE_ANGLE - RADIAN AntennaDemodDecodeDetails: type: object properties: outputNode: allOf: - $ref: "#/components/schemas/String" - description: Name of an antenna demod decode output node used in a contact. description: Details about an antenna demod decodeConfig used in a contact.
SpectrumConfig:
type: object
required:
- bandwidth
- centerFrequency
properties:
bandwidth:
allOf:
- $ref: "#/components/schemas/FrequencyBandwidth"
- description: Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:
For
AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54
MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
Config. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
polarization:
allOf:
- $ref: "#/components/schemas/Polarization"
- description: Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
description: Object that describes a spectral Config.
DecodeConfig:
type: object
required:
- unvalidatedJSON
properties:
unvalidatedJSON:
allOf:
- $ref: "#/components/schemas/JsonString"
- description: Unvalidated JSON of a decode Config.
description: Information about the decode Config.
DemodulationConfig:
type: object
required:
- unvalidatedJSON
properties:
unvalidatedJSON:
allOf:
- $ref: "#/components/schemas/JsonString"
- description: Unvalidated JSON of a demodulation Config.
description: Information about the demodulation Config.
UplinkSpectrumConfig:
type: object
required:
- centerFrequency
properties:
centerFrequency:
allOf:
- $ref: "#/components/schemas/Frequency"
- description: Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.
polarization:
allOf:
- $ref: "#/components/schemas/Polarization"
- description: Polarization of an uplink spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
description: Information about the uplink spectral Config.
Eirp:
type: object
required:
- units
- value
properties:
units:
allOf:
- $ref: "#/components/schemas/EirpUnits"
- description: Units of an EIRP.
value:
allOf:
- $ref: "#/components/schemas/Double"
- description: Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
description: Object that represents EIRP.
Boolean:
type: boolean
AnyArn:
type: string
pattern: ^(arn:aws:)[\s\S]{0,1024}$
minLength: 5
maxLength: 1024
AuditResults:
type: string
enum:
- HEALTHY
- UNHEALTHY
ConnectionDetails:
type: object
required:
- socketAddress
properties:
mtu:
allOf:
- $ref: "#/components/schemas/Integer"
- description: Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress:
allOf:
- $ref: "#/components/schemas/SocketAddress"
- description: A socket address.
description: Egress address of AgentEndpoint with an optional mtu.
RangedConnectionDetails:
type: object
required:
- socketAddress
properties:
mtu:
allOf:
- $ref: "#/components/schemas/RangedConnectionDetailsMtuInteger"
- description: Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress:
allOf:
- $ref: "#/components/schemas/RangedSocketAddress"
- description: A ranged socket address.
description: Ingress address of AgentEndpoint with a port range and an optional mtu.
SafeName:
type: string
pattern: ^[ a-zA-Z0-9_:-]{1,256}$
minLength: 1
maxLength: 256
AwsGroundStationAgentEndpoint:
type: object
required:
- egressAddress
- ingressAddress
- name
properties:
agentStatus:
allOf:
- $ref: "#/components/schemas/AgentStatus"
- description: The status of AgentEndpoint.
auditResults:
allOf:
- $ref: "#/components/schemas/AuditResults"
- description: The results of the audit.
egressAddress:
allOf:
- $ref: "#/components/schemas/ConnectionDetails"
- description: The egress address of AgentEndpoint.
ingressAddress:
allOf:
- $ref: "#/components/schemas/RangedConnectionDetails"
- description: The ingress address of AgentEndpoint.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
description: Information about AwsGroundStationAgentEndpoint.
BandwidthUnits:
type: string
enum:
- GHz
- MHz
- kHz
BucketArn:
type: string
Uuid:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 1
maxLength: 128
CancelContactRequest:
type: object
title: CancelContactRequest
properties: {}
description:
CapabilityArn:
type: string
CapabilityHealth:
type: string
enum:
- UNHEALTHY
- HEALTHY
CapabilityHealthReason:
type: string
enum:
- NO_REGISTERED_AGENT
- INVALID_IP_OWNERSHIP
- NOT_AUTHORIZED_TO_CREATE_SLR
- UNVERIFIED_IP_OWNERSHIP
- INITIALIZING_DATAPLANE
- DATAPLANE_FAILURE
- HEALTHY
CapabilityHealthReasonList:
type: array
items:
$ref: "#/components/schemas/CapabilityHealthReason"
minItems: 0
maxItems: 500
Long:
type: integer
ComponentTypeString:
type: string
pattern: ^[a-zA-Z0-9_]{1,64}$
ComponentStatusList:
type: array
items:
$ref: "#/components/schemas/ComponentStatusData"
minItems: 0
maxItems: 20
VersionStringList:
type: array
items:
$ref: "#/components/schemas/VersionString"
minItems: 1
maxItems: 20
ComponentVersion:
type: object
required:
- componentType
- versions
properties:
componentType:
allOf:
- $ref: "#/components/schemas/ComponentTypeString"
- description: Component type.
versions:
allOf:
- $ref: "#/components/schemas/VersionStringList"
- description: List of versions.
description: Version information for agent components.
ConfigArn:
type: string
ConfigCapabilityType:
type: string
enum:
- antenna-downlink
- antenna-downlink-demod-decode
- antenna-uplink
- dataflow-endpoint
- tracking
- uplink-echo
- s3-recording
S3RecordingDetails:
type: object
properties:
bucketArn:
allOf:
- $ref: "#/components/schemas/BucketArn"
- description: ARN of the bucket used.
keyTemplate:
allOf:
- $ref: "#/components/schemas/String"
- description: Key template used for the S3 Recording Configuration
description: Details about an S3 recording Config used in a contact.
ConfigDetails:
type: object
properties:
antennaDemodDecodeDetails:
allOf:
- $ref: "#/components/schemas/AntennaDemodDecodeDetails"
- description: Details for antenna demod decode Config in a contact.
endpointDetails:
$ref: "#/components/schemas/EndpointDetails"
s3RecordingDetails:
allOf:
- $ref: "#/components/schemas/S3RecordingDetails"
- description: Details for an S3 recording Config in a contact.
description: Details for certain Config object types in a contact.
ConfigListItem:
type: object
properties:
configArn:
allOf:
- $ref: "#/components/schemas/ConfigArn"
- description: ARN of a Config.
configId:
allOf:
- $ref: "#/components/schemas/String"
- description: UUID of a Config.
configType:
allOf:
- $ref: "#/components/schemas/ConfigCapabilityType"
- description: Type of a Config.
name:
allOf:
- $ref: "#/components/schemas/String"
- description: Name of a Config.
description: An item in a list of Config objects.
ConfigList:
type: array
items:
$ref: "#/components/schemas/ConfigListItem"
ConfigTypeData:
type: object
properties:
antennaDownlinkConfig:
allOf:
- $ref: "#/components/schemas/AntennaDownlinkConfig"
- description: Information about how AWS Ground Station should configure an antenna for downlink during a contact.
antennaDownlinkDemodDecodeConfig:
allOf:
- $ref: "#/components/schemas/AntennaDownlinkDemodDecodeConfig"
- description: Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
antennaUplinkConfig:
allOf:
- $ref: "#/components/schemas/AntennaUplinkConfig"
- description: Information about how AWS Ground Station should configure an antenna for uplink during a contact.
dataflowEndpointConfig:
allOf:
- $ref: "#/components/schemas/DataflowEndpointConfig"
- description: Information about the dataflow endpoint Config.
s3RecordingConfig:
allOf:
- $ref: "#/components/schemas/S3RecordingConfig"
- description: Information about an S3 recording Config.
trackingConfig:
allOf:
- $ref: "#/components/schemas/TrackingConfig"
- description: "Object that determines whether tracking should be used during a contact executed with this Config in the mission profile. "
uplinkEchoConfig:
allOf:
- $ref: "#/components/schemas/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.
Object containing the parameters of a Config.
See the subtype definitions for what each type of Config contains.
Config.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name of a Config.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a Config.
description:
DataflowEndpointGroupDurationInSeconds:
type: integer
minimum: 120
maximum: 480
EndpointDetailsList:
type: array
items:
$ref: "#/components/schemas/EndpointDetails"
minItems: 0
maxItems: 500
CreateDataflowEndpointGroupRequest:
type: object
required:
- endpointDetails
title: CreateDataflowEndpointGroupRequest
properties:
contactPostPassDurationSeconds:
allOf:
- $ref: "#/components/schemas/DataflowEndpointGroupDurationInSeconds"
- description: Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state. A Ground Station Dataflow Endpoint
Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the POSTPASS state.
contactPrePassDurationSeconds:
allOf:
- $ref: "#/components/schemas/DataflowEndpointGroupDurationInSeconds"
- description: Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state. A Ground Station Dataflow Endpoint
Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the PREPASS state.
endpointDetails:
allOf:
- $ref: "#/components/schemas/EndpointDetailsList"
- description: Endpoint details of each endpoint in the dataflow endpoint group.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags of a dataflow endpoint group.
description:
EphemerisData:
type: object
properties:
oem:
$ref: "#/components/schemas/OEMEphemeris"
tle:
$ref: "#/components/schemas/TLEEphemeris"
description: Ephemeris data.
CustomerEphemerisPriority:
type: integer
minimum: 1
maximum: 99999
CreateEphemerisRequest:
type: object
required:
- name
- satelliteId
title: CreateEphemerisRequest
properties:
enabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether to set the ephemeris status to ENABLED after validation.
Setting this to false will set the ephemeris status to DISABLED after
validation.
EXPIRED.
kmsKeyArn:
allOf:
- $ref: "#/components/schemas/KeyArn"
- description: The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority:
allOf:
- $ref: "#/components/schemas/CustomerEphemerisPriority"
- description: Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
satelliteId: allOf: - $ref: "#/components/schemas/Uuid" - description: AWS Ground Station satellite ID for this ephemeris. tags: allOf: - $ref: "#/components/schemas/TagsMap" - description: Tags assigned to an ephemeris. DurationInSeconds: type: integer minimum: 0 maximum: 21600 DataflowEdgeList: type: array items: $ref: "#/components/schemas/DataflowEdge" minItems: 0 maxItems: 500 PositiveDurationInSeconds: type: integer minimum: 1 maximum: 21600 KmsKey: type: object properties: kmsAliasArn: allOf: - $ref: "#/components/schemas/KeyAliasArn" - description: KMS Alias Arn. kmsKeyArn: allOf: - $ref: "#/components/schemas/KeyArn" - description: KMS Key Arn. description: AWS Key Management Service (KMS) Key. RoleArn: type: string CreateMissionProfileRequest: type: object required: - dataflowEdges - minimumViableContactDurationSeconds - name - trackingConfigArn title: CreateMissionProfileRequest properties: contactPostPassDurationSeconds: allOf: - $ref: "#/components/schemas/DurationInSeconds" - description: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished. contactPrePassDurationSeconds: allOf: - $ref: "#/components/schemas/DurationInSeconds" - description: Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass. dataflowEdges: allOf: - $ref: "#/components/schemas/DataflowEdgeList" - description: A list of lists of ARNs. Each list of ARNs is an edge, with a fromConfig and a to Config.
minimumViableContactDurationSeconds:
allOf:
- $ref: "#/components/schemas/PositiveDurationInSeconds"
- description: 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:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name of a mission profile.
streamsKmsKey:
allOf:
- $ref: "#/components/schemas/KmsKey"
- description: KMS key to use for encrypting streams.
streamsKmsRole:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: Role to use for encrypting streams with KMS key.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a mission profile.
trackingConfigArn:
allOf:
- $ref: "#/components/schemas/ConfigArn"
- description: ARN of a tracking Config.
description:
Criticality:
type: string
enum:
- PREFERRED
- REMOVED
- REQUIRED
Destination:
type: object
properties:
configDetails:
allOf:
- $ref: "#/components/schemas/ConfigDetails"
- description: Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
configId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a Config.
configType:
allOf:
- $ref: "#/components/schemas/ConfigCapabilityType"
- description: Type of a Config.
dataflowDestinationRegion:
allOf:
- $ref: "#/components/schemas/String"
- description: Region of a dataflow destination.
description: Dataflow details for the destination side.
Source:
type: object
properties:
configDetails:
allOf:
- $ref: "#/components/schemas/ConfigDetails"
- description: "Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode "
configId:
allOf:
- $ref: "#/components/schemas/String"
- description: UUID of a Config.
configType:
allOf:
- $ref: "#/components/schemas/ConfigCapabilityType"
- description: Type of a Config.
dataflowSourceRegion:
allOf:
- $ref: "#/components/schemas/String"
- description: Region of a dataflow source.
description: Dataflow details for the source side.
DataflowDetail:
type: object
properties:
destination:
$ref: "#/components/schemas/Destination"
errorMessage:
allOf:
- $ref: "#/components/schemas/String"
- description: Error message for a dataflow.
source:
$ref: "#/components/schemas/Source"
description: Information about a dataflow edge used in a contact.
DataflowEndpointMtuInteger:
type: integer
minimum: 1400
maximum: 1500
EndpointStatus:
type: string
enum:
- created
- creating
- deleted
- deleting
- failed
DataflowEndpoint:
type: object
properties:
address:
allOf:
- $ref: "#/components/schemas/SocketAddress"
- description: Socket address of a dataflow endpoint.
mtu:
allOf:
- $ref: "#/components/schemas/DataflowEndpointMtuInteger"
- description: Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name of a dataflow endpoint.
status:
allOf:
- $ref: "#/components/schemas/EndpointStatus"
- description: Status of a dataflow endpoint.
description: Information about a dataflow endpoint.
DataflowEndpointGroupArn:
type: string
DataflowEndpointListItem:
type: object
properties:
dataflowEndpointGroupArn:
allOf:
- $ref: "#/components/schemas/DataflowEndpointGroupArn"
- description: ARN of a dataflow endpoint group.
dataflowEndpointGroupId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a dataflow endpoint group.
description: Item in a list of DataflowEndpoint groups.
DataflowEndpointGroupList:
type: array
items:
$ref: "#/components/schemas/DataflowEndpointListItem"
DataflowList:
type: array
items:
$ref: "#/components/schemas/DataflowDetail"
JsonString:
type: string
pattern: ^[{}\[\]:.,"0-9A-z\-_\s]{2,8192}$
minLength: 2
maxLength: 8192
DeleteConfigRequest:
type: object
title: DeleteConfigRequest
properties: {}
description:
DeleteDataflowEndpointGroupRequest:
type: object
title: DeleteDataflowEndpointGroupRequest
properties: {}
description:
DeleteEphemerisRequest:
type: object
title: DeleteEphemerisRequest
properties: {}
DeleteMissionProfileRequest:
type: object
title: DeleteMissionProfileRequest
properties: {}
description:
DescribeContactRequest:
type: object
title: DescribeContactRequest
properties: {}
description:
DescribeEphemerisRequest:
type: object
title: DescribeEphemerisRequest
properties: {}
EphemerisInvalidReason:
type: string
enum:
- METADATA_INVALID
- TIME_RANGE_INVALID
- TRAJECTORY_INVALID
- KMS_KEY_INVALID
- VALIDATION_ERROR
EphemerisPriority:
type: integer
minimum: 0
maximum: 99999
EphemerisTypeDescription:
type: object
properties:
oem:
$ref: "#/components/schemas/EphemerisDescription"
tle:
$ref: "#/components/schemas/EphemerisDescription"
description:
DiscoveryData:
type: object
required:
- capabilityArns
- privateIpAddresses
- publicIpAddresses
properties:
capabilityArns:
allOf:
- $ref: "#/components/schemas/CapabilityArnList"
- description: List of capabilities to associate with agent.
privateIpAddresses:
allOf:
- $ref: "#/components/schemas/IpAddressList"
- description: List of private IP addresses to associate with agent.
publicIpAddresses:
allOf:
- $ref: "#/components/schemas/IpAddressList"
- description: List of public IP addresses to associate with agent.
description: Data for agent discovery.
Double:
type: number
format: double
EirpUnits:
type: string
enum:
- dBW
SecurityDetails:
type: object
required:
- roleArn
- securityGroupIds
- subnetIds
properties:
roleArn:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: "ARN to a role needed for connecting streams to your instances. "
securityGroupIds:
allOf:
- $ref: "#/components/schemas/SecurityGroupIdList"
- description: The security groups to attach to the elastic network interfaces.
subnetIds:
allOf:
- $ref: "#/components/schemas/SubnetList"
- description: A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
description: Information about endpoints.
EphemerisItem:
type: object
properties:
creationTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The time the ephemeris was uploaded in UTC.
enabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether or not the ephemeris is enabled.
ephemerisId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: The AWS Ground Station ephemeris ID.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority:
allOf:
- $ref: "#/components/schemas/EphemerisPriority"
- description: Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
sourceS3Object: allOf: - $ref: "#/components/schemas/S3Object" - description: Source S3 object used for the ephemeris. status: allOf: - $ref: "#/components/schemas/EphemerisStatus" - description: The status of the ephemeris. description: Ephemeris item. EphemeridesList: type: array items: $ref: "#/components/schemas/EphemerisItem" minItems: 1 maxItems: 500 S3Object: type: object properties: bucket: allOf: - $ref: "#/components/schemas/S3BucketName" - description: An Amazon S3 Bucket name. key: allOf: - $ref: "#/components/schemas/S3ObjectKey" - description: An Amazon S3 key for the ephemeris. version: allOf: - $ref: "#/components/schemas/S3VersionId" - description: For versioned S3 objects, the version to use for the ephemeris. description: Object stored in S3 containing ephemeris data. EphemerisDescription: type: object properties: ephemerisData: allOf: - $ref: "#/components/schemas/UnboundedString" - description: Supplied ephemeris data. sourceS3Object: allOf: - $ref: "#/components/schemas/S3Object" - description: Source S3 object used for the ephemeris. description: Description of ephemeris. EphemerisSource: type: string enum: - CUSTOMER_PROVIDED - SPACE_TRACK EphemerisMetaData: type: object required: - source properties: ephemerisId: allOf: - $ref: "#/components/schemas/Uuid" - description:UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from Space Track.
epoch: allOf: - $ref: "#/components/schemas/Timestamp" - description:The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided ephemerides.
name: allOf: - $ref: "#/components/schemas/SafeName" - description:A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
A name is only returned for customer-provider ephemerides that have a name associated.
source: allOf: - $ref: "#/components/schemas/EphemerisSource" - description: TheEphemerisSource that generated a given ephemeris.
description: Metadata describing a particular ephemeris.
EphemerisStatusList:
type: array
items:
$ref: "#/components/schemas/EphemerisStatus"
minItems: 0
maxItems: 500
FrequencyUnits:
type: string
enum:
- GHz
- MHz
- kHz
Frequency:
type: object
required:
- units
- value
properties:
units:
allOf:
- $ref: "#/components/schemas/FrequencyUnits"
- description: Frequency units.
value:
allOf:
- $ref: "#/components/schemas/Double"
- description: Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
description: Object that describes the frequency.
FrequencyBandwidth:
type: object
required:
- units
- value
properties:
units:
allOf:
- $ref: "#/components/schemas/BandwidthUnits"
- description: Frequency bandwidth units.
value:
allOf:
- $ref: "#/components/schemas/Double"
- description: 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.
ListContacts call. Used to get the next page of results.
satelliteArn:
allOf:
- $ref: "#/components/schemas/satelliteArn"
- description: ARN of a satellite.
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: Start time of a contact in UTC.
statusList:
allOf:
- $ref: "#/components/schemas/StatusList"
- description: Status of a contact reservation.
description:
ListDataflowEndpointGroupsRequest:
type: object
title: ListDataflowEndpointGroupsRequest
properties: {}
description:
ListEphemeridesRequest:
type: object
required:
- endTime
- satelliteId
- startTime
title: ListEphemeridesRequest
properties:
endTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and
endTime.
satelliteId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: The AWS Ground Station satellite ID to list ephemeris for.
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and
endTime.
statusList:
allOf:
- $ref: "#/components/schemas/EphemerisStatusList"
- description: The list of ephemeris status to return.
ListGroundStationsRequest:
type: object
title: ListGroundStationsRequest
properties: {}
description:
ListMissionProfilesRequest:
type: object
title: ListMissionProfilesRequest
properties: {}
description:
MissionProfileList:
type: array
items:
$ref: "#/components/schemas/MissionProfileListItem"
ListSatellitesRequest:
type: object
title: ListSatellitesRequest
properties: {}
description:
SatelliteList:
type: array
items:
$ref: "#/components/schemas/SatelliteListItem"
ListTagsForResourceRequest:
type: object
title: ListTagsForResourceRequest
properties: {}
description:
MissionProfileListItem:
type: object
properties:
missionProfileArn:
allOf:
- $ref: "#/components/schemas/MissionProfileArn"
- description: ARN of a mission profile.
missionProfileId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a mission profile.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name of a mission profile.
region:
allOf:
- $ref: "#/components/schemas/AWSRegion"
- description: Region of a mission profile.
description: Item in a list of mission profiles.
Polarization:
type: string
enum:
- LEFT_HAND
- NONE
- RIGHT_HAND
RangedConnectionDetailsMtuInteger:
type: integer
minimum: 1400
maximum: 1500
RangedSocketAddress:
type: object
required:
- name
- portRange
properties:
name:
allOf:
- $ref: "#/components/schemas/IpV4Address"
- description: IPv4 socket address.
portRange:
allOf:
- $ref: "#/components/schemas/IntegerRange"
- description: Port range of a socket address.
description: A socket address with a port range.
RegisterAgentRequest:
type: object
required:
- agentDetails
- discoveryData
title: RegisterAgentRequest
properties:
agentDetails:
allOf:
- $ref: "#/components/schemas/AgentDetails"
- description: Detailed information about the agent being registered.
discoveryData:
allOf:
- $ref: "#/components/schemas/DiscoveryData"
- description: Data for associating an agent with the capabilities it is managing.
ReserveContactRequest:
type: object
required:
- endTime
- groundStation
- missionProfileArn
- satelliteArn
- startTime
title: ReserveContactRequest
properties:
endTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: End time of a contact in UTC.
groundStation:
allOf:
- $ref: "#/components/schemas/GroundStationName"
- description: Name of a ground station.
missionProfileArn:
allOf:
- $ref: "#/components/schemas/MissionProfileArn"
- description: ARN of a mission profile.
satelliteArn:
allOf:
- $ref: "#/components/schemas/satelliteArn"
- description: ARN of a satellite
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: Start time of a contact in UTC.
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a contact.
description:
S3BucketName:
type: string
pattern: ^[a-z0-9.-]{3,63}$
minLength: 3
maxLength: 63
S3KeyPrefix:
type: string
pattern: ^([a-zA-Z0-9_\-=/]|\{satellite_id\}|\{config\-name}|\{s3\-config-id}|\{year\}|\{month\}|\{day\}){1,900}$
minLength: 1
maxLength: 900
S3ObjectKey:
type: string
pattern: ^[a-zA-Z0-9!*'\)\(./_-]{1,1024}$
minLength: 1
maxLength: 1024
S3VersionId:
type: string
pattern: ^[\s\S]{1,1024}$
minLength: 1
maxLength: 1024
SatelliteListItem:
type: object
properties:
currentEphemeris:
allOf:
- $ref: "#/components/schemas/EphemerisMetaData"
- description: The current ephemeris being used to compute the trajectory of the satellite.
groundStations:
allOf:
- $ref: "#/components/schemas/GroundStationIdList"
- description: A list of ground stations to which the satellite is on-boarded.
noradSatelliteID:
allOf:
- $ref: "#/components/schemas/noradSatelliteID"
- description: NORAD satellite ID number.
satelliteArn:
allOf:
- $ref: "#/components/schemas/satelliteArn"
- description: ARN of a satellite.
satelliteId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: UUID of a satellite.
description: Item in a list of satellites.
SecurityGroupIdList:
type: array
items:
$ref: "#/components/schemas/String"
SubnetList:
type: array
items:
$ref: "#/components/schemas/String"
TleLineOne:
type: string
pattern: "^1 [ 0-9]{5}[A-Z] [ 0-9]{5}[ A-Z]{3} [ 0-9]{5}[.][ 0-9]{8} (?:(?:[ 0+-][.][ 0-9]{8})|(?: [ +-][.][ 0-9]{7})) [ +-][ 0-9]{5}[+-][ 0-9] [ +-][ 0-9]{5}[+-][ 0-9] [ 0-9] [ 0-9]{4}[ 0-9]$"
minLength: 69
maxLength: 69
TleLineTwo:
type: string
pattern: ^2 [ 0-9]{5} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{7} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{2}[.][ 0-9]{13}[ 0-9]$
minLength: 69
maxLength: 69
TimeRange:
type: object
required:
- endTime
- startTime
properties:
endTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: Time in UTC at which the time range ends.
startTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: Time in UTC at which the time range starts.
description: A time range with a start and end time.
TLEData:
type: object
required:
- tleLine1
- tleLine2
- validTimeRange
properties:
tleLine1:
allOf:
- $ref: "#/components/schemas/TleLineOne"
- description: First line of two-line element set (TLE) data.
tleLine2:
allOf:
- $ref: "#/components/schemas/TleLineTwo"
- description: Second line of two-line element set (TLE) data.
validTimeRange:
allOf:
- $ref: "#/components/schemas/TimeRange"
- description: The valid time range for the TLE. Gaps or overlap are not permitted.
description: Two-line element set (TLE) data.
TLEDataList:
type: array
items:
$ref: "#/components/schemas/TLEData"
minItems: 1
maxItems: 500
TagKeys:
type: array
items:
$ref: "#/components/schemas/UnboundedString"
minItems: 0
maxItems: 500
TagResourceRequest:
type: object
required:
- tags
title: TagResourceRequest
properties:
tags:
allOf:
- $ref: "#/components/schemas/TagsMap"
- description: Tags assigned to a resource.
description:
UntagResourceRequest:
type: object
title: UntagResourceRequest
properties: {}
description:
UpdateAgentStatusRequest:
type: object
required:
- aggregateStatus
- componentStatuses
- taskId
title: UpdateAgentStatusRequest
properties:
aggregateStatus:
allOf:
- $ref: "#/components/schemas/AggregateStatus"
- description: Aggregate status for agent.
componentStatuses:
allOf:
- $ref: "#/components/schemas/ComponentStatusList"
- description: List of component statuses for agent.
taskId:
allOf:
- $ref: "#/components/schemas/Uuid"
- description: GUID of agent task.
UpdateConfigRequest:
type: object
required:
- configData
- name
title: UpdateConfigRequest
properties:
configData:
allOf:
- $ref: "#/components/schemas/ConfigTypeData"
- description: Parameters of a Config.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name of a Config.
description:
UpdateEphemerisRequest:
type: object
required:
- enabled
title: UpdateEphemerisRequest
properties:
enabled:
allOf:
- $ref: "#/components/schemas/Boolean"
- description: Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.
name:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority:
allOf:
- $ref: "#/components/schemas/EphemerisPriority"
- description: Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
UpdateMissionProfileRequest: type: object title: UpdateMissionProfileRequest properties: contactPostPassDurationSeconds: allOf: - $ref: "#/components/schemas/DurationInSeconds" - description: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished. contactPrePassDurationSeconds: allOf: - $ref: "#/components/schemas/DurationInSeconds" - description: Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished. dataflowEdges: allOf: - $ref: "#/components/schemas/DataflowEdgeList" - description: A list of lists of ARNs. Each list of ARNs is an edge, with a fromConfig and a to Config.
minimumViableContactDurationSeconds:
allOf:
- $ref: "#/components/schemas/PositiveDurationInSeconds"
- description: 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:
allOf:
- $ref: "#/components/schemas/SafeName"
- description: Name of a mission profile.
streamsKmsKey:
allOf:
- $ref: "#/components/schemas/KmsKey"
- description: KMS key to use for encrypting streams.
streamsKmsRole:
allOf:
- $ref: "#/components/schemas/RoleArn"
- description: Role to use for encrypting streams with KMS key.
trackingConfigArn:
allOf:
- $ref: "#/components/schemas/ConfigArn"
- description: ARN of a tracking Config.
description:
security:
- hmac: []