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

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

", "operations": { "CancelContact": { "name": "CancelContact", "http": { "method": "DELETE", "requestUri": "/contact/{contactId}", "responseCode": 200 }, "input": { "shape": "CancelContactRequest" }, "output": { "shape": "ContactIdResponse" }, "errors": [ { "shape": "DependencyException" }, { "shape": "InvalidParameterException" }, { "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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Creates a Config with the specified configData parameters.

\n

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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

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

\n

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

\n

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

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

Creates a mission profile.

\n

\n dataflowEdges is a list of lists of strings. Each lower level list of strings\n 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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Deletes a dataflow endpoint group.

", "idempotent": true }, "DeleteMissionProfile": { "name": "DeleteMissionProfile", "http": { "method": "DELETE", "requestUri": "/missionprofile/{missionProfileId}", "responseCode": 200 }, "input": { "shape": "DeleteMissionProfileRequest" }, "output": { "shape": "MissionProfileIdResponse" }, "errors": [ { "shape": "DependencyException" }, { "shape": "InvalidParameterException" }, { "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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Describes an existing contact.

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

Returns Config information.

\n

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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Returns the dataflow endpoint group.

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

Returns a mission profile.

" }, "ListConfigs": { "name": "ListConfigs", "http": { "method": "GET", "requestUri": "/config", "responseCode": 200 }, "input": { "shape": "ListConfigsRequest" }, "output": { "shape": "ListConfigsResponse" }, "errors": [ { "shape": "DependencyException" }, { "shape": "InvalidParameterException" }, { "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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Returns a list of contacts.

\n

If statusList contains AVAILABLE, the request must include\n groundstation, missionprofileArn, and satelliteArn.\n

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

Returns a list of DataflowEndpoint groups.

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

Returns a list of mission profiles.

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

Reserves a contact using specified parameters.

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

Updates the Config used when scheduling contacts.

\n

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

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

Updates a mission profile.

\n

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

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

Returns the number of minutes used by account.

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

Returns a satellite.

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

Returns a list of ground stations.

" }, "ListSatellites": { "name": "ListSatellites", "http": { "method": "GET", "requestUri": "/satellite", "responseCode": 200 }, "input": { "shape": "ListSatellitesRequest" }, "output": { "shape": "ListSatellitesResponse" }, "errors": [ { "shape": "DependencyException" }, { "shape": "InvalidParameterException" }, { "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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Returns a list of tags or a specified resource.

" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/tags/{resourceArn}", "responseCode": 200 }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "DependencyException" }, { "shape": "InvalidParameterException" }, { "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": "DependencyException" }, { "shape": "InvalidParameterException" }, { "shape": "ResourceNotFoundException" } ], "documentation": "

Deassigns a resource tag.

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

Parameters for a Config.

" }, "configId": { "shape": "String", "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": "

" }, "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 configure an antenna for downlink demod decode during a contact.

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

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

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

Information about the dataflow endpoint 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.

\n

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

" } }, "documentation": "

Object containing the parameters for a Config.

\n

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

" }, "noradSatelliteID": { "type": "integer", "min": 1, "max": 99999 }, "GroundStationData": { "type": "structure", "members": { "groundStationId": { "shape": "String", "documentation": "

ID of a ground station.

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

Name of a ground station.

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

Ground station Region.

" } }, "documentation": "

Information about the ground station data.

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

UUID of a Config.

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

Type of a Config.

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

" }, "GroundStationList": { "type": "list", "member": { "shape": "GroundStationData" } }, "SecurityGroupIdList": { "type": "list", "member": { "shape": "String" } }, "EndpointDetails": { "type": "structure", "members": { "endpoint": { "shape": "DataflowEndpoint", "documentation": "

A dataflow endpoint.

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

Endpoint security details.

" } }, "documentation": "

Information about the endpoint details.

" }, "DataflowEndpointGroupArn": { "type": "string" }, "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": "

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

ARN of a mission profile.

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

ID of a mission profile.

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

Name of a mission profile.

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

Region of a mission profile.

" } }, "documentation": "

