Start Earth Observation Job

sagemakergeospatialcapabilities_start_earth_observation_job

R Documentation

Use this operation to create an Earth observation job

Description

Use this operation to create an Earth observation job.

Usage

sagemakergeospatialcapabilities_start_earth_observation_job(ClientToken,
  ExecutionRoleArn, InputConfig, JobConfig, KmsKeyId, Name, Tags)

Arguments

ClientToken

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

ExecutionRoleArn

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

InputConfig

[required] Input configuration information for the Earth Observation job.

JobConfig

[required] An object containing information about the job configuration.

KmsKeyId

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

Name

[required] The name of the Earth Observation job.

Tags

Each tag consists of a key and a value.

Value

A list with the following syntax:

list(
  Arn = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  DurationInSeconds = 123,
  ExecutionRoleArn = "string",
  InputConfig = list(
    PreviousEarthObservationJobArn = "string",
    RasterDataCollectionQuery = list(
      AreaOfInterest = list(
        AreaOfInterestGeometry = list(
          MultiPolygonGeometry = list(
            Coordinates = list(
              list(
                list(
                  list(
                    123.0
                  )
                )
              )
            )
          ),
          PolygonGeometry = list(
            Coordinates = list(
              list(
                list(
                  123.0
                )
              )
            )
          )
        )
      ),
      PropertyFilters = list(
        LogicalOperator = "AND",
        Properties = list(
          list(
            Property = list(
              EoCloudCover = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              LandsatCloudCoverLand = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              Platform = list(
                ComparisonOperator = "EQUALS"|"NOT_EQUALS"|"STARTS_WITH",
                Value = "string"
              ),
              ViewOffNadir = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              ViewSunAzimuth = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              ViewSunElevation = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              )
            )
          )
        )
      ),
      RasterDataCollectionArn = "string",
      RasterDataCollectionName = "string",
      TimeRangeFilter = list(
        EndTime = as.POSIXct(
          "2015-01-01"
        ),
        StartTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  JobConfig = list(
    BandMathConfig = list(
      CustomIndices = list(
        Operations = list(
          list(
            Equation = "string",
            Name = "string",
            OutputType = "INT32"|"FLOAT32"|"INT16"|"FLOAT64"|"UINT16"
          )
        )
      ),
      PredefinedIndices = list(
        "string"
      )
    ),
    CloudMaskingConfig = list(),
    CloudRemovalConfig = list(
      AlgorithmName = "INTERPOLATION",
      InterpolationValue = "string",
      TargetBands = list(
        "string"
      )
    ),
    GeoMosaicConfig = list(
      AlgorithmName = "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM",
      TargetBands = list(
        "string"
      )
    ),
    LandCoverSegmentationConfig = list(),
    ResamplingConfig = list(
      AlgorithmName = "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM",
      OutputResolution = list(
        UserDefined = list(
          Unit = "METERS",
          Value = 123.0
        )
      ),
      TargetBands = list(
        "string"
      )
    ),
    StackConfig = list(
      OutputResolution = list(
        Predefined = "HIGHEST"|"LOWEST"|"AVERAGE",
        UserDefined = list(
          Unit = "METERS",
          Value = 123.0
        )
      ),
      TargetBands = list(
        "string"
      )
    ),
    TemporalStatisticsConfig = list(
      GroupBy = "ALL"|"YEARLY",
      Statistics = list(
        "MEAN"|"MEDIAN"|"STANDARD_DEVIATION"
      ),
      TargetBands = list(
        "string"
      )
    ),
    ZonalStatisticsConfig = list(
      Statistics = list(
        "MEAN"|"MEDIAN"|"STANDARD_DEVIATION"|"MAX"|"MIN"|"SUM"
      ),
      TargetBands = list(
        "string"
      ),
      ZoneS3Path = "string",
      ZoneS3PathKmsKeyId = "string"
    )
  ),
  KmsKeyId = "string",
  Name = "string",
  Status = "INITIALIZING"|"IN_PROGRESS"|"STOPPING"|"COMPLETED"|"STOPPED"|"FAILED"|"DELETING"|"DELETED",
  Tags = list(
    "string"
  )
)

Request syntax

svc$start_earth_observation_job(
  ClientToken = "string",
  ExecutionRoleArn = "string",
  InputConfig = list(
    PreviousEarthObservationJobArn = "string",
    RasterDataCollectionQuery = list(
      AreaOfInterest = list(
        AreaOfInterestGeometry = list(
          MultiPolygonGeometry = list(
            Coordinates = list(
              list(
                list(
                  list(
                    123.0
                  )
                )
              )
            )
          ),
          PolygonGeometry = list(
            Coordinates = list(
              list(
                list(
                  123.0
                )
              )
            )
          )
        )
      ),
      PropertyFilters = list(
        LogicalOperator = "AND",
        Properties = list(
          list(
            Property = list(
              EoCloudCover = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              LandsatCloudCoverLand = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              Platform = list(
                ComparisonOperator = "EQUALS"|"NOT_EQUALS"|"STARTS_WITH",
                Value = "string"
              ),
              ViewOffNadir = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              ViewSunAzimuth = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              ),
              ViewSunElevation = list(
                LowerBound = 123.0,
                UpperBound = 123.0
              )
            )
          )
        )
      ),
      RasterDataCollectionArn = "string",
      TimeRangeFilter = list(
        EndTime = as.POSIXct(
          "2015-01-01"
        ),
        StartTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  JobConfig = list(
    BandMathConfig = list(
      CustomIndices = list(
        Operations = list(
          list(
            Equation = "string",
            Name = "string",
            OutputType = "INT32"|"FLOAT32"|"INT16"|"FLOAT64"|"UINT16"
          )
        )
      ),
      PredefinedIndices = list(
        "string"
      )
    ),
    CloudMaskingConfig = list(),
    CloudRemovalConfig = list(
      AlgorithmName = "INTERPOLATION",
      InterpolationValue = "string",
      TargetBands = list(
        "string"
      )
    ),
    GeoMosaicConfig = list(
      AlgorithmName = "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM",
      TargetBands = list(
        "string"
      )
    ),
    LandCoverSegmentationConfig = list(),
    ResamplingConfig = list(
      AlgorithmName = "NEAR"|"BILINEAR"|"CUBIC"|"CUBICSPLINE"|"LANCZOS"|"AVERAGE"|"RMS"|"MODE"|"MAX"|"MIN"|"MED"|"Q1"|"Q3"|"SUM",
      OutputResolution = list(
        UserDefined = list(
          Unit = "METERS",
          Value = 123.0
        )
      ),
      TargetBands = list(
        "string"
      )
    ),
    StackConfig = list(
      OutputResolution = list(
        Predefined = "HIGHEST"|"LOWEST"|"AVERAGE",
        UserDefined = list(
          Unit = "METERS",
          Value = 123.0
        )
      ),
      TargetBands = list(
        "string"
      )
    ),
    TemporalStatisticsConfig = list(
      GroupBy = "ALL"|"YEARLY",
      Statistics = list(
        "MEAN"|"MEDIAN"|"STANDARD_DEVIATION"
      ),
      TargetBands = list(
        "string"
      )
    ),
    ZonalStatisticsConfig = list(
      Statistics = list(
        "MEAN"|"MEDIAN"|"STANDARD_DEVIATION"|"MAX"|"MIN"|"SUM"
      ),
      TargetBands = list(
        "string"
      ),
      ZoneS3Path = "string",
      ZoneS3PathKmsKeyId = "string"
    )
  ),
  KmsKeyId = "string",
  Name = "string",
  Tags = list(
    "string"
  )
)