Class: AWS.GroundStation

var params = {
  configData: { /* required */
    antennaDownlinkConfig: {
      spectrumConfig: { /* required */
        bandwidth: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        centerFrequency: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        polarization: LEFT_HAND | NONE | RIGHT_HAND
      }
    },
    antennaDownlinkDemodDecodeConfig: {
      decodeConfig: { /* required */
        unvalidatedJSON: 'STRING_VALUE' /* required */
      },
      demodulationConfig: { /* required */
        unvalidatedJSON: 'STRING_VALUE' /* required */
      },
      spectrumConfig: { /* required */
        bandwidth: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        centerFrequency: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        polarization: LEFT_HAND | NONE | RIGHT_HAND
      }
    },
    antennaUplinkConfig: {
      spectrumConfig: { /* required */
        centerFrequency: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        polarization: LEFT_HAND | NONE | RIGHT_HAND
      },
      targetEirp: { /* required */
        units: dBW, /* required */
        value: 'NUMBER_VALUE' /* required */
      },
      transmitDisabled: true || false
    },
    dataflowEndpointConfig: {
      dataflowEndpointName: 'STRING_VALUE', /* required */
      dataflowEndpointRegion: 'STRING_VALUE'
    },
    s3RecordingConfig: {
      bucketArn: 'STRING_VALUE', /* required */
      roleArn: 'STRING_VALUE', /* required */
      prefix: 'STRING_VALUE'
    },
    trackingConfig: {
      autotrack: PREFERRED | REMOVED | REQUIRED /* required */
    },
    uplinkEchoConfig: {
      antennaUplinkConfigArn: 'STRING_VALUE', /* required */
      enabled: true || false /* required */
    }
  },
  name: 'STRING_VALUE', /* required */
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
groundstation.createConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configData — (map)

    Parameters of a Config.

    • antennaDownlinkConfig — (map)

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

      • spectrumConfig — required — (map)

        Object that describes a spectral Config.

        • bandwidth — required — (map)

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

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

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

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

          • units — required — (String)

            Frequency bandwidth units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

            Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

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

            • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.

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

        • centerFrequency — required — (map)

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

          • units — required — (String)

            Frequency units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

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

        • polarization — (String)

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

          Possible values include:
          • "LEFT_HAND"
          • "NONE"
          • "RIGHT_HAND"
    • antennaDownlinkDemodDecodeConfig — (map)

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

      • decodeConfig — required — (map)

        Information about the decode Config.

        • unvalidatedJSON — required — (String)

          Unvalidated JSON of a decode Config.

      • demodulationConfig — required — (map)

        Information about the demodulation Config.

        • unvalidatedJSON — required — (String)

          Unvalidated JSON of a demodulation Config.

      • spectrumConfig — required — (map)

        Information about the spectral Config.

        • bandwidth — required — (map)

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

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

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

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

          • units — required — (String)

            Frequency bandwidth units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

            Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

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

            • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.

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

        • centerFrequency — required — (map)

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

          • units — required — (String)

            Frequency units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

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

        • polarization — (String)

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

          Possible values include:
          • "LEFT_HAND"
          • "NONE"
          • "RIGHT_HAND"
    • antennaUplinkConfig — (map)

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

      • spectrumConfig — required — (map)

        Information about the uplink spectral Config.

        • centerFrequency — required — (map)

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

          • units — required — (String)

            Frequency units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

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

        • polarization — (String)

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

          Possible values include:
          • "LEFT_HAND"
          • "NONE"
          • "RIGHT_HAND"
      • targetEirp — required — (map)

        EIRP of the target.

        • units — required — (String)

          Units of an EIRP.

          Possible values include:
          • "dBW"
        • value — required — (Float)

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

      • transmitDisabled — (Boolean)

        Whether or not uplink transmit is disabled.

    • dataflowEndpointConfig — (map)

      Information about the dataflow endpoint Config.

      • dataflowEndpointName — required — (String)

        Name of a dataflow endpoint.

      • dataflowEndpointRegion — (String)

        Region of a dataflow endpoint.

    • s3RecordingConfig — (map)

      Information about an S3 recording Config.

      • bucketArn — required — (String)

        ARN of the bucket to record to.

      • prefix — (String)

        S3 Key prefix to prefice data files.

      • roleArn — required — (String)

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

    • trackingConfig — (map)

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

      • autotrack — required — (String)

        Current setting for autotrack.

        Possible values include:
        • "PREFERRED"
        • "REMOVED"
        • "REQUIRED"
    • uplinkEchoConfig — (map)

      Information about an uplink echo Config.

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

      • antennaUplinkConfigArn — required — (String)

        ARN of an uplink Config.

      • enabled — required — (Boolean)

        Whether or not an uplink Config is enabled.

  • name — (String)

    Name of a Config.

  • tags — (map<String>)

    Tags assigned to a Config.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configArn — (String)

      ARN of a Config.

    • configId — (String)

      UUID of a Config.

    • configType — (String)

      Type of a Config.

      Possible values include:
      • "antenna-downlink"
      • "antenna-downlink-demod-decode"
      • "antenna-uplink"
      • "dataflow-endpoint"
      • "tracking"
      • "uplink-echo"
      • "s3-recording"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  endpointDetails: [ /* required */
    {
      endpoint: {
        address: {
          name: 'STRING_VALUE', /* required */
          port: 'NUMBER_VALUE' /* required */
        },
        mtu: 'NUMBER_VALUE',
        name: 'STRING_VALUE',
        status: created | creating | deleted | deleting | failed
      },
      securityDetails: {
        roleArn: 'STRING_VALUE', /* required */
        securityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        subnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
groundstation.createDataflowEndpointGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • endpointDetails — (Array<map>)

    Endpoint details of each endpoint in the dataflow endpoint group.

    • endpoint — (map)

      A dataflow endpoint.

      • address — (map)

        Socket address of a dataflow endpoint.

        • name — required — (String)

          Name of a socket address.

        • port — required — (Integer)

          Port of a socket address.

      • mtu — (Integer)

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

      • name — (String)

        Name of a dataflow endpoint.

      • status — (String)

        Status of a dataflow endpoint.

        Possible values include:
        • "created"
        • "creating"
        • "deleted"
        • "deleting"
        • "failed"
    • securityDetails — (map)

      Endpoint security details.

      • roleArn — required — (String)

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

      • securityGroupIds — required — (Array<String>)

        The security groups to attach to the elastic network interfaces.

      • subnetIds — required — (Array<String>)

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

  • tags — (map<String>)

    Tags of a dataflow endpoint group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataflowEndpointGroupId — (String)

      UUID of a dataflow endpoint group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataflowEdges: [ /* required */
    [
      'STRING_VALUE',
      /* more items */
    ],
    /* more items */
  ],
  minimumViableContactDurationSeconds: 'NUMBER_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  trackingConfigArn: 'STRING_VALUE', /* required */
  contactPostPassDurationSeconds: 'NUMBER_VALUE',
  contactPrePassDurationSeconds: 'NUMBER_VALUE',
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
groundstation.createMissionProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • contactPostPassDurationSeconds — (Integer)

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

  • contactPrePassDurationSeconds — (Integer)

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

  • dataflowEdges — (Array<Array<String>>)

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

  • minimumViableContactDurationSeconds — (Integer)

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

  • name — (String)

    Name of a mission profile.

  • tags — (map<String>)

    Tags assigned to a mission profile.

  • trackingConfigArn — (String)

    ARN of a tracking Config.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • missionProfileId — (String)

      UUID of a mission profile.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configId: 'STRING_VALUE', /* required */
  configType: antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo | s3-recording /* required */
};
groundstation.deleteConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configId — (String)

    UUID of a Config.

  • configType — (String)

    Type of a Config.

    Possible values include:
    • "antenna-downlink"
    • "antenna-downlink-demod-decode"
    • "antenna-uplink"
    • "dataflow-endpoint"
    • "tracking"
    • "uplink-echo"
    • "s3-recording"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configArn — (String)

      ARN of a Config.

    • configId — (String)

      UUID of a Config.

    • configType — (String)

      Type of a Config.

      Possible values include:
      • "antenna-downlink"
      • "antenna-downlink-demod-decode"
      • "antenna-uplink"
      • "dataflow-endpoint"
      • "tracking"
      • "uplink-echo"
      • "s3-recording"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataflowEndpointGroupId: 'STRING_VALUE' /* required */
};
groundstation.deleteDataflowEndpointGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataflowEndpointGroupId — (String)

    UUID of a dataflow endpoint group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataflowEndpointGroupId — (String)

      UUID of a dataflow endpoint group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  missionProfileId: 'STRING_VALUE' /* required */
};
groundstation.deleteMissionProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • missionProfileId — (String)

    UUID of a mission profile.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • missionProfileId — (String)

      UUID of a mission profile.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  contactId: 'STRING_VALUE' /* required */
};
groundstation.describeContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • contactId — (String)

    UUID of a contact.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contactId — (String)

      UUID of a contact.

    • contactStatus — (String)

      Status of a contact.

      Possible values include:
      • "AVAILABLE"
      • "AWS_CANCELLED"
      • "AWS_FAILED"
      • "CANCELLED"
      • "CANCELLING"
      • "COMPLETED"
      • "FAILED"
      • "FAILED_TO_SCHEDULE"
      • "PASS"
      • "POSTPASS"
      • "PREPASS"
      • "SCHEDULED"
      • "SCHEDULING"
    • dataflowList — (Array<map>)

      List describing source and destination details for each dataflow edge.

      • destination — (map)

        Dataflow details for the destination side.

        • configDetails — (map)

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

          • antennaDemodDecodeDetails — (map)

            Details for antenna demod decode Config in a contact.

            • outputNode — (String)

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

          • endpointDetails — (map)

            Information about the endpoint details.

            • endpoint — (map)

              A dataflow endpoint.

              • address — (map)

                Socket address of a dataflow endpoint.

                • name — required — (String)

                  Name of a socket address.

                • port — required — (Integer)

                  Port of a socket address.

              • mtu — (Integer)

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

              • name — (String)

                Name of a dataflow endpoint.

              • status — (String)

                Status of a dataflow endpoint.

                Possible values include:
                • "created"
                • "creating"
                • "deleted"
                • "deleting"
                • "failed"
            • securityDetails — (map)

              Endpoint security details.

              • roleArn — required — (String)

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

              • securityGroupIds — required — (Array<String>)

                The security groups to attach to the elastic network interfaces.

              • subnetIds — required — (Array<String>)

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

          • s3RecordingDetails — (map)

            Details for an S3 recording Config in a contact.

            • bucketArn — (String)

              ARN of the bucket used.

            • keyTemplate — (String)

              Template of the S3 key used.

        • configId — (String)

          UUID of a Config.

        • configType — (String)

          Type of a Config.

          Possible values include:
          • "antenna-downlink"
          • "antenna-downlink-demod-decode"
          • "antenna-uplink"
          • "dataflow-endpoint"
          • "tracking"
          • "uplink-echo"
          • "s3-recording"
        • dataflowDestinationRegion — (String)

          Region of a dataflow destination.

      • errorMessage — (String)

        Error message for a dataflow.

      • source — (map)

        Dataflow details for the source side.

        • configDetails — (map)

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

          • antennaDemodDecodeDetails — (map)

            Details for antenna demod decode Config in a contact.

            • outputNode — (String)

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

          • endpointDetails — (map)

            Information about the endpoint details.

            • endpoint — (map)

              A dataflow endpoint.

              • address — (map)

                Socket address of a dataflow endpoint.

                • name — required — (String)

                  Name of a socket address.

                • port — required — (Integer)

                  Port of a socket address.

              • mtu — (Integer)

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

              • name — (String)

                Name of a dataflow endpoint.

              • status — (String)

                Status of a dataflow endpoint.

                Possible values include:
                • "created"
                • "creating"
                • "deleted"
                • "deleting"
                • "failed"
            • securityDetails — (map)

              Endpoint security details.

              • roleArn — required — (String)

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

              • securityGroupIds — required — (Array<String>)

                The security groups to attach to the elastic network interfaces.

              • subnetIds — required — (Array<String>)

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

          • s3RecordingDetails — (map)

            Details for an S3 recording Config in a contact.

            • bucketArn — (String)

              ARN of the bucket used.

            • keyTemplate — (String)

              Template of the S3 key used.

        • configId — (String)

          UUID of a Config.

        • configType — (String)

          Type of a Config.

          Possible values include:
          • "antenna-downlink"
          • "antenna-downlink-demod-decode"
          • "antenna-uplink"
          • "dataflow-endpoint"
          • "tracking"
          • "uplink-echo"
          • "s3-recording"
        • dataflowSourceRegion — (String)

          Region of a dataflow source.

    • endTime — (Date)

      End time of a contact.

    • errorMessage — (String)

      Error message for a contact.

    • groundStation — (String)

      Ground station for a contact.

    • maximumElevation — (map)

      Maximum elevation angle of a contact.

      • unit — required — (String)

        Elevation angle units.

        Possible values include:
        • "DEGREE_ANGLE"
        • "RADIAN"
      • value — required — (Float)

        Elevation angle value.

    • missionProfileArn — (String)

      ARN of a mission profile.

    • postPassEndTime — (Date)

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

    • prePassStartTime — (Date)

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

    • region — (String)

      Region of a contact.

    • satelliteArn — (String)

      ARN of a satellite.

    • startTime — (Date)

      Start time of a contact.

    • tags — (map<String>)

      Tags assigned to a contact.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configId: 'STRING_VALUE', /* required */
  configType: antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo | s3-recording /* required */
};
groundstation.getConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configId — (String)

    UUID of a Config.

  • configType — (String)

    Type of a Config.

    Possible values include:
    • "antenna-downlink"
    • "antenna-downlink-demod-decode"
    • "antenna-uplink"
    • "dataflow-endpoint"
    • "tracking"
    • "uplink-echo"
    • "s3-recording"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configArn — (String)

      ARN of a Config

    • configData — (map)

      Data elements in a Config.

      • antennaDownlinkConfig — (map)

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

        • spectrumConfig — required — (map)

          Object that describes a spectral Config.

          • bandwidth — required — (map)

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

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

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

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

            • units — required — (String)

              Frequency bandwidth units.

              Possible values include:
              • "GHz"
              • "MHz"
              • "kHz"
            • value — required — (Float)

              Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

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

              • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.

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

          • centerFrequency — required — (map)

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

            • units — required — (String)

              Frequency units.

              Possible values include:
              • "GHz"
              • "MHz"
              • "kHz"
            • value — required — (Float)

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

          • polarization — (String)

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

            Possible values include:
            • "LEFT_HAND"
            • "NONE"
            • "RIGHT_HAND"
      • antennaDownlinkDemodDecodeConfig — (map)

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

        • decodeConfig — required — (map)

          Information about the decode Config.

          • unvalidatedJSON — required — (String)

            Unvalidated JSON of a decode Config.

        • demodulationConfig — required — (map)

          Information about the demodulation Config.

          • unvalidatedJSON — required — (String)

            Unvalidated JSON of a demodulation Config.

        • spectrumConfig — required — (map)

          Information about the spectral Config.

          • bandwidth — required — (map)

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

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

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

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

            • units — required — (String)

              Frequency bandwidth units.

              Possible values include:
              • "GHz"
              • "MHz"
              • "kHz"
            • value — required — (Float)

              Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

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

              • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.

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

          • centerFrequency — required — (map)

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

            • units — required — (String)

              Frequency units.

              Possible values include:
              • "GHz"
              • "MHz"
              • "kHz"
            • value — required — (Float)

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

          • polarization — (String)

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

            Possible values include:
            • "LEFT_HAND"
            • "NONE"
            • "RIGHT_HAND"
      • antennaUplinkConfig — (map)

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

        • spectrumConfig — required — (map)

          Information about the uplink spectral Config.

          • centerFrequency — required — (map)

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

            • units — required — (String)

              Frequency units.

              Possible values include:
              • "GHz"
              • "MHz"
              • "kHz"
            • value — required — (Float)

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

          • polarization — (String)

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

            Possible values include:
            • "LEFT_HAND"
            • "NONE"
            • "RIGHT_HAND"
        • targetEirp — required — (map)

          EIRP of the target.

          • units — required — (String)

            Units of an EIRP.

            Possible values include:
            • "dBW"
          • value — required — (Float)

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

        • transmitDisabled — (Boolean)

          Whether or not uplink transmit is disabled.

      • dataflowEndpointConfig — (map)

        Information about the dataflow endpoint Config.

        • dataflowEndpointName — required — (String)

          Name of a dataflow endpoint.

        • dataflowEndpointRegion — (String)

          Region of a dataflow endpoint.

      • s3RecordingConfig — (map)

        Information about an S3 recording Config.

        • bucketArn — required — (String)

          ARN of the bucket to record to.

        • prefix — (String)

          S3 Key prefix to prefice data files.

        • roleArn — required — (String)

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

      • trackingConfig — (map)

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

        • autotrack — required — (String)

          Current setting for autotrack.

          Possible values include:
          • "PREFERRED"
          • "REMOVED"
          • "REQUIRED"
      • uplinkEchoConfig — (map)

        Information about an uplink echo Config.

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

        • antennaUplinkConfigArn — required — (String)

          ARN of an uplink Config.

        • enabled — required — (Boolean)

          Whether or not an uplink Config is enabled.

    • configId — (String)

      UUID of a Config.

    • configType — (String)

      Type of a Config.

      Possible values include:
      • "antenna-downlink"
      • "antenna-downlink-demod-decode"
      • "antenna-uplink"
      • "dataflow-endpoint"
      • "tracking"
      • "uplink-echo"
      • "s3-recording"
    • name — (String)

      Name of a Config.

    • tags — (map<String>)

      Tags assigned to a Config.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  dataflowEndpointGroupId: 'STRING_VALUE' /* required */
};
groundstation.getDataflowEndpointGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • dataflowEndpointGroupId — (String)

    UUID of a dataflow endpoint group.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataflowEndpointGroupArn — (String)

      ARN of a dataflow endpoint group.

    • dataflowEndpointGroupId — (String)

      UUID of a dataflow endpoint group.

    • endpointsDetails — (Array<map>)

      Details of a dataflow endpoint.

      • endpoint — (map)

        A dataflow endpoint.

        • address — (map)

          Socket address of a dataflow endpoint.

          • name — required — (String)

            Name of a socket address.

          • port — required — (Integer)

            Port of a socket address.

        • mtu — (Integer)

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

        • name — (String)

          Name of a dataflow endpoint.

        • status — (String)

          Status of a dataflow endpoint.

          Possible values include:
          • "created"
          • "creating"
          • "deleted"
          • "deleting"
          • "failed"
      • securityDetails — (map)

        Endpoint security details.

        • roleArn — required — (String)

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

        • securityGroupIds — required — (Array<String>)

          The security groups to attach to the elastic network interfaces.

        • subnetIds — required — (Array<String>)

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

    • tags — (map<String>)

      Tags assigned to a dataflow endpoint group.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  month: 'NUMBER_VALUE', /* required */
  year: 'NUMBER_VALUE' /* required */
};
groundstation.getMinuteUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • month — (Integer)

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

  • year — (Integer)

    The year being requested, in the format of YYYY.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • estimatedMinutesRemaining — (Integer)

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

    • isReservedMinutesCustomer — (Boolean)

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

    • totalReservedMinuteAllocation — (Integer)

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

    • totalScheduledMinutes — (Integer)

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

    • upcomingMinutesScheduled — (Integer)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  missionProfileId: 'STRING_VALUE' /* required */
};
groundstation.getMissionProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • missionProfileId — (String)

    UUID of a mission profile.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contactPostPassDurationSeconds — (Integer)

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

    • contactPrePassDurationSeconds — (Integer)

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

    • dataflowEdges — (Array<Array<String>>)

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

    • minimumViableContactDurationSeconds — (Integer)

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

    • missionProfileArn — (String)

      ARN of a mission profile.

    • missionProfileId — (String)

      UUID of a mission profile.

    • name — (String)

      Name of a mission profile.

    • region — (String)

      Region of a mission profile.

    • tags — (map<String>)

      Tags assigned to a mission profile.

    • trackingConfigArn — (String)

      ARN of a tracking Config.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  satelliteId: 'STRING_VALUE' /* required */
};
groundstation.getSatellite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • satelliteId — (String)

    UUID of a satellite.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • groundStations — (Array<String>)

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

    • noradSatelliteID — (Integer)

      NORAD satellite ID number.

    • satelliteArn — (String)

      ARN of a satellite.

    • satelliteId — (String)

      UUID of a satellite.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