Item in a list of mission profiles.

" }, "SatelliteList": { "type": "list", "member": { "shape": "SatelliteListItem" } }, "ListDataflowEndpointGroupsResponse": { "type": "structure", "members": { "dataflowEndpointGroupList": { "shape": "DataflowEndpointGroupList", "documentation": "

A list of dataflow endpoint groups.

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

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

" } }, "documentation": "

" }, "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 configure an antenna for downlink demod decode during a contact.

" }, "MissionProfileIdResponse": { "type": "structure", "members": { "missionProfileId": { "shape": "String", "documentation": "

ID of a mission profile.

" } }, "documentation": "

" }, "SubnetList": { "type": "list", "member": { "shape": "String" } }, "Polarization": { "type": "string", "enum": [ "LEFT_HAND", "NONE", "RIGHT_HAND" ] }, "ConfigList": { "type": "list", "member": { "shape": "ConfigListItem" } }, "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.

" } }, "documentation": "

Information about the uplink Config of an antenna.

" }, "Integer": { "type": "integer", "box": true }, "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\n antenna for downlink during a contact.

" }, "Boolean": { "type": "boolean", "box": true }, "EndpointStatus": { "type": "string", "enum": [ "created", "creating", "deleted", "deleting", "failed" ] }, "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.

\n

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

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

Unvalidated JSON of a decode Config.

" } }, "documentation": "

Information about the decode Config.

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

ID of a dataflow endpoint group.

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

" }, "ContactStatus": { "type": "string", "enum": [ "AVAILABLE", "AWS_CANCELLED", "CANCELLED", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE", "PASS", "POSTPASS", "PREPASS", "SCHEDULED", "SCHEDULING" ] }, "MissionProfileList": { "type": "list", "member": { "shape": "MissionProfileListItem" } }, "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": "

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

Frequency units.

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

Frequency value.

" } }, "documentation": "

Object that describes the frequency.

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

" }, "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": "

" }, "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.

" }, "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\n executed with this Config in the mission profile.

" }, "CreateDataflowEndpointGroupRequest": { "type": "structure", "required": [ "endpointDetails" ], "members": { "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": "

" }, "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.

" }, "JsonString": { "type": "string", "min": 2, "max": 8192 }, "GetSatelliteRequest": { "type": "structure", "required": [ "satelliteId" ], "members": { "satelliteId": { "shape": "String", "documentation": "

UUID of a satellite.

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

" }, "CancelContactRequest": { "type": "structure", "required": [ "contactId" ], "members": { "contactId": { "shape": "String", "documentation": "

UUID of a contact.

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

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

Center frequency of an uplink spectral Config.

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

Polarization of an uplink spectral Config.

" } }, "documentation": "

Information about the uplink spectral Config.

" }, "UntagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tagKeys" ], "members": { "resourceArn": { "shape": "String", "documentation": "

ARN of a resource.

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

Keys of a resource tag.

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

" }, "satelliteArn": { "type": "string" }, "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 \n Config.

" }, "minimumViableContactDurationSeconds": { "shape": "DurationInSeconds", "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": "String", "documentation": "

ID of a mission profile.

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

Name of a mission profile.

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

Region of a mission profile.

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

Tags assigned to a mission profile.

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

ARN of a tracking Config.

" } }, "documentation": "

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

UUID of a contact.

" } }, "documentation": "

" }, "EndpointDetailsList": { "type": "list", "member": { "shape": "EndpointDetails" } }, "ListGroundStationsRequest": { "type": "structure", "members": { "maxResults": { "shape": "Integer", "documentation": "

Maximum number of ground stations returned.

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

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

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

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

" } }, "documentation": "

One or more parameters are not valid.

", "exception": true, "error": { "code": "InvalidParameterException", "httpStatusCode": 431, "senderFault": true } }, "DependencyException": { "type": "structure", "members": { "message": { "shape": "String" }, "parameterName": { "shape": "String", "documentation": "

" } }, "documentation": "

Dependency encountered an error.

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

UUID of a contact.

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

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

Resource was not found.

