SageMakergeospatialcapabilities.Client.get_earth_observation_job(**kwargs)¶Get the details for a previously initiated Earth Observation job.
See also: AWS API Documentation
Request Syntax
response = client.get_earth_observation_job(
Arn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Earth Observation job.
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DurationInSeconds': 123,
'ErrorDetails': {
'Message': 'string',
'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
},
'ExecutionRoleArn': 'string',
'ExportErrorDetails': {
'ExportResults': {
'Message': 'string',
'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
},
'ExportSourceImages': {
'Message': 'string',
'Type': 'CLIENT_ERROR'|'SERVER_ERROR'
}
},
'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'InputConfig': {
'DataSourceConfig': {
'S3Data': {
'KmsKeyId': 'string',
'MetadataProvider': 'PLANET_ORDER',
'S3Uri': 'string'
}
},
'PreviousEarthObservationJobArn': 'string',
'RasterDataCollectionQuery': {
'AreaOfInterest': {
'AreaOfInterestGeometry': {
'MultiPolygonGeometry': {
'Coordinates': [
[
[
[
123.0,
],
],
],
]
},
'PolygonGeometry': {
'Coordinates': [
[
[
123.0,
],
],
]
}
}
},
'PropertyFilters': {
'LogicalOperator': 'AND',
'Properties': [
{
'Property': {
'EoCloudCover': {
'LowerBound': ...,
'UpperBound': ...
},
'LandsatCloudCoverLand': {
'LowerBound': ...,
'UpperBound': ...
},
'Platform': {
'ComparisonOperator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH',
'Value': 'string'
},
'ViewOffNadir': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunAzimuth': {
'LowerBound': ...,
'UpperBound': ...
},
'ViewSunElevation': {
'LowerBound': ...,
'UpperBound': ...
}
}
},
]
},
'RasterDataCollectionArn': 'string',
'RasterDataCollectionName': 'string',
'TimeRangeFilter': {
'EndTime': datetime(2015, 1, 1),
'StartTime': datetime(2015, 1, 1)
}
}
},
'JobConfig': {
'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': ...
}
},
'TargetBands': [
'string',
]
},
'StackConfig': {
'OutputResolution': {
'Predefined': 'HIGHEST'|'LOWEST'|'AVERAGE',
'UserDefined': {
'Unit': 'METERS',
'Value': ...
}
},
'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'
}
},
'KmsKeyId': 'string',
'Name': 'string',
'OutputBands': [
{
'BandName': 'string',
'OutputDataType': 'INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16'
},
],
'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
The Amazon Resource Name (ARN) of the Earth Observation job.
The creation time of the initiated Earth Observation job.
The duration of Earth Observation job, in seconds.
Details about the errors generated during the Earth Observation job.
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
Details about the errors generated during ExportEarthObservationJob.
The status of the Earth Observation job.
Input data for the Earth Observation job.
The location of the input data.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: S3Data. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The URL to the Amazon S3 input.
The Amazon Resource Name (ARN) of the previous Earth Observation job.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: AreaOfInterestGeometry. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: MultiPolygonGeometry, PolygonGeometry. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
The coordinates of the multipolygon geometry.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
The value of the platform.
The lower bound to view the sun elevation.
The upper bound to view the sun elevation.
The name of the raster data collection.
The end time for the time-range filter.
The start time for the time-range filter.
An object containing information about the job configuration.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: BandMathConfig, CloudMaskingConfig, CloudRemovalConfig, GeoMosaicConfig, LandCoverSegmentationConfig, ResamplingConfig, StackConfig, TemporalStatisticsConfig, ZonalStatisticsConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
The name of the operation.
The type of the operation.
An object containing information about the job configuration for cloud masking.
An object containing information about the job configuration for cloud removal.
The name of the algorithm used for cloud removal.
The interpolation value you provide for cloud removal.
An object containing information about the job configuration for geomosaic.
The name of the algorithm being used for geomosaic.
The target bands for geomosaic.
An object containing information about the job configuration for land cover segmentation.
An object containing information about the job configuration for resampling.
The name of the algorithm used for resampling.
An object containing information about the job configuration for temporal statistics.
An object containing information about the job configuration for zonal statistics.
The Amazon Key Management Service (KMS) key ID for server-side encryption.
The name of the Earth Observation job.
A single EarthObservationJob output band.
The name of the band.
The datatype of the output band.
The status of a previously initiated Earth Observation job.
Each tag consists of a key and a value.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException