[ aws . sagemaker-geospatial ]

start-earth-observation-job

Description

Use this operation to create an Earth observation job.

See also: AWS API Documentation

Synopsis

  start-earth-observation-job
[--client-token <value>]
[--execution-role-arn <value>]
--input-config <value>
--job-config <value>
[--kms-key-id <value>]
--name <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--client-token (string)

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

--execution-role-arn (string)

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

--input-config (structure)

Input configuration information for the Earth Observation job.

DataSourceConfig -> (tagged union structure)

The location of the input data.>

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: S3Data.

S3Data -> (structure)

KmsKeyId -> (string)

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

MetadataProvider -> (string)

S3Uri -> (string)

The URL to the Amazon S3 input.

PreviousEarthObservationJobArn -> (string)

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

RasterDataCollectionQuery -> (structure)

AreaOfInterest -> (tagged union structure)

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AreaOfInterestGeometry.

AreaOfInterestGeometry -> (tagged union structure)

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.

MultiPolygonGeometry -> (structure)

Coordinates -> (list)

The coordinates of the multipolygon geometry.

(list)

(list)

(list)

(double)

PolygonGeometry -> (structure)

Coordinates -> (list)

(list)

(list)

(double)

PropertyFilters -> (structure)

LogicalOperator -> (string)

Properties -> (list)

(structure)

Property -> (tagged union structure)

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.

EoCloudCover -> (structure)

LowerBound -> (float)

UpperBound -> (float)

LandsatCloudCoverLand -> (structure)

LowerBound -> (float)

UpperBound -> (float)

Platform -> (structure)

ComparisonOperator -> (string)

Value -> (string)

The value of the platform.

ViewOffNadir -> (structure)

LowerBound -> (float)

UpperBound -> (float)

ViewSunAzimuth -> (structure)

LowerBound -> (float)

UpperBound -> (float)

ViewSunElevation -> (structure)

LowerBound -> (float)

The lower bound to view the sun elevation.

UpperBound -> (float)

The upper bound to view the sun elevation.

RasterDataCollectionArn -> (string)

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

TimeRangeFilter -> (structure)

EndTime -> (timestamp)

The end time for the time-range filter.

StartTime -> (timestamp)

The start time for the time-range filter.

JSON Syntax:

{
  "DataSourceConfig": {
    "S3Data": {
      "KmsKeyId": "string",
      "MetadataProvider": "PLANET_ORDER",
      "S3Uri": "string"
    }
  },
  "PreviousEarthObservationJobArn": "string",
  "RasterDataCollectionQuery": {
    "AreaOfInterest": {
      "AreaOfInterestGeometry": {
        "MultiPolygonGeometry": {
          "Coordinates": [
            [
              [
                [double, ...]
                ...
              ]
              ...
            ]
            ...
          ]
        },
        "PolygonGeometry": {
          "Coordinates": [
            [
              [double, ...]
              ...
            ]
            ...
          ]
        }
      }
    },
    "PropertyFilters": {
      "LogicalOperator": "AND",
      "Properties": [
        {
          "Property": {
            "EoCloudCover": {
              "LowerBound": float,
              "UpperBound": float
            },
            "LandsatCloudCoverLand": {
              "LowerBound": float,
              "UpperBound": float
            },
            "Platform": {
              "ComparisonOperator": "EQUALS"|"NOT_EQUALS"|"STARTS_WITH",
              "Value": "string"
            },
            "ViewOffNadir": {
              "LowerBound": float,
              "UpperBound": float
            },
            "ViewSunAzimuth": {
              "LowerBound": float,
              "UpperBound": float
            },
            "ViewSunElevation": {
              "LowerBound": float,
              "UpperBound": float
            }
          }
        }
        ...
      ]
    },
    "RasterDataCollectionArn": "string",
    "TimeRangeFilter": {
      "EndTime": timestamp,
      "StartTime": timestamp
    }
  }
}

--job-config (tagged union structure)

