Class: AWS.SageMakerGeospatial

var params = {
  Arn: 'STRING_VALUE' /* required */
};
sagemakergeospatial.deleteVectorEnrichmentJob(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.

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 = {
  Arn: 'STRING_VALUE', /* required */
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  OutputConfig: { /* required */
    S3Data: { /* required */
      S3Uri: 'STRING_VALUE', /* required */
      KmsKeyId: 'STRING_VALUE'
    }
  },
  ClientToken: 'STRING_VALUE',
  ExportSourceImages: true || false
};
sagemakergeospatial.exportEarthObservationJob(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: {}) —
  • Arn — (String)

    The input Amazon Resource Name (ARN) of the Earth Observation job being exported.

  • ClientToken — (String)

    A unique token that guarantees that the call to this API is idempotent.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ExecutionRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

  • ExportSourceImages — (Boolean)

    The source images provided to the Earth Observation job being exported.

  • OutputConfig — (map)

    An object containing information about the output file.

    • S3Data — required — (map)

      Path to Amazon S3 storage location for the output configuration file.

      • KmsKeyId — (String)

        The Key Management Service key ID for server-side encryption.

      • S3Uri — required — (String)

        The URL to the Amazon S3 data input.

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:

    • Arn — (String)

      The output Amazon Resource Name (ARN) of the Earth Observation job being exported.

    • CreationTime — (Date)

      The creation time.

    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

    • ExportSourceImages — (Boolean)

      The source images provided to the Earth Observation job being exported.

    • ExportStatus — (String)

      The status of the results of the Earth Observation job being exported.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
    • OutputConfig — (map)

      An object containing information about the output file.

      • S3Data — required — (map)

        Path to Amazon S3 storage location for the output configuration file.

        • KmsKeyId — (String)

          The Key Management Service key ID for server-side encryption.

        • S3Uri — required — (String)

          The URL to the Amazon S3 data input.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  OutputConfig: { /* required */
    S3Data: { /* required */
      S3Uri: 'STRING_VALUE', /* required */
      KmsKeyId: 'STRING_VALUE'
    }
  },
  ClientToken: 'STRING_VALUE'
};
sagemakergeospatial.exportVectorEnrichmentJob(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the Vector Enrichment job.

  • ClientToken — (String)

    A unique token that guarantees that the call to this API is idempotent.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ExecutionRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.

  • OutputConfig — (map)

    Output location information for exporting Vector Enrichment Job results.

    • S3Data — required — (map)

      The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.

      • KmsKeyId — (String)

        The Key Management Service key ID for server-side encryption.

      • S3Uri — required — (String)

        The URL to the Amazon S3 data for the Vector Enrichment job.

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:

    • Arn — (String)

      The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.

    • CreationTime — (Date)

      The creation time.

    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.

    • ExportStatus — (String)

      The status of the results the Vector Enrichment job being exported.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
    • OutputConfig — (map)

      Output location information for exporting Vector Enrichment Job results.

      • S3Data — required — (map)

        The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.

        • KmsKeyId — (String)

          The Key Management Service key ID for server-side encryption.

        • S3Uri — required — (String)

          The URL to the Amazon S3 data for the Vector Enrichment job.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE' /* required */
};
sagemakergeospatial.getEarthObservationJob(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the Earth Observation job.

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:

    • Arn — (String)

      The Amazon Resource Name (ARN) of the Earth Observation job.

    • CreationTime — (Date)

      The creation time of the initiated Earth Observation job.

    • DurationInSeconds — (Integer)

      The duration of Earth Observation job, in seconds.

    • ErrorDetails — (map)

      Details about the errors generated during the Earth Observation job.

      • Message — (String)

        A detailed message describing the error in an Earth Observation job.

      • Type — (String)

        The type of error in an Earth Observation job.

        Possible values include:
        • "CLIENT_ERROR"
        • "SERVER_ERROR"
    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

    • ExportErrorDetails — (map)

      Details about the errors generated during ExportEarthObservationJob.

      • ExportResults — (map)

        The structure for returning the export error details while exporting results of an Earth Observation job.

        • Message — (String)

          A detailed message describing the error in an export EarthObservationJob operation.

        • Type — (String)

          The type of error in an export EarthObservationJob operation.

          Possible values include:
          • "CLIENT_ERROR"
          • "SERVER_ERROR"
      • ExportSourceImages — (map)

        The structure for returning the export error details while exporting the source images of an Earth Observation job.

        • Message — (String)

          A detailed message describing the error in an export EarthObservationJob operation.

        • Type — (String)

          The type of error in an export EarthObservationJob operation.

          Possible values include:
          • "CLIENT_ERROR"
          • "SERVER_ERROR"
    • ExportStatus — (String)

      The status of the Earth Observation job.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
    • InputConfig — (map)

      Input data for the Earth Observation job.

      • PreviousEarthObservationJobArn — (String)

        The Amazon Resource Name (ARN) of the previous Earth Observation job.

      • RasterDataCollectionQuery — (map)

        The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.

        • AreaOfInterest — (map)

          The Area of Interest used in the search.

          • AreaOfInterestGeometry — (map)

            A GeoJSON object representing the geographic extent in the coordinate space.

            • MultiPolygonGeometry — (map)

              The structure representing the MultiPolygon Geometry.

              • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

                The coordinates of the multipolygon geometry.

            • PolygonGeometry — (map)

              The structure representing Polygon Geometry.

              • Coordinates — required — (Array<Array<Array<Float>>>)

                Coordinates representing a Polygon based on the GeoJson spec.

        • PropertyFilters — (map)

          Property filters used in the search.

          • LogicalOperator — (String)

            The Logical Operator used to combine the Property Filters.

            Possible values include:
            • "AND"
          • Properties — (Array<map>)

            A list of Property Filters.

            • Property — required — (map)

              Represents a single property to match with when searching a raster data collection.

              • EoCloudCover — (map)

                The structure representing EoCloudCover property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  Lower bound for EoCloudCover.

                • UpperBound — required — (Float)

                  Upper bound for EoCloudCover.

              • LandsatCloudCoverLand — (map)

                The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.

                • UpperBound — required — (Float)

                  The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.

              • Platform — (map)

                The structure representing Platform property filter consisting of value and comparison operator.

                • ComparisonOperator — (String)

                  The ComparisonOperator to use with PlatformInput.

                  Possible values include:
                  • "EQUALS"
                  • "NOT_EQUALS"
                  • "STARTS_WITH"
                • Value — required — (String)

                  The value of the platform.

              • ViewOffNadir — (map)

                The structure representing ViewOffNadir property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.

                • UpperBound — required — (Float)

                  The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.

              • ViewSunAzimuth — (map)

                The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.

                • UpperBound — required — (Float)

                  The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.

              • ViewSunElevation — (map)

                The structure representing ViewSunElevation property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The lower bound to view the sun elevation.

                • UpperBound — required — (Float)

                  The upper bound to view the sun elevation.

        • RasterDataCollectionArn — required — (String)

          The ARN of the Raster Data Collection against which the search is done.

        • RasterDataCollectionName — required — (String)

          The name of the raster data collection.

        • TimeRangeFilter — required — (map)

          The TimeRange filter used in the search.

          • EndTime — required — (Date)

            The ending time for the time range filter.

          • StartTime — required — (Date)

            The starting time for the time range filter.

    • JobConfig — (map)

      An object containing information about the job configuration.

      • BandMathConfig — (map)

        An object containing information about the job configuration for BandMath.

        • CustomIndices — (map)

          CustomIndices that are computed.

          • Operations — (Array<map>)

            A list of BandMath indices to compute.

            • Equation — required — (String)

              Textual representation of the math operation; Equation used to compute the spectral index.

            • Name — required — (String)

              The name of the operation.

            • OutputType — (String)

              The type of the operation.

              Possible values include:
              • "INT32"
              • "FLOAT32"
              • "INT16"
              • "FLOAT64"
              • "UINT16"
        • PredefinedIndices — (Array<String>)

          One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.

      • CloudMaskingConfig — (map)

        An object containing information about the job configuration for cloud masking.

      • CloudRemovalConfig — (map)

        An object containing information about the job configuration for cloud removal.

        • AlgorithmName — (String)

          The name of the algorithm used for cloud removal.

          Possible values include:
          • "INTERPOLATION"
        • InterpolationValue — (String)

          The interpolation value you provide for cloud removal.

        • TargetBands — (Array<String>)

          TargetBands to be returned in the output of CloudRemoval operation.

      • GeoMosaicConfig — (map)

        An object containing information about the job configuration for geomosaic.

        • AlgorithmName — (String)

          The name of the algorithm being used for geomosaic.

          Possible values include:
          • "NEAR"
          • "BILINEAR"
          • "CUBIC"
          • "CUBICSPLINE"
          • "LANCZOS"
          • "AVERAGE"
          • "RMS"
          • "MODE"
          • "MAX"
          • "MIN"
          • "MED"
          • "Q1"
          • "Q3"
          • "SUM"
        • TargetBands — (Array<String>)

          The target bands for geomosaic.

      • LandCoverSegmentationConfig — (map)

        An object containing information about the job configuration for land cover segmentation.

      • ResamplingConfig — (map)

        An object containing information about the job configuration for resampling.

        • AlgorithmName — (String)

          The name of the algorithm used for resampling.

          Possible values include:
          • "NEAR"
          • "BILINEAR"
          • "CUBIC"
          • "CUBICSPLINE"
          • "LANCZOS"
          • "AVERAGE"
          • "RMS"
          • "MODE"
          • "MAX"
          • "MIN"
          • "MED"
          • "Q1"
          • "Q3"
          • "SUM"
        • OutputResolution — required — (map)

          The structure representing output resolution (in target georeferenced units) of the result of resampling operation.

          • UserDefined — required — (map)

            User Defined Resolution for the output of Resampling operation defined by value and unit.

            • Unit — required — (String)

              The units for output resolution of the result.

              Possible values include:
              • "METERS"
            • Value — required — (Float)

              The value for output resolution of the result.

        • TargetBands — (Array<String>)

          Bands used in the operation. If no target bands are specified, it uses all bands available in the input.

      • StackConfig — (map)

        An object containing information about the job configuration for a Stacking Earth Observation job.

        • OutputResolution — (map)

          The structure representing output resolution (in target georeferenced units) of the result of stacking operation.

          • Predefined — (String)

            A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.

            Possible values include:
            • "HIGHEST"
            • "LOWEST"
            • "AVERAGE"
          • UserDefined — (map)

            The structure representing User Output Resolution for a Stacking operation defined as a value and unit.

            • Unit — required — (String)

              The units for output resolution of the result.

              Possible values include:
              • "METERS"
            • Value — required — (Float)

              The value for output resolution of the result.

        • TargetBands — (Array<String>)

          A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.

      • TemporalStatisticsConfig — (map)

        An object containing information about the job configuration for temporal statistics.

        • GroupBy — (String)

          The input for the temporal statistics grouping by time frequency option.

          Possible values include:
          • "ALL"
          • "YEARLY"
        • Statistics — required — (Array<String>)

          The list of the statistics method options.

        • TargetBands — (Array<String>)

          The list of target band names for the temporal statistic to calculate.

      • ZonalStatisticsConfig — (map)

        An object containing information about the job configuration for zonal statistics.

        • Statistics — required — (Array<String>)

          List of zonal statistics to compute.

        • TargetBands — (Array<String>)

          Bands used in the operation. If no target bands are specified, it uses all bands available input.

        • ZoneS3Path — required — (String)

          The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.

        • ZoneS3PathKmsKeyId — (String)

          The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

          The KmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

          For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

    • KmsKeyId — (String)

      The Key Management Service key ID for server-side encryption.

    • Name — (String)

      The name of the Earth Observation job.

    • OutputBands — (Array<map>)

      Bands available in the output of an operation.

      • BandName — required — (String)

        The name of the band.

      • OutputDataType — required — (String)

        The datatype of the output band.

        Possible values include:
        • "INT32"
        • "FLOAT32"
        • "INT16"
        • "FLOAT64"
        • "UINT16"
    • Status — (String)

      The status of a previously initiated Earth Observation job.

      Possible values include:
      • "INITIALIZING"
      • "IN_PROGRESS"
      • "STOPPING"
      • "COMPLETED"
      • "STOPPED"
      • "FAILED"
      • "DELETING"
      • "DELETED"
    • Tags — (map<String>)

      Each tag consists of a key and a value.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE' /* required */
};
sagemakergeospatial.getRasterDataCollection(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the raster data collection.

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:

    • Arn — (String)

      The Amazon Resource Name (ARN) of the raster data collection.

    • Description — (String)

      A description of the raster data collection.

    • DescriptionPageUrl — (String)

      The URL of the description page.

    • ImageSourceBands — (Array<String>)

      The list of image source bands in the raster data collection.

    • Name — (String)

      The name of the raster data collection.

    • SupportedFilters — (Array<map>)

      The filters supported by the raster data collection.

      • Maximum — (Float)

        The maximum value of the filter.

      • Minimum — (Float)

        The minimum value of the filter.

      • Name — required — (String)

        The name of the filter.

      • Type — required — (String)

        The type of the filter being used.

    • Tags — (map<String>)

      Each tag consists of a key and a value.

    • Type — (String)

      The raster data collection type.

      Possible values include:
      • "PUBLIC"
      • "PREMIUM"
      • "USER"

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  ImageAssets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Target: INPUT | OUTPUT, /* required */
  x: 'NUMBER_VALUE', /* required */
  y: 'NUMBER_VALUE', /* required */
  z: 'NUMBER_VALUE', /* required */
  ExecutionRoleArn: 'STRING_VALUE',
  ImageMask: true || false,
  OutputDataType: INT32 | FLOAT32 | INT16 | FLOAT64 | UINT16,
  OutputFormat: 'STRING_VALUE',
  PropertyFilters: 'STRING_VALUE',
  TimeRangeFilter: 'STRING_VALUE'
};
sagemakergeospatial.getTile(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the tile operation.

  • ExecutionRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role that you specify.

  • ImageAssets — (Array<String>)

    The particular assets or bands to tile.

  • ImageMask — (Boolean)

    Determines whether or not to return a valid data mask.

  • OutputDataType — (String)

    The output data type of the tile operation.

    Possible values include:
    • "INT32"
    • "FLOAT32"
    • "INT16"
    • "FLOAT64"
    • "UINT16"
  • OutputFormat — (String)

    The data format of the output tile. The formats include .npy, .png and .jpg.

  • PropertyFilters — (String)

    Property filters for the imagery to tile.

  • Target — (String)

    Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.

    Possible values include:
    • "INPUT"
    • "OUTPUT"
  • TimeRangeFilter — (String)

    Time range filter applied to imagery to find the images to tile.

  • x — (Integer)

    The x coordinate of the tile input.

  • y — (Integer)

    The y coordinate of the tile input.

  • z — (Integer)

    The z coordinate of the tile input.

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:

    • BinaryFile — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

      The output binary file.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE' /* required */
};
sagemakergeospatial.getVectorEnrichmentJob(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the Vector Enrichment job.

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:

    • Arn — (String)

      The Amazon Resource Name (ARN) of the Vector Enrichment job.

    • CreationTime — (Date)

      The creation time.

    • DurationInSeconds — (Integer)

      The duration of the Vector Enrichment job, in seconds.

    • ErrorDetails — (map)

      Details about the errors generated during the Vector Enrichment job.

      • ErrorMessage — (String)

        A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.

      • ErrorType — (String)

        The type of error generated during the Vector Enrichment job.

        Possible values include:
        • "CLIENT_ERROR"
        • "SERVER_ERROR"
    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

    • ExportErrorDetails — (map)

      Details about the errors generated during the ExportVectorEnrichmentJob.

      • Message — (String)

        The message providing details about the errors generated during the Vector Enrichment job.

      • Type — (String)

        The output error details for an Export operation on a Vector Enrichment job.

        Possible values include:
        • "CLIENT_ERROR"
        • "SERVER_ERROR"
    • ExportStatus — (String)

      The export status of the Vector Enrichment job being initiated.

      Possible values include:
      • "IN_PROGRESS"
      • "SUCCEEDED"
      • "FAILED"
    • InputConfig — (map)

      Input configuration information for the Vector Enrichment job.

      • DataSourceConfig — required — (map)

        The input structure for the data source that represents the storage type of the input data objects.

        • S3Data — (map)

          The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.

          • KmsKeyId — (String)

            The Key Management Service key ID for server-side encryption.

          • S3Uri — required — (String)

            The URL to the Amazon S3 data for the Vector Enrichment job.

      • DocumentType — required — (String)

        The input structure that defines the data source file type.

        Possible values include:
        • "CSV"
    • JobConfig — (map)

      An object containing information about the job configuration.

      • MapMatchingConfig — (map)

        The input structure for Map Matching operation type.

        • IdAttributeName — required — (String)

          The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.

        • TimestampAttributeName — required — (String)

          The name of the timestamp attribute.

        • XAttributeName — required — (String)

          The name of the X-attribute

        • YAttributeName — required — (String)

          The name of the Y-attribute

      • ReverseGeocodingConfig — (map)

        The input structure for Reverse Geocoding operation type.

        • XAttributeName — required — (String)

          The field name for the data that describes x-axis coordinate, eg. longitude of a point.

        • YAttributeName — required — (String)

          The field name for the data that describes y-axis coordinate, eg. latitude of a point.

    • KmsKeyId — (String)

      The Key Management Service key ID for server-side encryption.

    • Name — (String)

      The name of the Vector Enrichment job.

    • Status — (String)

      The status of the initiated Vector Enrichment job.

      Possible values include:
      • "INITIALIZING"
      • "IN_PROGRESS"
      • "STOPPING"
      • "STOPPED"
      • "COMPLETED"
      • "FAILED"
      • "DELETING"
      • "DELETED"
    • Tags — (map<String>)

      Each tag consists of a key and a value.

    • Type — (String)

      The type of the Vector Enrichment job being initiated.

      Possible values include:
      • "REVERSE_GEOCODING"
      • "MAP_MATCHING"

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: 'STRING_VALUE',
  SortOrder: ASCENDING | DESCENDING,
  StatusEquals: INITIALIZING | IN_PROGRESS | STOPPING | COMPLETED | STOPPED | FAILED | DELETING | DELETED
};
sagemakergeospatial.listEarthObservationJobs(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)

    The total number of items to return.

  • NextToken — (String)

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • SortBy — (String)

    The parameter by which to sort the results.

  • SortOrder — (String)

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    Possible values include:
    • "ASCENDING"
    • "DESCENDING"
  • StatusEquals — (String)

    A filter that retrieves only jobs with a specific status.

    Possible values include:
    • "INITIALIZING"
    • "IN_PROGRESS"
    • "STOPPING"
    • "COMPLETED"
    • "STOPPED"
    • "FAILED"
    • "DELETING"
    • "DELETED"

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:

    • EarthObservationJobSummaries — (Array<map>)

      Contains summary information about the Earth Observation jobs.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.

      • CreationTime — required — (Date)

        The creation time.

      • DurationInSeconds — required — (Integer)

        The duration of the session, in seconds.

      • Name — required — (String)

        The names of the Earth Observation jobs in the list.

      • OperationType — required — (String)

        The operation type for an Earth Observation job.

      • Status — required — (String)

        The status of the list of the Earth Observation jobs.

        Possible values include:
        • "INITIALIZING"
        • "IN_PROGRESS"
        • "STOPPING"
        • "COMPLETED"
        • "STOPPED"
        • "FAILED"
        • "DELETING"
        • "DELETED"
      • Tags — (map<String>)

        Each tag consists of a key and a value.

    • NextToken — (String)

      If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
