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

  • 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 Amazon Key Management Service (KMS) 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 Amazon Key Management Service (KMS) 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'
    }
  }
};
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.

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

        The Amazon Key Management Service (KMS) 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)
        • KmsKeyId — (String)

          The Amazon Key Management Service (KMS) 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)

      • Type — (String)

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

        • Type — (String)

          Possible values include:

          • "CLIENT_ERROR"
          • "SERVER_ERROR"
      • ExportSourceImages — (map)
        • Message — (String)

        • Type — (String)

          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.

      • DataSourceConfig — (map)

        The location of the input data.

        • S3Data — (map)
          • KmsKeyId — (String)

            The Amazon Key Management Service (KMS) key ID for server-side encryption.

          • MetadataProvider — required — (String)

            Possible values include:

            • "PLANET_ORDER"
          • S3Uri — required — (String)

            The URL to the Amazon S3 input.

      • PreviousEarthObservationJobArn — (String)

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

      • RasterDataCollectionQuery — (map)
        • AreaOfInterest — (map)
          • AreaOfInterestGeometry — (map)
            • MultiPolygonGeometry — (map)
              • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

                The coordinates of the multipolygon geometry.

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

        • PropertyFilters — (map)
          • LogicalOperator — (String)

            Possible values include:

            • "AND"
          • Properties — (Array<map>)
            • Property — required — (map)
              • EoCloudCover — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

              • LandsatCloudCoverLand — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

              • Platform — (map)
                • ComparisonOperator — (String)

                  Possible values include:

                  • "EQUALS"
                  • "NOT_EQUALS"
                  • "STARTS_WITH"
                • Value — required — (String)

                  The value of the platform.

              • ViewOffNadir — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

              • ViewSunAzimuth — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

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

        • RasterDataCollectionName — required — (String)

          The name of the raster data collection.

        • TimeRangeFilter — required — (map)
          • 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)
        • CustomIndices — (map)
          • Operations — (Array<map>)
            • Equation — required — (String)

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

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

      • 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)
          • UserDefined — required — (map)
            • Unit — required — (String)

              Possible values include:

              • "METERS"
            • Value — required — (Float)

        • TargetBands — (Array<String>)

      • StackConfig — (map)
        • OutputResolution — (map)
          • Predefined — (String)

            Possible values include:

            • "HIGHEST"
            • "LOWEST"
            • "AVERAGE"
          • UserDefined — (map)
            • Unit — required — (String)

              Possible values include:

              • "METERS"
            • Value — required — (Float)

        • TargetBands — (Array<String>)

      • TemporalStatisticsConfig — (map)

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

        • GroupBy — (String)

          Possible values include:

          • "ALL"
          • "YEARLY"
        • Statistics — required — (Array<String>)

        • TargetBands — (Array<String>)

      • ZonalStatisticsConfig — (map)

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

        • Statistics — required — (Array<String>)

        • TargetBands — (Array<String>)

        • ZoneS3Path — required — (String)

    • KmsKeyId — (String)

      The Amazon Key Management Service (KMS) key ID for server-side encryption.

    • Name — (String)

      The name of the Earth Observation job.

    • OutputBands — (Array<map>)
      • 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>)

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

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

        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)
        • S3Data — (map)
          • KmsKeyId — (String)

            The Amazon Key Management Service (KMS) key ID for server-side encryption.

          • S3Uri — required — (String)

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

      • DocumentType — required — (String)

        Possible values include:

        • "CSV"
    • JobConfig — (map)

      An object containing information about the job configuration.

      • MapMatchingConfig — (map)
        • IdAttributeName — required — (String)

        • 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)
        • XAttributeName — required — (String)

        • YAttributeName — required — (String)

    • KmsKeyId — (String)

      The Amazon Key Management Service (KMS) 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)

      • 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>)
        • 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)
    • AreaOfInterest — (map)
      • AreaOfInterestGeometry — (map)
        • MultiPolygonGeometry — (map)
          • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

            The coordinates of the multipolygon geometry.

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

    • BandFilter — (Array<String>)

    • PropertyFilters — (map)
      • LogicalOperator — (String)

        Possible values include:

        • "AND"
      • Properties — (Array<map>)
        • Property — required — (map)
          • EoCloudCover — (map)
            • LowerBound — required — (Float)

            • UpperBound — required — (Float)

          • LandsatCloudCoverLand — (map)
            • LowerBound — required — (Float)

            • UpperBound — required — (Float)

          • Platform — (map)
            • ComparisonOperator — (String)

              Possible values include:

              • "EQUALS"
              • "NOT_EQUALS"
              • "STARTS_WITH"
            • Value — required — (String)

              The value of the platform.

          • ViewOffNadir — (map)
            • LowerBound — required — (Float)

            • UpperBound — required — (Float)

          • ViewSunAzimuth — (map)
            • LowerBound — required — (Float)

            • UpperBound — required — (Float)

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

    • Items — (Array<map>)
      • Assets — (map<map>)
        • Href — (String)

      • DateTime — required — (Date)

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

        • Type — required — (String)

      • Id — required — (String)

        A unique Id for the source item.

      • Properties — (map)
        • EoCloudCover — (Float)

        • LandsatCloudCoverLand — (Float)

        • Platform — (String)

        • ViewOffNadir — (Float)

        • ViewSunAzimuth — (Float)

        • ViewSunElevation — (Float)

    • 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 = {
  InputConfig: { /* required */
    DataSourceConfig: {
      S3Data: {
        MetadataProvider: PLANET_ORDER, /* required */
        S3Uri: 'STRING_VALUE', /* required */
        KmsKeyId: 'STRING_VALUE'
      }
    },
    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 */
      ]
    }
  },
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  ExecutionRoleArn: '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.

    • DataSourceConfig — (map)

      The location of the input data.>

      • S3Data — (map)
        • KmsKeyId — (String)

          The Amazon Key Management Service (KMS) key ID for server-side encryption.

        • MetadataProvider — required — (String)

          Possible values include:

          • "PLANET_ORDER"
        • S3Uri — required — (String)

          The URL to the Amazon S3 input.

    • PreviousEarthObservationJobArn — (String)

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

    • RasterDataCollectionQuery — (map)
      • AreaOfInterest — (map)

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

        • AreaOfInterestGeometry — (map)
          • MultiPolygonGeometry — (map)
            • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

              The coordinates of the multipolygon geometry.

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

      • PropertyFilters — (map)
        • LogicalOperator — (String)

          Possible values include:

          • "AND"
        • Properties — (Array<map>)
          • Property — required — (map)
            • EoCloudCover — (map)
              • LowerBound — required — (Float)

              • UpperBound — required — (Float)

            • LandsatCloudCoverLand — (map)
              • LowerBound — required — (Float)

              • UpperBound — required — (Float)

            • Platform — (map)
              • ComparisonOperator — (String)

                Possible values include:

                • "EQUALS"
                • "NOT_EQUALS"
                • "STARTS_WITH"
              • Value — required — (String)

                The value of the platform.

            • ViewOffNadir — (map)
              • LowerBound — required — (Float)

              • UpperBound — required — (Float)

            • ViewSunAzimuth — (map)
              • LowerBound — required — (Float)

              • UpperBound — required — (Float)

            • ViewSunElevation — (map)
              • 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)
        • 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)
      • CustomIndices — (map)
        • Operations — (Array<map>)
          • Equation — required — (String)

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

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

    • 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)
        • UserDefined — required — (map)
          • Unit — required — (String)

            Possible values include:

            • "METERS"
          • Value — required — (Float)

      • TargetBands — (Array<String>)

    • StackConfig — (map)
      • OutputResolution — (map)
        • Predefined — (String)

          Possible values include:

          • "HIGHEST"
          • "LOWEST"
          • "AVERAGE"
        • UserDefined — (map)
          • Unit — required — (String)

            Possible values include:

            • "METERS"
          • Value — required — (Float)

      • TargetBands — (Array<String>)

    • TemporalStatisticsConfig — (map)

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

      • GroupBy — (String)

        Possible values include:

        • "ALL"
        • "YEARLY"
      • Statistics — required — (Array<String>)

      • TargetBands — (Array<String>)

    • ZonalStatisticsConfig — (map)

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

      • Statistics — required — (Array<String>)

      • TargetBands — (Array<String>)

      • ZoneS3Path — required — (String)

  • KmsKeyId — (String)

    The Amazon Key Management Service (KMS) 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.

      • DataSourceConfig — (map)

        The location of the input data.

        • S3Data — (map)
          • KmsKeyId — (String)

            The Amazon Key Management Service (KMS) key ID for server-side encryption.

          • MetadataProvider — required — (String)

            Possible values include:

            • "PLANET_ORDER"
          • S3Uri — required — (String)

            The URL to the Amazon S3 input.

      • PreviousEarthObservationJobArn — (String)

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

      • RasterDataCollectionQuery — (map)
        • AreaOfInterest — (map)
          • AreaOfInterestGeometry — (map)
            • MultiPolygonGeometry — (map)
              • Coordinates — required — (Array<Array<Array<Array<Float>>>>)

                The coordinates of the multipolygon geometry.

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

        • PropertyFilters — (map)
          • LogicalOperator — (String)

            Possible values include:

            • "AND"
          • Properties — (Array<map>)
            • Property — required — (map)
              • EoCloudCover — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

              • LandsatCloudCoverLand — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

              • Platform — (map)
                • ComparisonOperator — (String)

                  Possible values include:

                  • "EQUALS"
                  • "NOT_EQUALS"
                  • "STARTS_WITH"
                • Value — required — (String)

                  The value of the platform.

              • ViewOffNadir — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

              • ViewSunAzimuth — (map)
                • LowerBound — required — (Float)

                • UpperBound — required — (Float)

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

        • RasterDataCollectionName — required — (String)

          The name of the raster data collection.

        • TimeRangeFilter — required — (map)
          • 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)
        • CustomIndices — (map)
          • Operations — (Array<map>)
            • Equation — required — (String)

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

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

      • 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)
          • UserDefined — required — (map)
            • Unit — required — (String)

              Possible values include:

              • "METERS"
            • Value — required — (Float)

        • TargetBands — (Array<String>)

      • StackConfig — (map)
        • OutputResolution — (map)
          • Predefined — (String)

            Possible values include:

            • "HIGHEST"
            • "LOWEST"
            • "AVERAGE"
          • UserDefined — (map)
            • Unit — required — (String)

              Possible values include:

              • "METERS"
            • Value — required — (Float)

        • TargetBands — (Array<String>)

      • TemporalStatisticsConfig — (map)

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

        • GroupBy — (String)

          Possible values include:

          • "ALL"
          • "YEARLY"
        • Statistics — required — (Array<String>)

        • TargetBands — (Array<String>)

      • ZonalStatisticsConfig — (map)

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

        • Statistics — required — (Array<String>)

        • TargetBands — (Array<String>)

        • ZoneS3Path — required — (String)

    • KmsKeyId — (String)

      The Amazon Key Management Service (KMS) 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)
      • S3Data — (map)
        • KmsKeyId — (String)

          The Amazon Key Management Service (KMS) key ID for server-side encryption.

        • S3Uri — required — (String)

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

    • DocumentType — required — (String)

      Possible values include:

      • "CSV"
  • JobConfig — (map)

    An object containing information about the job configuration.

    • MapMatchingConfig — (map)
      • IdAttributeName — required — (String)

      • 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)
      • XAttributeName — required — (String)

      • YAttributeName — required — (String)

  • KmsKeyId — (String)

    The Amazon Key Management Service (KMS) 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)
        • S3Data — (map)
          • KmsKeyId — (String)

            The Amazon Key Management Service (KMS) key ID for server-side encryption.

          • S3Uri — required — (String)

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

      • DocumentType — required — (String)

        Possible values include:

        • "CSV"
    • JobConfig — (map)

      An object containing information about the job configuration.

      • MapMatchingConfig — (map)
        • IdAttributeName — required — (String)

        • 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)
        • XAttributeName — required — (String)

        • YAttributeName — required — (String)

    • KmsKeyId — (String)

      The Amazon Key Management Service (KMS) 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.