", "exception": true, "error": { "code": "ResourceNotFoundException", "httpStatusCode": 434, "senderFault": true } }, "Timestamp": { "type": "timestamp" }, "DeleteConfigRequest": { "type": "structure", "required": [ "configId", "configType" ], "members": { "configId": { "shape": "String", "documentation": "

UUID of a Config.

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

Type of a Config.

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

" }, "BandwidthUnits": { "type": "string", "enum": [ "GHz", "MHz", "kHz" ] }, "SpectrumConfig": { "type": "structure", "required": [ "bandwidth", "centerFrequency" ], "members": { "bandwidth": { "shape": "FrequencyBandwidth", "documentation": "

Bandwidth of a spectral Config.

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

Center frequency of a spectral Config.

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

Polarization of a spectral Config.

" } }, "documentation": "

Object that describes a spectral Config.

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

Unvalidated JSON of a demodulation Config.

" } }, "documentation": "

Information about the demodulation Config.

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

List of mission profiles

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

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

" } }, "documentation": "

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

List of Config items.

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

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

" } }, "documentation": "

" }, "DataflowEdge": { "type": "list", "member": { "shape": "ConfigArn" }, "min": 2, "max": 2 }, "SafeName": { "type": "string", "min": 1, "max": 256, "pattern": "^[ a-zA-Z0-9_:-]+$" }, "Eirp": { "type": "structure", "required": [ "units", "value" ], "members": { "units": { "shape": "EirpUnits", "documentation": "

Units of an EIRP.

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

Value of an EIRP.

" } }, "documentation": "

Object that represents EIRP.

" }, "RoleArn": { "type": "string" }, "ListMissionProfilesRequest": { "type": "structure", "members": { "maxResults": { "shape": "Integer", "documentation": "

Maximum number of mission profiles returned.

", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "String", "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": "

" }, "GetSatelliteResponse": { "type": "structure", "members": { "dateCreated": { "shape": "Timestamp", "documentation": "

When a satellite was created.

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

When a satellite was last updated.

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

NORAD satellite ID number.

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

ARN of a satellite.

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

UUID of a satellite.

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

Tags assigned to a satellite.

" } }, "documentation": "

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

End time of a contact.

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

Name of a ground station.

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

Maximum number of contacts returned.

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

ARN of a mission profile.

" }, "nextToken": { "shape": "String", "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.

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

Status of a contact reservation.

" } }, "documentation": "

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

UUID of a contact.

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

Status of a contact.

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

End time of a contact.

" }, "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.

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

ARN of a satellite.

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

Start time of a contact.

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

Tags assigned to a contact.

" } }, "documentation": "

Data describing a contact.

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

List of ground stations.

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

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

" } }, "documentation": "

" }, "DataflowEndpoint": { "type": "structure", "members": { "address": { "shape": "SocketAddress", "documentation": "

Socket address 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.

" }, "ListConfigsRequest": { "type": "structure", "members": { "maxResults": { "shape": "Integer", "documentation": "

Maximum number of Configs returned.

", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "String", "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": "

" }, "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.

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

ARN of a Config\n

" }, "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": "

" }, "TagsMap": { "type": "map", "key": { "shape": "String" }, "value": { "shape": "String" } }, "TagResourceResponse": { "type": "structure", "members": { }, "documentation": "

" }, "DeleteMissionProfileRequest": { "type": "structure", "required": [ "missionProfileId" ], "members": { "missionProfileId": { "shape": "String", "documentation": "

UUID of a mission profile.

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

" }, "DataflowEndpointGroupList": { "type": "list", "member": { "shape": "DataflowEndpointListItem" } }, "ContactList": { "type": "list", "member": { "shape": "ContactData" } }, "DurationInSeconds": { "type": "integer", "min": 1, "max": 21600 }, "SatelliteListItem": { "type": "structure", "members": { "noradSatelliteID": { "shape": "noradSatelliteID", "documentation": "

NORAD satellite ID number.

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

ARN of a satellite.

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

ID of a satellite.

" } }, "documentation": "

Item in a list of satellites.

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

