Class: AWS.GroundStation

Inherits:
AWS.Service show all
Identifier:
groundstation
API Version:
2019-05-23
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using GroundStation

var groundstation = new AWS.GroundStation();
groundstation.cancelContact(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the GroundStation object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var groundstation = new AWS.GroundStation({apiVersion: '2019-05-23'});

You can also set the API version globally in AWS.config.apiVersions using the groundstation service identifier:

AWS.config.apiVersions = {
  groundstation: '2019-05-23',
  // other service API versions
};

var groundstation = new AWS.GroundStation();

Version:

  • 2019-05-23

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.GroundStation(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a GroundStation object

var groundstation = new AWS.GroundStation({apiVersion: '2019-05-23'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.GroundStation.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.GroundStation.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.GroundStation.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelContact(params = {}, callback) ⇒ AWS.Request

Cancels a contact with a specified contact ID.

Service Reference:

Examples:

Calling the cancelContact operation

var params = {
  contactId: 'STRING_VALUE' /* required */
};
groundstation.cancelContact(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.

Returns:

  • (AWS.Request)

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

createConfig(params = {}, callback) ⇒ AWS.Request

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

Service Reference:

Examples:

Calling the createConfig operation

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 */
      }
    },
    dataflowEndpointConfig: {
      dataflowEndpointName: 'STRING_VALUE' /* required */
    },
    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.

        • spectrumConfigrequired — (map)

          Object that describes a spectral Config.

          • bandwidthrequired — (map)

            Bandwidth of a spectral Config.

            • unitsrequired — (String)

              Frequency bandwidth units.

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

              Frequency bandwidth value.

          • centerFrequencyrequired — (map)

            Center frequency of a spectral Config.

            • unitsrequired — (String)

              Frequency units.

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

              Frequency value.

          • polarization — (String)

            Polarization of a spectral Config.

            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.

        • decodeConfigrequired — (map)

          Information about the decode Config.

          • unvalidatedJSONrequired — (String)

            Unvalidated JSON of a decode Config.

        • demodulationConfigrequired — (map)

          Information about the demodulation Config.

          • unvalidatedJSONrequired — (String)

            Unvalidated JSON of a demodulation Config.

        • spectrumConfigrequired — (map)

          Information about the spectral Config.

          • bandwidthrequired — (map)

            Bandwidth of a spectral Config.

            • unitsrequired — (String)

              Frequency bandwidth units.

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

              Frequency bandwidth value.

          • centerFrequencyrequired — (map)

            Center frequency of a spectral Config.

            • unitsrequired — (String)

              Frequency units.

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

              Frequency value.

          • polarization — (String)

            Polarization of a spectral Config.

            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.

        • spectrumConfigrequired — (map)

          Information about the uplink spectral Config.

          • centerFrequencyrequired — (map)

            Center frequency of an uplink spectral Config.

            • unitsrequired — (String)

              Frequency units.

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

              Frequency value.

          • polarization — (String)

            Polarization of an uplink spectral Config.

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

          EIRP of the target.

          • unitsrequired — (String)

            Units of an EIRP.

            Possible values include:
            • "dBW"
          • valuerequired — (Float)

            Value of an EIRP.

      • dataflowEndpointConfig — (map)

        Information about the dataflow endpoint Config.

        • dataflowEndpointNamerequired — (String)

          Name of a dataflow endpoint.

      • trackingConfig — (map)

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

        • autotrackrequired — (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.

        • antennaUplinkConfigArnrequired — (String)

          ARN of an uplink Config.

        • enabledrequired — (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"

Returns:

  • (AWS.Request)

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

createDataflowEndpointGroup(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createDataflowEndpointGroup operation

var params = {
  endpointDetails: [ /* required */
    {
      endpoint: {
        address: {
          name: 'STRING_VALUE', /* required */
          port: 'NUMBER_VALUE' /* required */
        },
        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.

          • namerequired — (String)

            Name of a socket address.

          • portrequired — (Integer)

            Port of a socket address.

        • 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.

        • roleArnrequired — (String)

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

        • securityGroupIdsrequired — (Array<String>)

          The security groups to attach to the elastic network interfaces.

        • subnetIdsrequired — (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)

        ID of a dataflow endpoint group.

Returns:

  • (AWS.Request)

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

createMissionProfile(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createMissionProfile operation

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)

        ID of a mission profile.

Returns:

  • (AWS.Request)

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

deleteConfig(params = {}, callback) ⇒ AWS.Request

Deletes a Config.

Service Reference:

Examples:

Calling the deleteConfig operation

var params = {
  configId: 'STRING_VALUE', /* required */
  configType: antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo /* 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"

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"

Returns:

  • (AWS.Request)

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

deleteDataflowEndpointGroup(params = {}, callback) ⇒ AWS.Request

Deletes a dataflow endpoint group.

Service Reference:

Examples:

Calling the deleteDataflowEndpointGroup operation

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)

      ID 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)

        ID of a dataflow endpoint group.

Returns:

  • (AWS.Request)

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

deleteMissionProfile(params = {}, callback) ⇒ AWS.Request

Deletes a mission profile.

Service Reference:

Examples:

Calling the deleteMissionProfile operation

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)

        ID of a mission profile.

Returns:

  • (AWS.Request)

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

describeContact(params = {}, callback) ⇒ AWS.Request

Describes an existing contact.

Service Reference:

Examples:

Calling the describeContact operation

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"
        • "CANCELLED"
        • "COMPLETED"
        • "FAILED"
        • "FAILED_TO_SCHEDULE"
        • "PASS"
        • "POSTPASS"
        • "PREPASS"
        • "SCHEDULED"
        • "SCHEDULING"
      • 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.

        • unitrequired — (String)

          Elevation angle units.

          Possible values include:
          • "DEGREE_ANGLE"
          • "RADIAN"
        • valuerequired — (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.

      • 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.

getConfig(params = {}, callback) ⇒ AWS.Request

Returns Config information.

Only one Config response can be returned.

Service Reference:

Examples:

Calling the getConfig operation

var params = {
  configId: 'STRING_VALUE', /* required */
  configType: antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo /* 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"

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.

          • spectrumConfigrequired — (map)

            Object that describes a spectral Config.

            • bandwidthrequired — (map)

              Bandwidth of a spectral Config.

              • unitsrequired — (String)

                Frequency bandwidth units.

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

                Frequency bandwidth value.

            • centerFrequencyrequired — (map)

              Center frequency of a spectral Config.

              • unitsrequired — (String)

                Frequency units.

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

                Frequency value.

            • polarization — (String)

              Polarization of a spectral Config.

              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.

          • decodeConfigrequired — (map)

            Information about the decode Config.

            • unvalidatedJSONrequired — (String)

              Unvalidated JSON of a decode Config.

          • demodulationConfigrequired — (map)

            Information about the demodulation Config.

            • unvalidatedJSONrequired — (String)

              Unvalidated JSON of a demodulation Config.

          • spectrumConfigrequired — (map)

            Information about the spectral Config.

            • bandwidthrequired — (map)

              Bandwidth of a spectral Config.

              • unitsrequired — (String)

                Frequency bandwidth units.

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

                Frequency bandwidth value.

            • centerFrequencyrequired — (map)

              Center frequency of a spectral Config.

              • unitsrequired — (String)

                Frequency units.

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

                Frequency value.

            • polarization — (String)

              Polarization of a spectral Config.

              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.

          • spectrumConfigrequired — (map)

            Information about the uplink spectral Config.

            • centerFrequencyrequired — (map)

              Center frequency of an uplink spectral Config.

              • unitsrequired — (String)

                Frequency units.

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

                Frequency value.

            • polarization — (String)

              Polarization of an uplink spectral Config.

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

            EIRP of the target.

            • unitsrequired — (String)

              Units of an EIRP.

              Possible values include:
              • "dBW"
            • valuerequired — (Float)

              Value of an EIRP.

        • dataflowEndpointConfig — (map)

          Information about the dataflow endpoint Config.

          • dataflowEndpointNamerequired — (String)

            Name of a dataflow endpoint.

        • trackingConfig — (map)

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

          • autotrackrequired — (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.

          • antennaUplinkConfigArnrequired — (String)

            ARN of an uplink Config.

          • enabledrequired — (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"
      • 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.

getDataflowEndpointGroup(params = {}, callback) ⇒ AWS.Request

Returns the dataflow endpoint group.

Service Reference:

Examples:

Calling the getDataflowEndpointGroup operation

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.

            • namerequired — (String)

              Name of a socket address.

            • portrequired — (Integer)

              Port of a socket address.

          • 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.

          • roleArnrequired — (String)

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

          • securityGroupIdsrequired — (Array<String>)

            The security groups to attach to the elastic network interfaces.

          • subnetIdsrequired — (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.

getMinuteUsage(params = {}, callback) ⇒ AWS.Request

Returns the number of minutes used by account.

Service Reference:

Examples:

Calling the getMinuteUsage operation

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.

getMissionProfile(params = {}, callback) ⇒ AWS.Request

Returns a mission profile.

Service Reference:

Examples:

Calling the getMissionProfile operation

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)

        ID 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.

getSatellite(params = {}, callback) ⇒ AWS.Request

Returns a satellite.

Service Reference:

Examples:

Calling the getSatellite operation

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:

      • dateCreated — (Date)

        When a satellite was created.

      • lastUpdated — (Date)

        When a satellite was last updated.

      • noradSatelliteID — (Integer)

        NORAD satellite ID number.

      • satelliteArn — (String)

        ARN of a satellite.

      • satelliteId — (String)

        UUID of a satellite.

      • tags — (map<String>)

        Tags assigned to a satellite.

Returns:

  • (AWS.Request)

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

listConfigs(params = {}, callback) ⇒ AWS.Request

Returns a list of Config objects.

Service Reference:

Examples:

Calling the listConfigs operation

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"
        • 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.

listContacts(params = {}, callback) ⇒ AWS.Request

Returns a list of contacts.

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

Service Reference:

Examples:

Calling the listContacts operation

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 | CANCELLED | 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"
          • "CANCELLED"
          • "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.

          • unitrequired — (String)

            Elevation angle units.

            Possible values include:
            • "DEGREE_ANGLE"
            • "RADIAN"
          • valuerequired — (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.

        • 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.

listDataflowEndpointGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of DataflowEndpoint groups.

Service Reference:

Examples:

Calling the listDataflowEndpointGroups operation

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.

listGroundStations(params = {}, callback) ⇒ AWS.Request

Returns a list of ground stations.

Service Reference:

Examples:

Calling the listGroundStations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: '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.

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)

          ID 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.

listMissionProfiles(params = {}, callback) ⇒ AWS.Request

Returns a list of mission profiles.

Service Reference:

Examples:

Calling the listMissionProfiles operation

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)

          ID 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.

listSatellites(params = {}, callback) ⇒ AWS.Request

Returns a list of satellites.

Service Reference:

Examples:

Calling the listSatellites operation

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.

        • noradSatelliteID — (Integer)

          NORAD satellite ID number.

        • satelliteArn — (String)

          ARN of a satellite.

        • satelliteId — (String)

          ID of a satellite.

Returns:

  • (AWS.Request)

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of tags or a specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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.

reserveContact(params = {}, callback) ⇒ AWS.Request

Reserves a contact using specified parameters.

Service Reference:

Examples:

Calling the reserveContact operation

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.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns a tag to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: {
    '<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.

untagResource(params = {}, callback) ⇒ AWS.Request

Deassigns a resource tag.

Service Reference:

Examples:

Calling the untagResource operation

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.

updateConfig(params = {}, callback) ⇒ AWS.Request

Updates the Config used when scheduling contacts.

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

Service Reference:

Examples:

Calling the updateConfig operation

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 */
      }
    },
    dataflowEndpointConfig: {
      dataflowEndpointName: 'STRING_VALUE' /* required */
    },
    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, /* 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 for a Config.

      • antennaDownlinkConfig — (map)

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

        • spectrumConfigrequired — (map)

          Object that describes a spectral Config.

          • bandwidthrequired — (map)

            Bandwidth of a spectral Config.

            • unitsrequired — (String)

              Frequency bandwidth units.

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

              Frequency bandwidth value.

          • centerFrequencyrequired — (map)

            Center frequency of a spectral Config.

            • unitsrequired — (String)

              Frequency units.

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

              Frequency value.

          • polarization — (String)

            Polarization of a spectral Config.

            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.

        • decodeConfigrequired — (map)

          Information about the decode Config.

          • unvalidatedJSONrequired — (String)

            Unvalidated JSON of a decode Config.

        • demodulationConfigrequired — (map)

          Information about the demodulation Config.

          • unvalidatedJSONrequired — (String)

            Unvalidated JSON of a demodulation Config.

        • spectrumConfigrequired — (map)

          Information about the spectral Config.

          • bandwidthrequired — (map)

            Bandwidth of a spectral Config.

            • unitsrequired — (String)

              Frequency bandwidth units.

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

              Frequency bandwidth value.

          • centerFrequencyrequired — (map)

            Center frequency of a spectral Config.

            • unitsrequired — (String)

              Frequency units.

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

              Frequency value.

          • polarization — (String)

            Polarization of a spectral Config.

            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.

        • spectrumConfigrequired — (map)

          Information about the uplink spectral Config.

          • centerFrequencyrequired — (map)

            Center frequency of an uplink spectral Config.

            • unitsrequired — (String)

              Frequency units.

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

              Frequency value.

          • polarization — (String)

            Polarization of an uplink spectral Config.

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

          EIRP of the target.

          • unitsrequired — (String)

            Units of an EIRP.

            Possible values include:
            • "dBW"
          • valuerequired — (Float)

            Value of an EIRP.

      • dataflowEndpointConfig — (map)

        Information about the dataflow endpoint Config.

        • dataflowEndpointNamerequired — (String)

          Name of a dataflow endpoint.

      • trackingConfig — (map)

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

        • autotrackrequired — (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.

        • antennaUplinkConfigArnrequired — (String)

          ARN of an uplink Config.

        • enabledrequired — (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"
    • 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"

Returns:

  • (AWS.Request)

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

updateMissionProfile(params = {}, callback) ⇒ AWS.Request

Updates a mission profile.

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

Service Reference:

Examples:

Calling the updateMissionProfile operation

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)

      ID 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)

        ID of a mission profile.

Returns:

  • (AWS.Request)

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