groundstation.listConfigs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    Maximum number of Configs returned.

  • nextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configList — (Array<map>)

      List of Config items.

      • configArn — (String)

        ARN of a Config.

      • configId — (String)

        UUID of a Config.

      • configType — (String)

        Type of a Config.

        Possible values include:
        • "antenna-downlink"
        • "antenna-downlink-demod-decode"
        • "antenna-uplink"
        • "dataflow-endpoint"
        • "tracking"
        • "uplink-echo"
        • "s3-recording"
      • name — (String)

        Name of a Config.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  statusList: [ /* required */
    AVAILABLE | AWS_CANCELLED | AWS_FAILED | CANCELLED | CANCELLING | COMPLETED | FAILED | FAILED_TO_SCHEDULE | PASS | POSTPASS | PREPASS | SCHEDULED | SCHEDULING,
    /* more items */
  ],
  groundStation: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  missionProfileArn: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  satelliteArn: 'STRING_VALUE'
};
groundstation.listContacts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • endTime — (Date)

    End time of a contact.

  • groundStation — (String)

    Name of a ground station.

  • maxResults — (Integer)

    Maximum number of contacts returned.

  • missionProfileArn — (String)

    ARN of a mission profile.

  • nextToken — (String)

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

  • satelliteArn — (String)

    ARN of a satellite.

  • startTime — (Date)

    Start time of a contact.

  • statusList — (Array<String>)

    Status of a contact reservation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contactList — (Array<map>)

      List of contacts.

      • contactId — (String)

        UUID of a contact.

      • contactStatus — (String)

        Status of a contact.

        Possible values include:
        • "AVAILABLE"
        • "AWS_CANCELLED"
        • "AWS_FAILED"
        • "CANCELLED"
        • "CANCELLING"
        • "COMPLETED"
        • "FAILED"
        • "FAILED_TO_SCHEDULE"
        • "PASS"
        • "POSTPASS"
        • "PREPASS"
        • "SCHEDULED"
        • "SCHEDULING"
      • endTime — (Date)

        End time of a contact.

      • errorMessage — (String)

        Error message of a contact.

      • groundStation — (String)

        Name of a ground station.

      • maximumElevation — (map)

        Maximum elevation angle of a contact.

        • unit — required — (String)

          Elevation angle units.

          Possible values include:
          • "DEGREE_ANGLE"
          • "RADIAN"
        • value — required — (Float)

          Elevation angle value.

      • missionProfileArn — (String)

        ARN of a mission profile.

      • postPassEndTime — (Date)

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

      • prePassStartTime — (Date)

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

      • region — (String)

        Region of a contact.

      • satelliteArn — (String)

        ARN of a satellite.

      • startTime — (Date)

        Start time of a contact.

      • tags — (map<String>)

        Tags assigned to a contact.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
