SageMakergeospatialcapabilities.Client.start_earth_observation_job(**kwargs)¶Use this operation to create an Earth observation job.
See also: AWS API Documentation
Request Syntax
response = client.start_earth_observation_job(
ClientToken='string',
ExecutionRoleArn='string',
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',
'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',
Tags={
'string': 'string'
}
)
A unique token that guarantees that the call to this API is idempotent.
This field is autopopulated if not provided.
[REQUIRED]
Input configuration information 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 can be set: S3Data.
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.
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.
The coordinates of the multipolygon geometry.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.
The value of the platform.
The lower bound to view the sun elevation.
The upper bound to view the sun elevation.
The Amazon Resource Name (ARN) of the raster data collection.
The end time for the time-range filter.
The start time for the time-range filter.
[REQUIRED]
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.
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.
[REQUIRED]
The name of the Earth Observation job.
Each tag consists of a key and a value.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DurationInSeconds': 123,
'ExecutionRoleArn': 'string',
'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',
'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Earth Observation job.
CreationTime (datetime) --
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 (dict) --
Input configuration information for the Earth Observation job.
DataSourceConfig (dict) --
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'}
S3Data (dict) --
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 (dict) --
AreaOfInterest (dict) --
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'}
AreaOfInterestGeometry (dict) --
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'}
MultiPolygonGeometry (dict) --
Coordinates (list) --
The coordinates of the multipolygon geometry.
PolygonGeometry (dict) --
PropertyFilters (dict) --
LogicalOperator (string) --
Properties (list) --
(dict) --
Property (dict) --
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'}
EoCloudCover (dict) --
LandsatCloudCoverLand (dict) --
Platform (dict) --
ComparisonOperator (string) --
Value (string) --
The value of the platform.
ViewOffNadir (dict) --
ViewSunAzimuth (dict) --
ViewSunElevation (dict) --
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 (dict) --
EndTime (datetime) --
The end time for the time-range filter.
StartTime (datetime) --
The start time for the time-range filter.
JobConfig (dict) --
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'}
BandMathConfig (dict) --
CustomIndices (dict) --
Operations (list) --
(dict) --
Equation (string) --
Name (string) --
The name of the operation.
OutputType (string) --
The type of the operation.
PredefinedIndices (list) --
CloudMaskingConfig (dict) --
An object containing information about the job configuration for cloud masking.
CloudRemovalConfig (dict) --
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) --
GeoMosaicConfig (dict) --
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.
LandCoverSegmentationConfig (dict) --
An object containing information about the job configuration for land cover segmentation.
ResamplingConfig (dict) --
An object containing information about the job configuration for resampling.
AlgorithmName (string) --
The name of the algorithm used for resampling.
OutputResolution (dict) --
TargetBands (list) --
StackConfig (dict) --
TemporalStatisticsConfig (dict) --
An object containing information about the job configuration for temporal statistics.
ZonalStatisticsConfig (dict) --
An object containing information about the job configuration for zonal statistics.
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 (dict) --
Each tag consists of a key and a value.
Exceptions
SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededExceptionSageMakergeospatialcapabilities.Client.exceptions.AccessDeniedExceptionSageMakergeospatialcapabilities.Client.exceptions.ValidationExceptionSageMakergeospatialcapabilities.Client.exceptions.ThrottlingExceptionSageMakergeospatialcapabilities.Client.exceptions.InternalServerExceptionSageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundExceptionSageMakergeospatialcapabilities.Client.exceptions.ConflictException