An object containing information about the job configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: BandMathConfig, CloudMaskingConfig, CloudRemovalConfig, GeoMosaicConfig, LandCoverSegmentationConfig, ResamplingConfig, StackConfig, TemporalStatisticsConfig, ZonalStatisticsConfig.

BandMathConfig -> (structure)

CustomIndices -> (structure)

Operations -> (list)

(structure)

Equation -> (string)

Name -> (string)

The name of the operation.

OutputType -> (string)

The type of the operation.

PredefinedIndices -> (list)

(string)

CloudMaskingConfig -> (structure)

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

CloudRemovalConfig -> (structure)

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

AlgorithmName -> (string)

The name of the algorithm used for cloud removal.

InterpolationValue -> (string)

The interpolation value you provide for cloud removal.

TargetBands -> (list)

(string)

GeoMosaicConfig -> (structure)

An object containing information about the job configuration for geomosaic.

AlgorithmName -> (string)

The name of the algorithm being used for geomosaic.

TargetBands -> (list)

The target bands for geomosaic.

(string)

LandCoverSegmentationConfig -> (structure)

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

ResamplingConfig -> (structure)

An object containing information about the job configuration for resampling.

AlgorithmName -> (string)

The name of the algorithm used for resampling.

OutputResolution -> (structure)

UserDefined -> (structure)

Unit -> (string)

Value -> (float)

TargetBands -> (list)

(string)

StackConfig -> (structure)

OutputResolution -> (structure)

Predefined -> (string)

UserDefined -> (structure)

Unit -> (string)

Value -> (float)

TargetBands -> (list)

(string)

TemporalStatisticsConfig -> (structure)

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

GroupBy -> (string)

Statistics -> (list)

(string)

TargetBands -> (list)

(string)

ZonalStatisticsConfig -> (structure)

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

Statistics -> (list)

(string)

TargetBands -> (list)

(string)

ZoneS3Path -> (string)

JSON Syntax:

{
  "BandMathConfig": {
    "CustomIndices": {
      "Operations": [
        {
          "Equation": "string",
          "Name": "string",
          "OutputType": "INT32"|"FLOAT32"|"INT16"|"FLOAT64"|"UINT16"
        }
        ...
      ]
    },
    "PredefinedIndices": ["string", ...]
  },
  "CloudMaskingConfig": {

  },
  "CloudRemovalConfig": {
    "AlgorithmName": "INTERPOLATION",
    "InterpolationValue": "string",
    "TargetBands": ["string", ...]
  },
  "GeoMosaicConfig": {
    "AlgorithmName": "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM",
    "TargetBands": ["string", ...]
  },
  "LandCoverSegmentationConfig": {

  },
  "ResamplingConfig": {
    "AlgorithmName": "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM",
    "OutputResolution": {
      "UserDefined": {
        "Unit": "METERS",
        "Value": float
      }
    },
    "TargetBands": ["string", ...]
  },
  "StackConfig": {
    "OutputResolution": {
      "Predefined": "HIGHEST"|"LOWEST"|"AVERAGE",
      "UserDefined": {
        "Unit": "METERS",
        "Value": float
      }
    },
    "TargetBands": ["string", ...]
  },
  "TemporalStatisticsConfig": {
    "GroupBy": "ALL"|"YEARLY",
    "Statistics": ["MEAN"|"MEDIAN"|"STANDARD_DEVIATION", ...],
    "TargetBands": ["string", ...]
  },
  "ZonalStatisticsConfig": {
    "Statistics": ["MEAN"|"MEDIAN"|"STANDARD_DEVIATION"|"MAX"|"MIN"|"SUM", ...],
    "TargetBands": ["string", ...],
    "ZoneS3Path": "string"
  }
}

--kms-key-id (string)

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

--name (string)

The name of the Earth Observation job.

--tags (map)

Each tag consists of a key and a value.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json

• text

• table

• yaml

• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on

• off

• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

Arn -> (string)

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

CreationTime -> (timestamp)

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 -> (structure)

