{ "version":"2.0", "metadata":{ "apiVersion":"2019-05-23", "endpointPrefix":"groundstation", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"AWS Ground Station", "serviceId":"GroundStation", "signatureVersion":"v4", "signingName":"groundstation", "uid":"groundstation-2019-05-23" }, "operations":{ "CancelContact":{ "name":"CancelContact", "http":{ "method":"DELETE", "requestUri":"/contact/{contactId}", "responseCode":200 }, "input":{"shape":"CancelContactRequest"}, "output":{"shape":"ContactIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Cancels a contact with a specified contact ID.

", "idempotent":true }, "CreateConfig":{ "name":"CreateConfig", "http":{ "method":"POST", "requestUri":"/config", "responseCode":200 }, "input":{"shape":"CreateConfigRequest"}, "output":{"shape":"ConfigIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates a `Config` with the specified `configData` parameters.

Only one type of `configData` can be specified.

" }, "CreateDataflowEndpointGroup":{ "name":"CreateDataflowEndpointGroup", "http":{ "method":"POST", "requestUri":"/dataflowEndpointGroup", "responseCode":200 }, "input":{"shape":"CreateDataflowEndpointGroupRequest"}, "output":{"shape":"DataflowEndpointGroupIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "CreateEphemeris":{ "name":"CreateEphemeris", "http":{ "method":"POST", "requestUri":"/ephemeris", "responseCode":200 }, "input":{"shape":"CreateEphemerisRequest"}, "output":{"shape":"EphemerisIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates an Ephemeris with the specified `EphemerisData`.

" }, "CreateMissionProfile":{ "name":"CreateMissionProfile", "http":{ "method":"POST", "requestUri":"/missionprofile", "responseCode":200 }, "input":{"shape":"CreateMissionProfileRequest"}, "output":{"shape":"MissionProfileIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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.

" }, "DeleteConfig":{ "name":"DeleteConfig", "http":{ "method":"DELETE", "requestUri":"/config/{configType}/{configId}", "responseCode":200 }, "input":{"shape":"DeleteConfigRequest"}, "output":{"shape":"ConfigIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a `Config`.

", "idempotent":true }, "DeleteDataflowEndpointGroup":{ "name":"DeleteDataflowEndpointGroup", "http":{ "method":"DELETE", "requestUri":"/dataflowEndpointGroup/{dataflowEndpointGroupId}", "responseCode":200 }, "input":{"shape":"DeleteDataflowEndpointGroupRequest"}, "output":{"shape":"DataflowEndpointGroupIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a dataflow endpoint group.

", "idempotent":true }, "DeleteEphemeris":{ "name":"DeleteEphemeris", "http":{ "method":"DELETE", "requestUri":"/ephemeris/{ephemerisId}", "responseCode":200 }, "input":{"shape":"DeleteEphemerisRequest"}, "output":{"shape":"EphemerisIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes an ephemeris

", "idempotent":true }, "DeleteMissionProfile":{ "name":"DeleteMissionProfile", "http":{ "method":"DELETE", "requestUri":"/missionprofile/{missionProfileId}", "responseCode":200 }, "input":{"shape":"DeleteMissionProfileRequest"}, "output":{"shape":"MissionProfileIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a mission profile.

", "idempotent":true }, "DescribeContact":{ "name":"DescribeContact", "http":{ "method":"GET", "requestUri":"/contact/{contactId}", "responseCode":200 }, "input":{"shape":"DescribeContactRequest"}, "output":{"shape":"DescribeContactResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes an existing contact.

" }, "DescribeEphemeris":{ "name":"DescribeEphemeris", "http":{ "method":"GET", "requestUri":"/ephemeris/{ephemerisId}", "responseCode":200 }, "input":{"shape":"DescribeEphemerisRequest"}, "output":{"shape":"DescribeEphemerisResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes an existing ephemeris.

" }, "GetAgentConfiguration":{ "name":"GetAgentConfiguration", "http":{ "method":"GET", "requestUri":"/agent/{agentId}/configuration", "responseCode":200 }, "input":{"shape":"GetAgentConfigurationRequest"}, "output":{"shape":"GetAgentConfigurationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

Gets the latest configuration information for a registered agent.

" }, "GetConfig":{ "name":"GetConfig", "http":{ "method":"GET", "requestUri":"/config/{configType}/{configId}", "responseCode":200 }, "input":{"shape":"GetConfigRequest"}, "output":{"shape":"GetConfigResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns `Config` information.

Only one `Config` response can be returned.

" }, "GetDataflowEndpointGroup":{ "name":"GetDataflowEndpointGroup", "http":{ "method":"GET", "requestUri":"/dataflowEndpointGroup/{dataflowEndpointGroupId}", "responseCode":200 }, "input":{"shape":"GetDataflowEndpointGroupRequest"}, "output":{"shape":"GetDataflowEndpointGroupResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns the dataflow endpoint group.

" }, "GetMinuteUsage":{ "name":"GetMinuteUsage", "http":{ "method":"POST", "requestUri":"/minute-usage", "responseCode":200 }, "input":{"shape":"GetMinuteUsageRequest"}, "output":{"shape":"GetMinuteUsageResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns the number of reserved minutes used by account.

" }, "GetMissionProfile":{ "name":"GetMissionProfile", "http":{ "method":"GET", "requestUri":"/missionprofile/{missionProfileId}", "responseCode":200 }, "input":{"shape":"GetMissionProfileRequest"}, "output":{"shape":"GetMissionProfileResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a mission profile.

" }, "GetSatellite":{ "name":"GetSatellite", "http":{ "method":"GET", "requestUri":"/satellite/{satelliteId}", "responseCode":200 }, "input":{"shape":"GetSatelliteRequest"}, "output":{"shape":"GetSatelliteResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a satellite.

" }, "ListConfigs":{ "name":"ListConfigs", "http":{ "method":"GET", "requestUri":"/config", "responseCode":200 }, "input":{"shape":"ListConfigsRequest"}, "output":{"shape":"ListConfigsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of `Config` objects.

" }, "ListContacts":{ "name":"ListContacts", "http":{ "method":"POST", "requestUri":"/contacts", "responseCode":200 }, "input":{"shape":"ListContactsRequest"}, "output":{"shape":"ListContactsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of contacts.

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

" }, "ListDataflowEndpointGroups":{ "name":"ListDataflowEndpointGroups", "http":{ "method":"GET", "requestUri":"/dataflowEndpointGroup", "responseCode":200 }, "input":{"shape":"ListDataflowEndpointGroupsRequest"}, "output":{"shape":"ListDataflowEndpointGroupsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of `DataflowEndpoint` groups.

" }, "ListEphemerides":{ "name":"ListEphemerides", "http":{ "method":"POST", "requestUri":"/ephemerides", "responseCode":200 }, "input":{"shape":"ListEphemeridesRequest"}, "output":{"shape":"ListEphemeridesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List existing ephemerides.

" }, "ListGroundStations":{ "name":"ListGroundStations", "http":{ "method":"GET", "requestUri":"/groundstation", "responseCode":200 }, "input":{"shape":"ListGroundStationsRequest"}, "output":{"shape":"ListGroundStationsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of ground stations.

" }, "ListMissionProfiles":{ "name":"ListMissionProfiles", "http":{ "method":"GET", "requestUri":"/missionprofile", "responseCode":200 }, "input":{"shape":"ListMissionProfilesRequest"}, "output":{"shape":"ListMissionProfilesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of mission profiles.

" }, "ListSatellites":{ "name":"ListSatellites", "http":{ "method":"GET", "requestUri":"/satellite", "responseCode":200 }, "input":{"shape":"ListSatellitesRequest"}, "output":{"shape":"ListSatellitesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of satellites.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a list of tags for a specified resource.

" }, "RegisterAgent":{ "name":"RegisterAgent", "http":{ "method":"POST", "requestUri":"/agent", "responseCode":200 }, "input":{"shape":"RegisterAgentRequest"}, "output":{"shape":"RegisterAgentResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

Registers a new agent with AWS Ground Station.

" }, "ReserveContact":{ "name":"ReserveContact", "http":{ "method":"POST", "requestUri":"/contact", "responseCode":200 }, "input":{"shape":"ReserveContactRequest"}, "output":{"shape":"ContactIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Reserves a contact using specified parameters.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Assigns a tag to a resource.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deassigns a resource tag.

", "idempotent":true }, "UpdateAgentStatus":{ "name":"UpdateAgentStatus", "http":{ "method":"PUT", "requestUri":"/agent/{agentId}", "responseCode":200 }, "input":{"shape":"UpdateAgentStatusRequest"}, "output":{"shape":"UpdateAgentStatusResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

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

Update the status of the agent.

", "idempotent":true }, "UpdateConfig":{ "name":"UpdateConfig", "http":{ "method":"PUT", "requestUri":"/config/{configType}/{configId}", "responseCode":200 }, "input":{"shape":"UpdateConfigRequest"}, "output":{"shape":"ConfigIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates the `Config` used when scheduling contacts.

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

", "idempotent":true }, "UpdateEphemeris":{ "name":"UpdateEphemeris", "http":{ "method":"PUT", "requestUri":"/ephemeris/{ephemerisId}", "responseCode":200 }, "input":{"shape":"UpdateEphemerisRequest"}, "output":{"shape":"EphemerisIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates an existing ephemeris

", "idempotent":true }, "UpdateMissionProfile":{ "name":"UpdateMissionProfile", "http":{ "method":"PUT", "requestUri":"/missionprofile/{missionProfileId}", "responseCode":200 }, "input":{"shape":"UpdateMissionProfileRequest"}, "output":{"shape":"MissionProfileIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"DependencyException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a mission profile.

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

", "idempotent":true } }, "shapes":{ "AWSRegion":{ "type":"string", "max":128, "min":1, "pattern":"^[\\w-]+$" }, "AgentCpuCoresList":{ "type":"list", "member":{"shape":"Integer"}, "max":256, "min":0 }, "AgentDetails":{ "type":"structure", "required":[ "agentVersion", "componentVersions", "instanceId", "instanceType" ], "members":{ "agentCpuCores":{ "shape":"AgentCpuCoresList", "documentation":"

List of CPU cores reserved for the agent.

" }, "agentVersion":{ "shape":"VersionString", "documentation":"

Current agent version.

" }, "componentVersions":{ "shape":"ComponentVersionList", "documentation":"

List of versions being used by agent components.

" }, "instanceId":{ "shape":"InstanceId", "documentation":"

ID of EC2 instance agent is running on.

" }, "instanceType":{ "shape":"InstanceType", "documentation":"

Type of EC2 instance agent is running on.

" }, "reservedCpuCores":{ "shape":"AgentCpuCoresList", "documentation":"

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.

" } }, "documentation":"

Detailed information about the agent.

" }, "AgentStatus":{ "type":"string", "enum":[ "SUCCESS", "FAILED", "ACTIVE", "INACTIVE" ] }, "AggregateStatus":{ "type":"structure", "required":["status"], "members":{ "signatureMap":{ "shape":"SignatureMap", "documentation":"

Sparse map of failure signatures.

" }, "status":{ "shape":"AgentStatus", "documentation":"

Aggregate status.

" } }, "documentation":"

Aggregate status of Agent components.

" }, "AngleUnits":{ "type":"string", "enum":[ "DEGREE_ANGLE", "RADIAN" ] }, "AntennaDemodDecodeDetails":{ "type":"structure", "members":{ "outputNode":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

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

" }, "AntennaDownlinkConfig":{ "type":"structure", "required":["spectrumConfig"], "members":{ "spectrumConfig":{ "shape":"SpectrumConfig", "documentation":"

Object that describes a spectral `Config`.

" } }, "documentation":"

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

" }, "AntennaDownlinkDemodDecodeConfig":{ "type":"structure", "required":[ "decodeConfig", "demodulationConfig", "spectrumConfig" ], "members":{ "decodeConfig":{ "shape":"DecodeConfig", "documentation":"

Information about the decode `Config`.

" }, "demodulationConfig":{ "shape":"DemodulationConfig", "documentation":"

Information about the demodulation `Config`.

" }, "spectrumConfig":{ "shape":"SpectrumConfig", "documentation":"

Information about the spectral `Config`.

" } }, "documentation":"

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

" }, "AntennaUplinkConfig":{ "type":"structure", "required":[ "spectrumConfig", "targetEirp" ], "members":{ "spectrumConfig":{ "shape":"UplinkSpectrumConfig", "documentation":"

Information about the uplink spectral `Config`.

" }, "targetEirp":{ "shape":"Eirp", "documentation":"

EIRP of the target.

" }, "transmitDisabled":{ "shape":"Boolean", "documentation":"

Whether or not uplink transmit is disabled.

" } }, "documentation":"

Information about the uplink `Config` of an antenna.

" }, "AnyArn":{ "type":"string", "max":1024, "min":5, "pattern":"^(arn:aws:)[\\s\\S]{0,1024}$" }, "AuditResults":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY" ] }, "AwsGroundStationAgentEndpoint":{ "type":"structure", "required":[ "egressAddress", "ingressAddress", "name" ], "members":{ "agentStatus":{ "shape":"AgentStatus", "documentation":"

The status of AgentEndpoint.

" }, "auditResults":{ "shape":"AuditResults", "documentation":"

The results of the audit.

" }, "egressAddress":{ "shape":"ConnectionDetails", "documentation":"

The egress address of AgentEndpoint.

" }, "ingressAddress":{ "shape":"RangedConnectionDetails", "documentation":"

The ingress address of AgentEndpoint.

" }, "name":{ "shape":"SafeName", "documentation":"

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

" } }, "documentation":"

Information about AwsGroundStationAgentEndpoint.

" }, "BandwidthUnits":{ "type":"string", "enum":[ "GHz", "MHz", "kHz" ] }, "Boolean":{ "type":"boolean", "box":true }, "BucketArn":{"type":"string"}, "CancelContactRequest":{ "type":"structure", "required":["contactId"], "members":{ "contactId":{ "shape":"Uuid", "documentation":"

UUID of a contact.

", "location":"uri", "locationName":"contactId" } }, "documentation":"

" }, "CapabilityArn":{"type":"string"}, "CapabilityArnList":{ "type":"list", "member":{"shape":"CapabilityArn"}, "max":20, "min":1 }, "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":"list", "member":{"shape":"CapabilityHealthReason"}, "max":500, "min":0 }, "ComponentStatusData":{ "type":"structure", "required":[ "capabilityArn", "componentType", "dataflowId", "status" ], "members":{ "bytesReceived":{ "shape":"Long", "documentation":"

Bytes received by the component.

" }, "bytesSent":{ "shape":"Long", "documentation":"

Bytes sent by the component.

" }, "capabilityArn":{ "shape":"CapabilityArn", "documentation":"

Capability ARN of the component.

" }, "componentType":{ "shape":"ComponentTypeString", "documentation":"

The Component type.

" }, "dataflowId":{ "shape":"Uuid", "documentation":"

Dataflow UUID associated with the component.

" }, "packetsDropped":{ "shape":"Long", "documentation":"

Packets dropped by component.

" }, "status":{ "shape":"AgentStatus", "documentation":"

Component status.

" } }, "documentation":"

Data on the status of agent components.

" }, "ComponentStatusList":{ "type":"list", "member":{"shape":"ComponentStatusData"}, "max":20, "min":0 }, "ComponentTypeString":{ "type":"string", "pattern":"^[a-zA-Z0-9_]{1,64}$" }, "ComponentVersion":{ "type":"structure", "required":[ "componentType", "versions" ], "members":{ "componentType":{ "shape":"ComponentTypeString", "documentation":"

Component type.

" }, "versions":{ "shape":"VersionStringList", "documentation":"

List of versions.

" } }, "documentation":"

Version information for agent components.

" }, "ComponentVersionList":{ "type":"list", "member":{"shape":"ComponentVersion"}, "max":20, "min":1 }, "ConfigArn":{"type":"string"}, "ConfigCapabilityType":{ "type":"string", "enum":[ "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo", "s3-recording" ] }, "ConfigDetails":{ "type":"structure", "members":{ "antennaDemodDecodeDetails":{ "shape":"AntennaDemodDecodeDetails", "documentation":"

Details for antenna demod decode `Config` in a contact.

" }, "endpointDetails":{"shape":"EndpointDetails"}, "s3RecordingDetails":{ "shape":"S3RecordingDetails", "documentation":"

Details for an S3 recording `Config` in a contact.

" } }, "documentation":"

Details for certain `Config` object types in a contact.

", "union":true }, "ConfigIdResponse":{ "type":"structure", "members":{ "configArn":{ "shape":"ConfigArn", "documentation":"

ARN of a `Config`.

" }, "configId":{ "shape":"String", "documentation":"

UUID of a `Config`.

" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

" } }, "documentation":"

" }, "ConfigList":{ "type":"list", "member":{"shape":"ConfigListItem"} }, "ConfigListItem":{ "type":"structure", "members":{ "configArn":{ "shape":"ConfigArn", "documentation":"

ARN of a `Config`.

" }, "configId":{ "shape":"String", "documentation":"

UUID of a `Config`.

" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

" }, "name":{ "shape":"String", "documentation":"

Name of a `Config`.

" } }, "documentation":"

An item in a list of `Config` objects.

" }, "ConfigTypeData":{ "type":"structure", "members":{ "antennaDownlinkConfig":{ "shape":"AntennaDownlinkConfig", "documentation":"

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

" }, "antennaDownlinkDemodDecodeConfig":{ "shape":"AntennaDownlinkDemodDecodeConfig", "documentation":"

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

" }, "antennaUplinkConfig":{ "shape":"AntennaUplinkConfig", "documentation":"

Information about how AWS Ground Station should conﬁgure an antenna for uplink during a contact.

" }, "dataflowEndpointConfig":{ "shape":"DataflowEndpointConfig", "documentation":"

Information about the dataflow endpoint `Config`.

" }, "s3RecordingConfig":{ "shape":"S3RecordingConfig", "documentation":"

Information about an S3 recording `Config`.

" }, "trackingConfig":{ "shape":"TrackingConfig", "documentation":"

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

" }, "uplinkEchoConfig":{ "shape":"UplinkEchoConfig", "documentation":"

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.

" } }, "documentation":"

Object containing the parameters of a `Config`.

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

", "union":true }, "ConnectionDetails":{ "type":"structure", "required":["socketAddress"], "members":{ "mtu":{ "shape":"Integer", "documentation":"

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

" }, "socketAddress":{ "shape":"SocketAddress", "documentation":"

A socket address.

" } }, "documentation":"

Egress address of AgentEndpoint with an optional mtu.

" }, "ContactData":{ "type":"structure", "members":{ "contactId":{ "shape":"Uuid", "documentation":"

UUID of a contact.

" }, "contactStatus":{ "shape":"ContactStatus", "documentation":"

Status of a contact.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

End time of a contact in UTC.

" }, "errorMessage":{ "shape":"String", "documentation":"

Error message of a contact.

" }, "groundStation":{ "shape":"String", "documentation":"

Name of a ground station.

" }, "maximumElevation":{ "shape":"Elevation", "documentation":"

Maximum elevation angle of a contact.

" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"

ARN of a mission profile.

" }, "postPassEndTime":{ "shape":"Timestamp", "documentation":"

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

" }, "prePassStartTime":{ "shape":"Timestamp", "documentation":"

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

" }, "region":{ "shape":"String", "documentation":"

Region of a contact.

" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"

ARN of a satellite.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

Start time of a contact in UTC.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a contact.

" } }, "documentation":"

Data describing a contact.

" }, "ContactIdResponse":{ "type":"structure", "members":{ "contactId":{ "shape":"Uuid", "documentation":"

UUID of a contact.

" } }, "documentation":"

" }, "ContactList":{ "type":"list", "member":{"shape":"ContactData"} }, "ContactStatus":{ "type":"string", "enum":[ "AVAILABLE", "AWS_CANCELLED", "AWS_FAILED", "CANCELLED", "CANCELLING", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING" ] }, "CreateConfigRequest":{ "type":"structure", "required":[ "configData", "name" ], "members":{ "configData":{ "shape":"ConfigTypeData", "documentation":"

Parameters of a `Config`.

" }, "name":{ "shape":"SafeName", "documentation":"

Name of a `Config`.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a `Config`.

" } }, "documentation":"

" }, "CreateDataflowEndpointGroupRequest":{ "type":"structure", "required":["endpointDetails"], "members":{ "contactPostPassDurationSeconds":{ "shape":"DataflowEndpointGroupDurationInSeconds", "documentation":"

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":{ "shape":"DataflowEndpointGroupDurationInSeconds", "documentation":"

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":{ "shape":"EndpointDetailsList", "documentation":"

Endpoint details of each endpoint in the dataflow endpoint group.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags of a dataflow endpoint group.

" } }, "documentation":"

" }, "CreateEphemerisRequest":{ "type":"structure", "required":[ "name", "satelliteId" ], "members":{ "enabled":{ "shape":"Boolean", "documentation":"

Whether to set the ephemeris status to `ENABLED` after validation.

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

" }, "ephemeris":{ "shape":"EphemerisData", "documentation":"

Ephemeris data.

" }, "expirationTime":{ "shape":"Timestamp", "documentation":"

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

" }, "kmsKeyArn":{ "shape":"KeyArn", "documentation":"

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

" }, "name":{ "shape":"SafeName", "documentation":"

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

" }, "priority":{ "shape":"CustomerEphemerisPriority", "documentation":"

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":{ "shape":"Uuid", "documentation":"

AWS Ground Station satellite ID for this ephemeris.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to an ephemeris.

" } } }, "CreateMissionProfileRequest":{ "type":"structure", "required":[ "dataflowEdges", "minimumViableContactDurationSeconds", "name", "trackingConfigArn" ], "members":{ "contactPostPassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"

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

" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"

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

" }, "dataflowEdges":{ "shape":"DataflowEdgeList", "documentation":"

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

" }, "minimumViableContactDurationSeconds":{ "shape":"PositiveDurationInSeconds", "documentation":"

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":{ "shape":"SafeName", "documentation":"

Name of a mission profile.

" }, "streamsKmsKey":{ "shape":"KmsKey", "documentation":"

KMS key to use for encrypting streams.

" }, "streamsKmsRole":{ "shape":"RoleArn", "documentation":"

Role to use for encrypting streams with KMS key.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a mission profile.

" }, "trackingConfigArn":{ "shape":"ConfigArn", "documentation":"

ARN of a tracking `Config`.

" } }, "documentation":"

" }, "Criticality":{ "type":"string", "enum":[ "PREFERRED", "REMOVED", "REQUIRED" ] }, "CustomerEphemerisPriority":{ "type":"integer", "box":true, "max":99999, "min":1 }, "DataflowDetail":{ "type":"structure", "members":{ "destination":{"shape":"Destination"}, "errorMessage":{ "shape":"String", "documentation":"

Error message for a dataflow.

" }, "source":{"shape":"Source"} }, "documentation":"

Information about a dataflow edge used in a contact.

" }, "DataflowEdge":{ "type":"list", "member":{"shape":"ConfigArn"}, "max":2, "min":2 }, "DataflowEdgeList":{ "type":"list", "member":{"shape":"DataflowEdge"}, "max":500, "min":0 }, "DataflowEndpoint":{ "type":"structure", "members":{ "address":{ "shape":"SocketAddress", "documentation":"

Socket address of a dataflow endpoint.

" }, "mtu":{ "shape":"DataflowEndpointMtuInteger", "documentation":"

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

" }, "name":{ "shape":"SafeName", "documentation":"

Name of a dataflow endpoint.

" }, "status":{ "shape":"EndpointStatus", "documentation":"

Status of a dataflow endpoint.

" } }, "documentation":"

Information about a dataflow endpoint.

" }, "DataflowEndpointConfig":{ "type":"structure", "required":["dataflowEndpointName"], "members":{ "dataflowEndpointName":{ "shape":"String", "documentation":"

Name of a dataflow endpoint.

" }, "dataflowEndpointRegion":{ "shape":"String", "documentation":"

Region of a dataflow endpoint.

" } }, "documentation":"

Information about the dataflow endpoint `Config`.

" }, "DataflowEndpointGroupArn":{"type":"string"}, "DataflowEndpointGroupDurationInSeconds":{ "type":"integer", "box":true, "max":480, "min":120 }, "DataflowEndpointGroupIdResponse":{ "type":"structure", "members":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"

UUID of a dataflow endpoint group.

" } }, "documentation":"

" }, "DataflowEndpointGroupList":{ "type":"list", "member":{"shape":"DataflowEndpointListItem"} }, "DataflowEndpointListItem":{ "type":"structure", "members":{ "dataflowEndpointGroupArn":{ "shape":"DataflowEndpointGroupArn", "documentation":"

ARN of a dataflow endpoint group.

" }, "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"

UUID of a dataflow endpoint group.

" } }, "documentation":"

Item in a list of `DataflowEndpoint` groups.

" }, "DataflowEndpointMtuInteger":{ "type":"integer", "box":true, "max":1500, "min":1400 }, "DataflowList":{ "type":"list", "member":{"shape":"DataflowDetail"} }, "DecodeConfig":{ "type":"structure", "required":["unvalidatedJSON"], "members":{ "unvalidatedJSON":{ "shape":"JsonString", "documentation":"

Unvalidated JSON of a decode `Config`.

" } }, "documentation":"

Information about the decode `Config`.

" }, "DeleteConfigRequest":{ "type":"structure", "required":[ "configId", "configType" ], "members":{ "configId":{ "shape":"Uuid", "documentation":"

UUID of a `Config`.

", "location":"uri", "locationName":"configId" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

", "location":"uri", "locationName":"configType" } }, "documentation":"

" }, "DeleteDataflowEndpointGroupRequest":{ "type":"structure", "required":["dataflowEndpointGroupId"], "members":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"

UUID of a dataflow endpoint group.

", "location":"uri", "locationName":"dataflowEndpointGroupId" } }, "documentation":"

" }, "DeleteEphemerisRequest":{ "type":"structure", "required":["ephemerisId"], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"

The AWS Ground Station ephemeris ID.

", "location":"uri", "locationName":"ephemerisId" } } }, "DeleteMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"

UUID of a mission profile.

", "location":"uri", "locationName":"missionProfileId" } }, "documentation":"

" }, "DemodulationConfig":{ "type":"structure", "required":["unvalidatedJSON"], "members":{ "unvalidatedJSON":{ "shape":"JsonString", "documentation":"

Unvalidated JSON of a demodulation `Config`.

" } }, "documentation":"

Information about the demodulation `Config`.

" }, "DependencyException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "parameterName":{ "shape":"String", "documentation":"

" } }, "documentation":"

Dependency encountered an error.

", "error":{"httpStatusCode":531}, "exception":true, "fault":true }, "DescribeContactRequest":{ "type":"structure", "required":["contactId"], "members":{ "contactId":{ "shape":"Uuid", "documentation":"

UUID of a contact.

", "location":"uri", "locationName":"contactId" } }, "documentation":"

" }, "DescribeContactResponse":{ "type":"structure", "members":{ "contactId":{ "shape":"Uuid", "documentation":"

UUID of a contact.

" }, "contactStatus":{ "shape":"ContactStatus", "documentation":"

Status of a contact.

" }, "dataflowList":{ "shape":"DataflowList", "documentation":"

List describing source and destination details for each dataflow edge.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

End time of a contact in UTC.

" }, "errorMessage":{ "shape":"String", "documentation":"

Error message for a contact.

" }, "groundStation":{ "shape":"String", "documentation":"

Ground station for a contact.

" }, "maximumElevation":{ "shape":"Elevation", "documentation":"

Maximum elevation angle of a contact.

" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"

ARN of a mission profile.

" }, "postPassEndTime":{ "shape":"Timestamp", "documentation":"

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

" }, "prePassStartTime":{ "shape":"Timestamp", "documentation":"

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

" }, "region":{ "shape":"String", "documentation":"

Region of a contact.

" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"

ARN of a satellite.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

Start time of a contact in UTC.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a contact.

" } }, "documentation":"

" }, "DescribeEphemerisRequest":{ "type":"structure", "required":["ephemerisId"], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"

The AWS Ground Station ephemeris ID.

", "location":"uri", "locationName":"ephemerisId" } } }, "DescribeEphemerisResponse":{ "type":"structure", "members":{ "creationTime":{ "shape":"Timestamp", "documentation":"

The time the ephemeris was uploaded in UTC.

" }, "enabled":{ "shape":"Boolean", "documentation":"

Whether or not the ephemeris is enabled.

" }, "ephemerisId":{ "shape":"Uuid", "documentation":"

The AWS Ground Station ephemeris ID.

" }, "invalidReason":{ "shape":"EphemerisInvalidReason", "documentation":"

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

" }, "name":{ "shape":"SafeName", "documentation":"

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

" }, "priority":{ "shape":"EphemerisPriority", "documentation":"

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":{ "shape":"Uuid", "documentation":"

The AWS Ground Station satellite ID associated with ephemeris.

" }, "status":{ "shape":"EphemerisStatus", "documentation":"

The status of the ephemeris.

" }, "suppliedData":{ "shape":"EphemerisTypeDescription", "documentation":"

Supplied ephemeris data.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to an ephemeris.

" } } }, "Destination":{ "type":"structure", "members":{ "configDetails":{ "shape":"ConfigDetails", "documentation":"

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

" }, "configId":{ "shape":"Uuid", "documentation":"

UUID of a `Config`.

" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

" }, "dataflowDestinationRegion":{ "shape":"String", "documentation":"

Region of a dataflow destination.

" } }, "documentation":"

Dataflow details for the destination side.

" }, "DiscoveryData":{ "type":"structure", "required":[ "capabilityArns", "privateIpAddresses", "publicIpAddresses" ], "members":{ "capabilityArns":{ "shape":"CapabilityArnList", "documentation":"

List of capabilities to associate with agent.

" }, "privateIpAddresses":{ "shape":"IpAddressList", "documentation":"

List of private IP addresses to associate with agent.

" }, "publicIpAddresses":{ "shape":"IpAddressList", "documentation":"

List of public IP addresses to associate with agent.

" } }, "documentation":"

Data for agent discovery.

" }, "Double":{ "type":"double", "box":true }, "DurationInSeconds":{ "type":"integer", "box":true, "max":21600, "min":0 }, "Eirp":{ "type":"structure", "required":[ "units", "value" ], "members":{ "units":{ "shape":"EirpUnits", "documentation":"

Units of an EIRP.

" }, "value":{ "shape":"Double", "documentation":"

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

" } }, "documentation":"

Object that represents EIRP.

" }, "EirpUnits":{ "type":"string", "enum":["dBW"] }, "Elevation":{ "type":"structure", "required":[ "unit", "value" ], "members":{ "unit":{ "shape":"AngleUnits", "documentation":"

Elevation angle units.

" }, "value":{ "shape":"Double", "documentation":"

Elevation angle value.

" } }, "documentation":"

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

" }, "EndpointDetails":{ "type":"structure", "members":{ "awsGroundStationAgentEndpoint":{ "shape":"AwsGroundStationAgentEndpoint", "documentation":"

An agent endpoint.

" }, "endpoint":{ "shape":"DataflowEndpoint", "documentation":"

A dataflow endpoint.

" }, "healthReasons":{ "shape":"CapabilityHealthReasonList", "documentation":"

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

" }, "healthStatus":{ "shape":"CapabilityHealth", "documentation":"

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

" }, "securityDetails":{ "shape":"SecurityDetails", "documentation":"

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

" } }, "documentation":"

Information about the endpoint details.

" }, "EndpointDetailsList":{ "type":"list", "member":{"shape":"EndpointDetails"}, "max":500, "min":0 }, "EndpointStatus":{ "type":"string", "enum":[ "created", "creating", "deleted", "deleting", "failed" ] }, "EphemeridesList":{ "type":"list", "member":{"shape":"EphemerisItem"}, "max":500, "min":1 }, "EphemerisData":{ "type":"structure", "members":{ "oem":{"shape":"OEMEphemeris"}, "tle":{"shape":"TLEEphemeris"} }, "documentation":"

Ephemeris data.

", "union":true }, "EphemerisDescription":{ "type":"structure", "members":{ "ephemerisData":{ "shape":"UnboundedString", "documentation":"

Supplied ephemeris data.

" }, "sourceS3Object":{ "shape":"S3Object", "documentation":"

Source S3 object used for the ephemeris.

" } }, "documentation":"

Description of ephemeris.

" }, "EphemerisIdResponse":{ "type":"structure", "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"

The AWS Ground Station ephemeris ID.

" } } }, "EphemerisInvalidReason":{ "type":"string", "enum":[ "METADATA_INVALID", "TIME_RANGE_INVALID", "TRAJECTORY_INVALID", "KMS_KEY_INVALID", "VALIDATION_ERROR" ] }, "EphemerisItem":{ "type":"structure", "members":{ "creationTime":{ "shape":"Timestamp", "documentation":"

The time the ephemeris was uploaded in UTC.

" }, "enabled":{ "shape":"Boolean", "documentation":"

Whether or not the ephemeris is enabled.

" }, "ephemerisId":{ "shape":"Uuid", "documentation":"

The AWS Ground Station ephemeris ID.

" }, "name":{ "shape":"SafeName", "documentation":"

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

" }, "priority":{ "shape":"EphemerisPriority", "documentation":"

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":{ "shape":"S3Object", "documentation":"

Source S3 object used for the ephemeris.

" }, "status":{ "shape":"EphemerisStatus", "documentation":"

The status of the ephemeris.

" } }, "documentation":"

Ephemeris item.

" }, "EphemerisMetaData":{ "type":"structure", "required":["source"], "members":{ "ephemerisId":{ "shape":"Uuid", "documentation":"

UUID of a customer-provided ephemeris.

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

" }, "epoch":{ "shape":"Timestamp", "documentation":"

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

This field is not populated for customer-provided ephemerides.

" }, "name":{ "shape":"SafeName", "documentation":"

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":{ "shape":"EphemerisSource", "documentation":"

The `EphemerisSource` that generated a given ephemeris.

" } }, "documentation":"

Metadata describing a particular ephemeris.

" }, "EphemerisPriority":{ "type":"integer", "box":true, "max":99999, "min":0 }, "EphemerisSource":{ "type":"string", "enum":[ "CUSTOMER_PROVIDED", "SPACE_TRACK" ] }, "EphemerisStatus":{ "type":"string", "enum":[ "VALIDATING", "INVALID", "ERROR", "ENABLED", "DISABLED", "EXPIRED" ] }, "EphemerisStatusList":{ "type":"list", "member":{"shape":"EphemerisStatus"}, "max":500, "min":0 }, "EphemerisTypeDescription":{ "type":"structure", "members":{ "oem":{"shape":"EphemerisDescription"}, "tle":{"shape":"EphemerisDescription"} }, "documentation":"

", "union":true }, "Frequency":{ "type":"structure", "required":[ "units", "value" ], "members":{ "units":{ "shape":"FrequencyUnits", "documentation":"

Frequency units.

" }, "value":{ "shape":"Double", "documentation":"

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

" } }, "documentation":"

Object that describes the frequency.

" }, "FrequencyBandwidth":{ "type":"structure", "required":[ "units", "value" ], "members":{ "units":{ "shape":"BandwidthUnits", "documentation":"

Frequency bandwidth units.

" }, "value":{ "shape":"Double", "documentation":"

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.

" } }, "documentation":"

Object that describes the frequency bandwidth.

" }, "FrequencyUnits":{ "type":"string", "enum":[ "GHz", "MHz", "kHz" ] }, "GetAgentConfigurationRequest":{ "type":"structure", "required":["agentId"], "members":{ "agentId":{ "shape":"Uuid", "documentation":"

UUID of agent to get configuration information for.

", "location":"uri", "locationName":"agentId" } } }, "GetAgentConfigurationResponse":{ "type":"structure", "members":{ "agentId":{ "shape":"Uuid", "documentation":"

UUID of agent.

" }, "taskingDocument":{ "shape":"String", "documentation":"

Tasking document for agent.

" } } }, "GetConfigRequest":{ "type":"structure", "required":[ "configId", "configType" ], "members":{ "configId":{ "shape":"Uuid", "documentation":"

UUID of a `Config`.

", "location":"uri", "locationName":"configId" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

", "location":"uri", "locationName":"configType" } }, "documentation":"

" }, "GetConfigResponse":{ "type":"structure", "required":[ "configArn", "configData", "configId", "name" ], "members":{ "configArn":{ "shape":"ConfigArn", "documentation":"

ARN of a `Config`

" }, "configData":{ "shape":"ConfigTypeData", "documentation":"

Data elements in a `Config`.

" }, "configId":{ "shape":"String", "documentation":"

UUID of a `Config`.

" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

" }, "name":{ "shape":"String", "documentation":"

Name of a `Config`.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a `Config`.

" } }, "documentation":"

" }, "GetDataflowEndpointGroupRequest":{ "type":"structure", "required":["dataflowEndpointGroupId"], "members":{ "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"

UUID of a dataflow endpoint group.

", "location":"uri", "locationName":"dataflowEndpointGroupId" } }, "documentation":"

" }, "GetDataflowEndpointGroupResponse":{ "type":"structure", "members":{ "contactPostPassDurationSeconds":{ "shape":"DataflowEndpointGroupDurationInSeconds", "documentation":"

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":{ "shape":"DataflowEndpointGroupDurationInSeconds", "documentation":"

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":{ "shape":"DataflowEndpointGroupArn", "documentation":"

ARN of a dataflow endpoint group.

" }, "dataflowEndpointGroupId":{ "shape":"Uuid", "documentation":"

UUID of a dataflow endpoint group.

" }, "endpointsDetails":{ "shape":"EndpointDetailsList", "documentation":"

Details of a dataflow endpoint.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a dataflow endpoint group.

" } }, "documentation":"

" }, "GetMinuteUsageRequest":{ "type":"structure", "required":[ "month", "year" ], "members":{ "month":{ "shape":"Month", "documentation":"

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

" }, "year":{ "shape":"Year", "documentation":"

The year being requested, in the format of YYYY.

" } }, "documentation":"

" }, "GetMinuteUsageResponse":{ "type":"structure", "members":{ "estimatedMinutesRemaining":{ "shape":"Integer", "documentation":"

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

" }, "isReservedMinutesCustomer":{ "shape":"Boolean", "documentation":"

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

" }, "totalReservedMinuteAllocation":{ "shape":"Integer", "documentation":"

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

" }, "totalScheduledMinutes":{ "shape":"Integer", "documentation":"

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

" }, "upcomingMinutesScheduled":{ "shape":"Integer", "documentation":"

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

" } }, "documentation":"

" }, "GetMissionProfileRequest":{ "type":"structure", "required":["missionProfileId"], "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"

UUID of a mission profile.

", "location":"uri", "locationName":"missionProfileId" } }, "documentation":"

" }, "GetMissionProfileResponse":{ "type":"structure", "members":{ "contactPostPassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"

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

" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"

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

" }, "dataflowEdges":{ "shape":"DataflowEdgeList", "documentation":"

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

" }, "minimumViableContactDurationSeconds":{ "shape":"PositiveDurationInSeconds", "documentation":"

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":{ "shape":"MissionProfileArn", "documentation":"

ARN of a mission profile.

" }, "missionProfileId":{ "shape":"Uuid", "documentation":"

UUID of a mission profile.

" }, "name":{ "shape":"SafeName", "documentation":"

Name of a mission profile.

" }, "region":{ "shape":"AWSRegion", "documentation":"

Region of a mission profile.

" }, "streamsKmsKey":{ "shape":"KmsKey", "documentation":"

KMS key to use for encrypting streams.

" }, "streamsKmsRole":{ "shape":"RoleArn", "documentation":"

Role to use for encrypting streams with KMS key.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a mission profile.

" }, "trackingConfigArn":{ "shape":"ConfigArn", "documentation":"

ARN of a tracking `Config`.

" } }, "documentation":"

" }, "GetSatelliteRequest":{ "type":"structure", "required":["satelliteId"], "members":{ "satelliteId":{ "shape":"Uuid", "documentation":"

UUID of a satellite.

", "location":"uri", "locationName":"satelliteId" } }, "documentation":"

" }, "GetSatelliteResponse":{ "type":"structure", "members":{ "currentEphemeris":{ "shape":"EphemerisMetaData", "documentation":"

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

" }, "groundStations":{ "shape":"GroundStationIdList", "documentation":"

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

" }, "noradSatelliteID":{ "shape":"noradSatelliteID", "documentation":"

NORAD satellite ID number.

" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"

ARN of a satellite.

" }, "satelliteId":{ "shape":"Uuid", "documentation":"

UUID of a satellite.

" } }, "documentation":"

" }, "GroundStationData":{ "type":"structure", "members":{ "groundStationId":{ "shape":"GroundStationName", "documentation":"

UUID of a ground station.

" }, "groundStationName":{ "shape":"GroundStationName", "documentation":"

Name of a ground station.

" }, "region":{ "shape":"AWSRegion", "documentation":"

Ground station Region.

" } }, "documentation":"

Information about the ground station data.

" }, "GroundStationIdList":{ "type":"list", "member":{"shape":"GroundStationName"}, "max":500, "min":0 }, "GroundStationList":{ "type":"list", "member":{"shape":"GroundStationData"} }, "GroundStationName":{ "type":"string", "max":500, "min":4, "pattern":"^[ a-zA-Z0-9-._:=]{4,256}$" }, "InstanceId":{ "type":"string", "max":64, "min":10, "pattern":"^[a-z0-9-]{10,64}$" }, "InstanceType":{ "type":"string", "max":64, "min":1, "pattern":"^[a-z0-9.-]{1,64}$" }, "Integer":{ "type":"integer", "box":true }, "IntegerRange":{ "type":"structure", "required":[ "maximum", "minimum" ], "members":{ "maximum":{ "shape":"Integer", "documentation":"

A maximum value.

" }, "minimum":{ "shape":"Integer", "documentation":"

A minimum value.

" } }, "documentation":"

An integer range that has a minimum and maximum value.

" }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "parameterName":{ "shape":"String", "documentation":"

" } }, "documentation":"

One or more parameters are not valid.

", "error":{ "httpStatusCode":431, "senderFault":true }, "exception":true }, "IpAddressList":{ "type":"list", "member":{"shape":"IpV4Address"}, "max":20, "min":1 }, "IpV4Address":{ "type":"string", "max":16, "min":7, "pattern":"^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$" }, "JsonString":{ "type":"string", "max":8192, "min":2, "pattern":"^[{}\\[\\]:.,\"0-9A-z\\-_\\s]{2,8192}$" }, "KeyAliasArn":{ "type":"string", "max":512, "min":1, "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}))$" }, "KeyAliasName":{ "type":"string", "max":256, "min":1, "pattern":"^alias/[a-zA-Z0-9:/_-]+$" }, "KeyArn":{"type":"string"}, "KmsKey":{ "type":"structure", "members":{ "kmsAliasArn":{ "shape":"KeyAliasArn", "documentation":"

KMS Alias Arn.

" }, "kmsAliasName":{ "shape":"KeyAliasName", "documentation":"

KMS Alias Name.

" }, "kmsKeyArn":{ "shape":"KeyArn", "documentation":"

KMS Key Arn.

" } }, "documentation":"

AWS Key Management Service (KMS) Key.

", "union":true }, "ListConfigsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"

Maximum number of `Configs` returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

" }, "ListConfigsResponse":{ "type":"structure", "members":{ "configList":{ "shape":"ConfigList", "documentation":"

List of `Config` items.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

" } }, "documentation":"

" }, "ListContactsRequest":{ "type":"structure", "required":[ "endTime", "startTime", "statusList" ], "members":{ "endTime":{ "shape":"Timestamp", "documentation":"

End time of a contact in UTC.

" }, "groundStation":{ "shape":"GroundStationName", "documentation":"

Name of a ground station.

" }, "maxResults":{ "shape":"PaginationMaxResults", "documentation":"

Maximum number of contacts returned.

" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"

ARN of a mission profile.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"

ARN of a satellite.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

Start time of a contact in UTC.

" }, "statusList":{ "shape":"StatusList", "documentation":"

Status of a contact reservation.

" } }, "documentation":"

" }, "ListContactsResponse":{ "type":"structure", "members":{ "contactList":{ "shape":"ContactList", "documentation":"

List of contacts.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

" } }, "documentation":"

" }, "ListDataflowEndpointGroupsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"

Maximum number of dataflow endpoint groups returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

" }, "ListDataflowEndpointGroupsResponse":{ "type":"structure", "members":{ "dataflowEndpointGroupList":{ "shape":"DataflowEndpointGroupList", "documentation":"

A list of dataflow endpoint groups.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

" } }, "documentation":"

" }, "ListEphemeridesRequest":{ "type":"structure", "required":[ "endTime", "satelliteId", "startTime" ], "members":{ "endTime":{ "shape":"Timestamp", "documentation":"

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

" }, "maxResults":{ "shape":"PaginationMaxResults", "documentation":"

Maximum number of ephemerides to return.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

Pagination token.

", "location":"querystring", "locationName":"nextToken" }, "satelliteId":{ "shape":"Uuid", "documentation":"

The AWS Ground Station satellite ID to list ephemeris for.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

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":{ "shape":"EphemerisStatusList", "documentation":"

The list of ephemeris status to return.

" } } }, "ListEphemeridesResponse":{ "type":"structure", "members":{ "ephemerides":{ "shape":"EphemeridesList", "documentation":"

List of ephemerides.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

Pagination token.

" } } }, "ListGroundStationsRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"

Maximum number of ground stations returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" }, "satelliteId":{ "shape":"Uuid", "documentation":"

Satellite ID to retrieve on-boarded ground stations.

", "location":"querystring", "locationName":"satelliteId" } }, "documentation":"

" }, "ListGroundStationsResponse":{ "type":"structure", "members":{ "groundStationList":{ "shape":"GroundStationList", "documentation":"

List of ground stations.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

" } }, "documentation":"

" }, "ListMissionProfilesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"

Maximum number of mission profiles returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

" }, "ListMissionProfilesResponse":{ "type":"structure", "members":{ "missionProfileList":{ "shape":"MissionProfileList", "documentation":"

List of mission profiles.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

" } }, "documentation":"

" }, "ListSatellitesRequest":{ "type":"structure", "members":{ "maxResults":{ "shape":"PaginationMaxResults", "documentation":"

Maximum number of satellites returned.

", "location":"querystring", "locationName":"maxResults" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

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

", "location":"querystring", "locationName":"nextToken" } }, "documentation":"

" }, "ListSatellitesResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

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

" }, "satellites":{ "shape":"SatelliteList", "documentation":"

List of satellites.

" } }, "documentation":"

" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"AnyArn", "documentation":"

ARN of a resource.

", "location":"uri", "locationName":"resourceArn" } }, "documentation":"

" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a resource.

" } }, "documentation":"

" }, "Long":{ "type":"long", "box":true }, "MissionProfileArn":{"type":"string"}, "MissionProfileIdResponse":{ "type":"structure", "members":{ "missionProfileId":{ "shape":"Uuid", "documentation":"

UUID of a mission profile.

" } }, "documentation":"

" }, "MissionProfileList":{ "type":"list", "member":{"shape":"MissionProfileListItem"} }, "MissionProfileListItem":{ "type":"structure", "members":{ "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"

ARN of a mission profile.

" }, "missionProfileId":{ "shape":"Uuid", "documentation":"

UUID of a mission profile.

" }, "name":{ "shape":"SafeName", "documentation":"

Name of a mission profile.

" }, "region":{ "shape":"AWSRegion", "documentation":"

Region of a mission profile.

" } }, "documentation":"

Item in a list of mission profiles.

" }, "Month":{ "type":"integer", "box":true, "max":12, "min":1 }, "OEMEphemeris":{ "type":"structure", "members":{ "oemData":{ "shape":"UnboundedString", "documentation":"

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

" }, "s3Object":{ "shape":"S3Object", "documentation":"

Identifies the S3 object to be used as the ephemeris.

" } }, "documentation":"

Ephemeris data in Orbit Ephemeris Message (OEM) format.

" }, "PaginationMaxResults":{ "type":"integer", "box":true, "max":100, "min":0 }, "PaginationToken":{ "type":"string", "max":1000, "min":3, "pattern":"^[A-Za-z0-9-/+_.=]+$" }, "Polarization":{ "type":"string", "enum":[ "LEFT_HAND", "NONE", "RIGHT_HAND" ] }, "PositiveDurationInSeconds":{ "type":"integer", "box":true, "max":21600, "min":1 }, "RangedConnectionDetails":{ "type":"structure", "required":["socketAddress"], "members":{ "mtu":{ "shape":"RangedConnectionDetailsMtuInteger", "documentation":"

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

" }, "socketAddress":{ "shape":"RangedSocketAddress", "documentation":"

A ranged socket address.

" } }, "documentation":"

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

" }, "RangedConnectionDetailsMtuInteger":{ "type":"integer", "box":true, "max":1500, "min":1400 }, "RangedSocketAddress":{ "type":"structure", "required":[ "name", "portRange" ], "members":{ "name":{ "shape":"IpV4Address", "documentation":"

IPv4 socket address.

" }, "portRange":{ "shape":"IntegerRange", "documentation":"

Port range of a socket address.

" } }, "documentation":"

A socket address with a port range.

" }, "RegisterAgentRequest":{ "type":"structure", "required":[ "agentDetails", "discoveryData" ], "members":{ "agentDetails":{ "shape":"AgentDetails", "documentation":"

Detailed information about the agent being registered.

" }, "discoveryData":{ "shape":"DiscoveryData", "documentation":"

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

" } } }, "RegisterAgentResponse":{ "type":"structure", "members":{ "agentId":{ "shape":"Uuid", "documentation":"

UUID of registered agent.

" } } }, "ReserveContactRequest":{ "type":"structure", "required":[ "endTime", "groundStation", "missionProfileArn", "satelliteArn", "startTime" ], "members":{ "endTime":{ "shape":"Timestamp", "documentation":"

End time of a contact in UTC.

" }, "groundStation":{ "shape":"GroundStationName", "documentation":"

Name of a ground station.

" }, "missionProfileArn":{ "shape":"MissionProfileArn", "documentation":"

ARN of a mission profile.

" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"

ARN of a satellite

" }, "startTime":{ "shape":"Timestamp", "documentation":"

Start time of a contact in UTC.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a contact.

" } }, "documentation":"

" }, "ResourceLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "parameterName":{ "shape":"String", "documentation":"

" } }, "documentation":"

Account limits for this resource have been exceeded.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

Resource was not found.

", "error":{ "httpStatusCode":434, "senderFault":true }, "exception":true }, "RoleArn":{"type":"string"}, "S3BucketName":{ "type":"string", "max":63, "min":3, "pattern":"^[a-z0-9.-]{3,63}$" }, "S3KeyPrefix":{ "type":"string", "max":900, "min":1, "pattern":"^([a-zA-Z0-9_\\-=/]|\\{satellite_id\\}|\\{config\\-name}|\\{s3\\-config-id}|\\{year\\}|\\{month\\}|\\{day\\}){1,900}$" }, "S3Object":{ "type":"structure", "members":{ "bucket":{ "shape":"S3BucketName", "documentation":"

An Amazon S3 Bucket name.

" }, "key":{ "shape":"S3ObjectKey", "documentation":"

An Amazon S3 key for the ephemeris.

" }, "version":{ "shape":"S3VersionId", "documentation":"

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

" } }, "documentation":"

Object stored in S3 containing ephemeris data.

" }, "S3ObjectKey":{ "type":"string", "max":1024, "min":1, "pattern":"^[a-zA-Z0-9!*'\\)\\(./_-]{1,1024}$" }, "S3RecordingConfig":{ "type":"structure", "required":[ "bucketArn", "roleArn" ], "members":{ "bucketArn":{ "shape":"BucketArn", "documentation":"

ARN of the bucket to record to.

" }, "prefix":{ "shape":"S3KeyPrefix", "documentation":"

S3 Key prefix to prefice data files.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

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

" } }, "documentation":"

Information about an S3 recording `Config`.

" }, "S3RecordingDetails":{ "type":"structure", "members":{ "bucketArn":{ "shape":"BucketArn", "documentation":"

ARN of the bucket used.

" }, "keyTemplate":{ "shape":"String", "documentation":"

Key template used for the S3 Recording Configuration

" } }, "documentation":"

Details about an S3 recording `Config` used in a contact.

" }, "S3VersionId":{ "type":"string", "max":1024, "min":1, "pattern":"^[\\s\\S]{1,1024}$" }, "SafeName":{ "type":"string", "max":256, "min":1, "pattern":"^[ a-zA-Z0-9_:-]{1,256}$" }, "SatelliteList":{ "type":"list", "member":{"shape":"SatelliteListItem"} }, "SatelliteListItem":{ "type":"structure", "members":{ "currentEphemeris":{ "shape":"EphemerisMetaData", "documentation":"

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

" }, "groundStations":{ "shape":"GroundStationIdList", "documentation":"

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

" }, "noradSatelliteID":{ "shape":"noradSatelliteID", "documentation":"

NORAD satellite ID number.

" }, "satelliteArn":{ "shape":"satelliteArn", "documentation":"

ARN of a satellite.

" }, "satelliteId":{ "shape":"Uuid", "documentation":"

UUID of a satellite.

" } }, "documentation":"

Item in a list of satellites.

" }, "SecurityDetails":{ "type":"structure", "required":[ "roleArn", "securityGroupIds", "subnetIds" ], "members":{ "roleArn":{ "shape":"RoleArn", "documentation":"

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

" }, "securityGroupIds":{ "shape":"SecurityGroupIdList", "documentation":"

The security groups to attach to the elastic network interfaces.

" }, "subnetIds":{ "shape":"SubnetList", "documentation":"

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

" } }, "documentation":"

Information about endpoints.

" }, "SecurityGroupIdList":{ "type":"list", "member":{"shape":"String"} }, "SignatureMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Boolean"} }, "SocketAddress":{ "type":"structure", "required":[ "name", "port" ], "members":{ "name":{ "shape":"String", "documentation":"

Name of a socket address.

" }, "port":{ "shape":"Integer", "documentation":"

Port of a socket address.

" } }, "documentation":"

Information about the socket address.

" }, "Source":{ "type":"structure", "members":{ "configDetails":{ "shape":"ConfigDetails", "documentation":"

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

" }, "configId":{ "shape":"String", "documentation":"

UUID of a `Config`.

" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

" }, "dataflowSourceRegion":{ "shape":"String", "documentation":"

Region of a dataflow source.

" } }, "documentation":"

Dataflow details for the source side.

" }, "SpectrumConfig":{ "type":"structure", "required":[ "bandwidth", "centerFrequency" ], "members":{ "bandwidth":{ "shape":"FrequencyBandwidth", "documentation":"

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

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

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

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

" }, "centerFrequency":{ "shape":"Frequency", "documentation":"

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

" }, "polarization":{ "shape":"Polarization", "documentation":"

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

" } }, "documentation":"

Object that describes a spectral `Config`.

" }, "StatusList":{ "type":"list", "member":{"shape":"ContactStatus"}, "max":500, "min":0 }, "String":{"type":"string"}, "SubnetList":{ "type":"list", "member":{"shape":"String"} }, "TLEData":{ "type":"structure", "required":[ "tleLine1", "tleLine2", "validTimeRange" ], "members":{ "tleLine1":{ "shape":"TleLineOne", "documentation":"

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

" }, "tleLine2":{ "shape":"TleLineTwo", "documentation":"

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

" }, "validTimeRange":{ "shape":"TimeRange", "documentation":"

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

" } }, "documentation":"

Two-line element set (TLE) data.

" }, "TLEDataList":{ "type":"list", "member":{"shape":"TLEData"}, "max":500, "min":1 }, "TLEEphemeris":{ "type":"structure", "members":{ "s3Object":{ "shape":"S3Object", "documentation":"

Identifies the S3 object to be used as the ephemeris.

" }, "tleData":{ "shape":"TLEDataList", "documentation":"

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

" } }, "documentation":"

Two-line element set (TLE) ephemeris.

" }, "TagKeys":{ "type":"list", "member":{"shape":"UnboundedString"}, "max":500, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"AnyArn", "documentation":"

ARN of a resource tag.

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagsMap", "documentation":"

Tags assigned to a resource.

" } }, "documentation":"

" }, "TagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "TagsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "TimeRange":{ "type":"structure", "required":[ "endTime", "startTime" ], "members":{ "endTime":{ "shape":"Timestamp", "documentation":"

Time in UTC at which the time range ends.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

Time in UTC at which the time range starts.

" } }, "documentation":"

A time range with a start and end time.

" }, "Timestamp":{"type":"timestamp"}, "TleLineOne":{ "type":"string", "max":69, "min":69, "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]$" }, "TleLineTwo":{ "type":"string", "max":69, "min":69, "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]$" }, "TrackingConfig":{ "type":"structure", "required":["autotrack"], "members":{ "autotrack":{ "shape":"Criticality", "documentation":"

Current setting for autotrack.

" } }, "documentation":"

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

" }, "UnboundedString":{ "type":"string", "min":1, "pattern":"^[\\s\\S]+$" }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"AnyArn", "documentation":"

ARN of a resource.

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeys", "documentation":"

Keys of a resource tag.

", "location":"querystring", "locationName":"tagKeys" } }, "documentation":"

" }, "UntagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "UpdateAgentStatusRequest":{ "type":"structure", "required":[ "agentId", "aggregateStatus", "componentStatuses", "taskId" ], "members":{ "agentId":{ "shape":"Uuid", "documentation":"

UUID of agent to update.

", "location":"uri", "locationName":"agentId" }, "aggregateStatus":{ "shape":"AggregateStatus", "documentation":"

Aggregate status for agent.

" }, "componentStatuses":{ "shape":"ComponentStatusList", "documentation":"

List of component statuses for agent.

" }, "taskId":{ "shape":"Uuid", "documentation":"

GUID of agent task.

" } } }, "UpdateAgentStatusResponse":{ "type":"structure", "required":["agentId"], "members":{ "agentId":{ "shape":"Uuid", "documentation":"

UUID of updated agent.

" } } }, "UpdateConfigRequest":{ "type":"structure", "required":[ "configData", "configId", "configType", "name" ], "members":{ "configData":{ "shape":"ConfigTypeData", "documentation":"

Parameters of a `Config`.

" }, "configId":{ "shape":"Uuid", "documentation":"

UUID of a `Config`.

", "location":"uri", "locationName":"configId" }, "configType":{ "shape":"ConfigCapabilityType", "documentation":"

Type of a `Config`.

", "location":"uri", "locationName":"configType" }, "name":{ "shape":"SafeName", "documentation":"

Name of a `Config`.

" } }, "documentation":"

" }, "UpdateEphemerisRequest":{ "type":"structure", "required":[ "enabled", "ephemerisId" ], "members":{ "enabled":{ "shape":"Boolean", "documentation":"

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

" }, "ephemerisId":{ "shape":"Uuid", "documentation":"

The AWS Ground Station ephemeris ID.

", "location":"uri", "locationName":"ephemerisId" }, "name":{ "shape":"SafeName", "documentation":"

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

" }, "priority":{ "shape":"EphemerisPriority", "documentation":"

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":"structure", "required":["missionProfileId"], "members":{ "contactPostPassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"

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

" }, "contactPrePassDurationSeconds":{ "shape":"DurationInSeconds", "documentation":"

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

" }, "dataflowEdges":{ "shape":"DataflowEdgeList", "documentation":"

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

" }, "minimumViableContactDurationSeconds":{ "shape":"PositiveDurationInSeconds", "documentation":"

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

" }, "missionProfileId":{ "shape":"Uuid", "documentation":"

UUID of a mission profile.

", "location":"uri", "locationName":"missionProfileId" }, "name":{ "shape":"SafeName", "documentation":"

Name of a mission profile.

" }, "streamsKmsKey":{ "shape":"KmsKey", "documentation":"

KMS key to use for encrypting streams.

" }, "streamsKmsRole":{ "shape":"RoleArn", "documentation":"

Role to use for encrypting streams with KMS key.

" }, "trackingConfigArn":{ "shape":"ConfigArn", "documentation":"

ARN of a tracking `Config`.

" } }, "documentation":"

" }, "UplinkEchoConfig":{ "type":"structure", "required":[ "antennaUplinkConfigArn", "enabled" ], "members":{ "antennaUplinkConfigArn":{ "shape":"ConfigArn", "documentation":"

ARN of an uplink `Config`.

" }, "enabled":{ "shape":"Boolean", "documentation":"

Whether or not an uplink `Config` is enabled.

" } }, "documentation":"

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.

" }, "UplinkSpectrumConfig":{ "type":"structure", "required":["centerFrequency"], "members":{ "centerFrequency":{ "shape":"Frequency", "documentation":"

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

" }, "polarization":{ "shape":"Polarization", "documentation":"

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

" } }, "documentation":"

Information about the uplink spectral `Config`.

" }, "Uuid":{ "type":"string", "max":128, "min":1, "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "VersionString":{ "type":"string", "max":64, "min":1, "pattern":"^(0|[1-9]\\d*)(\\.(0|[1-9]\\d*))*$" }, "VersionStringList":{ "type":"list", "member":{"shape":"VersionString"}, "max":20, "min":1 }, "Year":{ "type":"integer", "box":true, "max":3000, "min":2018 }, "noradSatelliteID":{ "type":"integer", "max":99999, "min":0 }, "satelliteArn":{"type":"string"} }, "documentation":"

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.

" }