2023/03/30 - Amazon SageMaker geospatial capabilities - 5 updated api methods
Changes Amazon SageMaker geospatial capabilities now supports server-side encryption with customer managed KMS key and SageMaker notebooks with a SageMaker geospatial image in a Amazon SageMaker Domain with VPC only mode.
{'ClientToken': 'string'}
Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
See also: AWS API Documentation
Request Syntax
client.export_earth_observation_job(
Arn='string',
ClientToken='string',
ExecutionRoleArn='string',
ExportSourceImages=True|False,
OutputConfig={
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
)
string
[REQUIRED]
The input Amazon Resource Name (ARN) of the Earth Observation job being exported.
string
A unique token that guarantees that the call to this API is idempotent.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
boolean
The source images provided to the Earth Observation job being exported.
dict
[REQUIRED]
An object containing information about the output file.
S3Data (dict) -- [REQUIRED]
Path to Amazon S3 storage location for the output configuration file.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
S3Uri (string) -- [REQUIRED]
The URL to the Amazon S3 data input.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExecutionRoleArn': 'string',
'ExportSourceImages': True|False,
'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'OutputConfig': {
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
}
Response Structure
(dict) --
Arn (string) --
The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
CreationTime (datetime) --
The creation time.
ExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
ExportSourceImages (boolean) --
The source images provided to the Earth Observation job being exported.
ExportStatus (string) --
The status of the results of the Earth Observation job being exported.
OutputConfig (dict) --
An object containing information about the output file.
S3Data (dict) --
Path to Amazon S3 storage location for the output configuration file.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
S3Uri (string) --
The URL to the Amazon S3 data input.
{'ClientToken': 'string'}
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
See also: AWS API Documentation
Request Syntax
client.export_vector_enrichment_job(
Arn='string',
ClientToken='string',
ExecutionRoleArn='string',
OutputConfig={
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Vector Enrichment job.
string
A unique token that guarantees that the call to this API is idempotent.
This field is autopopulated if not provided.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.
dict
[REQUIRED]
Output location information for exporting Vector Enrichment Job results.
S3Data (dict) -- [REQUIRED]
The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
S3Uri (string) -- [REQUIRED]
The URL to the Amazon S3 data for the Vector Enrichment job.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExecutionRoleArn': 'string',
'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'OutputConfig': {
'S3Data': {
'KmsKeyId': 'string',
'S3Uri': 'string'
}
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
CreationTime (datetime) --
The creation time.
ExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.
ExportStatus (string) --
The status of the results the Vector Enrichment job being exported.
OutputConfig (dict) --
Output location information for exporting Vector Enrichment Job results.
S3Data (dict) --
The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
S3Uri (string) --
The URL to the Amazon S3 data for the Vector Enrichment job.
{'JobConfig': {'ZonalStatisticsConfig': {'ZoneS3PathKmsKeyId': 'string'}}}
Get the details for a previously initiated Earth Observation job.
See also: AWS API Documentation
Request Syntax
client.get_earth_observation_job(
Arn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Earth Observation job.
dict
Response Syntax
{
'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',
'ZoneS3PathKmsKeyId': '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
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Earth Observation job.
CreationTime (datetime) --
The creation time of the initiated Earth Observation job.
DurationInSeconds (integer) --
The duration of Earth Observation job, in seconds.
ErrorDetails (dict) --
Details about the errors generated during the Earth Observation job.
Message (string) --
A detailed message describing the error in an Earth Observation job.
Type (string) --
The type of error in an Earth Observation job.
ExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
ExportErrorDetails (dict) --
Details about the errors generated during ExportEarthObservationJob.
ExportResults (dict) --
The structure for returning the export error details while exporting results of an Earth Observation job.
Message (string) --
A detailed message describing the error in an export EarthObservationJob operation.
Type (string) --
The type of error in an export EarthObservationJob operation.
ExportSourceImages (dict) --
The structure for returning the export error details while exporting the source images of an Earth Observation job.
Message (string) --
A detailed message describing the error in an export EarthObservationJob operation.
Type (string) --
The type of error in an export EarthObservationJob operation.
ExportStatus (string) --
The status of the Earth Observation job.
InputConfig (dict) --
Input data for the Earth Observation job.
DataSourceConfig (dict) --
The location of the input data.
S3Data (dict) --
The input structure for S3Data; representing the Amazon S3 location of the input data objects.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
MetadataProvider (string) --
Metadata provider from whom the Amazon S3 data has been acquired.
S3Uri (string) --
The URL to the Amazon S3 input.
PreviousEarthObservationJobArn (string) --
The Amazon Resource Name (ARN) of the previous Earth Observation job.
RasterDataCollectionQuery (dict) --
The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.
AreaOfInterest (dict) --
The Area of Interest used in the search.
AreaOfInterestGeometry (dict) --
A GeoJSON object representing the geographic extent in the coordinate space.
MultiPolygonGeometry (dict) --
The structure representing the MultiPolygon Geometry.
Coordinates (list) --
The coordinates of the multipolygon geometry.
(list) --
(list) --
(list) --
(float) --
PolygonGeometry (dict) --
The structure representing Polygon Geometry.
Coordinates (list) --
Coordinates representing a Polygon based on the GeoJson spec.
(list) --
(list) --
(float) --
PropertyFilters (dict) --
Property filters used in the search.
LogicalOperator (string) --
The Logical Operator used to combine the Property Filters.
Properties (list) --
A list of Property Filters.
(dict) --
The structure representing a single PropertyFilter.
Property (dict) --
Represents a single property to match with when searching a raster data collection.
EoCloudCover (dict) --
The structure representing EoCloudCover property filter containing a lower bound and upper bound.
LowerBound (float) --
Lower bound for EoCloudCover.
UpperBound (float) --
Upper bound for EoCloudCover.
LandsatCloudCoverLand (dict) --
The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.
LowerBound (float) --
The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.
UpperBound (float) --
The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.
Platform (dict) --
The structure representing Platform property filter consisting of value and comparison operator.
ComparisonOperator (string) --
The ComparisonOperator to use with PlatformInput.
Value (string) --
The value of the platform.
ViewOffNadir (dict) --
The structure representing ViewOffNadir property filter containing a lower bound and upper bound.
LowerBound (float) --
The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.
UpperBound (float) --
The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.
ViewSunAzimuth (dict) --
The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.
LowerBound (float) --
The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.
UpperBound (float) --
The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.
ViewSunElevation (dict) --
The structure representing ViewSunElevation property filter containing a lower bound and upper bound.
LowerBound (float) --
The lower bound to view the sun elevation.
UpperBound (float) --
The upper bound to view the sun elevation.
RasterDataCollectionArn (string) --
The ARN of the Raster Data Collection against which the search is done.
RasterDataCollectionName (string) --
The name of the raster data collection.
TimeRangeFilter (dict) --
The TimeRange filter used in the search.
EndTime (datetime) --
The ending time for the time range filter.
StartTime (datetime) --
The starting time for the time range filter.
JobConfig (dict) --
An object containing information about the job configuration.
BandMathConfig (dict) --
An object containing information about the job configuration for BandMath.
CustomIndices (dict) --
CustomIndices that are computed.
Operations (list) --
A list of BandMath indices to compute.
(dict) --
Represents an arithmetic operation to compute spectral index.
Equation (string) --
Textual representation of the math operation; Equation used to compute the spectral index.
Name (string) --
The name of the operation.
OutputType (string) --
The type of the operation.
PredefinedIndices (list) --
One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.
(string) --
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) --
TargetBands to be returned in the output of CloudRemoval operation.
(string) --
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.
(string) --
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) --
The structure representing output resolution (in target georeferenced units) of the result of resampling operation.
UserDefined (dict) --
User Defined Resolution for the output of Resampling operation defined by value and unit.
Unit (string) --
The units for output resolution of the result.
Value (float) --
The value for output resolution of the result.
TargetBands (list) --
Bands used in the operation. If no target bands are specified, it uses all bands available in the input.
(string) --
StackConfig (dict) --
An object containing information about the job configuration for a Stacking Earth Observation job.
OutputResolution (dict) --
The structure representing output resolution (in target georeferenced units) of the result of stacking operation.
Predefined (string) --
A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.
UserDefined (dict) --
The structure representing User Output Resolution for a Stacking operation defined as a value and unit.
Unit (string) --
The units for output resolution of the result.
Value (float) --
The value for output resolution of the result.
TargetBands (list) --
A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.
(string) --
TemporalStatisticsConfig (dict) --
An object containing information about the job configuration for temporal statistics.
GroupBy (string) --
The input for the temporal statistics grouping by time frequency option.
Statistics (list) --
The list of the statistics method options.
(string) --
TargetBands (list) --
The list of target band names for the temporal statistic to calculate.
(string) --
ZonalStatisticsConfig (dict) --
An object containing information about the job configuration for zonal statistics.
Statistics (list) --
List of zonal statistics to compute.
(string) --
TargetBands (list) --
Bands used in the operation. If no target bands are specified, it uses all bands available input.
(string) --
ZoneS3Path (string) --
The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
ZoneS3PathKmsKeyId (string) --
The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
Name (string) --
The name of the Earth Observation job.
OutputBands (list) --
Bands available in the output of an operation.
(dict) --
A single EarthObservationJob output band.
BandName (string) --
The name of the band.
OutputDataType (string) --
The datatype of the output band.
Status (string) --
The status of a previously initiated Earth Observation job.
Tags (dict) --
Each tag consists of a key and a value.
(string) --
(string) --
{'ExecutionRoleArn': 'string'}
Gets a web mercator tile for the given Earth Observation job.
See also: AWS API Documentation
Request Syntax
client.get_tile(
Arn='string',
ExecutionRoleArn='string',
ImageAssets=[
'string',
],
ImageMask=True|False,
OutputDataType='INT32'|'FLOAT32'|'INT16'|'FLOAT64'|'UINT16',
OutputFormat='string',
PropertyFilters='string',
Target='INPUT'|'OUTPUT',
TimeRangeFilter='string',
x=123,
y=123,
z=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the tile operation.
string
The Amazon Resource Name (ARN) of the IAM role that you specify.
list
[REQUIRED]
The particular assets or bands to tile.
(string) --
boolean
Determines whether or not to return a valid data mask.
string
The output data type of the tile operation.
string
The data format of the output tile. The formats include .npy, .png and .jpg.
string
Property filters for the imagery to tile.
string
[REQUIRED]
Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
string
Time range filter applied to imagery to find the images to tile.
integer
[REQUIRED]
The x coordinate of the tile input.
integer
[REQUIRED]
The y coordinate of the tile input.
integer
[REQUIRED]
The z coordinate of the tile input.
dict
Response Syntax
{
'BinaryFile': StreamingBody()
}
Response Structure
(dict) --
BinaryFile (:class:`.StreamingBody`) --
The output binary file.
{'JobConfig': {'ZonalStatisticsConfig': {'ZoneS3PathKmsKeyId': 'string'}}}
Use this operation to create an Earth observation job.
See also: AWS API Documentation
Request Syntax
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',
'ZoneS3PathKmsKeyId': 'string'
}
},
KmsKeyId='string',
Name='string',
Tags={
'string': 'string'
}
)
string
A unique token that guarantees that the call to this API is idempotent.
This field is autopopulated if not provided.
string
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
dict
[REQUIRED]
Input configuration information for the Earth Observation job.
DataSourceConfig (dict) --
The location of the input data.>
S3Data (dict) --
The input structure for S3Data; representing the Amazon S3 location of the input data objects.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
MetadataProvider (string) -- [REQUIRED]
Metadata provider from whom the Amazon S3 data has been acquired.
S3Uri (string) -- [REQUIRED]
The URL to the Amazon S3 input.
PreviousEarthObservationJobArn (string) --
The Amazon Resource Name (ARN) of the previous Earth Observation job.
RasterDataCollectionQuery (dict) --
The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters.
AreaOfInterest (dict) --
The area of interest being queried for the raster data collection.
AreaOfInterestGeometry (dict) --
A GeoJSON object representing the geographic extent in the coordinate space.
MultiPolygonGeometry (dict) --
The structure representing the MultiPolygon Geometry.
Coordinates (list) -- [REQUIRED]
The coordinates of the multipolygon geometry.
(list) --
(list) --
(list) --
(float) --
PolygonGeometry (dict) --
The structure representing Polygon Geometry.
Coordinates (list) -- [REQUIRED]
Coordinates representing a Polygon based on the GeoJson spec.
(list) --
(list) --
(float) --
PropertyFilters (dict) --
The list of Property filters used in the Raster Data Collection Query.
LogicalOperator (string) --
The Logical Operator used to combine the Property Filters.
Properties (list) --
A list of Property Filters.
(dict) --
The structure representing a single PropertyFilter.
Property (dict) -- [REQUIRED]
Represents a single property to match with when searching a raster data collection.
EoCloudCover (dict) --
The structure representing EoCloudCover property filter containing a lower bound and upper bound.
LowerBound (float) -- [REQUIRED]
Lower bound for EoCloudCover.
UpperBound (float) -- [REQUIRED]
Upper bound for EoCloudCover.
LandsatCloudCoverLand (dict) --
The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.
LowerBound (float) -- [REQUIRED]
The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.
UpperBound (float) -- [REQUIRED]
The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.
Platform (dict) --
The structure representing Platform property filter consisting of value and comparison operator.
ComparisonOperator (string) --
The ComparisonOperator to use with PlatformInput.
Value (string) -- [REQUIRED]
The value of the platform.
ViewOffNadir (dict) --
The structure representing ViewOffNadir property filter containing a lower bound and upper bound.
LowerBound (float) -- [REQUIRED]
The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.
UpperBound (float) -- [REQUIRED]
The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.
ViewSunAzimuth (dict) --
The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.
LowerBound (float) -- [REQUIRED]
The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.
UpperBound (float) -- [REQUIRED]
The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.
ViewSunElevation (dict) --
The structure representing ViewSunElevation property filter containing a lower bound and upper bound.
LowerBound (float) -- [REQUIRED]
The lower bound to view the sun elevation.
UpperBound (float) -- [REQUIRED]
The upper bound to view the sun elevation.
RasterDataCollectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the raster data collection.
TimeRangeFilter (dict) -- [REQUIRED]
The TimeRange Filter used in the RasterDataCollection Query.
EndTime (datetime) -- [REQUIRED]
The end time for the time-range filter.
StartTime (datetime) -- [REQUIRED]
The start time for the time-range filter.
dict
[REQUIRED]
An object containing information about the job configuration.
BandMathConfig (dict) --
An object containing information about the job configuration for BandMath.
CustomIndices (dict) --
CustomIndices that are computed.
Operations (list) --
A list of BandMath indices to compute.
(dict) --
Represents an arithmetic operation to compute spectral index.
Equation (string) -- [REQUIRED]
Textual representation of the math operation; Equation used to compute the spectral index.
Name (string) -- [REQUIRED]
The name of the operation.
OutputType (string) --
The type of the operation.
PredefinedIndices (list) --
One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.
(string) --
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) --
TargetBands to be returned in the output of CloudRemoval operation.
(string) --
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.
(string) --
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) -- [REQUIRED]
The structure representing output resolution (in target georeferenced units) of the result of resampling operation.
UserDefined (dict) -- [REQUIRED]
User Defined Resolution for the output of Resampling operation defined by value and unit.
Unit (string) -- [REQUIRED]
The units for output resolution of the result.
Value (float) -- [REQUIRED]
The value for output resolution of the result.
TargetBands (list) --
Bands used in the operation. If no target bands are specified, it uses all bands available in the input.
(string) --
StackConfig (dict) --
An object containing information about the job configuration for a Stacking Earth Observation job.
OutputResolution (dict) --
The structure representing output resolution (in target georeferenced units) of the result of stacking operation.
Predefined (string) --
A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.
UserDefined (dict) --
The structure representing User Output Resolution for a Stacking operation defined as a value and unit.
Unit (string) -- [REQUIRED]
The units for output resolution of the result.
Value (float) -- [REQUIRED]
The value for output resolution of the result.
TargetBands (list) --
A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.
(string) --
TemporalStatisticsConfig (dict) --
An object containing information about the job configuration for temporal statistics.
GroupBy (string) --
The input for the temporal statistics grouping by time frequency option.
Statistics (list) -- [REQUIRED]
The list of the statistics method options.
(string) --
TargetBands (list) --
The list of target band names for the temporal statistic to calculate.
(string) --
ZonalStatisticsConfig (dict) --
An object containing information about the job configuration for zonal statistics.
Statistics (list) -- [REQUIRED]
List of zonal statistics to compute.
(string) --
TargetBands (list) --
Bands used in the operation. If no target bands are specified, it uses all bands available input.
(string) --
ZoneS3Path (string) -- [REQUIRED]
The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
ZoneS3PathKmsKeyId (string) --
The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
string
The Key Management Service key ID for server-side encryption.
string
[REQUIRED]
The name of the Earth Observation job.
dict
Each tag consists of a key and a value.
(string) --
(string) --
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',
'ZoneS3PathKmsKeyId': '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.
S3Data (dict) --
The input structure for S3Data; representing the Amazon S3 location of the input data objects.
KmsKeyId (string) --
The Key Management Service key ID for server-side encryption.
MetadataProvider (string) --
Metadata provider from whom the Amazon S3 data has been acquired.
S3Uri (string) --
The URL to the Amazon S3 input.
PreviousEarthObservationJobArn (string) --
The Amazon Resource Name (ARN) of the previous Earth Observation job.
RasterDataCollectionQuery (dict) --
The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.
AreaOfInterest (dict) --
The Area of Interest used in the search.
AreaOfInterestGeometry (dict) --
A GeoJSON object representing the geographic extent in the coordinate space.
MultiPolygonGeometry (dict) --
The structure representing the MultiPolygon Geometry.
Coordinates (list) --
The coordinates of the multipolygon geometry.
(list) --
(list) --
(list) --
(float) --
PolygonGeometry (dict) --
The structure representing Polygon Geometry.
Coordinates (list) --
Coordinates representing a Polygon based on the GeoJson spec.
(list) --
(list) --
(float) --
PropertyFilters (dict) --
Property filters used in the search.
LogicalOperator (string) --
The Logical Operator used to combine the Property Filters.
Properties (list) --
A list of Property Filters.
(dict) --
The structure representing a single PropertyFilter.
Property (dict) --
Represents a single property to match with when searching a raster data collection.
EoCloudCover (dict) --
The structure representing EoCloudCover property filter containing a lower bound and upper bound.
LowerBound (float) --
Lower bound for EoCloudCover.
UpperBound (float) --
Upper bound for EoCloudCover.
LandsatCloudCoverLand (dict) --
The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.
LowerBound (float) --
The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.
UpperBound (float) --
The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.
Platform (dict) --
The structure representing Platform property filter consisting of value and comparison operator.
ComparisonOperator (string) --
The ComparisonOperator to use with PlatformInput.
Value (string) --
The value of the platform.
ViewOffNadir (dict) --
The structure representing ViewOffNadir property filter containing a lower bound and upper bound.
LowerBound (float) --
The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.
UpperBound (float) --
The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.
ViewSunAzimuth (dict) --
The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.
LowerBound (float) --
The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.
UpperBound (float) --
The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.
ViewSunElevation (dict) --
The structure representing ViewSunElevation property filter containing a lower bound and upper bound.
LowerBound (float) --
The lower bound to view the sun elevation.
UpperBound (float) --
The upper bound to view the sun elevation.
RasterDataCollectionArn (string) --
The ARN of the Raster Data Collection against which the search is done.
RasterDataCollectionName (string) --
The name of the raster data collection.
TimeRangeFilter (dict) --
The TimeRange filter used in the search.
EndTime (datetime) --
The ending time for the time range filter.
StartTime (datetime) --
The starting time for the time range filter.
JobConfig (dict) --
An object containing information about the job configuration.
BandMathConfig (dict) --
An object containing information about the job configuration for BandMath.
CustomIndices (dict) --
CustomIndices that are computed.
Operations (list) --
A list of BandMath indices to compute.
(dict) --
Represents an arithmetic operation to compute spectral index.
Equation (string) --
Textual representation of the math operation; Equation used to compute the spectral index.
Name (string) --
The name of the operation.
OutputType (string) --
The type of the operation.
PredefinedIndices (list) --
One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2, MSAVI, NDWI, NDMI, NDSI, and WDRVI.
(string) --
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) --
TargetBands to be returned in the output of CloudRemoval operation.
(string) --
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.
(string) --
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) --
The structure representing output resolution (in target georeferenced units) of the result of resampling operation.
UserDefined (dict) --
User Defined Resolution for the output of Resampling operation defined by value and unit.
Unit (string) --
The units for output resolution of the result.
Value (float) --
The value for output resolution of the result.
TargetBands (list) --
Bands used in the operation. If no target bands are specified, it uses all bands available in the input.
(string) --
StackConfig (dict) --
An object containing information about the job configuration for a Stacking Earth Observation job.
OutputResolution (dict) --
The structure representing output resolution (in target georeferenced units) of the result of stacking operation.
Predefined (string) --
A string value representing Predefined Output Resolution for a stacking operation. Allowed values are HIGHEST, LOWEST, and AVERAGE.
UserDefined (dict) --
The structure representing User Output Resolution for a Stacking operation defined as a value and unit.
Unit (string) --
The units for output resolution of the result.
Value (float) --
The value for output resolution of the result.
TargetBands (list) --
A list of bands to be stacked in the specified order. When the parameter is not provided, all the available bands in the data collection are stacked in the alphabetical order of their asset names.
(string) --
TemporalStatisticsConfig (dict) --
An object containing information about the job configuration for temporal statistics.
GroupBy (string) --
The input for the temporal statistics grouping by time frequency option.
Statistics (list) --
The list of the statistics method options.
(string) --
TargetBands (list) --
The list of target band names for the temporal statistic to calculate.
(string) --
ZonalStatisticsConfig (dict) --
An object containing information about the job configuration for zonal statistics.
Statistics (list) --
List of zonal statistics to compute.
(string) --
TargetBands (list) --
Bands used in the operation. If no target bands are specified, it uses all bands available input.
(string) --
ZoneS3Path (string) --
The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
ZoneS3PathKmsKeyId (string) --
The Amazon Resource Name (ARN) or an ID of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to decrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
KmsKeyId (string) --
The Key Management Service 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.
(string) --
(string) --