sagemakergeospatial.listRasterDataCollections(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)

    The total number of items to return.

  • NextToken — (String)

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set 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:

    • NextToken — (String)

      If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

    • RasterDataCollectionSummaries — (Array<map>)

      Contains summary information about the raster data collection.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the raster data collection.

      • Description — required — (String)

        A description of the raster data collection.

      • DescriptionPageUrl — (String)

        The description URL of the raster data collection.

      • Name — required — (String)

        The name of the raster data collection.

      • SupportedFilters — required — (Array<map>)

        The list of filters supported by the raster data collection.

        • Maximum — (Float)

          The maximum value of the filter.

        • Minimum — (Float)

          The minimum value of the filter.

        • Name — required — (String)

          The name of the filter.

        • Type — required — (String)

          The type of the filter being used.

      • Tags — (map<String>)

        Each tag consists of a key and a value.

      • Type — required — (String)

        The type of raster data collection.

        Possible values include:
        • "PUBLIC"
        • "PREMIUM"
        • "USER"

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
sagemakergeospatial.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)

    The Amazon Resource Name (ARN) of the resource you want to 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. The data object has the following properties:

    • Tags — (map<String>)

      Each tag consists of a key and a value.

Returns:

• (AWS.Request) —

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

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortBy: 'STRING_VALUE',
  SortOrder: ASCENDING | DESCENDING,
  StatusEquals: 'STRING_VALUE'
};
sagemakergeospatial.listVectorEnrichmentJobs(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)

    The maximum number of items to return.

  • NextToken — (String)

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • SortBy — (String)

    The parameter by which to sort the results.

  • SortOrder — (String)

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

    Possible values include:
    • "ASCENDING"
    • "DESCENDING"
  • StatusEquals — (String)

    A filter that retrieves only jobs with a specific status.

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)

      If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

    • VectorEnrichmentJobSummaries — (Array<map>)

      Contains summary information about the Vector Enrichment jobs.

      • Arn — required — (String)

        The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.

      • CreationTime — required — (Date)

        The creation time.

      • DurationInSeconds — required — (Integer)

        The duration of the session, in seconds.

      • Name — required — (String)

        The names of the Vector Enrichment jobs in the list.

      • Status — required — (String)

        The status of the Vector Enrichment jobs list.

        Possible values include:
        • "INITIALIZING"
        • "IN_PROGRESS"
        • "STOPPING"
        • "STOPPED"
        • "COMPLETED"
        • "FAILED"
        • "DELETING"
        • "DELETED"
      • Tags — (map<String>)

        Each tag consists of a key and a value.

      • Type — required — (String)

        The type of the list of Vector Enrichment jobs.

        Possible values include:
        • "REVERSE_GEOCODING"
        • "MAP_MATCHING"

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  RasterDataCollectionQuery: { /* required */
    TimeRangeFilter: { /* required */
      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 */
    },
    AreaOfInterest: {
      AreaOfInterestGeometry: {
        MultiPolygonGeometry: {
          Coordinates: [ /* required */
            [
              [
                [
                  'NUMBER_VALUE',
                  /* more items */
                ],
                /* more items */
              ],
              /* more items */
            ],
            /* more items */
          ]
        },
        PolygonGeometry: {
          Coordinates: [ /* required */
            [
              [
                'NUMBER_VALUE',
                /* more items */
              ],
              /* more items */
            ],
            /* more items */
          ]
        }
      }
    },
    BandFilter: [
      'STRING_VALUE',
      /* more items */
    ],
    PropertyFilters: {
      LogicalOperator: AND,
      Properties: [
        {
          Property: { /* required */
            EoCloudCover: {
              LowerBound: 'NUMBER_VALUE', /* required */
              UpperBound: 'NUMBER_VALUE' /* required */
            },
            LandsatCloudCoverLand: {
              LowerBound: 'NUMBER_VALUE', /* required */
              UpperBound: 'NUMBER_VALUE' /* required */
            },
            Platform: {
              Value: 'STRING_VALUE', /* required */
              ComparisonOperator: EQUALS | NOT_EQUALS | STARTS_WITH
            },
            ViewOffNadir: {
              LowerBound: 'NUMBER_VALUE', /* required */
              UpperBound: 'NUMBER_VALUE' /* required */
            },
            ViewSunAzimuth: {
              LowerBound: 'NUMBER_VALUE', /* required */
              UpperBound: 'NUMBER_VALUE' /* required */
            },
            ViewSunElevation: {
              LowerBound: 'NUMBER_VALUE', /* required */
              UpperBound: 'NUMBER_VALUE' /* required */
            }
          }
        },
        /* more items */
      ]
    }
  },
  NextToken: 'STRING_VALUE'
};
sagemakergeospatial.searchRasterDataCollection(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the raster data collection.

  • NextToken — (String)

    If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

  • RasterDataCollectionQuery — (map)

    RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.

    • AreaOfInterest — (map)

      The Area of interest to be used in the search query.

      • AreaOfInterestGeometry — (map)

        A GeoJSON object representing the geographic extent in the coordinate space.

        • MultiPolygonGeometry — (map)

          The structure representing the MultiPolygon Geometry.

          • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

            The coordinates of the multipolygon geometry.

        • PolygonGeometry — (map)

          The structure representing Polygon Geometry.

          • Coordinates — required — (Array<Array<Array<Float>>>)

            Coordinates representing a Polygon based on the GeoJson spec.

    • BandFilter — (Array<String>)

      The list of Bands to be displayed in the result for each item.

    • PropertyFilters — (map)

      The Property Filters used in the search query.

      • LogicalOperator — (String)

        The Logical Operator used to combine the Property Filters.

        Possible values include:
        • "AND"
      • Properties — (Array<map>)

        A list of Property Filters.

        • Property — required — (map)

          Represents a single property to match with when searching a raster data collection.

          • EoCloudCover — (map)

            The structure representing EoCloudCover property filter containing a lower bound and upper bound.

            • LowerBound — required — (Float)

              Lower bound for EoCloudCover.

            • UpperBound — required — (Float)

              Upper bound for EoCloudCover.

          • LandsatCloudCoverLand — (map)

            The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.

            • LowerBound — required — (Float)

              The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.

            • UpperBound — required — (Float)

              The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.

          • Platform — (map)

            The structure representing Platform property filter consisting of value and comparison operator.

            • ComparisonOperator — (String)

              The ComparisonOperator to use with PlatformInput.

              Possible values include:
              • "EQUALS"
              • "NOT_EQUALS"
              • "STARTS_WITH"
            • Value — required — (String)

              The value of the platform.

          • ViewOffNadir — (map)

            The structure representing ViewOffNadir property filter containing a lower bound and upper bound.

            • LowerBound — required — (Float)

              The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.

            • UpperBound — required — (Float)

              The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.

          • ViewSunAzimuth — (map)

            The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.

            • LowerBound — required — (Float)

              The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.

            • UpperBound — required — (Float)

              The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.

          • ViewSunElevation — (map)

            The structure representing ViewSunElevation property filter containing a lower bound and upper bound.

            • LowerBound — required — (Float)

              The lower bound to view the sun elevation.

            • UpperBound — required — (Float)

              The upper bound to view the sun elevation.

    • TimeRangeFilter — required — (map)

      The TimeRange Filter used in the search query.

      • EndTime — required — (Date)

        The end time for the time-range filter.

      • StartTime — required — (Date)

        The start time for the time-range filter.

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:

    • ApproximateResultCount — (Integer)

      Approximate number of results in the response.

    • Items — (Array<map>)

      List of items matching the Raster DataCollectionQuery.

      • Assets — (map<map>)

        This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.

        • Href — (String)

          Link to the asset object.

      • DateTime — required — (Date)

        The searchable date and time of the item, in UTC.

      • Geometry — required — (map)

        The item Geometry in GeoJson format.

        • Coordinates — required — (Array<Array<Array<Float>>>)

          The coordinates of the GeoJson Geometry.

        • Type — required — (String)

          GeoJson Geometry types like Polygon and MultiPolygon.

      • Id — required — (String)

        A unique Id for the source item.

      • Properties — (map)

        This field contains additional properties of the item.

        • EoCloudCover — (Float)

          Estimate of cloud cover.

        • LandsatCloudCoverLand — (Float)

          Land cloud cover for Landsat Data Collection.

        • Platform — (String)

          Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.

        • ViewOffNadir — (Float)

          The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).

        • ViewSunAzimuth — (Float)

          The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).

        • ViewSunElevation — (Float)

          The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.

    • NextToken — (String)

      If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  InputConfig: { /* required */
    PreviousEarthObservationJobArn: 'STRING_VALUE',
    RasterDataCollectionQuery: {
      RasterDataCollectionArn: 'STRING_VALUE', /* required */
      TimeRangeFilter: { /* required */
        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 */
      },
      AreaOfInterest: {
        AreaOfInterestGeometry: {
          MultiPolygonGeometry: {
            Coordinates: [ /* required */
              [
                [
                  [
                    'NUMBER_VALUE',
                    /* more items */
                  ],
                  /* more items */
                ],
                /* more items */
              ],
              /* more items */
            ]
          },
          PolygonGeometry: {
            Coordinates: [ /* required */
              [
                [
                  'NUMBER_VALUE',
                  /* more items */
                ],
                /* more items */
              ],
              /* more items */
            ]
          }
        }
      },
      PropertyFilters: {
        LogicalOperator: AND,
        Properties: [
          {
            Property: { /* required */
              EoCloudCover: {
                LowerBound: 'NUMBER_VALUE', /* required */
                UpperBound: 'NUMBER_VALUE' /* required */
              },
              LandsatCloudCoverLand: {
                LowerBound: 'NUMBER_VALUE', /* required */
                UpperBound: 'NUMBER_VALUE' /* required */
              },
              Platform: {
                Value: 'STRING_VALUE', /* required */
                ComparisonOperator: EQUALS | NOT_EQUALS | STARTS_WITH
              },
              ViewOffNadir: {
                LowerBound: 'NUMBER_VALUE', /* required */
                UpperBound: 'NUMBER_VALUE' /* required */
              },
              ViewSunAzimuth: {
                LowerBound: 'NUMBER_VALUE', /* required */
                UpperBound: 'NUMBER_VALUE' /* required */
              },
              ViewSunElevation: {
                LowerBound: 'NUMBER_VALUE', /* required */
                UpperBound: 'NUMBER_VALUE' /* required */
              }
            }
          },
          /* more items */
        ]
      }
    }
  },
  JobConfig: { /* required */
    BandMathConfig: {
      CustomIndices: {
        Operations: [
          {
            Equation: 'STRING_VALUE', /* required */
            Name: 'STRING_VALUE', /* required */
            OutputType: INT32 | FLOAT32 | INT16 | FLOAT64 | UINT16
          },
          /* more items */
        ]
      },
      PredefinedIndices: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    CloudMaskingConfig: {
    },
    CloudRemovalConfig: {
      AlgorithmName: INTERPOLATION,
      InterpolationValue: 'STRING_VALUE',
      TargetBands: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    GeoMosaicConfig: {
      AlgorithmName: NEAR | BILINEAR | CUBIC | CUBICSPLINE | LANCZOS | AVERAGE | RMS | MODE | MAX | MIN | MED | Q1 | Q3 | SUM,
      TargetBands: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    LandCoverSegmentationConfig: {
    },
    ResamplingConfig: {
      OutputResolution: { /* required */
        UserDefined: { /* required */
          Unit: METERS, /* required */
          Value: 'NUMBER_VALUE' /* required */
        }
      },
      AlgorithmName: NEAR | BILINEAR | CUBIC | CUBICSPLINE | LANCZOS | AVERAGE | RMS | MODE | MAX | MIN | MED | Q1 | Q3 | SUM,
      TargetBands: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    StackConfig: {
      OutputResolution: {
        Predefined: HIGHEST | LOWEST | AVERAGE,
        UserDefined: {
          Unit: METERS, /* required */
          Value: 'NUMBER_VALUE' /* required */
        }
      },
      TargetBands: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    TemporalStatisticsConfig: {
      Statistics: [ /* required */
        MEAN | MEDIAN | STANDARD_DEVIATION,
        /* more items */
      ],
      GroupBy: ALL | YEARLY,
      TargetBands: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    ZonalStatisticsConfig: {
      Statistics: [ /* required */
        MEAN | MEDIAN | STANDARD_DEVIATION | MAX | MIN | SUM,
        /* more items */
      ],
      ZoneS3Path: 'STRING_VALUE', /* required */
      TargetBands: [
        'STRING_VALUE',
        /* more items */
      ],
      ZoneS3PathKmsKeyId: 'STRING_VALUE'
    }
  },
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  Tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
sagemakergeospatial.startEarthObservationJob(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: {}) —
  • ClientToken — (String)

    A unique token that guarantees that the call to this API is idempotent.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ExecutionRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

  • InputConfig — (map)

    Input configuration information for the Earth Observation job.

    • PreviousEarthObservationJobArn — (String)

      The Amazon Resource Name (ARN) of the previous Earth Observation job.

    • RasterDataCollectionQuery — (map)

      The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters.

      • AreaOfInterest — (map)

        The area of interest being queried for the raster data collection.

        • AreaOfInterestGeometry — (map)

          A GeoJSON object representing the geographic extent in the coordinate space.

          • MultiPolygonGeometry — (map)

            The structure representing the MultiPolygon Geometry.

            • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

              The coordinates of the multipolygon geometry.

          • PolygonGeometry — (map)

            The structure representing Polygon Geometry.

            • Coordinates — required — (Array<Array<Array<Float>>>)

              Coordinates representing a Polygon based on the GeoJson spec.

      • PropertyFilters — (map)

        The list of Property filters used in the Raster Data Collection Query.

        • LogicalOperator — (String)

          The Logical Operator used to combine the Property Filters.

          Possible values include:
          • "AND"
        • Properties — (Array<map>)

          A list of Property Filters.

          • Property — required — (map)

            Represents a single property to match with when searching a raster data collection.

            • EoCloudCover — (map)

              The structure representing EoCloudCover property filter containing a lower bound and upper bound.

              • LowerBound — required — (Float)

                Lower bound for EoCloudCover.

              • UpperBound — required — (Float)

                Upper bound for EoCloudCover.

            • LandsatCloudCoverLand — (map)

              The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.

              • LowerBound — required — (Float)

                The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.

              • UpperBound — required — (Float)

                The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.

            • Platform — (map)

              The structure representing Platform property filter consisting of value and comparison operator.

              • ComparisonOperator — (String)

                The ComparisonOperator to use with PlatformInput.

                Possible values include:
                • "EQUALS"
                • "NOT_EQUALS"
                • "STARTS_WITH"
              • Value — required — (String)

                The value of the platform.

            • ViewOffNadir — (map)

              The structure representing ViewOffNadir property filter containing a lower bound and upper bound.

              • LowerBound — required — (Float)

                The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.

              • UpperBound — required — (Float)

                The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.

            • ViewSunAzimuth — (map)

              The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.

              • LowerBound — required — (Float)

                The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.

              • UpperBound — required — (Float)

                The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.

            • ViewSunElevation — (map)

              The structure representing ViewSunElevation property filter containing a lower bound and upper bound.

              • LowerBound — required — (Float)

                The lower bound to view the sun elevation.

              • UpperBound — required — (Float)

                The upper bound to view the sun elevation.

      • RasterDataCollectionArn — required — (String)

        The Amazon Resource Name (ARN) of the raster data collection.

      • TimeRangeFilter — required — (map)

        The TimeRange Filter used in the RasterDataCollection Query.

        • EndTime — required — (Date)

          The end time for the time-range filter.

        • StartTime — required — (Date)

          The start time for the time-range filter.

  • JobConfig — (map)

    An object containing information about the job configuration.

    • BandMathConfig — (map)

      An object containing information about the job configuration for BandMath.

      • CustomIndices — (map)

        CustomIndices that are computed.

        • Operations — (Array<map>)

          A list of BandMath indices to compute.

          • Equation — required — (String)

            Textual representation of the math operation; Equation used to compute the spectral index.

          • Name — required — (String)

            The name of the operation.

          • OutputType — (String)

            The type of the operation.

            Possible values include:
            • "INT32"
            • "FLOAT32"
            • "INT16"
            • "FLOAT64"
            • "UINT16"
      • PredefinedIndices — (Array<String>)

        One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.

    • CloudMaskingConfig — (map)

      An object containing information about the job configuration for cloud masking.

    • CloudRemovalConfig — (map)

      An object containing information about the job configuration for cloud removal.

      • AlgorithmName — (String)

        The name of the algorithm used for cloud removal.

        Possible values include:
        • "INTERPOLATION"
      • InterpolationValue — (String)

        The interpolation value you provide for cloud removal.

      • TargetBands — (Array<String>)

        TargetBands to be returned in the output of CloudRemoval operation.

    • GeoMosaicConfig — (map)

      An object containing information about the job configuration for geomosaic.

      • AlgorithmName — (String)

        The name of the algorithm being used for geomosaic.

        Possible values include:
        • "NEAR"
        • "BILINEAR"
        • "CUBIC"
        • "CUBICSPLINE"
        • "LANCZOS"
        • "AVERAGE"
        • "RMS"
        • "MODE"
        • "MAX"
        • "MIN"
        • "MED"
        • "Q1"
        • "Q3"
        • "SUM"
      • TargetBands — (Array<String>)

        The target bands for geomosaic.

    • LandCoverSegmentationConfig — (map)

      An object containing information about the job configuration for land cover segmentation.

    • ResamplingConfig — (map)

      An object containing information about the job configuration for resampling.

      • AlgorithmName — (String)

        The name of the algorithm used for resampling.

        Possible values include:
        • "NEAR"
        • "BILINEAR"
        • "CUBIC"
        • "CUBICSPLINE"
        • "LANCZOS"
        • "AVERAGE"
        • "RMS"
        • "MODE"
        • "MAX"
        • "MIN"
        • "MED"
        • "Q1"
        • "Q3"
        • "SUM"
      • OutputResolution — required — (map)

        The structure representing output resolution (in target georeferenced units) of the result of resampling operation.

        • UserDefined — required — (map)

          User Defined Resolution for the output of Resampling operation defined by value and unit.

          • Unit — required — (String)

            The units for output resolution of the result.

            Possible values include:
            • "METERS"
          • Value — required — (Float)

            The value for output resolution of the result.

      • TargetBands — (Array<String>)

        Bands used in the operation. If no target bands are specified, it uses all bands available in the input.

    • StackConfig — (map)

      An object containing information about the job configuration for a Stacking Earth Observation job.

      • OutputResolution — (map)

        The structure representing output resolution (in target georeferenced units) of the result of stacking operation.

        • Predefined — (String)

          A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.

          Possible values include:
          • "HIGHEST"
          • "LOWEST"
          • "AVERAGE"
        • UserDefined — (map)

          The structure representing User Output Resolution for a Stacking operation defined as a value and unit.

          • Unit — required — (String)

            The units for output resolution of the result.

            Possible values include:
            • "METERS"
          • Value — required — (Float)

            The value for output resolution of the result.

      • TargetBands — (Array<String>)

        A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.

    • TemporalStatisticsConfig — (map)

      An object containing information about the job configuration for temporal statistics.

      • GroupBy — (String)

        The input for the temporal statistics grouping by time frequency option.

        Possible values include:
        • "ALL"
        • "YEARLY"
      • Statistics — required — (Array<String>)

        The list of the statistics method options.

      • TargetBands — (Array<String>)

        The list of target band names for the temporal statistic to calculate.

    • ZonalStatisticsConfig — (map)

      An object containing information about the job configuration for zonal statistics.

      • Statistics — required — (Array<String>)

        List of zonal statistics to compute.

      • TargetBands — (Array<String>)

        Bands used in the operation. If no target bands are specified, it uses all bands available input.

      • ZoneS3Path — required — (String)

        The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.

      • ZoneS3PathKmsKeyId — (String)

        The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

        The KmsKeyId can be any of the following formats:

        • // KMS Key ID

          "1234abcd-12ab-34cd-56ef-1234567890ab"

        • // Amazon Resource Name (ARN) of a KMS Key

          "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

        For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

  • KmsKeyId — (String)

    The Key Management Service key ID for server-side encryption.

  • Name — (String)

    The name of the Earth Observation job.

  • Tags — (map<String>)

    Each tag consists of a key and a value.

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:

    • Arn — (String)

      The Amazon Resource Name (ARN) of the Earth Observation job.

    • CreationTime — (Date)

      The creation time.

    • DurationInSeconds — (Integer)

      The duration of the session, in seconds.

    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

    • InputConfig — (map)

      Input configuration information for the Earth Observation job.

      • PreviousEarthObservationJobArn — (String)

        The Amazon Resource Name (ARN) of the previous Earth Observation job.

      • RasterDataCollectionQuery — (map)

        The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.

        • AreaOfInterest — (map)

          The Area of Interest used in the search.

          • AreaOfInterestGeometry — (map)

            A GeoJSON object representing the geographic extent in the coordinate space.

            • MultiPolygonGeometry — (map)

              The structure representing the MultiPolygon Geometry.

              • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

                The coordinates of the multipolygon geometry.

            • PolygonGeometry — (map)

              The structure representing Polygon Geometry.

              • Coordinates — required — (Array<Array<Array<Float>>>)

                Coordinates representing a Polygon based on the GeoJson spec.

        • PropertyFilters — (map)

          Property filters used in the search.

          • LogicalOperator — (String)

            The Logical Operator used to combine the Property Filters.

            Possible values include:
            • "AND"
          • Properties — (Array<map>)

            A list of Property Filters.

            • Property — required — (map)

              Represents a single property to match with when searching a raster data collection.

              • EoCloudCover — (map)

                The structure representing EoCloudCover property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  Lower bound for EoCloudCover.

                • UpperBound — required — (Float)

                  Upper bound for EoCloudCover.

              • LandsatCloudCoverLand — (map)

                The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.

                • UpperBound — required — (Float)

                  The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.

              • Platform — (map)

                The structure representing Platform property filter consisting of value and comparison operator.

                • ComparisonOperator — (String)

                  The ComparisonOperator to use with PlatformInput.

                  Possible values include:
                  • "EQUALS"
                  • "NOT_EQUALS"
                  • "STARTS_WITH"
                • Value — required — (String)

                  The value of the platform.

              • ViewOffNadir — (map)

                The structure representing ViewOffNadir property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.

                • UpperBound — required — (Float)

                  The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.

              • ViewSunAzimuth — (map)

                The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.

                • UpperBound — required — (Float)

                  The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.

              • ViewSunElevation — (map)

                The structure representing ViewSunElevation property filter containing a lower bound and upper bound.

                • LowerBound — required — (Float)

                  The lower bound to view the sun elevation.

                • UpperBound — required — (Float)

                  The upper bound to view the sun elevation.

        • RasterDataCollectionArn — required — (String)

          The ARN of the Raster Data Collection against which the search is done.

        • RasterDataCollectionName — required — (String)

          The name of the raster data collection.

        • TimeRangeFilter — required — (map)

          The TimeRange filter used in the search.

          • EndTime — required — (Date)

            The ending time for the time range filter.

          • StartTime — required — (Date)

            The starting time for the time range filter.

    • JobConfig — (map)

      An object containing information about the job configuration.

      • BandMathConfig — (map)

        An object containing information about the job configuration for BandMath.

        • CustomIndices — (map)

          CustomIndices that are computed.

          • Operations — (Array<map>)

            A list of BandMath indices to compute.

            • Equation — required — (String)

              Textual representation of the math operation; Equation used to compute the spectral index.

            • Name — required — (String)

              The name of the operation.

            • OutputType — (String)

              The type of the operation.

              Possible values include:
              • "INT32"
              • "FLOAT32"
              • "INT16"
              • "FLOAT64"
              • "UINT16"
        • PredefinedIndices — (Array<String>)

          One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.

      • CloudMaskingConfig — (map)

        An object containing information about the job configuration for cloud masking.

      • CloudRemovalConfig — (map)

        An object containing information about the job configuration for cloud removal.

        • AlgorithmName — (String)

          The name of the algorithm used for cloud removal.

          Possible values include:
          • "INTERPOLATION"
        • InterpolationValue — (String)

          The interpolation value you provide for cloud removal.

        • TargetBands — (Array<String>)

          TargetBands to be returned in the output of CloudRemoval operation.

      • GeoMosaicConfig — (map)

        An object containing information about the job configuration for geomosaic.

        • AlgorithmName — (String)

          The name of the algorithm being used for geomosaic.

          Possible values include:
          • "NEAR"
          • "BILINEAR"
          • "CUBIC"
          • "CUBICSPLINE"
          • "LANCZOS"
          • "AVERAGE"
          • "RMS"
          • "MODE"
          • "MAX"
          • "MIN"
          • "MED"
          • "Q1"
          • "Q3"
          • "SUM"
        • TargetBands — (Array<String>)

          The target bands for geomosaic.

      • LandCoverSegmentationConfig — (map)

        An object containing information about the job configuration for land cover segmentation.

      • ResamplingConfig — (map)

        An object containing information about the job configuration for resampling.

        • AlgorithmName — (String)

          The name of the algorithm used for resampling.

          Possible values include:
          • "NEAR"
          • "BILINEAR"
          • "CUBIC"
          • "CUBICSPLINE"
          • "LANCZOS"
          • "AVERAGE"
          • "RMS"
          • "MODE"
          • "MAX"
          • "MIN"
          • "MED"
          • "Q1"
          • "Q3"
          • "SUM"
        • OutputResolution — required — (map)

          The structure representing output resolution (in target georeferenced units) of the result of resampling operation.

          • UserDefined — required — (map)

            User Defined Resolution for the output of Resampling operation defined by value and unit.

            • Unit — required — (String)

              The units for output resolution of the result.

              Possible values include:
              • "METERS"
            • Value — required — (Float)

              The value for output resolution of the result.

        • TargetBands — (Array<String>)

          Bands used in the operation. If no target bands are specified, it uses all bands available in the input.

      • StackConfig — (map)

        An object containing information about the job configuration for a Stacking Earth Observation job.

        • OutputResolution — (map)

          The structure representing output resolution (in target georeferenced units) of the result of stacking operation.

          • Predefined — (String)

            A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.

            Possible values include:
            • "HIGHEST"
            • "LOWEST"
            • "AVERAGE"
          • UserDefined — (map)

            The structure representing User Output Resolution for a Stacking operation defined as a value and unit.

            • Unit — required — (String)

              The units for output resolution of the result.

              Possible values include:
              • "METERS"
            • Value — required — (Float)

              The value for output resolution of the result.

        • TargetBands — (Array<String>)

          A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.

      • TemporalStatisticsConfig — (map)

        An object containing information about the job configuration for temporal statistics.

        • GroupBy — (String)

          The input for the temporal statistics grouping by time frequency option.

          Possible values include:
          • "ALL"
          • "YEARLY"
        • Statistics — required — (Array<String>)

          The list of the statistics method options.

        • TargetBands — (Array<String>)

          The list of target band names for the temporal statistic to calculate.

      • ZonalStatisticsConfig — (map)

        An object containing information about the job configuration for zonal statistics.

        • Statistics — required — (Array<String>)

          List of zonal statistics to compute.

        • TargetBands — (Array<String>)

          Bands used in the operation. If no target bands are specified, it uses all bands available input.

        • ZoneS3Path — required — (String)

          The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.

        • ZoneS3PathKmsKeyId — (String)

          The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

          The KmsKeyId can be any of the following formats:

          • // KMS Key ID

            "1234abcd-12ab-34cd-56ef-1234567890ab"

          • // Amazon Resource Name (ARN) of a KMS Key

            "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

          For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

    • KmsKeyId — (String)

      The Key Management Service key ID for server-side encryption.

    • Name — (String)

      The name of the Earth Observation job.

    • Status — (String)

      The status of the Earth Observation job.

      Possible values include:
      • "INITIALIZING"
      • "IN_PROGRESS"
      • "STOPPING"
      • "COMPLETED"
      • "STOPPED"
      • "FAILED"
      • "DELETING"
      • "DELETED"
    • Tags — (map<String>)

      Each tag consists of a key and a value.

Returns:

• (AWS.Request) —

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

var params = {
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  InputConfig: { /* required */
    DataSourceConfig: { /* required */
      S3Data: {
        S3Uri: 'STRING_VALUE', /* required */
        KmsKeyId: 'STRING_VALUE'
      }
    },
    DocumentType: CSV /* required */
  },
  JobConfig: { /* required */
    MapMatchingConfig: {
      IdAttributeName: 'STRING_VALUE', /* required */
      TimestampAttributeName: 'STRING_VALUE', /* required */
      XAttributeName: 'STRING_VALUE', /* required */
      YAttributeName: 'STRING_VALUE' /* required */
    },
    ReverseGeocodingConfig: {
      XAttributeName: 'STRING_VALUE', /* required */
      YAttributeName: 'STRING_VALUE' /* required */
    }
  },
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  Tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
sagemakergeospatial.startVectorEnrichmentJob(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: {}) —
  • ClientToken — (String)

    A unique token that guarantees that the call to this API is idempotent.

    If a token is not provided, the SDK will use a version 4 UUID.
  • ExecutionRoleArn — (String)

    The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

  • InputConfig — (map)

    Input configuration information for the Vector Enrichment job.

    • DataSourceConfig — required — (map)

      The input structure for the data source that represents the storage type of the input data objects.

      • S3Data — (map)

        The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.

        • KmsKeyId — (String)

          The Key Management Service key ID for server-side encryption.

        • S3Uri — required — (String)

          The URL to the Amazon S3 data for the Vector Enrichment job.

    • DocumentType — required — (String)

      The input structure that defines the data source file type.

      Possible values include:
      • "CSV"
  • JobConfig — (map)

    An object containing information about the job configuration.

    • MapMatchingConfig — (map)

      The input structure for Map Matching operation type.

      • IdAttributeName — required — (String)

        The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.

      • TimestampAttributeName — required — (String)

        The name of the timestamp attribute.

      • XAttributeName — required — (String)

        The name of the X-attribute

      • YAttributeName — required — (String)

        The name of the Y-attribute

    • ReverseGeocodingConfig — (map)

      The input structure for Reverse Geocoding operation type.

      • XAttributeName — required — (String)

        The field name for the data that describes x-axis coordinate, eg. longitude of a point.

      • YAttributeName — required — (String)

        The field name for the data that describes y-axis coordinate, eg. latitude of a point.

  • KmsKeyId — (String)

    The Key Management Service key ID for server-side encryption.

  • Name — (String)

    The name of the Vector Enrichment job.

  • Tags — (map<String>)

    Each tag consists of a key and a value.

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:

    • Arn — (String)

      The Amazon Resource Name (ARN) of the Vector Enrichment job.

    • CreationTime — (Date)

      The creation time.

    • DurationInSeconds — (Integer)

      The duration of the Vector Enrichment job, in seconds.

    • ExecutionRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

    • InputConfig — (map)

      Input configuration information for starting the Vector Enrichment job.

      • DataSourceConfig — required — (map)

        The input structure for the data source that represents the storage type of the input data objects.

        • S3Data — (map)

          The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.

          • KmsKeyId — (String)

            The Key Management Service key ID for server-side encryption.

          • S3Uri — required — (String)

            The URL to the Amazon S3 data for the Vector Enrichment job.

      • DocumentType — required — (String)

        The input structure that defines the data source file type.

        Possible values include:
        • "CSV"
    • JobConfig — (map)

      An object containing information about the job configuration.

      • MapMatchingConfig — (map)

        The input structure for Map Matching operation type.

        • IdAttributeName — required — (String)

          The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.

        • TimestampAttributeName — required — (String)

          The name of the timestamp attribute.

        • XAttributeName — required — (String)

          The name of the X-attribute

        • YAttributeName — required — (String)

          The name of the Y-attribute

      • ReverseGeocodingConfig — (map)

        The input structure for Reverse Geocoding operation type.

        • XAttributeName — required — (String)

          The field name for the data that describes x-axis coordinate, eg. longitude of a point.

        • YAttributeName — required — (String)

          The field name for the data that describes y-axis coordinate, eg. latitude of a point.

    • KmsKeyId — (String)

      The Key Management Service key ID for server-side encryption.

    • Name — (String)

      The name of the Vector Enrichment job.

    • Status — (String)

      The status of the Vector Enrichment job being started.

      Possible values include:
      • "INITIALIZING"
      • "IN_PROGRESS"
      • "STOPPING"
      • "STOPPED"
      • "COMPLETED"
      • "FAILED"
      • "DELETING"
      • "DELETED"
    • Tags — (map<String>)

      Each tag consists of a key and a value.

    • Type — (String)

      The type of the Vector Enrichment job.

      Possible values include:
      • "REVERSE_GEOCODING"
      • "MAP_MATCHING"

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE' /* required */
};
sagemakergeospatial.stopEarthObservationJob(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the Earth Observation job being stopped.

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 = {
  Arn: 'STRING_VALUE' /* required */
};
sagemakergeospatial.stopVectorEnrichmentJob(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: {}) —
  • Arn — (String)

    The Amazon Resource Name (ARN) of the Vector Enrichment job.

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 */
  Tags: { /* required */
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
sagemakergeospatial.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)

    The Amazon Resource Name (ARN) of the resource you want to tag.

  • Tags — (map<String>)

    Each tag consists of a key and a value.

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 */
  ]
};
sagemakergeospatial.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)

    The Amazon Resource Name (ARN) of the resource you want to untag.

  • TagKeys — (Array<String>)

    Keys of the tags you want to remove.

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.