# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [CancelContact](API_CancelContact.md) 
+  [CreateConfig](API_CreateConfig.md) 
+  [CreateDataflowEndpointGroup](API_CreateDataflowEndpointGroup.md) 
+  [CreateDataflowEndpointGroupV2](API_CreateDataflowEndpointGroupV2.md) 
+  [CreateEphemeris](API_CreateEphemeris.md) 
+  [CreateMissionProfile](API_CreateMissionProfile.md) 
+  [DeleteConfig](API_DeleteConfig.md) 
+  [DeleteDataflowEndpointGroup](API_DeleteDataflowEndpointGroup.md) 
+  [DeleteEphemeris](API_DeleteEphemeris.md) 
+  [DeleteMissionProfile](API_DeleteMissionProfile.md) 
+  [DescribeContact](API_DescribeContact.md) 
+  [DescribeContactVersion](API_DescribeContactVersion.md) 
+  [DescribeEphemeris](API_DescribeEphemeris.md) 
+  [GetAgentConfiguration](API_GetAgentConfiguration.md) 
+  [GetAgentTaskResponseUrl](API_GetAgentTaskResponseUrl.md) 
+  [GetConfig](API_GetConfig.md) 
+  [GetDataflowEndpointGroup](API_GetDataflowEndpointGroup.md) 
+  [GetMinuteUsage](API_GetMinuteUsage.md) 
+  [GetMissionProfile](API_GetMissionProfile.md) 
+  [GetSatellite](API_GetSatellite.md) 
+  [ListAntennas](API_ListAntennas.md) 
+  [ListConfigs](API_ListConfigs.md) 
+  [ListContacts](API_ListContacts.md) 
+  [ListContactVersions](API_ListContactVersions.md) 
+  [ListDataflowEndpointGroups](API_ListDataflowEndpointGroups.md) 
+  [ListEphemerides](API_ListEphemerides.md) 
+  [ListGroundStationReservations](API_ListGroundStationReservations.md) 
+  [ListGroundStations](API_ListGroundStations.md) 
+  [ListMissionProfiles](API_ListMissionProfiles.md) 
+  [ListSatellites](API_ListSatellites.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [RegisterAgent](API_RegisterAgent.md) 
+  [ReserveContact](API_ReserveContact.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAgentStatus](API_UpdateAgentStatus.md) 
+  [UpdateConfig](API_UpdateConfig.md) 
+  [UpdateContact](API_UpdateContact.md) 
+  [UpdateEphemeris](API_UpdateEphemeris.md) 
+  [UpdateMissionProfile](API_UpdateMissionProfile.md) 

# CancelContact
<a name="API_CancelContact"></a>

Cancels or stops a contact with a specified contact ID based on its position in the [contact lifecycle](https://docs.aws.amazon.com/ground-station/latest/ug/contacts.lifecycle.html).

For contacts that:
+ Have yet to start, the contact will be cancelled.
+ Have started but have yet to finish, the contact will be stopped.

## Request Syntax
<a name="API_CancelContact_RequestSyntax"></a>

```
DELETE /contact/contactId HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contactId](#API_CancelContact_RequestSyntax) **   <a name="groundstation-CancelContact-request-uri-contactId"></a>
UUID of a contact.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_CancelContact_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactId": "string",
   "versionId": number
}
```

## Response Elements
<a name="API_CancelContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactId](#API_CancelContact_ResponseSyntax) **   <a name="groundstation-CancelContact-response-contactId"></a>
UUID of a contact.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [versionId](#API_CancelContact_ResponseSyntax) **   <a name="groundstation-CancelContact-response-versionId"></a>
Version ID of a contact.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 128.

## Errors
<a name="API_CancelContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_CancelContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/CancelContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/CancelContact) 

# CreateConfig
<a name="API_CreateConfig"></a>

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

Only one type of `configData` can be specified.

## Request Syntax
<a name="API_CreateConfig_RequestSyntax"></a>

```
POST /config HTTP/1.1
Content-type: application/json

{
   "configData": { ... },
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateConfig_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configData](#API_CreateConfig_RequestSyntax) **   <a name="groundstation-CreateConfig-request-configData"></a>
Parameters of a `Config`.  
Type: [ConfigTypeData](API_ConfigTypeData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [name](#API_CreateConfig_RequestSyntax) **   <a name="groundstation-CreateConfig-request-name"></a>
Name of a `Config`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

 ** [tags](#API_CreateConfig_RequestSyntax) **   <a name="groundstation-CreateConfig-request-tags"></a>
Tags assigned to a `Config`.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configArn": "string",
   "configId": "string",
   "configType": "string"
}
```

## Response Elements
<a name="API_CreateConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configArn](#API_CreateConfig_ResponseSyntax) **   <a name="groundstation-CreateConfig-response-configArn"></a>
ARN of a `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?` 

 ** [configId](#API_CreateConfig_ResponseSyntax) **   <a name="groundstation-CreateConfig-response-configId"></a>
UUID of a `Config`.  
Type: String

 ** [configType](#API_CreateConfig_ResponseSyntax) **   <a name="groundstation-CreateConfig-response-configType"></a>
Type of a `Config`.  
Type: String  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink` 

## Errors
<a name="API_CreateConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceLimitExceededException **   
Account limits for this resource have been exceeded.    
 ** parameterName **   
Name of the parameter that exceeded the resource limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_CreateConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/CreateConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/CreateConfig) 

# CreateDataflowEndpointGroup
<a name="API_CreateDataflowEndpointGroup"></a>

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.

## Request Syntax
<a name="API_CreateDataflowEndpointGroup_RequestSyntax"></a>

```
POST /dataflowEndpointGroup HTTP/1.1
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "endpointDetails": [ 
      { 
         "awsGroundStationAgentEndpoint": { 
            "agentStatus": "string",
            "auditResults": "string",
            "egressAddress": { 
               "mtu": number,
               "socketAddress": { 
                  "name": "string",
                  "port": number
               }
            },
            "ingressAddress": { 
               "mtu": number,
               "socketAddress": { 
                  "name": "string",
                  "portRange": { 
                     "maximum": number,
                     "minimum": number
                  }
               }
            },
            "name": "string"
         },
         "downlinkAwsGroundStationAgentEndpoint": { 
            "agentStatus": "string",
            "auditResults": "string",
            "dataflowDetails": { ... },
            "name": "string"
         },
         "endpoint": { 
            "address": { 
               "name": "string",
               "port": number
            },
            "mtu": number,
            "name": "string",
            "status": "string"
         },
         "healthReasons": [ "string" ],
         "healthStatus": "string",
         "securityDetails": { 
            "roleArn": "string",
            "securityGroupIds": [ "string" ],
            "subnetIds": [ "string" ]
         },
         "uplinkAwsGroundStationAgentEndpoint": { 
            "agentStatus": "string",
            "auditResults": "string",
            "dataflowDetails": { ... },
            "name": "string"
         }
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDataflowEndpointGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDataflowEndpointGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contactPostPassDurationSeconds](#API_CreateDataflowEndpointGroup_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroup-request-contactPostPassDurationSeconds"></a>
 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](https://docs.aws.amazon.com/ground-station/latest/ug/monitoring.automating-events.html) will be emitted when the Dataflow Endpoint Group enters and exits the `POSTPASS` state.   
Type: Integer  
Valid Range: Minimum value of 30. Maximum value of 480.  
Required: No

 ** [contactPrePassDurationSeconds](#API_CreateDataflowEndpointGroup_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroup-request-contactPrePassDurationSeconds"></a>
 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](https://docs.aws.amazon.com/ground-station/latest/ug/monitoring.automating-events.html) will be emitted when the Dataflow Endpoint Group enters and exits the `PREPASS` state.   
Type: Integer  
Valid Range: Minimum value of 30. Maximum value of 480.  
Required: No

 ** [endpointDetails](#API_CreateDataflowEndpointGroup_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroup-request-endpointDetails"></a>
Endpoint details of each endpoint in the dataflow endpoint group. All dataflow endpoints within a single dataflow endpoint group must be of the same type. You cannot mix [ AWS Ground Station Agent endpoints](https://docs.aws.amazon.com/ground-station/latest/APIReference/API_AwsGroundStationAgentEndpoint.html) with [Dataflow endpoints](https://docs.aws.amazon.com/ground-station/latest/APIReference/API_DataflowEndpoint.html) in the same group. If your use case requires both types of endpoints, you must create separate dataflow endpoint groups for each type.   
Type: Array of [EndpointDetails](API_EndpointDetails.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Required: Yes

 ** [tags](#API_CreateDataflowEndpointGroup_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroup-request-tags"></a>
Tags of a dataflow endpoint group.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateDataflowEndpointGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataflowEndpointGroupId": "string"
}
```

## Response Elements
<a name="API_CreateDataflowEndpointGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dataflowEndpointGroupId](#API_CreateDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-CreateDataflowEndpointGroup-response-dataflowEndpointGroupId"></a>
UUID of a dataflow endpoint group.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_CreateDataflowEndpointGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_CreateDataflowEndpointGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/CreateDataflowEndpointGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/CreateDataflowEndpointGroup) 

# CreateDataflowEndpointGroupV2
<a name="API_CreateDataflowEndpointGroupV2"></a>

Creates a `DataflowEndpoint` group containing the specified list of Ground Station Agent based endpoints.

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.

## Request Syntax
<a name="API_CreateDataflowEndpointGroupV2_RequestSyntax"></a>

```
POST /dataflowEndpointGroupV2 HTTP/1.1
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "endpoints": [ 
      { ... }
   ],
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDataflowEndpointGroupV2_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDataflowEndpointGroupV2_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contactPostPassDurationSeconds](#API_CreateDataflowEndpointGroupV2_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroupV2-request-contactPostPassDurationSeconds"></a>
 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](https://docs.aws.amazon.com/ground-station/latest/ug/monitoring.automating-events.html) will be emitted when the Dataflow Endpoint Group enters and exits the `POSTPASS` state.   
Type: Integer  
Valid Range: Minimum value of 30. Maximum value of 480.  
Required: No

 ** [contactPrePassDurationSeconds](#API_CreateDataflowEndpointGroupV2_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroupV2-request-contactPrePassDurationSeconds"></a>
 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](https://docs.aws.amazon.com/ground-station/latest/ug/monitoring.automating-events.html) will be emitted when the Dataflow Endpoint Group enters and exits the `PREPASS` state.   
Type: Integer  
Valid Range: Minimum value of 30. Maximum value of 480.  
Required: No

 ** [endpoints](#API_CreateDataflowEndpointGroupV2_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroupV2-request-endpoints"></a>
Dataflow endpoint group's endpoint definitions  
Type: Array of [CreateEndpointDetails](API_CreateEndpointDetails.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 12 items.  
Required: Yes

 ** [tags](#API_CreateDataflowEndpointGroupV2_RequestSyntax) **   <a name="groundstation-CreateDataflowEndpointGroupV2-request-tags"></a>
Tags of a V2 dataflow endpoint group.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateDataflowEndpointGroupV2_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataflowEndpointGroupId": "string"
}
```

## Response Elements
<a name="API_CreateDataflowEndpointGroupV2_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dataflowEndpointGroupId](#API_CreateDataflowEndpointGroupV2_ResponseSyntax) **   <a name="groundstation-CreateDataflowEndpointGroupV2-response-dataflowEndpointGroupId"></a>
Dataflow endpoint group ID  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_CreateDataflowEndpointGroupV2_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

 ** ServiceQuotaExceededException **   
Request would cause a service quota to be exceeded.    
 ** parameterName **   
Parameter name that caused the exception
HTTP Status Code: 402

## See Also
<a name="API_CreateDataflowEndpointGroupV2_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/CreateDataflowEndpointGroupV2) 

# CreateEphemeris
<a name="API_CreateEphemeris"></a>

Create an ephemeris with your specified [EphemerisData](API_EphemerisData.md).

## Request Syntax
<a name="API_CreateEphemeris_RequestSyntax"></a>

```
POST /ephemeris HTTP/1.1
Content-type: application/json

{
   "enabled": boolean,
   "ephemeris": { ... },
   "expirationTime": number,
   "kmsKeyArn": "string",
   "name": "string",
   "priority": number,
   "satelliteId": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateEphemeris_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateEphemeris_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [enabled](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-enabled"></a>
Set to `true` to enable the ephemeris after validation. Set to `false` to keep it disabled.  
Type: Boolean  
Required: No

 ** [ephemeris](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-ephemeris"></a>
Ephemeris data.  
Type: [EphemerisData](API_EphemerisData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [expirationTime](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-expirationTime"></a>
An overall expiration time for the ephemeris in UTC, after which it will become `EXPIRED`.  
Type: Timestamp  
Required: No

 ** [kmsKeyArn](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-kmsKeyArn"></a>
The ARN of the KMS key to use for encrypting the ephemeris.  
Type: String  
Required: No

 ** [name](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-name"></a>
A name that you can use to identify the ephemeris.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

 ** [priority](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-priority"></a>
A priority score that determines which ephemeris to use when multiple ephemerides overlap.  
Higher numbers take precedence. The default is 1. Must be 1 or greater.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 99999.  
Required: No

 ** [satelliteId](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-satelliteId"></a>
The satellite ID that associates this ephemeris with a satellite in AWS Ground Station.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [tags](#API_CreateEphemeris_RequestSyntax) **   <a name="groundstation-CreateEphemeris-request-tags"></a>
Tags assigned to an ephemeris.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_CreateEphemeris_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ephemerisId": "string"
}
```

## Response Elements
<a name="API_CreateEphemeris_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ephemerisId](#API_CreateEphemeris_ResponseSyntax) **   <a name="groundstation-CreateEphemeris-response-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_CreateEphemeris_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_CreateEphemeris_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/CreateEphemeris) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/CreateEphemeris) 

# CreateMissionProfile
<a name="API_CreateMissionProfile"></a>

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.

## Request Syntax
<a name="API_CreateMissionProfile_RequestSyntax"></a>

```
POST /missionprofile HTTP/1.1
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "dataflowEdges": [ 
      [ "string" ]
   ],
   "minimumViableContactDurationSeconds": number,
   "name": "string",
   "streamsKmsKey": { ... },
   "streamsKmsRole": "string",
   "tags": { 
      "string" : "string" 
   },
   "telemetrySinkConfigArn": "string",
   "trackingConfigArn": "string"
}
```

## URI Request Parameters
<a name="API_CreateMissionProfile_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateMissionProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contactPostPassDurationSeconds](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-contactPostPassDurationSeconds"></a>
Amount of time after a contact ends that you'd like to receive a Ground Station Contact State Change event indicating the pass has finished.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 21600.  
Required: No

 ** [contactPrePassDurationSeconds](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-contactPrePassDurationSeconds"></a>
Amount of time prior to contact start you'd like to receive a Ground Station Contact State Change event indicating an upcoming pass.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 21600.  
Required: No

 ** [dataflowEdges](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-dataflowEdges"></a>
A list of lists of ARNs. Each list of ARNs is an edge, with a *from* ` Config` and a *to* `Config`.  
Type: Array of arrays of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Array Members: Fixed number of 2 items.  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?`   
Required: Yes

 ** [minimumViableContactDurationSeconds](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-minimumViableContactDurationSeconds"></a>
Smallest amount of time in seconds that you'd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 21600.  
Required: Yes

 ** [name](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-name"></a>
Name of a mission profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

 ** [streamsKmsKey](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-streamsKmsKey"></a>
KMS key to use for encrypting streams.  
Type: [KmsKey](API_KmsKey.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [streamsKmsRole](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-streamsKmsRole"></a>
Role to use for encrypting streams with KMS key.  
Type: String  
Length Constraints: Minimum length of 30. Maximum length of 165.  
Pattern: `arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\w+=,.@-]{1,64}`   
Required: No

 ** [tags](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-tags"></a>
Tags assigned to a mission profile.  
Type: String to string map  
Required: No

 ** [telemetrySinkConfigArn](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-telemetrySinkConfigArn"></a>
ARN of a telemetry sink `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?`   
Required: No

 ** [trackingConfigArn](#API_CreateMissionProfile_RequestSyntax) **   <a name="groundstation-CreateMissionProfile-request-trackingConfigArn"></a>
ARN of a tracking `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?`   
Required: Yes

## Response Syntax
<a name="API_CreateMissionProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "missionProfileId": "string"
}
```

## Response Elements
<a name="API_CreateMissionProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [missionProfileId](#API_CreateMissionProfile_ResponseSyntax) **   <a name="groundstation-CreateMissionProfile-response-missionProfileId"></a>
UUID of a mission profile.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_CreateMissionProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_CreateMissionProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/CreateMissionProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/CreateMissionProfile) 

# DeleteConfig
<a name="API_DeleteConfig"></a>

Deletes a `Config`.

## Request Syntax
<a name="API_DeleteConfig_RequestSyntax"></a>

```
DELETE /config/configType/configId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [configId](#API_DeleteConfig_RequestSyntax) **   <a name="groundstation-DeleteConfig-request-uri-configId"></a>
UUID of a `Config`.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [configType](#API_DeleteConfig_RequestSyntax) **   <a name="groundstation-DeleteConfig-request-uri-configType"></a>
Type of a `Config`.  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink`   
Required: Yes

## Request Body
<a name="API_DeleteConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configArn": "string",
   "configId": "string",
   "configType": "string"
}
```

## Response Elements
<a name="API_DeleteConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configArn](#API_DeleteConfig_ResponseSyntax) **   <a name="groundstation-DeleteConfig-response-configArn"></a>
ARN of a `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?` 

 ** [configId](#API_DeleteConfig_ResponseSyntax) **   <a name="groundstation-DeleteConfig-response-configId"></a>
UUID of a `Config`.  
Type: String

 ** [configType](#API_DeleteConfig_ResponseSyntax) **   <a name="groundstation-DeleteConfig-response-configType"></a>
Type of a `Config`.  
Type: String  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink` 

## Errors
<a name="API_DeleteConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_DeleteConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/DeleteConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DeleteConfig) 

# DeleteDataflowEndpointGroup
<a name="API_DeleteDataflowEndpointGroup"></a>

Deletes a dataflow endpoint group.

## Request Syntax
<a name="API_DeleteDataflowEndpointGroup_RequestSyntax"></a>

```
DELETE /dataflowEndpointGroup/dataflowEndpointGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataflowEndpointGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataflowEndpointGroupId](#API_DeleteDataflowEndpointGroup_RequestSyntax) **   <a name="groundstation-DeleteDataflowEndpointGroup-request-uri-dataflowEndpointGroupId"></a>
UUID of a dataflow endpoint group.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_DeleteDataflowEndpointGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataflowEndpointGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataflowEndpointGroupId": "string"
}
```

## Response Elements
<a name="API_DeleteDataflowEndpointGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dataflowEndpointGroupId](#API_DeleteDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-DeleteDataflowEndpointGroup-response-dataflowEndpointGroupId"></a>
UUID of a dataflow endpoint group.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_DeleteDataflowEndpointGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_DeleteDataflowEndpointGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DeleteDataflowEndpointGroup) 

# DeleteEphemeris
<a name="API_DeleteEphemeris"></a>

Delete an ephemeris.

## Request Syntax
<a name="API_DeleteEphemeris_RequestSyntax"></a>

```
DELETE /ephemeris/ephemerisId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEphemeris_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ephemerisId](#API_DeleteEphemeris_RequestSyntax) **   <a name="groundstation-DeleteEphemeris-request-uri-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_DeleteEphemeris_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEphemeris_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ephemerisId": "string"
}
```

## Response Elements
<a name="API_DeleteEphemeris_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ephemerisId](#API_DeleteEphemeris_ResponseSyntax) **   <a name="groundstation-DeleteEphemeris-response-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_DeleteEphemeris_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceInUseException **   
The specified resource is in use by non-terminal state contacts and cannot be modified or deleted.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_DeleteEphemeris_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/DeleteEphemeris) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DeleteEphemeris) 

# DeleteMissionProfile
<a name="API_DeleteMissionProfile"></a>

Deletes a mission profile.

## Request Syntax
<a name="API_DeleteMissionProfile_RequestSyntax"></a>

```
DELETE /missionprofile/missionProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteMissionProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [missionProfileId](#API_DeleteMissionProfile_RequestSyntax) **   <a name="groundstation-DeleteMissionProfile-request-uri-missionProfileId"></a>
UUID of a mission profile.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_DeleteMissionProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteMissionProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "missionProfileId": "string"
}
```

## Response Elements
<a name="API_DeleteMissionProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [missionProfileId](#API_DeleteMissionProfile_ResponseSyntax) **   <a name="groundstation-DeleteMissionProfile-response-missionProfileId"></a>
UUID of a mission profile.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_DeleteMissionProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_DeleteMissionProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/DeleteMissionProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DeleteMissionProfile) 

# DescribeContact
<a name="API_DescribeContact"></a>

Describes an existing contact.

## Request Syntax
<a name="API_DescribeContact_RequestSyntax"></a>

```
GET /contact/contactId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contactId](#API_DescribeContact_RequestSyntax) **   <a name="groundstation-DescribeContact-request-uri-contactId"></a>
UUID of a contact.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_DescribeContact_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactId": "string",
   "contactStatus": "string",
   "dataflowList": [ 
      { 
         "destination": { 
            "configDetails": { ... },
            "configId": "string",
            "configType": "string",
            "dataflowDestinationRegion": "string"
         },
         "errorMessage": "string",
         "source": { 
            "configDetails": { ... },
            "configId": "string",
            "configType": "string",
            "dataflowSourceRegion": "string"
         }
      }
   ],
   "endTime": number,
   "ephemeris": { 
      "ephemerisId": "string",
      "ephemerisType": "string"
   },
   "errorMessage": "string",
   "groundStation": "string",
   "maximumElevation": { 
      "unit": "string",
      "value": number
   },
   "missionProfileArn": "string",
   "postPassEndTime": number,
   "prePassStartTime": number,
   "region": "string",
   "satelliteArn": "string",
   "startTime": number,
   "tags": { 
      "string" : "string" 
   },
   "trackingOverrides": { 
      "programTrackSettings": { ... }
   },
   "version": { 
      "activated": number,
      "created": number,
      "failureCodes": [ "string" ],
      "failureMessage": "string",
      "lastUpdated": number,
      "status": "string",
      "superseded": number,
      "versionId": number
   },
   "visibilityEndTime": number,
   "visibilityStartTime": number
}
```

## Response Elements
<a name="API_DescribeContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactId](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-contactId"></a>
UUID of a contact.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [contactStatus](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-contactStatus"></a>
Status of a contact.  
Type: String  
Valid Values: `SCHEDULING | FAILED_TO_SCHEDULE | SCHEDULED | CANCELLED | AWS_CANCELLED | PREPASS | PASS | POSTPASS | COMPLETED | FAILED | AVAILABLE | CANCELLING | AWS_FAILED` 

 ** [dataflowList](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-dataflowList"></a>
List describing source and destination details for each dataflow edge.  
Type: Array of [DataflowDetail](API_DataflowDetail.md) objects

 ** [endTime](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-endTime"></a>
End time of a contact in UTC.  
Type: Timestamp

 ** [ephemeris](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-ephemeris"></a>
The ephemeris that determines antenna pointing directions for the contact.  
Type: [EphemerisResponseData](API_EphemerisResponseData.md) object

 ** [errorMessage](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-errorMessage"></a>
Error message for a contact.  
Type: String

 ** [groundStation](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-groundStation"></a>
Ground station for a contact.  
Type: String

 ** [maximumElevation](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-maximumElevation"></a>
Maximum elevation angle of a contact.  
Type: [Elevation](API_Elevation.md) object

 ** [missionProfileArn](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-missionProfileArn"></a>
ARN of a mission profile.  
Type: String  
Length Constraints: Minimum length of 89. Maximum length of 138.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [postPassEndTime](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-postPassEndTime"></a>
End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.  
Type: Timestamp

 ** [prePassStartTime](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-prePassStartTime"></a>
Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.  
Type: Timestamp

 ** [region](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-region"></a>
Region where the `ReserveContact` API was called to schedule this contact.  
Type: String

 ** [satelliteArn](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-satelliteArn"></a>
ARN of a satellite.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [startTime](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-startTime"></a>
Start time of a contact in UTC.  
Type: Timestamp

 ** [tags](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-tags"></a>
Tags assigned to a contact.  
Type: String to string map

 ** [trackingOverrides](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-trackingOverrides"></a>
Tracking configuration overrides specified when the contact was reserved.  
Type: [TrackingOverrides](API_TrackingOverrides.md) object

 ** [version](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-version"></a>
Version information for a contact.  
Type: [ContactVersion](API_ContactVersion.md) object

 ** [visibilityEndTime](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-visibilityEndTime"></a>
 Projected time in UTC your satellite will set below the [receive mask](https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html). This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.  
Type: Timestamp

 ** [visibilityStartTime](#API_DescribeContact_ResponseSyntax) **   <a name="groundstation-DescribeContact-response-visibilityStartTime"></a>
 Projected time in UTC your satellite will rise above the [receive mask](https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html). This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.  
Type: Timestamp

## Errors
<a name="API_DescribeContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_DescribeContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/DescribeContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DescribeContact) 

# DescribeContactVersion
<a name="API_DescribeContactVersion"></a>

Describes a specific version of a contact.

## Request Syntax
<a name="API_DescribeContactVersion_RequestSyntax"></a>

```
GET /contact/contactId/versions/versionId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeContactVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contactId](#API_DescribeContactVersion_RequestSyntax) **   <a name="groundstation-DescribeContactVersion-request-uri-contactId"></a>
UUID of a contact.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [versionId](#API_DescribeContactVersion_RequestSyntax) **   <a name="groundstation-DescribeContactVersion-request-uri-versionId"></a>
Version ID of a contact.  
Valid Range: Minimum value of 1. Maximum value of 128.  
Required: Yes

## Request Body
<a name="API_DescribeContactVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeContactVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactId": "string",
   "contactStatus": "string",
   "dataflowList": [ 
      { 
         "destination": { 
            "configDetails": { ... },
            "configId": "string",
            "configType": "string",
            "dataflowDestinationRegion": "string"
         },
         "errorMessage": "string",
         "source": { 
            "configDetails": { ... },
            "configId": "string",
            "configType": "string",
            "dataflowSourceRegion": "string"
         }
      }
   ],
   "endTime": number,
   "ephemeris": { 
      "ephemerisId": "string",
      "ephemerisType": "string"
   },
   "errorMessage": "string",
   "groundStation": "string",
   "maximumElevation": { 
      "unit": "string",
      "value": number
   },
   "missionProfileArn": "string",
   "postPassEndTime": number,
   "prePassStartTime": number,
   "region": "string",
   "satelliteArn": "string",
   "startTime": number,
   "tags": { 
      "string" : "string" 
   },
   "trackingOverrides": { 
      "programTrackSettings": { ... }
   },
   "version": { 
      "activated": number,
      "created": number,
      "failureCodes": [ "string" ],
      "failureMessage": "string",
      "lastUpdated": number,
      "status": "string",
      "superseded": number,
      "versionId": number
   },
   "visibilityEndTime": number,
   "visibilityStartTime": number
}
```

## Response Elements
<a name="API_DescribeContactVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactId](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-contactId"></a>
UUID of a contact.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [contactStatus](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-contactStatus"></a>
Status of a contact.  
Type: String  
Valid Values: `SCHEDULING | FAILED_TO_SCHEDULE | SCHEDULED | CANCELLED | AWS_CANCELLED | PREPASS | PASS | POSTPASS | COMPLETED | FAILED | AVAILABLE | CANCELLING | AWS_FAILED` 

 ** [dataflowList](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-dataflowList"></a>
List describing source and destination details for each dataflow edge.  
Type: Array of [DataflowDetail](API_DataflowDetail.md) objects

 ** [endTime](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-endTime"></a>
End time of a contact in UTC.  
Type: Timestamp

 ** [ephemeris](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-ephemeris"></a>
The ephemeris that determines antenna pointing directions for the contact.  
Type: [EphemerisResponseData](API_EphemerisResponseData.md) object

 ** [errorMessage](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-errorMessage"></a>
Error message for a contact.  
Type: String

 ** [groundStation](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-groundStation"></a>
Ground station for a contact.  
Type: String

 ** [maximumElevation](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-maximumElevation"></a>
Maximum elevation angle of a contact.  
Type: [Elevation](API_Elevation.md) object

 ** [missionProfileArn](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-missionProfileArn"></a>
ARN of the contact's mission profile.  
Type: String  
Length Constraints: Minimum length of 89. Maximum length of 138.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [postPassEndTime](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-postPassEndTime"></a>
End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.  
Type: Timestamp

 ** [prePassStartTime](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-prePassStartTime"></a>
Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.  
Type: Timestamp

 ** [region](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-region"></a>
Region where the `ReserveContact` API was called to schedule this contact.  
Type: String

 ** [satelliteArn](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-satelliteArn"></a>
ARN of a satellite.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [startTime](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-startTime"></a>
Start time of a contact in UTC.  
Type: Timestamp

 ** [tags](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-tags"></a>
Tags assigned to a contact.  
Type: String to string map

 ** [trackingOverrides](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-trackingOverrides"></a>
Tracking configuration overrides applied to this contact version. For the initial version, these are the overrides specified when the contact was reserved. For subsequent versions, these are the overrides associated with that specific version update.  
Type: [TrackingOverrides](API_TrackingOverrides.md) object

 ** [version](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-version"></a>
Version information for a contact.  
Type: [ContactVersion](API_ContactVersion.md) object

 ** [visibilityEndTime](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-visibilityEndTime"></a>
 Projected time in UTC your satellite will set below the [receive mask](https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html). This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.  
Type: Timestamp

 ** [visibilityStartTime](#API_DescribeContactVersion_ResponseSyntax) **   <a name="groundstation-DescribeContactVersion-response-visibilityStartTime"></a>
 Projected time in UTC your satellite will rise above the [receive mask](https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html). This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.  
Type: Timestamp

## Errors
<a name="API_DescribeContactVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_DescribeContactVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/DescribeContactVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DescribeContactVersion) 

# DescribeEphemeris
<a name="API_DescribeEphemeris"></a>

Retrieve information about an existing ephemeris.

## Request Syntax
<a name="API_DescribeEphemeris_RequestSyntax"></a>

```
GET /ephemeris/ephemerisId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeEphemeris_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ephemerisId](#API_DescribeEphemeris_RequestSyntax) **   <a name="groundstation-DescribeEphemeris-request-uri-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_DescribeEphemeris_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeEphemeris_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "creationTime": number,
   "enabled": boolean,
   "ephemerisId": "string",
   "errorReasons": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string"
      }
   ],
   "invalidReason": "string",
   "name": "string",
   "priority": number,
   "satelliteId": "string",
   "status": "string",
   "suppliedData": { ... },
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_DescribeEphemeris_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [creationTime](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-creationTime"></a>
The time the ephemeris was uploaded in UTC.  
Type: Timestamp

 ** [enabled](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-enabled"></a>
Whether or not the ephemeris is enabled.  
Type: Boolean

 ** [ephemerisId](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [errorReasons](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-errorReasons"></a>
Detailed error information for ephemerides with `INVALID` status.  
Provides specific error codes and messages to help diagnose validation failures.  
Type: Array of [EphemerisErrorReason](API_EphemerisErrorReason.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

 ** [invalidReason](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-invalidReason"></a>
Reason that an ephemeris failed validation. Appears only when the status is `INVALID`.  
Type: String  
Valid Values: `METADATA_INVALID | TIME_RANGE_INVALID | TRAJECTORY_INVALID | KMS_KEY_INVALID | VALIDATION_ERROR` 

 ** [name](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-name"></a>
A name that you can use to identify the ephemeris.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}` 

 ** [priority](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-priority"></a>
A priority score that determines which ephemeris to use when multiple ephemerides overlap.  
Higher numbers take precedence. The default is 1. Must be 1 or greater.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 99999.

 ** [satelliteId](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-satelliteId"></a>
The AWS Ground Station satellite ID associated with ephemeris.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [status](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-status"></a>
The status of the ephemeris.  
Type: String  
Valid Values: `VALIDATING | INVALID | ERROR | ENABLED | DISABLED | EXPIRED` 

 ** [suppliedData](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-suppliedData"></a>
Supplied ephemeris data.  
Type: [EphemerisTypeDescription](API_EphemerisTypeDescription.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [tags](#API_DescribeEphemeris_ResponseSyntax) **   <a name="groundstation-DescribeEphemeris-response-tags"></a>
Tags assigned to an ephemeris.  
Type: String to string map

## Errors
<a name="API_DescribeEphemeris_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_DescribeEphemeris_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/DescribeEphemeris) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/DescribeEphemeris) 

# GetAgentConfiguration
<a name="API_GetAgentConfiguration"></a>

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

Gets the latest configuration information for a registered agent.

## Request Syntax
<a name="API_GetAgentConfiguration_RequestSyntax"></a>

```
GET /agent/agentId/configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAgentConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_GetAgentConfiguration_RequestSyntax) **   <a name="groundstation-GetAgentConfiguration-request-uri-agentId"></a>
UUID of agent to get configuration information for.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetAgentConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAgentConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "agentId": "string",
   "taskingDocument": "string"
}
```

## Response Elements
<a name="API_GetAgentConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentId](#API_GetAgentConfiguration_ResponseSyntax) **   <a name="groundstation-GetAgentConfiguration-response-agentId"></a>
UUID of agent.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [taskingDocument](#API_GetAgentConfiguration_ResponseSyntax) **   <a name="groundstation-GetAgentConfiguration-response-taskingDocument"></a>
Tasking document for agent.  
Type: String

## Errors
<a name="API_GetAgentConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_GetAgentConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/GetAgentConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GetAgentConfiguration) 

# GetAgentTaskResponseUrl
<a name="API_GetAgentTaskResponseUrl"></a>

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

Gets a presigned URL for uploading agent task response logs.

## Request Syntax
<a name="API_GetAgentTaskResponseUrl_RequestSyntax"></a>

```
GET /agentResponseUrl/agentId/taskId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAgentTaskResponseUrl_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_GetAgentTaskResponseUrl_RequestSyntax) **   <a name="groundstation-GetAgentTaskResponseUrl-request-uri-agentId"></a>
UUID of agent requesting the response URL.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [taskId](#API_GetAgentTaskResponseUrl_RequestSyntax) **   <a name="groundstation-GetAgentTaskResponseUrl-request-uri-taskId"></a>
GUID of the agent task for which the response URL is being requested.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetAgentTaskResponseUrl_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAgentTaskResponseUrl_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "agentId": "string",
   "presignedLogUrl": "string",
   "taskId": "string"
}
```

## Response Elements
<a name="API_GetAgentTaskResponseUrl_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentId](#API_GetAgentTaskResponseUrl_ResponseSyntax) **   <a name="groundstation-GetAgentTaskResponseUrl-response-agentId"></a>
UUID of the agent.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [presignedLogUrl](#API_GetAgentTaskResponseUrl_ResponseSyntax) **   <a name="groundstation-GetAgentTaskResponseUrl-response-presignedLogUrl"></a>
Presigned URL for uploading agent task response logs.  
Type: String

 ** [taskId](#API_GetAgentTaskResponseUrl_ResponseSyntax) **   <a name="groundstation-GetAgentTaskResponseUrl-response-taskId"></a>
GUID of the agent task.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_GetAgentTaskResponseUrl_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_GetAgentTaskResponseUrl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/GetAgentTaskResponseUrl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GetAgentTaskResponseUrl) 

# GetConfig
<a name="API_GetConfig"></a>

Returns `Config` information.

Only one `Config` response can be returned.

## Request Syntax
<a name="API_GetConfig_RequestSyntax"></a>

```
GET /config/configType/configId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [configId](#API_GetConfig_RequestSyntax) **   <a name="groundstation-GetConfig-request-uri-configId"></a>
UUID of a `Config`.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [configType](#API_GetConfig_RequestSyntax) **   <a name="groundstation-GetConfig-request-uri-configType"></a>
Type of a `Config`.  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink`   
Required: Yes

## Request Body
<a name="API_GetConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configArn": "string",
   "configData": { ... },
   "configId": "string",
   "configType": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configArn](#API_GetConfig_ResponseSyntax) **   <a name="groundstation-GetConfig-response-configArn"></a>
ARN of a `Config`   
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?` 

 ** [configData](#API_GetConfig_ResponseSyntax) **   <a name="groundstation-GetConfig-response-configData"></a>
Data elements in a `Config`.  
Type: [ConfigTypeData](API_ConfigTypeData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [configId](#API_GetConfig_ResponseSyntax) **   <a name="groundstation-GetConfig-response-configId"></a>
UUID of a `Config`.  
Type: String

 ** [configType](#API_GetConfig_ResponseSyntax) **   <a name="groundstation-GetConfig-response-configType"></a>
Type of a `Config`.  
Type: String  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink` 

 ** [name](#API_GetConfig_ResponseSyntax) **   <a name="groundstation-GetConfig-response-name"></a>
Name of a `Config`.  
Type: String

 ** [tags](#API_GetConfig_ResponseSyntax) **   <a name="groundstation-GetConfig-response-tags"></a>
Tags assigned to a `Config`.  
Type: String to string map

## Errors
<a name="API_GetConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_GetConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/GetConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GetConfig) 

# GetDataflowEndpointGroup
<a name="API_GetDataflowEndpointGroup"></a>

Returns the dataflow endpoint group.

## Request Syntax
<a name="API_GetDataflowEndpointGroup_RequestSyntax"></a>

```
GET /dataflowEndpointGroup/dataflowEndpointGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDataflowEndpointGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataflowEndpointGroupId](#API_GetDataflowEndpointGroup_RequestSyntax) **   <a name="groundstation-GetDataflowEndpointGroup-request-uri-dataflowEndpointGroupId"></a>
UUID of a dataflow endpoint group.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetDataflowEndpointGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDataflowEndpointGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "dataflowEndpointGroupArn": "string",
   "dataflowEndpointGroupId": "string",
   "endpointsDetails": [ 
      { 
         "awsGroundStationAgentEndpoint": { 
            "agentStatus": "string",
            "auditResults": "string",
            "egressAddress": { 
               "mtu": number,
               "socketAddress": { 
                  "name": "string",
                  "port": number
               }
            },
            "ingressAddress": { 
               "mtu": number,
               "socketAddress": { 
                  "name": "string",
                  "portRange": { 
                     "maximum": number,
                     "minimum": number
                  }
               }
            },
            "name": "string"
         },
         "downlinkAwsGroundStationAgentEndpoint": { 
            "agentStatus": "string",
            "auditResults": "string",
            "dataflowDetails": { ... },
            "name": "string"
         },
         "endpoint": { 
            "address": { 
               "name": "string",
               "port": number
            },
            "mtu": number,
            "name": "string",
            "status": "string"
         },
         "healthReasons": [ "string" ],
         "healthStatus": "string",
         "securityDetails": { 
            "roleArn": "string",
            "securityGroupIds": [ "string" ],
            "subnetIds": [ "string" ]
         },
         "uplinkAwsGroundStationAgentEndpoint": { 
            "agentStatus": "string",
            "auditResults": "string",
            "dataflowDetails": { ... },
            "name": "string"
         }
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetDataflowEndpointGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactPostPassDurationSeconds](#API_GetDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-GetDataflowEndpointGroup-response-contactPostPassDurationSeconds"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 30. Maximum value of 480.

 ** [contactPrePassDurationSeconds](#API_GetDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-GetDataflowEndpointGroup-response-contactPrePassDurationSeconds"></a>
Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a `PREPASS` state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the `PREPASS` state.  
Type: Integer  
Valid Range: Minimum value of 30. Maximum value of 480.

 ** [dataflowEndpointGroupArn](#API_GetDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-GetDataflowEndpointGroup-response-dataflowEndpointGroupArn"></a>
ARN of a dataflow endpoint group.  
Type: String  
Length Constraints: Minimum length of 97. Maximum length of 146.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:dataflow-endpoint-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [dataflowEndpointGroupId](#API_GetDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-GetDataflowEndpointGroup-response-dataflowEndpointGroupId"></a>
UUID of a dataflow endpoint group.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [endpointsDetails](#API_GetDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-GetDataflowEndpointGroup-response-endpointsDetails"></a>
Details of a dataflow endpoint.  
Type: Array of [EndpointDetails](API_EndpointDetails.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 500 items.

 ** [tags](#API_GetDataflowEndpointGroup_ResponseSyntax) **   <a name="groundstation-GetDataflowEndpointGroup-response-tags"></a>
Tags assigned to a dataflow endpoint group.  
Type: String to string map

## Errors
<a name="API_GetDataflowEndpointGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_GetDataflowEndpointGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/GetDataflowEndpointGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GetDataflowEndpointGroup) 

# GetMinuteUsage
<a name="API_GetMinuteUsage"></a>

Returns the number of reserved minutes used by account.

## Request Syntax
<a name="API_GetMinuteUsage_RequestSyntax"></a>

```
POST /minute-usage HTTP/1.1
Content-type: application/json

{
   "month": number,
   "year": number
}
```

## URI Request Parameters
<a name="API_GetMinuteUsage_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetMinuteUsage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [month](#API_GetMinuteUsage_RequestSyntax) **   <a name="groundstation-GetMinuteUsage-request-month"></a>
The month being requested, with a value of 1-12.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 12.  
Required: Yes

 ** [year](#API_GetMinuteUsage_RequestSyntax) **   <a name="groundstation-GetMinuteUsage-request-year"></a>
The year being requested, in the format of YYYY.  
Type: Integer  
Valid Range: Minimum value of 2018. Maximum value of 3000.  
Required: Yes

## Response Syntax
<a name="API_GetMinuteUsage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "estimatedMinutesRemaining": number,
   "isReservedMinutesCustomer": boolean,
   "totalReservedMinuteAllocation": number,
   "totalScheduledMinutes": number,
   "upcomingMinutesScheduled": number
}
```

## Response Elements
<a name="API_GetMinuteUsage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [estimatedMinutesRemaining](#API_GetMinuteUsage_ResponseSyntax) **   <a name="groundstation-GetMinuteUsage-response-estimatedMinutesRemaining"></a>
Estimated number of minutes remaining for an account, specific to the month being requested.  
Type: Integer

 ** [isReservedMinutesCustomer](#API_GetMinuteUsage_ResponseSyntax) **   <a name="groundstation-GetMinuteUsage-response-isReservedMinutesCustomer"></a>
Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.  
Type: Boolean

 ** [totalReservedMinuteAllocation](#API_GetMinuteUsage_ResponseSyntax) **   <a name="groundstation-GetMinuteUsage-response-totalReservedMinuteAllocation"></a>
Total number of reserved minutes allocated, specific to the month being requested.  
Type: Integer

 ** [totalScheduledMinutes](#API_GetMinuteUsage_ResponseSyntax) **   <a name="groundstation-GetMinuteUsage-response-totalScheduledMinutes"></a>
Total scheduled minutes for an account, specific to the month being requested.  
Type: Integer

 ** [upcomingMinutesScheduled](#API_GetMinuteUsage_ResponseSyntax) **   <a name="groundstation-GetMinuteUsage-response-upcomingMinutesScheduled"></a>
Upcoming minutes scheduled for an account, specific to the month being requested.  
Type: Integer

## Errors
<a name="API_GetMinuteUsage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_GetMinuteUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/GetMinuteUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GetMinuteUsage) 

# GetMissionProfile
<a name="API_GetMissionProfile"></a>

Returns a mission profile.

## Request Syntax
<a name="API_GetMissionProfile_RequestSyntax"></a>

```
GET /missionprofile/missionProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMissionProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [missionProfileId](#API_GetMissionProfile_RequestSyntax) **   <a name="groundstation-GetMissionProfile-request-uri-missionProfileId"></a>
UUID of a mission profile.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetMissionProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMissionProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "dataflowEdges": [ 
      [ "string" ]
   ],
   "minimumViableContactDurationSeconds": number,
   "missionProfileArn": "string",
   "missionProfileId": "string",
   "name": "string",
   "region": "string",
   "streamsKmsKey": { ... },
   "streamsKmsRole": "string",
   "tags": { 
      "string" : "string" 
   },
   "telemetrySinkConfigArn": "string",
   "trackingConfigArn": "string"
}
```

## Response Elements
<a name="API_GetMissionProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactPostPassDurationSeconds](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-contactPostPassDurationSeconds"></a>
Amount of time after a contact ends that you'd like to receive a CloudWatch event indicating the pass has finished.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 21600.

 ** [contactPrePassDurationSeconds](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-contactPrePassDurationSeconds"></a>
Amount of time prior to contact start you'd like to receive a CloudWatch event indicating an upcoming pass.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 21600.

 ** [dataflowEdges](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-dataflowEdges"></a>
A list of lists of ARNs. Each list of ARNs is an edge, with a *from* ` Config` and a *to* `Config`.  
Type: Array of arrays of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Array Members: Fixed number of 2 items.  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?` 

 ** [minimumViableContactDurationSeconds](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-minimumViableContactDurationSeconds"></a>
Smallest amount of time in seconds that you'd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 21600.

 ** [missionProfileArn](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-missionProfileArn"></a>
ARN of a mission profile.  
Type: String  
Length Constraints: Minimum length of 89. Maximum length of 138.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [missionProfileId](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-missionProfileId"></a>
UUID of a mission profile.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [name](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-name"></a>
Name of a mission profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}` 

 ** [region](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-region"></a>
Region of a mission profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w-]+` 

 ** [streamsKmsKey](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-streamsKmsKey"></a>
KMS key to use for encrypting streams.  
Type: [KmsKey](API_KmsKey.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [streamsKmsRole](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-streamsKmsRole"></a>
Role to use for encrypting streams with KMS key.  
Type: String  
Length Constraints: Minimum length of 30. Maximum length of 165.  
Pattern: `arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\w+=,.@-]{1,64}` 

 ** [tags](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-tags"></a>
Tags assigned to a mission profile.  
Type: String to string map

 ** [telemetrySinkConfigArn](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-telemetrySinkConfigArn"></a>
ARN of a telemetry sink `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?` 

 ** [trackingConfigArn](#API_GetMissionProfile_ResponseSyntax) **   <a name="groundstation-GetMissionProfile-response-trackingConfigArn"></a>
ARN of a tracking `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?` 

## Errors
<a name="API_GetMissionProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_GetMissionProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/GetMissionProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GetMissionProfile) 

# GetSatellite
<a name="API_GetSatellite"></a>

Returns a satellite.

## Request Syntax
<a name="API_GetSatellite_RequestSyntax"></a>

```
GET /satellite/satelliteId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSatellite_RequestParameters"></a>

The request uses the following URI parameters.

 ** [satelliteId](#API_GetSatellite_RequestSyntax) **   <a name="groundstation-GetSatellite-request-uri-satelliteId"></a>
UUID of a satellite.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_GetSatellite_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSatellite_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "currentEphemeris": { 
      "ephemerisId": "string",
      "epoch": number,
      "name": "string",
      "source": "string"
   },
   "groundStations": [ "string" ],
   "noradSatelliteID": number,
   "satelliteArn": "string",
   "satelliteId": "string"
}
```

## Response Elements
<a name="API_GetSatellite_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [currentEphemeris](#API_GetSatellite_ResponseSyntax) **   <a name="groundstation-GetSatellite-response-currentEphemeris"></a>
The current ephemeris being used to compute the trajectory of the satellite.  
Type: [EphemerisMetaData](API_EphemerisMetaData.md) object

 ** [groundStations](#API_GetSatellite_ResponseSyntax) **   <a name="groundstation-GetSatellite-response-groundStations"></a>
A list of ground stations to which the satellite is on-boarded.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Length Constraints: Minimum length of 4. Maximum length of 97.  
Pattern: `[ a-zA-Z0-9-._:=]{4,97}` 

 ** [noradSatelliteID](#API_GetSatellite_ResponseSyntax) **   <a name="groundstation-GetSatellite-response-noradSatelliteID"></a>
NORAD satellite ID number.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 99999.

 ** [satelliteArn](#API_GetSatellite_ResponseSyntax) **   <a name="groundstation-GetSatellite-response-satelliteArn"></a>
ARN of a satellite.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [satelliteId](#API_GetSatellite_ResponseSyntax) **   <a name="groundstation-GetSatellite-response-satelliteId"></a>
UUID of a satellite.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_GetSatellite_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_GetSatellite_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/GetSatellite) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/GetSatellite) 

# ListAntennas
<a name="API_ListAntennas"></a>

Returns a list of antennas at a specified ground station.

## Request Syntax
<a name="API_ListAntennas_RequestSyntax"></a>

```
GET /groundstation/groundStationId/antenna?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAntennas_RequestParameters"></a>

The request uses the following URI parameters.

 ** [groundStationId](#API_ListAntennas_RequestSyntax) **   <a name="groundstation-ListAntennas-request-uri-groundStationId"></a>
ID of a ground station.  
Length Constraints: Minimum length of 4. Maximum length of 97.  
Pattern: `[ a-zA-Z0-9-._:=]{4,97}`   
Required: Yes

 ** [maxResults](#API_ListAntennas_RequestSyntax) **   <a name="groundstation-ListAntennas-request-uri-maxResults"></a>
Maximum number of antennas returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListAntennas_RequestSyntax) **   <a name="groundstation-ListAntennas-request-uri-nextToken"></a>
Next token returned in the request of a previous `ListAntennas` call. Used to get the next page of results.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Request Body
<a name="API_ListAntennas_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAntennas_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "antennaList": [ 
      { 
         "antennaName": "string",
         "groundStationName": "string",
         "region": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAntennas_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [antennaList](#API_ListAntennas_ResponseSyntax) **   <a name="groundstation-ListAntennas-response-antennaList"></a>
List of antennas.  
Type: Array of [AntennaListItem](API_AntennaListItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_ListAntennas_ResponseSyntax) **   <a name="groundstation-ListAntennas-response-nextToken"></a>
Next token to be used in a subsequent `ListAntennas` call to retrieve the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListAntennas_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

## See Also
<a name="API_ListAntennas_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListAntennas) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListAntennas) 

# ListConfigs
<a name="API_ListConfigs"></a>

Returns a list of `Config` objects.

## Request Syntax
<a name="API_ListConfigs_RequestSyntax"></a>

```
GET /config?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListConfigs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListConfigs_RequestSyntax) **   <a name="groundstation-ListConfigs-request-uri-maxResults"></a>
Maximum number of `Configs` returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListConfigs_RequestSyntax) **   <a name="groundstation-ListConfigs-request-uri-nextToken"></a>
Next token returned in the request of a previous `ListConfigs` call. Used to get the next page of results.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Request Body
<a name="API_ListConfigs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListConfigs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configList": [ 
      { 
         "configArn": "string",
         "configId": "string",
         "configType": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListConfigs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configList](#API_ListConfigs_ResponseSyntax) **   <a name="groundstation-ListConfigs-response-configList"></a>
List of `Config` items.  
Type: Array of [ConfigListItem](API_ConfigListItem.md) objects

 ** [nextToken](#API_ListConfigs_ResponseSyntax) **   <a name="groundstation-ListConfigs-response-nextToken"></a>
Next token returned in the response of a previous `ListConfigs` call. Used to get the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListConfigs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListConfigs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListConfigs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListConfigs) 

# ListContacts
<a name="API_ListContacts"></a>

Returns a list of contacts.

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

## Request Syntax
<a name="API_ListContacts_RequestSyntax"></a>

```
POST /contacts HTTP/1.1
Content-type: application/json

{
   "endTime": number,
   "ephemeris": { ... },
   "groundStation": "string",
   "maxResults": number,
   "missionProfileArn": "string",
   "nextToken": "string",
   "satelliteArn": "string",
   "startTime": number,
   "statusList": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListContacts_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListContacts_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [endTime](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-endTime"></a>
End time of a contact in UTC.  
Type: Timestamp  
Required: Yes

 ** [ephemeris](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-ephemeris"></a>
Filter for selecting contacts that use a specific ephemeris".  
Type: [EphemerisFilter](API_EphemerisFilter.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [groundStation](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-groundStation"></a>
Name of a ground station.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 97.  
Pattern: `[ a-zA-Z0-9-._:=]{4,97}`   
Required: No

 ** [maxResults](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-maxResults"></a>
Maximum number of contacts returned.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [missionProfileArn](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-missionProfileArn"></a>
ARN of a mission profile.  
Type: String  
Length Constraints: Minimum length of 89. Maximum length of 138.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [nextToken](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-nextToken"></a>
Next token returned in the request of a previous `ListContacts` call. Used to get the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+`   
Required: No

 ** [satelliteArn](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-satelliteArn"></a>
ARN of a satellite.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [startTime](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-startTime"></a>
Start time of a contact in UTC.  
Type: Timestamp  
Required: Yes

 ** [statusList](#API_ListContacts_RequestSyntax) **   <a name="groundstation-ListContacts-request-statusList"></a>
Status of a contact reservation.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Valid Values: `SCHEDULING | FAILED_TO_SCHEDULE | SCHEDULED | CANCELLED | AWS_CANCELLED | PREPASS | PASS | POSTPASS | COMPLETED | FAILED | AVAILABLE | CANCELLING | AWS_FAILED`   
Required: Yes

## Response Syntax
<a name="API_ListContacts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactList": [ 
      { 
         "contactId": "string",
         "contactStatus": "string",
         "endTime": number,
         "ephemeris": { 
            "ephemerisId": "string",
            "ephemerisType": "string"
         },
         "errorMessage": "string",
         "groundStation": "string",
         "maximumElevation": { 
            "unit": "string",
            "value": number
         },
         "missionProfileArn": "string",
         "postPassEndTime": number,
         "prePassStartTime": number,
         "region": "string",
         "satelliteArn": "string",
         "startTime": number,
         "tags": { 
            "string" : "string" 
         },
         "version": { 
            "activated": number,
            "created": number,
            "failureCodes": [ "string" ],
            "failureMessage": "string",
            "lastUpdated": number,
            "status": "string",
            "superseded": number,
            "versionId": number
         },
         "visibilityEndTime": number,
         "visibilityStartTime": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListContacts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactList](#API_ListContacts_ResponseSyntax) **   <a name="groundstation-ListContacts-response-contactList"></a>
List of contacts.  
Type: Array of [ContactData](API_ContactData.md) objects

 ** [nextToken](#API_ListContacts_ResponseSyntax) **   <a name="groundstation-ListContacts-response-nextToken"></a>
Next token returned in the response of a previous `ListContacts` call. Used to get the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListContacts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListContacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListContacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListContacts) 

# ListContactVersions
<a name="API_ListContactVersions"></a>

Returns a list of versions for a specified contact.

## Request Syntax
<a name="API_ListContactVersions_RequestSyntax"></a>

```
GET /contact/contactId/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contactId](#API_ListContactVersions_RequestSyntax) **   <a name="groundstation-ListContactVersions-request-uri-contactId"></a>
UUID of a contact.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [maxResults](#API_ListContactVersions_RequestSyntax) **   <a name="groundstation-ListContactVersions-request-uri-maxResults"></a>
Maximum number of contact versions returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListContactVersions_RequestSyntax) **   <a name="groundstation-ListContactVersions-request-uri-nextToken"></a>
Next token returned in the request of a previous `ListContactVersions` call. Used to get the next page of results.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Request Body
<a name="API_ListContactVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactVersionsList": [ 
      { 
         "activated": number,
         "created": number,
         "failureCodes": [ "string" ],
         "failureMessage": "string",
         "lastUpdated": number,
         "status": "string",
         "superseded": number,
         "versionId": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListContactVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactVersionsList](#API_ListContactVersions_ResponseSyntax) **   <a name="groundstation-ListContactVersions-response-contactVersionsList"></a>
List of contact versions.  
Type: Array of [ContactVersion](API_ContactVersion.md) objects

 ** [nextToken](#API_ListContactVersions_ResponseSyntax) **   <a name="groundstation-ListContactVersions-response-nextToken"></a>
Next token to be used in a subsequent `ListContactVersions` call to retrieve the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListContactVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListContactVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListContactVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListContactVersions) 

# ListDataflowEndpointGroups
<a name="API_ListDataflowEndpointGroups"></a>

Returns a list of `DataflowEndpoint` groups.

## Request Syntax
<a name="API_ListDataflowEndpointGroups_RequestSyntax"></a>

```
GET /dataflowEndpointGroup?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataflowEndpointGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListDataflowEndpointGroups_RequestSyntax) **   <a name="groundstation-ListDataflowEndpointGroups-request-uri-maxResults"></a>
Maximum number of dataflow endpoint groups returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListDataflowEndpointGroups_RequestSyntax) **   <a name="groundstation-ListDataflowEndpointGroups-request-uri-nextToken"></a>
Next token returned in the request of a previous `ListDataflowEndpointGroups` call. Used to get the next page of results.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Request Body
<a name="API_ListDataflowEndpointGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataflowEndpointGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "dataflowEndpointGroupList": [ 
      { 
         "dataflowEndpointGroupArn": "string",
         "dataflowEndpointGroupId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataflowEndpointGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dataflowEndpointGroupList](#API_ListDataflowEndpointGroups_ResponseSyntax) **   <a name="groundstation-ListDataflowEndpointGroups-response-dataflowEndpointGroupList"></a>
A list of dataflow endpoint groups.  
Type: Array of [DataflowEndpointListItem](API_DataflowEndpointListItem.md) objects

 ** [nextToken](#API_ListDataflowEndpointGroups_ResponseSyntax) **   <a name="groundstation-ListDataflowEndpointGroups-response-nextToken"></a>
Next token returned in the response of a previous `ListDataflowEndpointGroups` call. Used to get the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListDataflowEndpointGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListDataflowEndpointGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListDataflowEndpointGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListDataflowEndpointGroups) 

# ListEphemerides
<a name="API_ListEphemerides"></a>

List your existing ephemerides.

## Request Syntax
<a name="API_ListEphemerides_RequestSyntax"></a>

```
POST /ephemerides?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "endTime": number,
   "ephemerisType": "string",
   "satelliteId": "string",
   "startTime": number,
   "statusList": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListEphemerides_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListEphemerides_RequestSyntax) **   <a name="groundstation-ListEphemerides-request-uri-maxResults"></a>
Maximum number of ephemerides to return.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListEphemerides_RequestSyntax) **   <a name="groundstation-ListEphemerides-request-uri-nextToken"></a>
Pagination token.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Request Body
<a name="API_ListEphemerides_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [endTime](#API_ListEphemerides_RequestSyntax) **   <a name="groundstation-ListEphemerides-request-endTime"></a>
The end time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.  
Type: Timestamp  
Required: Yes

 ** [ephemerisType](#API_ListEphemerides_RequestSyntax) **   <a name="groundstation-ListEphemerides-request-ephemerisType"></a>
Filter ephemerides by type. If not specified, all ephemeris types will be returned.  
Type: String  
Valid Values: `TLE | OEM | AZ_EL | SERVICE_MANAGED`   
Required: No

 ** [satelliteId](#API_ListEphemerides_RequestSyntax) **   <a name="groundstation-ListEphemerides-request-satelliteId"></a>
The AWS Ground Station satellite ID to list ephemeris for.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [startTime](#API_ListEphemerides_RequestSyntax) **   <a name="groundstation-ListEphemerides-request-startTime"></a>
The start time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.  
Type: Timestamp  
Required: Yes

 ** [statusList](#API_ListEphemerides_RequestSyntax) **   <a name="groundstation-ListEphemerides-request-statusList"></a>
The list of ephemeris status to return.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Valid Values: `VALIDATING | INVALID | ERROR | ENABLED | DISABLED | EXPIRED`   
Required: No

## Response Syntax
<a name="API_ListEphemerides_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ephemerides": [ 
      { 
         "creationTime": number,
         "enabled": boolean,
         "ephemerisId": "string",
         "ephemerisType": "string",
         "name": "string",
         "priority": number,
         "sourceS3Object": { 
            "bucket": "string",
            "key": "string",
            "version": "string"
         },
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEphemerides_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ephemerides](#API_ListEphemerides_ResponseSyntax) **   <a name="groundstation-ListEphemerides-response-ephemerides"></a>
List of ephemerides.  
Type: Array of [EphemerisItem](API_EphemerisItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 500 items.

 ** [nextToken](#API_ListEphemerides_ResponseSyntax) **   <a name="groundstation-ListEphemerides-response-nextToken"></a>
Pagination token.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListEphemerides_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListEphemerides_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListEphemerides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListEphemerides) 

# ListGroundStationReservations
<a name="API_ListGroundStationReservations"></a>

Returns a list of reservations for a specified ground station.

## Request Syntax
<a name="API_ListGroundStationReservations_RequestSyntax"></a>

```
GET /groundstation/groundStationId/reservation?endTime=endTime&maxResults=maxResults&nextToken=nextToken&reservationTypes=reservationTypes&startTime=startTime HTTP/1.1
```

## URI Request Parameters
<a name="API_ListGroundStationReservations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [endTime](#API_ListGroundStationReservations_RequestSyntax) **   <a name="groundstation-ListGroundStationReservations-request-uri-endTime"></a>
End time of the reservation window in UTC.  
Required: Yes

 ** [groundStationId](#API_ListGroundStationReservations_RequestSyntax) **   <a name="groundstation-ListGroundStationReservations-request-uri-groundStationId"></a>
ID of a ground station.  
Length Constraints: Minimum length of 4. Maximum length of 97.  
Pattern: `[ a-zA-Z0-9-._:=]{4,97}`   
Required: Yes

 ** [maxResults](#API_ListGroundStationReservations_RequestSyntax) **   <a name="groundstation-ListGroundStationReservations-request-uri-maxResults"></a>
Maximum number of ground station reservations returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListGroundStationReservations_RequestSyntax) **   <a name="groundstation-ListGroundStationReservations-request-uri-nextToken"></a>
Next token returned in the request of a previous `ListGroundStationReservations` call. Used to get the next page of results.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

 ** [reservationTypes](#API_ListGroundStationReservations_RequestSyntax) **   <a name="groundstation-ListGroundStationReservations-request-uri-reservationTypes"></a>
Types of reservations to filter by.  
Valid Values: `MAINTENANCE | CONTACT` 

 ** [startTime](#API_ListGroundStationReservations_RequestSyntax) **   <a name="groundstation-ListGroundStationReservations-request-uri-startTime"></a>
Start time of the reservation window in UTC.  
Required: Yes

## Request Body
<a name="API_ListGroundStationReservations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListGroundStationReservations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "reservationList": [ 
      { 
         "antennaName": "string",
         "endTime": number,
         "groundStationId": "string",
         "reservationDetails": { ... },
         "reservationType": "string",
         "startTime": number
      }
   ]
}
```

## Response Elements
<a name="API_ListGroundStationReservations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListGroundStationReservations_ResponseSyntax) **   <a name="groundstation-ListGroundStationReservations-response-nextToken"></a>
Next token to be used in a subsequent `ListGroundStationReservations` call to retrieve the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

 ** [reservationList](#API_ListGroundStationReservations_ResponseSyntax) **   <a name="groundstation-ListGroundStationReservations-response-reservationList"></a>
List of ground station reservations.  
Type: Array of [GroundStationReservationListItem](API_GroundStationReservationListItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_ListGroundStationReservations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

## See Also
<a name="API_ListGroundStationReservations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListGroundStationReservations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListGroundStationReservations) 

# ListGroundStations
<a name="API_ListGroundStations"></a>

Returns a list of ground stations. 

## Request Syntax
<a name="API_ListGroundStations_RequestSyntax"></a>

```
GET /groundstation?maxResults=maxResults&nextToken=nextToken&satelliteId=satelliteId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListGroundStations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListGroundStations_RequestSyntax) **   <a name="groundstation-ListGroundStations-request-uri-maxResults"></a>
Maximum number of ground stations returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListGroundStations_RequestSyntax) **   <a name="groundstation-ListGroundStations-request-uri-nextToken"></a>
Next token that can be supplied in the next call to get the next page of ground stations.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

 ** [satelliteId](#API_ListGroundStations_RequestSyntax) **   <a name="groundstation-ListGroundStations-request-uri-satelliteId"></a>
Satellite ID to retrieve on-boarded ground stations.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Request Body
<a name="API_ListGroundStations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListGroundStations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "groundStationList": [ 
      { 
         "groundStationId": "string",
         "groundStationName": "string",
         "region": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListGroundStations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [groundStationList](#API_ListGroundStations_ResponseSyntax) **   <a name="groundstation-ListGroundStations-response-groundStationList"></a>
List of ground stations.  
Type: Array of [GroundStationData](API_GroundStationData.md) objects

 ** [nextToken](#API_ListGroundStations_ResponseSyntax) **   <a name="groundstation-ListGroundStations-response-nextToken"></a>
Next token that can be supplied in the next call to get the next page of ground stations.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListGroundStations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListGroundStations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListGroundStations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListGroundStations) 

# ListMissionProfiles
<a name="API_ListMissionProfiles"></a>

Returns a list of mission profiles.

## Request Syntax
<a name="API_ListMissionProfiles_RequestSyntax"></a>

```
GET /missionprofile?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListMissionProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListMissionProfiles_RequestSyntax) **   <a name="groundstation-ListMissionProfiles-request-uri-maxResults"></a>
Maximum number of mission profiles returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListMissionProfiles_RequestSyntax) **   <a name="groundstation-ListMissionProfiles-request-uri-nextToken"></a>
Next token returned in the request of a previous `ListMissionProfiles` call. Used to get the next page of results.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Request Body
<a name="API_ListMissionProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListMissionProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "missionProfileList": [ 
      { 
         "missionProfileArn": "string",
         "missionProfileId": "string",
         "name": "string",
         "region": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListMissionProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [missionProfileList](#API_ListMissionProfiles_ResponseSyntax) **   <a name="groundstation-ListMissionProfiles-response-missionProfileList"></a>
List of mission profiles.  
Type: Array of [MissionProfileListItem](API_MissionProfileListItem.md) objects

 ** [nextToken](#API_ListMissionProfiles_ResponseSyntax) **   <a name="groundstation-ListMissionProfiles-response-nextToken"></a>
Next token returned in the response of a previous `ListMissionProfiles` call. Used to get the next page of results.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Errors
<a name="API_ListMissionProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListMissionProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListMissionProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListMissionProfiles) 

# ListSatellites
<a name="API_ListSatellites"></a>

Returns a list of satellites.

## Request Syntax
<a name="API_ListSatellites_RequestSyntax"></a>

```
GET /satellite?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSatellites_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListSatellites_RequestSyntax) **   <a name="groundstation-ListSatellites-request-uri-maxResults"></a>
Maximum number of satellites returned.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_ListSatellites_RequestSyntax) **   <a name="groundstation-ListSatellites-request-uri-nextToken"></a>
Next token that can be supplied in the next call to get the next page of satellites.  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

## Request Body
<a name="API_ListSatellites_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSatellites_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "satellites": [ 
      { 
         "currentEphemeris": { 
            "ephemerisId": "string",
            "epoch": number,
            "name": "string",
            "source": "string"
         },
         "groundStations": [ "string" ],
         "noradSatelliteID": number,
         "satelliteArn": "string",
         "satelliteId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSatellites_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListSatellites_ResponseSyntax) **   <a name="groundstation-ListSatellites-response-nextToken"></a>
Next token that can be supplied in the next call to get the next page of satellites.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 1000.  
Pattern: `[A-Za-z0-9-/+_.=]+` 

 ** [satellites](#API_ListSatellites_ResponseSyntax) **   <a name="groundstation-ListSatellites-response-satellites"></a>
List of satellites.  
Type: Array of [SatelliteListItem](API_SatelliteListItem.md) objects

## Errors
<a name="API_ListSatellites_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListSatellites_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListSatellites) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListSatellites) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Returns a list of tags for a specified resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="groundstation-ListTagsForResource-request-uri-resourceArn"></a>
ARN of a resource.  
Length Constraints: Minimum length of 5. Maximum length of 1024.  
Pattern: `(arn:aws:)[\s\S]{0,1024}`   
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="groundstation-ListTagsForResource-response-tags"></a>
Tags assigned to a resource.  
Type: String to string map

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ListTagsForResource) 

# RegisterAgent
<a name="API_RegisterAgent"></a>

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

 Registers a new agent with AWS Ground Station. 

## Request Syntax
<a name="API_RegisterAgent_RequestSyntax"></a>

```
POST /agent HTTP/1.1
Content-type: application/json

{
   "agentDetails": { 
      "agentCpuCores": [ number ],
      "agentVersion": "string",
      "componentVersions": [ 
         { 
            "componentType": "string",
            "versions": [ "string" ]
         }
      ],
      "instanceId": "string",
      "instanceType": "string",
      "reservedCpuCores": [ number ]
   },
   "discoveryData": { 
      "capabilityArns": [ "string" ],
      "privateIpAddresses": [ "string" ],
      "publicIpAddresses": [ "string" ]
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_RegisterAgent_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_RegisterAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [agentDetails](#API_RegisterAgent_RequestSyntax) **   <a name="groundstation-RegisterAgent-request-agentDetails"></a>
Detailed information about the agent being registered.  
Type: [AgentDetails](API_AgentDetails.md) object  
Required: Yes

 ** [discoveryData](#API_RegisterAgent_RequestSyntax) **   <a name="groundstation-RegisterAgent-request-discoveryData"></a>
Data for associating an agent with the capabilities it is managing.  
Type: [DiscoveryData](API_DiscoveryData.md) object  
Required: Yes

 ** [tags](#API_RegisterAgent_RequestSyntax) **   <a name="groundstation-RegisterAgent-request-tags"></a>
Tags assigned to an `Agent`.  
Type: String to string map  
Required: No

## Response Syntax
<a name="API_RegisterAgent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "agentId": "string"
}
```

## Response Elements
<a name="API_RegisterAgent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentId](#API_RegisterAgent_ResponseSyntax) **   <a name="groundstation-RegisterAgent-response-agentId"></a>
UUID of registered agent.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_RegisterAgent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_RegisterAgent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/RegisterAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/RegisterAgent) 

# ReserveContact
<a name="API_ReserveContact"></a>

Reserves a contact using specified parameters.

## Request Syntax
<a name="API_ReserveContact_RequestSyntax"></a>

```
POST /contact HTTP/1.1
Content-type: application/json

{
   "endTime": number,
   "groundStation": "string",
   "missionProfileArn": "string",
   "satelliteArn": "string",
   "startTime": number,
   "tags": { 
      "string" : "string" 
   },
   "trackingOverrides": { 
      "programTrackSettings": { ... }
   }
}
```

## URI Request Parameters
<a name="API_ReserveContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ReserveContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [endTime](#API_ReserveContact_RequestSyntax) **   <a name="groundstation-ReserveContact-request-endTime"></a>
End time of a contact in UTC.  
Type: Timestamp  
Required: Yes

 ** [groundStation](#API_ReserveContact_RequestSyntax) **   <a name="groundstation-ReserveContact-request-groundStation"></a>
Name of a ground station.  
Type: String  
Length Constraints: Minimum length of 4. Maximum length of 97.  
Pattern: `[ a-zA-Z0-9-._:=]{4,97}`   
Required: Yes

 ** [missionProfileArn](#API_ReserveContact_RequestSyntax) **   <a name="groundstation-ReserveContact-request-missionProfileArn"></a>
ARN of a mission profile.  
Type: String  
Length Constraints: Minimum length of 89. Maximum length of 138.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:mission-profile/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [satelliteArn](#API_ReserveContact_RequestSyntax) **   <a name="groundstation-ReserveContact-request-satelliteArn"></a>
ARN of a satellite  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [startTime](#API_ReserveContact_RequestSyntax) **   <a name="groundstation-ReserveContact-request-startTime"></a>
Start time of a contact in UTC.  
Type: Timestamp  
Required: Yes

 ** [tags](#API_ReserveContact_RequestSyntax) **   <a name="groundstation-ReserveContact-request-tags"></a>
Tags assigned to a contact.  
Type: String to string map  
Required: No

 ** [trackingOverrides](#API_ReserveContact_RequestSyntax) **   <a name="groundstation-ReserveContact-request-trackingOverrides"></a>
Tracking configuration overrides for the contact.  
Type: [TrackingOverrides](API_TrackingOverrides.md) object  
Required: No

## Response Syntax
<a name="API_ReserveContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactId": "string",
   "versionId": number
}
```

## Response Elements
<a name="API_ReserveContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactId](#API_ReserveContact_ResponseSyntax) **   <a name="groundstation-ReserveContact-response-contactId"></a>
UUID of a contact.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [versionId](#API_ReserveContact_ResponseSyntax) **   <a name="groundstation-ReserveContact-response-versionId"></a>
Version ID of a contact.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 128.

## Errors
<a name="API_ReserveContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceLimitExceededException **   
Account limits for this resource have been exceeded.    
 ** parameterName **   
Name of the parameter that exceeded the resource limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_ReserveContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/ReserveContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/ReserveContact) 

# TagResource
<a name="API_TagResource"></a>

Assigns a tag to a resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="groundstation-TagResource-request-uri-resourceArn"></a>
ARN of a resource tag.  
Length Constraints: Minimum length of 5. Maximum length of 1024.  
Pattern: `(arn:aws:)[\s\S]{0,1024}`   
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="groundstation-TagResource-request-tags"></a>
Tags assigned to a resource.  
Type: String to string map  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Deassigns a resource tag.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="groundstation-UntagResource-request-uri-resourceArn"></a>
ARN of a resource.  
Length Constraints: Minimum length of 5. Maximum length of 1024.  
Pattern: `(arn:aws:)[\s\S]{0,1024}`   
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="groundstation-UntagResource-request-uri-tagKeys"></a>
Keys of a resource tag.  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Length Constraints: Minimum length of 1.  
Pattern: `[\s\S]+`   
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UntagResource) 

# UpdateAgentStatus
<a name="API_UpdateAgentStatus"></a>

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

Update the status of the agent.

## Request Syntax
<a name="API_UpdateAgentStatus_RequestSyntax"></a>

```
PUT /agent/agentId HTTP/1.1
Content-type: application/json

{
   "aggregateStatus": { 
      "signatureMap": { 
         "string" : boolean 
      },
      "status": "string"
   },
   "componentStatuses": [ 
      { 
         "bytesReceived": number,
         "bytesSent": number,
         "capabilityArn": "string",
         "componentType": "string",
         "dataflowId": "string",
         "packetsDropped": number,
         "status": "string"
      }
   ],
   "taskId": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAgentStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_UpdateAgentStatus_RequestSyntax) **   <a name="groundstation-UpdateAgentStatus-request-uri-agentId"></a>
UUID of agent to update.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_UpdateAgentStatus_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [aggregateStatus](#API_UpdateAgentStatus_RequestSyntax) **   <a name="groundstation-UpdateAgentStatus-request-aggregateStatus"></a>
Aggregate status for agent.  
Type: [AggregateStatus](API_AggregateStatus.md) object  
Required: Yes

 ** [componentStatuses](#API_UpdateAgentStatus_RequestSyntax) **   <a name="groundstation-UpdateAgentStatus-request-componentStatuses"></a>
List of component statuses for agent.  
Type: Array of [ComponentStatusData](API_ComponentStatusData.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: Yes

 ** [taskId](#API_UpdateAgentStatus_RequestSyntax) **   <a name="groundstation-UpdateAgentStatus-request-taskId"></a>
GUID of agent task.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Response Syntax
<a name="API_UpdateAgentStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "agentId": "string"
}
```

## Response Elements
<a name="API_UpdateAgentStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentId](#API_UpdateAgentStatus_ResponseSyntax) **   <a name="groundstation-UpdateAgentStatus-response-agentId"></a>
UUID of updated agent.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_UpdateAgentStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_UpdateAgentStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/UpdateAgentStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UpdateAgentStatus) 

# UpdateConfig
<a name="API_UpdateConfig"></a>

Updates the `Config` used when scheduling contacts.

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

## Request Syntax
<a name="API_UpdateConfig_RequestSyntax"></a>

```
PUT /config/configType/configId HTTP/1.1
Content-type: application/json

{
   "configData": { ... },
   "name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [configId](#API_UpdateConfig_RequestSyntax) **   <a name="groundstation-UpdateConfig-request-uri-configId"></a>
UUID of a `Config`.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [configType](#API_UpdateConfig_RequestSyntax) **   <a name="groundstation-UpdateConfig-request-uri-configType"></a>
Type of a `Config`.  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink`   
Required: Yes

## Request Body
<a name="API_UpdateConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configData](#API_UpdateConfig_RequestSyntax) **   <a name="groundstation-UpdateConfig-request-configData"></a>
Parameters of a `Config`.  
Type: [ConfigTypeData](API_ConfigTypeData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [name](#API_UpdateConfig_RequestSyntax) **   <a name="groundstation-UpdateConfig-request-name"></a>
Name of a `Config`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: Yes

## Response Syntax
<a name="API_UpdateConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configArn": "string",
   "configId": "string",
   "configType": "string"
}
```

## Response Elements
<a name="API_UpdateConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configArn](#API_UpdateConfig_ResponseSyntax) **   <a name="groundstation-UpdateConfig-response-configArn"></a>
ARN of a `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?` 

 ** [configId](#API_UpdateConfig_ResponseSyntax) **   <a name="groundstation-UpdateConfig-response-configId"></a>
UUID of a `Config`.  
Type: String

 ** [configType](#API_UpdateConfig_ResponseSyntax) **   <a name="groundstation-UpdateConfig-response-configType"></a>
Type of a `Config`.  
Type: String  
Valid Values: `antenna-downlink | antenna-downlink-demod-decode | tracking | dataflow-endpoint | antenna-uplink | uplink-echo | s3-recording | telemetry-sink` 

## Errors
<a name="API_UpdateConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_UpdateConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/UpdateConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UpdateConfig) 

# UpdateContact
<a name="API_UpdateContact"></a>

Updates a specific contact.

## Request Syntax
<a name="API_UpdateContact_RequestSyntax"></a>

```
POST /contact/contactId/versions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "satelliteArn": "string",
   "trackingOverrides": { 
      "programTrackSettings": { ... }
   }
}
```

## URI Request Parameters
<a name="API_UpdateContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contactId](#API_UpdateContact_RequestSyntax) **   <a name="groundstation-UpdateContact-request-uri-contactId"></a>
UUID of a contact.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_UpdateContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateContact_RequestSyntax) **   <a name="groundstation-UpdateContact-request-clientToken"></a>
A client token is a unique, case-sensitive string of up to 64 ASCII characters. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[!-~]{1,64}`   
Required: No

 ** [satelliteArn](#API_UpdateContact_RequestSyntax) **   <a name="groundstation-UpdateContact-request-satelliteArn"></a>
ARN of a satellite.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 132.  
Pattern: `arn:aws:groundstation:([-a-z0-9]{1,50})?:[0-9]{12}:satellite/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: No

 ** [trackingOverrides](#API_UpdateContact_RequestSyntax) **   <a name="groundstation-UpdateContact-request-trackingOverrides"></a>
Overrides the default tracking configuration on an antenna during a contact.  
Type: [TrackingOverrides](API_TrackingOverrides.md) object  
Required: No

## Response Syntax
<a name="API_UpdateContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contactId": "string",
   "versionId": number
}
```

## Response Elements
<a name="API_UpdateContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contactId](#API_UpdateContact_ResponseSyntax) **   <a name="groundstation-UpdateContact-response-contactId"></a>
UUID of a contact.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [versionId](#API_UpdateContact_ResponseSyntax) **   <a name="groundstation-UpdateContact-response-versionId"></a>
Version ID of a contact.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 128.

## Errors
<a name="API_UpdateContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceLimitExceededException **   
Account limits for this resource have been exceeded.    
 ** parameterName **   
Name of the parameter that exceeded the resource limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_UpdateContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/UpdateContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UpdateContact) 

# UpdateEphemeris
<a name="API_UpdateEphemeris"></a>

Update an existing ephemeris.

## Request Syntax
<a name="API_UpdateEphemeris_RequestSyntax"></a>

```
PUT /ephemeris/ephemerisId HTTP/1.1
Content-type: application/json

{
   "enabled": boolean,
   "name": "string",
   "priority": number
}
```

## URI Request Parameters
<a name="API_UpdateEphemeris_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ephemerisId](#API_UpdateEphemeris_RequestSyntax) **   <a name="groundstation-UpdateEphemeris-request-uri-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_UpdateEphemeris_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [enabled](#API_UpdateEphemeris_RequestSyntax) **   <a name="groundstation-UpdateEphemeris-request-enabled"></a>
Enable or disable the ephemeris. Changing this value doesn't require re-validation.  
Type: Boolean  
Required: Yes

 ** [name](#API_UpdateEphemeris_RequestSyntax) **   <a name="groundstation-UpdateEphemeris-request-name"></a>
A name that you can use to identify the ephemeris.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: No

 ** [priority](#API_UpdateEphemeris_RequestSyntax) **   <a name="groundstation-UpdateEphemeris-request-priority"></a>
A priority score that determines which ephemeris to use when multiple ephemerides overlap.  
Higher numbers take precedence. The default is 1. Must be 1 or greater.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 99999.  
Required: No

## Response Syntax
<a name="API_UpdateEphemeris_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ephemerisId": "string"
}
```

## Response Elements
<a name="API_UpdateEphemeris_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ephemerisId](#API_UpdateEphemeris_ResponseSyntax) **   <a name="groundstation-UpdateEphemeris-response-ephemerisId"></a>
The AWS Ground Station ephemeris ID.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_UpdateEphemeris_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_UpdateEphemeris_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/UpdateEphemeris) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UpdateEphemeris) 

# UpdateMissionProfile
<a name="API_UpdateMissionProfile"></a>

Updates a mission profile.

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

## Request Syntax
<a name="API_UpdateMissionProfile_RequestSyntax"></a>

```
PUT /missionprofile/missionProfileId HTTP/1.1
Content-type: application/json

{
   "contactPostPassDurationSeconds": number,
   "contactPrePassDurationSeconds": number,
   "dataflowEdges": [ 
      [ "string" ]
   ],
   "minimumViableContactDurationSeconds": number,
   "name": "string",
   "streamsKmsKey": { ... },
   "streamsKmsRole": "string",
   "telemetrySinkConfigArn": "string",
   "trackingConfigArn": "string"
}
```

## URI Request Parameters
<a name="API_UpdateMissionProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [missionProfileId](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-uri-missionProfileId"></a>
UUID of a mission profile.  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

## Request Body
<a name="API_UpdateMissionProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contactPostPassDurationSeconds](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-contactPostPassDurationSeconds"></a>
Amount of time after a contact ends that you'd like to receive a Ground Station Contact State Change event indicating the pass has finished.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 21600.  
Required: No

 ** [contactPrePassDurationSeconds](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-contactPrePassDurationSeconds"></a>
Amount of time after a contact ends that you'd like to receive a Ground Station Contact State Change event indicating the pass has finished.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 21600.  
Required: No

 ** [dataflowEdges](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-dataflowEdges"></a>
A list of lists of ARNs. Each list of ARNs is an edge, with a *from* ` Config` and a *to* `Config`.  
Type: Array of arrays of strings  
Array Members: Minimum number of 0 items. Maximum number of 500 items.  
Array Members: Fixed number of 2 items.  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?`   
Required: No

 ** [minimumViableContactDurationSeconds](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-minimumViableContactDurationSeconds"></a>
Smallest amount of time in seconds that you'd like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 21600.  
Required: No

 ** [name](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-name"></a>
Name of a mission profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[ a-zA-Z0-9_:-]{1,256}`   
Required: No

 ** [streamsKmsKey](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-streamsKmsKey"></a>
KMS key to use for encrypting streams.  
Type: [KmsKey](API_KmsKey.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [streamsKmsRole](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-streamsKmsRole"></a>
Role to use for encrypting streams with KMS key.  
Type: String  
Length Constraints: Minimum length of 30. Maximum length of 165.  
Pattern: `arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[\w+=,.@-]{1,64}`   
Required: No

 ** [telemetrySinkConfigArn](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-telemetrySinkConfigArn"></a>
ARN of a telemetry sink `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?`   
Required: No

 ** [trackingConfigArn](#API_UpdateMissionProfile_RequestSyntax) **   <a name="groundstation-UpdateMissionProfile-request-trackingConfigArn"></a>
ARN of a tracking `Config`.  
Type: String  
Length Constraints: Minimum length of 82. Maximum length of 424.  
Pattern: `arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?`   
Required: No

## Response Syntax
<a name="API_UpdateMissionProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "missionProfileId": "string"
}
```

## Response Elements
<a name="API_UpdateMissionProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [missionProfileId](#API_UpdateMissionProfile_ResponseSyntax) **   <a name="groundstation-UpdateMissionProfile-response-missionProfileId"></a>
UUID of a mission profile.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_UpdateMissionProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** DependencyException **   
Dependency encountered an error.    
 ** parameterName **   
Name of the parameter that caused the exception.
HTTP Status Code: 531

 ** InvalidParameterException **   
One or more parameters are not valid.    
 ** parameterName **   
Name of the invalid parameter.
HTTP Status Code: 431

 ** ResourceNotFoundException **   
Resource was not found.  
HTTP Status Code: 434

## See Also
<a name="API_UpdateMissionProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/groundstation-2019-05-23/UpdateMissionProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/groundstation-2019-05-23/UpdateMissionProfile)