GetEarthObservationJob
Get the details for a previously initiated Earth Observation job.
Request Syntax
GET /earth-observation-jobs/Arn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Arn
-
The Amazon Resource Name (ARN) of the Earth Observation job.
Pattern:
^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"CreationTime": number,
"DurationInSeconds": number,
"ErrorDetails": {
"Message": "string",
"Type": "string"
},
"ExecutionRoleArn": "string",
"ExportErrorDetails": {
"ExportResults": {
"Message": "string",
"Type": "string"
},
"ExportSourceImages": {
"Message": "string",
"Type": "string"
}
},
"ExportStatus": "string",
"InputConfig": {
"DataSourceConfig": {
"S3Data": {
"KmsKeyId": "string",
"MetadataProvider": "string",
"S3Uri": "string"
}
},
"PreviousEarthObservationJobArn": "string",
"RasterDataCollectionQuery": {
"AreaOfInterest": {
"AreaOfInterestGeometry": {
"MultiPolygonGeometry": {
"Coordinates": [
[
[
[ number ]
]
]
]
},
"PolygonGeometry": {
"Coordinates": [
[
[ number ]
]
]
}
}
},
"PropertyFilters": {
"LogicalOperator": "string",
"Properties": [
{
"Property": {
"EoCloudCover": {
"LowerBound": number,
"UpperBound": number
},
"LandsatCloudCoverLand": {
"LowerBound": number,
"UpperBound": number
},
"Platform": {
"ComparisonOperator": "string",
"Value": "string"
},
"ViewOffNadir": {
"LowerBound": number,
"UpperBound": number
},
"ViewSunAzimuth": {
"LowerBound": number,
"UpperBound": number
},
"ViewSunElevation": {
"LowerBound": number,
"UpperBound": number
}
}
}
]
},
"RasterDataCollectionArn": "string",
"RasterDataCollectionName": "string",
"TimeRangeFilter": {
"EndTime": number,
"StartTime": number
}
}
},
"JobConfig": {
"BandMathConfig": {
"CustomIndices": {
"Operations": [
{
"Equation": "string",
"Name": "string",
"OutputType": "string"
}
]
},
"PredefinedIndices": [ "string" ]
},
"CloudMaskingConfig": {
},
"CloudRemovalConfig": {
"AlgorithmName": "string",
"InterpolationValue": "string",
"TargetBands": [ "string" ]
},
"GeoMosaicConfig": {
"AlgorithmName": "string",
"TargetBands": [ "string" ]
},
"LandCoverSegmentationConfig": {
},
"ResamplingConfig": {
"AlgorithmName": "string",
"OutputResolution": {
"UserDefined": {
"Unit": "string",
"Value": number
}
},
"TargetBands": [ "string" ]
},
"StackConfig": {
"OutputResolution": {
"Predefined": "string",
"UserDefined": {
"Unit": "string",
"Value": number
}
},
"TargetBands": [ "string" ]
},
"TemporalStatisticsConfig": {
"GroupBy": "string",
"Statistics": [ "string" ],
"TargetBands": [ "string" ]
},
"ZonalStatisticsConfig": {
"Statistics": [ "string" ],
"TargetBands": [ "string" ],
"ZoneS3Path": "string"
}
},
"KmsKeyId": "string",
"Name": "string",
"OutputBands": [
{
"BandName": "string",
"OutputDataType": "string"
}
],
"Status": "string",
"Tags": {
"string" : "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) of the Earth Observation job.
Type: String
- CreationTime
-
The creation time of the initiated Earth Observation job.
Type: Timestamp
- DurationInSeconds
-
The duration of Earth Observation job, in seconds.
Type: Integer
- ErrorDetails
-
Details about the errors generated during the Earth Observation job.
Type: EarthObservationJobErrorDetails object
- ExecutionRoleArn
-
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
Type: String
- ExportErrorDetails
-
Details about the errors generated during ExportEarthObservationJob.
Type: ExportErrorDetails object
- ExportStatus
-
The status of the Earth Observation job.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | FAILED - InputConfig
-
Input data for the Earth Observation job.
Type: InputConfigOutput object
- JobConfig
-
An object containing information about the job configuration.
Type: JobConfigInput object
- KmsKeyId
-
The Amazon Key Management Service (KMS) key ID for server-side encryption.
Type: String
- Name
-
The name of the Earth Observation job.
Type: String
- OutputBands
-
Bands available in the output of an operation.
Type: Array of OutputBand objects
- Status
-
The status of a previously initiated Earth Observation job.
Type: String
Valid Values:
INITIALIZING | IN_PROGRESS | STOPPING | COMPLETED | STOPPED | FAILED | DELETING | DELETED - Tags
-
Each tag consists of a key and a value.
Type: String to string map
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