Input configuration information for the Earth Observation job.

DataSourceConfig -> (tagged union structure)

The location of the input data.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: S3Data.

S3Data -> (structure)

KmsKeyId -> (string)

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

MetadataProvider -> (string)

S3Uri -> (string)

The URL to the Amazon S3 input.

PreviousEarthObservationJobArn -> (string)

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

RasterDataCollectionQuery -> (structure)

AreaOfInterest -> (tagged union structure)

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AreaOfInterestGeometry.

AreaOfInterestGeometry -> (tagged union structure)

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.

MultiPolygonGeometry -> (structure)

Coordinates -> (list)

The coordinates of the multipolygon geometry.

(list)

(list)

(list)

(double)

PolygonGeometry -> (structure)

Coordinates -> (list)

(list)

(list)

(double)

PropertyFilters -> (structure)

LogicalOperator -> (string)

Properties -> (list)

(structure)

Property -> (tagged union structure)

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.

EoCloudCover -> (structure)

LowerBound -> (float)

UpperBound -> (float)

LandsatCloudCoverLand -> (structure)

LowerBound -> (float)

UpperBound -> (float)

Platform -> (structure)

ComparisonOperator -> (string)

Value -> (string)

The value of the platform.

ViewOffNadir -> (structure)

LowerBound -> (float)

UpperBound -> (float)

ViewSunAzimuth -> (structure)

LowerBound -> (float)

UpperBound -> (float)

ViewSunElevation -> (structure)

LowerBound -> (float)

The lower bound to view the sun elevation.

UpperBound -> (float)

The upper bound to view the sun elevation.

RasterDataCollectionArn -> (string)

RasterDataCollectionName -> (string)

The name of the raster data collection.

TimeRangeFilter -> (structure)

EndTime -> (timestamp)

The end time for the time-range filter.

StartTime -> (timestamp)

The start time for the time-range filter.

JobConfig -> (tagged union structure)

An object containing information about the job configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: BandMathConfig, CloudMaskingConfig, CloudRemovalConfig, GeoMosaicConfig, LandCoverSegmentationConfig, ResamplingConfig, StackConfig, TemporalStatisticsConfig, ZonalStatisticsConfig.

BandMathConfig -> (structure)

CustomIndices -> (structure)

Operations -> (list)

(structure)

Equation -> (string)

Name -> (string)

The name of the operation.

OutputType -> (string)

The type of the operation.

PredefinedIndices -> (list)

(string)

CloudMaskingConfig -> (structure)

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

CloudRemovalConfig -> (structure)

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

AlgorithmName -> (string)

The name of the algorithm used for cloud removal.

InterpolationValue -> (string)

The interpolation value you provide for cloud removal.

TargetBands -> (list)

(string)

GeoMosaicConfig -> (structure)

An object containing information about the job configuration for geomosaic.

AlgorithmName -> (string)

The name of the algorithm being used for geomosaic.

TargetBands -> (list)

The target bands for geomosaic.

(string)

LandCoverSegmentationConfig -> (structure)

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

ResamplingConfig -> (structure)

An object containing information about the job configuration for resampling.

AlgorithmName -> (string)

The name of the algorithm used for resampling.

OutputResolution -> (structure)

UserDefined -> (structure)

Unit -> (string)

Value -> (float)

TargetBands -> (list)

(string)

StackConfig -> (structure)

OutputResolution -> (structure)

Predefined -> (string)

UserDefined -> (structure)

Unit -> (string)

Value -> (float)

TargetBands -> (list)

(string)

TemporalStatisticsConfig -> (structure)

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

GroupBy -> (string)

Statistics -> (list)

(string)

TargetBands -> (list)

(string)

ZonalStatisticsConfig -> (structure)

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

Statistics -> (list)

(string)

TargetBands -> (list)

(string)

ZoneS3Path -> (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.

Tags -> (map)

Each tag consists of a key and a value.

key -> (string)

value -> (string)