UUID of a mission profile.

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

" }, "Double": { "type": "double", "box": true }, "ListSatellitesResponse": { "type": "structure", "members": { "nextToken": { "shape": "String", "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": "

" }, "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 \n Config.

" }, "minimumViableContactDurationSeconds": { "shape": "DurationInSeconds", "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.

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

Tags assigned to a mission profile.

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

ARN of a tracking Config.

" } }, "documentation": "

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

End time of a contact.

" }, "groundStation": { "shape": "String", "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.

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

Tags assigned to a contact.

" } }, "documentation": "

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

Name of a dataflow endpoint.

" } }, "documentation": "

Information about the dataflow endpoint Config.

" }, "Uuid": { "type": "string", "min": 1, "max": 128, "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" }, "ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "shape": "TagsMap", "documentation": "

Tags assigned to a resource.

" } }, "documentation": "

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

List of contacts.

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

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

" } }, "documentation": "

" }, "DataflowEdgeList": { "type": "list", "member": { "shape": "DataflowEdge" } }, "DescribeContactResponse": { "type": "structure", "members": { "contactId": { "shape": "String", "documentation": "

UUID of a contact.

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

Status of a contact.

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

End time of a contact.

" }, "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.

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

ARN of a satellite.

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

Start time of a contact.

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

Tags assigned to a contact.

" } }, "documentation": "

" }, "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.

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

ARN of a resource.

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

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

Maximum number of dataflow endpoint groups returned.

", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "String", "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": "

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

Frequency bandwidth units.

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

Frequency bandwidth value.

" } }, "documentation": "

Object that describes the frequency bandwidth.

" }, "String": { "type": "string" }, "ListSatellitesRequest": { "type": "structure", "members": { "maxResults": { "shape": "Integer", "documentation": "

Maximum number of satellites returned.

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

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

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

" }, "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 \n Config.

" }, "minimumViableContactDurationSeconds": { "shape": "DurationInSeconds", "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": "String", "documentation": "

ID of a mission profile.

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

Name of a mission profile.

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

ARN of a tracking Config.

" } }, "documentation": "

" }, "FrequencyUnits": { "type": "string", "enum": [ "GHz", "MHz", "kHz" ] }, "TagResourceRequest": { "type": "structure", "required": [ "resourceArn" ], "members": { "resourceArn": { "shape": "String", "documentation": "

ARN of a resource tag.

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

Tags assigned to a resource.

" } }, "documentation": "

" }, "Criticality": { "type": "string", "enum": [ "PREFERRED", "REMOVED", "REQUIRED" ] }, "ConfigCapabilityType": { "type": "string", "enum": [ "antenna-downlink", "antenna-downlink-demod-decode", "antenna-uplink", "dataflow-endpoint", "tracking", "uplink-echo" ] }, "TagKeys": { "type": "list", "member": { "shape": "String" } }, "AngleUnits": { "type": "string", "enum": [ "DEGREE_ANGLE", "RADIAN" ] }, "DataflowEndpointListItem": { "type": "structure", "members": { "dataflowEndpointGroupArn": { "shape": "DataflowEndpointGroupArn", "documentation": "

ARN of a dataflow endpoint group.

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

UUID of a dataflow endpoint group.

" } }, "documentation": "

Item in a list of DataflowEndpoint groups.

" }, "GetDataflowEndpointGroupResponse": { "type": "structure", "members": { "dataflowEndpointGroupArn": { "shape": "DataflowEndpointGroupArn", "documentation": "

ARN of a dataflow endpoint group.

" }, "dataflowEndpointGroupId": { "shape": "String", "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": "

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

UUID of a dataflow endpoint group.

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

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

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

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

The year being requested, in the format of YYYY.

" } }, "documentation": "

" }, "DataflowEndpointGroupIdResponse": { "type": "structure", "members": { "dataflowEndpointGroupId": { "shape": "String", "documentation": "

ID of a dataflow endpoint group.

" } }, "documentation": "

" }, "EirpUnits": { "type": "string", "enum": [ "dBW" ] } } }