groundstation.listDataflowEndpointGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    Maximum number of dataflow endpoint groups returned.

  • nextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataflowEndpointGroupList — (Array<map>)

      A list of dataflow endpoint groups.

      • dataflowEndpointGroupArn — (String)

        ARN of a dataflow endpoint group.

      • dataflowEndpointGroupId — (String)

        UUID of a dataflow endpoint group.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  satelliteId: 'STRING_VALUE'
};
groundstation.listGroundStations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    Maximum number of ground stations returned.

  • nextToken — (String)

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

  • satelliteId — (String)

    Satellite ID to retrieve on-boarded ground stations.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • groundStationList — (Array<map>)

      List of ground stations.

      • groundStationId — (String)

        UUID of a ground station.

      • groundStationName — (String)

        Name of a ground station.

      • region — (String)

        Ground station Region.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
groundstation.listMissionProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    Maximum number of mission profiles returned.

  • nextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • missionProfileList — (Array<map>)

      List of mission profiles.

      • missionProfileArn — (String)

        ARN of a mission profile.

      • missionProfileId — (String)

        UUID of a mission profile.

      • name — (String)

        Name of a mission profile.

      • region — (String)

        Region of a mission profile.

    • nextToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
groundstation.listSatellites(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • maxResults — (Integer)

    Maximum number of satellites returned.

  • nextToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • nextToken — (String)

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

    • satellites — (Array<map>)

      List of satellites.

      • groundStations — (Array<String>)

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

      • noradSatelliteID — (Integer)

        NORAD satellite ID number.

      • satelliteArn — (String)

        ARN of a satellite.

      • satelliteId — (String)

        UUID of a satellite.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
groundstation.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    ARN of a resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      Tags assigned to a resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  groundStation: 'STRING_VALUE', /* required */
  missionProfileArn: 'STRING_VALUE', /* required */
  satelliteArn: 'STRING_VALUE', /* required */
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
groundstation.reserveContact(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • endTime — (Date)

    End time of a contact.

  • groundStation — (String)

    Name of a ground station.

  • missionProfileArn — (String)

    ARN of a mission profile.

  • satelliteArn — (String)

    ARN of a satellite

  • startTime — (Date)

    Start time of a contact.

  • tags — (map<String>)

    Tags assigned to a contact.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • contactId — (String)

      UUID of a contact.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
groundstation.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    ARN of a resource tag.

  • tags — (map<String>)

    Tags assigned to a resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
groundstation.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    ARN of a resource.

  • tagKeys — (Array<String>)

    Keys of a resource tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  configData: { /* required */
    antennaDownlinkConfig: {
      spectrumConfig: { /* required */
        bandwidth: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        centerFrequency: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        polarization: LEFT_HAND | NONE | RIGHT_HAND
      }
    },
    antennaDownlinkDemodDecodeConfig: {
      decodeConfig: { /* required */
        unvalidatedJSON: 'STRING_VALUE' /* required */
      },
      demodulationConfig: { /* required */
        unvalidatedJSON: 'STRING_VALUE' /* required */
      },
      spectrumConfig: { /* required */
        bandwidth: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        centerFrequency: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        polarization: LEFT_HAND | NONE | RIGHT_HAND
      }
    },
    antennaUplinkConfig: {
      spectrumConfig: { /* required */
        centerFrequency: { /* required */
          units: GHz | MHz | kHz, /* required */
          value: 'NUMBER_VALUE' /* required */
        },
        polarization: LEFT_HAND | NONE | RIGHT_HAND
      },
      targetEirp: { /* required */
        units: dBW, /* required */
        value: 'NUMBER_VALUE' /* required */
      },
      transmitDisabled: true || false
    },
    dataflowEndpointConfig: {
      dataflowEndpointName: 'STRING_VALUE', /* required */
      dataflowEndpointRegion: 'STRING_VALUE'
    },
    s3RecordingConfig: {
      bucketArn: 'STRING_VALUE', /* required */
      roleArn: 'STRING_VALUE', /* required */
      prefix: 'STRING_VALUE'
    },
    trackingConfig: {
      autotrack: PREFERRED | REMOVED | REQUIRED /* required */
    },
    uplinkEchoConfig: {
      antennaUplinkConfigArn: 'STRING_VALUE', /* required */
      enabled: true || false /* required */
    }
  },
  configId: 'STRING_VALUE', /* required */
  configType: antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo | s3-recording, /* required */
  name: 'STRING_VALUE' /* required */
};
groundstation.updateConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • configData — (map)

    Parameters of a Config.

    • antennaDownlinkConfig — (map)

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

      • spectrumConfig — required — (map)

        Object that describes a spectral Config.

        • bandwidth — required — (map)

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

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

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

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

          • units — required — (String)

            Frequency bandwidth units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

            Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

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

            • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.

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

        • centerFrequency — required — (map)

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

          • units — required — (String)

            Frequency units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

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

        • polarization — (String)

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

          Possible values include:
          • "LEFT_HAND"
          • "NONE"
          • "RIGHT_HAND"
    • antennaDownlinkDemodDecodeConfig — (map)

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

      • decodeConfig — required — (map)

        Information about the decode Config.

        • unvalidatedJSON — required — (String)

          Unvalidated JSON of a decode Config.

      • demodulationConfig — required — (map)

        Information about the demodulation Config.

        • unvalidatedJSON — required — (String)

          Unvalidated JSON of a demodulation Config.

      • spectrumConfig — required — (map)

        Information about the spectral Config.

        • bandwidth — required — (map)

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

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

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

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

          • units — required — (String)

            Frequency bandwidth units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

            Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

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

            • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.

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

        • centerFrequency — required — (map)

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

          • units — required — (String)

            Frequency units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

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

        • polarization — (String)

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

          Possible values include:
          • "LEFT_HAND"
          • "NONE"
          • "RIGHT_HAND"
    • antennaUplinkConfig — (map)

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

      • spectrumConfig — required — (map)

        Information about the uplink spectral Config.

        • centerFrequency — required — (map)

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

          • units — required — (String)

            Frequency units.

            Possible values include:
            • "GHz"
            • "MHz"
            • "kHz"
          • value — required — (Float)

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

        • polarization — (String)

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

          Possible values include:
          • "LEFT_HAND"
          • "NONE"
          • "RIGHT_HAND"
      • targetEirp — required — (map)

        EIRP of the target.

        • units — required — (String)

          Units of an EIRP.

          Possible values include:
          • "dBW"
        • value — required — (Float)

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

      • transmitDisabled — (Boolean)

        Whether or not uplink transmit is disabled.

    • dataflowEndpointConfig — (map)

      Information about the dataflow endpoint Config.

      • dataflowEndpointName — required — (String)

        Name of a dataflow endpoint.

      • dataflowEndpointRegion — (String)

        Region of a dataflow endpoint.

    • s3RecordingConfig — (map)

      Information about an S3 recording Config.

      • bucketArn — required — (String)

        ARN of the bucket to record to.

      • prefix — (String)

        S3 Key prefix to prefice data files.

      • roleArn — required — (String)

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

    • trackingConfig — (map)

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

      • autotrack — required — (String)

        Current setting for autotrack.

        Possible values include:
        • "PREFERRED"
        • "REMOVED"
        • "REQUIRED"
    • uplinkEchoConfig — (map)

      Information about an uplink echo Config.

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

      • antennaUplinkConfigArn — required — (String)

        ARN of an uplink Config.

      • enabled — required — (Boolean)

        Whether or not an uplink Config is enabled.

  • configId — (String)

    UUID of a Config.

  • configType — (String)

    Type of a Config.

    Possible values include:
    • "antenna-downlink"
    • "antenna-downlink-demod-decode"
    • "antenna-uplink"
    • "dataflow-endpoint"
    • "tracking"
    • "uplink-echo"
    • "s3-recording"
  • name — (String)

    Name of a Config.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • configArn — (String)

      ARN of a Config.

    • configId — (String)

      UUID of a Config.

    • configType — (String)

      Type of a Config.

      Possible values include:
      • "antenna-downlink"
      • "antenna-downlink-demod-decode"
      • "antenna-uplink"
      • "dataflow-endpoint"
      • "tracking"
      • "uplink-echo"
      • "s3-recording"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  missionProfileId: 'STRING_VALUE', /* required */
  contactPostPassDurationSeconds: 'NUMBER_VALUE',
  contactPrePassDurationSeconds: 'NUMBER_VALUE',
  dataflowEdges: [
    [
      'STRING_VALUE',
      /* more items */
    ],
    /* more items */
  ],
  minimumViableContactDurationSeconds: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  trackingConfigArn: 'STRING_VALUE'
};
groundstation.updateMissionProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • contactPostPassDurationSeconds — (Integer)

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

  • contactPrePassDurationSeconds — (Integer)

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

  • dataflowEdges — (Array<Array<String>>)

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

  • minimumViableContactDurationSeconds — (Integer)

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

  • missionProfileId — (String)

    UUID of a mission profile.

  • name — (String)

    Name of a mission profile.

  • trackingConfigArn — (String)

    ARN of a tracking Config.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • missionProfileId — (String)

      UUID of a mission profile.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.