Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartEarthObservationJob

Use this operation to create an Earth observation job.

Request Syntax


POST /earth-observation-jobs HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ExecutionRoleArn": "string",
   "InputConfig": { 
      "PreviousEarthObservationJobArn": "string",
      "RasterDataCollectionQuery": { 
         "AreaOfInterest": { ... },
         "PropertyFilters": { 
            "LogicalOperator": "string",
            "Properties": [ 
               { 
                  "Property": { ... }
               }
            ]
         },
         "RasterDataCollectionArn": "string",
         "TimeRangeFilter": { 
            "EndTime": number,
            "StartTime": number
         }
      }
   },
   "JobConfig": { ... },
   "KmsKeyId": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

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

Type: String

Length Constraints: Minimum length of 36. Maximum length of 64.

Required: No

ExecutionRoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:(aws[a-z-]*):iam::([0-9]{12}):role/[a-zA-Z0-9+=,.@_/-]+$

Required: Yes

InputConfig

Input configuration information for the Earth Observation job.

Type: InputConfigInput object

Required: Yes

JobConfig

An object containing information about the job configuration.

Type: JobConfigInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

KmsKeyId

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

Name

The name of the Earth Observation job.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: Yes

Tags

Each tag consists of a key and a value.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationTime": "string",
   "DurationInSeconds": number,
   "ExecutionRoleArn": "string",
   "InputConfig": { 
      "PreviousEarthObservationJobArn": "string",
      "RasterDataCollectionQuery": { 
         "AreaOfInterest": { ... },
         "PropertyFilters": { 
            "LogicalOperator": "string",
            "Properties": [ 
               { 
                  "Property": { ... }
               }
            ]
         },
         "RasterDataCollectionArn": "string",
         "RasterDataCollectionName": "string",
         "TimeRangeFilter": { 
            "EndTime": "string",
            "StartTime": "string"
         }
      }
   },
   "JobConfig": { ... },
   "KmsKeyId": "string",
   "Name": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}