AreaOfInterestGeometry areaOfInterestGeometry
A GeoJSON object representing the geographic extent in the coordinate space.
MultiPolygonGeometryInput multiPolygonGeometry
The structure representing the MultiPolygon Geometry.
PolygonGeometryInput polygonGeometry
The structure representing Polygon Geometry.
String href
Link to the asset object.
CustomIndicesInput customIndices
CustomIndices that are computed.
List<E> predefinedIndices
One or many of the supported predefined indices to compute. Allowed values: NDVI, EVI2,
MSAVI, NDWI, NDMI, NDSI, and WDRVI.
String resourceId
Identifier of the resource affected.
String arn
The Amazon Resource Name (ARN) of the Earth Observation job being deleted.
String arn
The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.
String arn
The input Amazon Resource Name (ARN) of the Earth Observation job being exported.
String clientToken
A unique token that guarantees that the call to this API is idempotent.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
Boolean exportSourceImages
The source images provided to the Earth Observation job being exported.
OutputConfigInput outputConfig
An object containing information about the output file.
String arn
The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
Date creationTime
The creation time.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
Boolean exportSourceImages
The source images provided to the Earth Observation job being exported.
String exportStatus
The status of the results of the Earth Observation job being exported.
OutputConfigInput outputConfig
An object containing information about the output file.
ExportErrorDetailsOutput exportResults
The structure for returning the export error details while exporting results of an Earth Observation job.
ExportErrorDetailsOutput exportSourceImages
The structure for returning the export error details while exporting the source images of an Earth Observation job.
VectorEnrichmentJobS3Data s3Data
The input structure for Amazon S3 data; representing the Amazon S3 location of the input data objects.
String arn
The Amazon Resource Name (ARN) of the Vector Enrichment job.
String clientToken
A unique token that guarantees that the call to this API is idempotent.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.
ExportVectorEnrichmentJobOutputConfig outputConfig
Output location information for exporting Vector Enrichment Job results.
String arn
The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
Date creationTime
The creation time.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.
String exportStatus
The status of the results the Vector Enrichment job being exported.
ExportVectorEnrichmentJobOutputConfig outputConfig
Output location information for exporting Vector Enrichment Job results.
String arn
The Amazon Resource Name (ARN) of the Earth Observation job.
String arn
The Amazon Resource Name (ARN) of the Earth Observation job.
Date creationTime
The creation time of the initiated Earth Observation job.
Integer durationInSeconds
The duration of Earth Observation job, in seconds.
EarthObservationJobErrorDetails errorDetails
Details about the errors generated during the Earth Observation job.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
ExportErrorDetails exportErrorDetails
Details about the errors generated during ExportEarthObservationJob.
String exportStatus
The status of the Earth Observation job.
InputConfigOutput inputConfig
Input data for the Earth Observation job.
JobConfigInput jobConfig
An object containing information about the job configuration.
String kmsKeyId
The Key Management Service key ID for server-side encryption.
String name
The name of the Earth Observation job.
List<E> outputBands
Bands available in the output of an operation.
String status
The status of a previously initiated Earth Observation job.
Map<K,V> tags
Each tag consists of a key and a value.
String arn
The Amazon Resource Name (ARN) of the raster data collection.
String arn
The Amazon Resource Name (ARN) of the raster data collection.
String description
A description of the raster data collection.
String descriptionPageUrl
The URL of the description page.
List<E> imageSourceBands
The list of image source bands in the raster data collection.
String name
The name of the raster data collection.
List<E> supportedFilters
The filters supported by the raster data collection.
Map<K,V> tags
Each tag consists of a key and a value.
String type
The raster data collection type.
String arn
The Amazon Resource Name (ARN) of the tile operation.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specify.
List<E> imageAssets
The particular assets or bands to tile.
Boolean imageMask
Determines whether or not to return a valid data mask.
String outputDataType
The output data type of the tile operation.
String outputFormat
The data format of the output tile. The formats include .npy, .png and .jpg.
String propertyFilters
Property filters for the imagery to tile.
String target
Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.
String timeRangeFilter
Time range filter applied to imagery to find the images to tile.
Integer x
The x coordinate of the tile input.
Integer y
The y coordinate of the tile input.
Integer z
The z coordinate of the tile input.
InputStream binaryFile
The output binary file.
String arn
The Amazon Resource Name (ARN) of the Vector Enrichment job.
String arn
The Amazon Resource Name (ARN) of the Vector Enrichment job.
Date creationTime
The creation time.
Integer durationInSeconds
The duration of the Vector Enrichment job, in seconds.
VectorEnrichmentJobErrorDetails errorDetails
Details about the errors generated during the Vector Enrichment job.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
VectorEnrichmentJobExportErrorDetails exportErrorDetails
Details about the errors generated during the ExportVectorEnrichmentJob.
String exportStatus
The export status of the Vector Enrichment job being initiated.
VectorEnrichmentJobInputConfig inputConfig
Input configuration information for the Vector Enrichment job.
VectorEnrichmentJobConfig jobConfig
An object containing information about the job configuration.
String kmsKeyId
The Key Management Service key ID for server-side encryption.
String name
The name of the Vector Enrichment job.
String status
The status of the initiated Vector Enrichment job.
Map<K,V> tags
Each tag consists of a key and a value.
String type
The type of the Vector Enrichment job being initiated.
String previousEarthObservationJobArn
The Amazon Resource Name (ARN) of the previous Earth Observation job.
RasterDataCollectionQueryInput rasterDataCollectionQuery
The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn,TimeRange and Property Filters.
String previousEarthObservationJobArn
The Amazon Resource Name (ARN) of the previous Earth Observation job.
RasterDataCollectionQueryOutput rasterDataCollectionQuery
The structure representing the RasterDataCollection Query consisting of the Area of Interest, RasterDataCollectionArn, RasterDataCollectionName, TimeRange, and Property Filters.
String resourceId
Map<K,V> assets
This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.
Date dateTime
The searchable date and time of the item, in UTC.
Geometry geometry
The item Geometry in GeoJson format.
String id
A unique Id for the source item.
Properties properties
This field contains additional properties of the item.
BandMathConfigInput bandMathConfig
An object containing information about the job configuration for BandMath.
CloudMaskingConfigInput cloudMaskingConfig
An object containing information about the job configuration for cloud masking.
CloudRemovalConfigInput cloudRemovalConfig
An object containing information about the job configuration for cloud removal.
GeoMosaicConfigInput geoMosaicConfig
An object containing information about the job configuration for geomosaic.
LandCoverSegmentationConfigInput landCoverSegmentationConfig
An object containing information about the job configuration for land cover segmentation.
ResamplingConfigInput resamplingConfig
An object containing information about the job configuration for resampling.
StackConfigInput stackConfig
An object containing information about the job configuration for a Stacking Earth Observation job.
TemporalStatisticsConfigInput temporalStatisticsConfig
An object containing information about the job configuration for temporal statistics.
ZonalStatisticsConfigInput zonalStatisticsConfig
An object containing information about the job configuration for zonal statistics.
Float lowerBound
The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.
Float upperBound
The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.
String arn
The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.
Date creationTime
The creation time.
Integer durationInSeconds
The duration of the session, in seconds.
String name
The names of the Earth Observation jobs in the list.
String operationType
The operation type for an Earth Observation job.
String status
The status of the list of the Earth Observation jobs.
Map<K,V> tags
Each tag consists of a key and a value.
Integer maxResults
The total number of items to return.
String nextToken
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
String sortBy
The parameter by which to sort the results.
String sortOrder
An optional value that specifies whether you want the results sorted in Ascending or
Descending order.
String statusEquals
A filter that retrieves only jobs with a specific status.
String resourceArn
The Amazon Resource Name (ARN) of the resource you want to tag.
String arn
The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.
Date creationTime
The creation time.
Integer durationInSeconds
The duration of the session, in seconds.
String name
The names of the Vector Enrichment jobs in the list.
String status
The status of the Vector Enrichment jobs list.
Map<K,V> tags
Each tag consists of a key and a value.
String type
The type of the list of Vector Enrichment jobs.
Integer maxResults
The maximum number of items to return.
String nextToken
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
String sortBy
The parameter by which to sort the results.
String sortOrder
An optional value that specifies whether you want the results sorted in Ascending or
Descending order.
String statusEquals
A filter that retrieves only jobs with a specific status.
String idAttributeName
The field name for the data that describes the identifier representing a collection of GPS points belonging to an individual trace.
String timestampAttributeName
The name of the timestamp attribute.
String xAttributeName
The name of the X-attribute
String yAttributeName
The name of the Y-attribute
ExportS3DataInput s3Data
Path to Amazon S3 storage location for the output configuration file.
UserDefined userDefined
User Defined Resolution for the output of Resampling operation defined by value and unit.
String predefined
A string value representing Predefined Output Resolution for a stacking operation. Allowed values are
HIGHEST, LOWEST, and AVERAGE.
UserDefined userDefined
The structure representing User Output Resolution for a Stacking operation defined as a value and unit.
List<E> coordinates
Coordinates representing a Polygon based on the GeoJson spec.
Float eoCloudCover
Estimate of cloud cover.
Float landsatCloudCoverLand
Land cloud cover for Landsat Data Collection.
String platform
Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
Float viewOffNadir
The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
Float viewSunAzimuth
The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
Float viewSunElevation
The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during nautical twilight.
EoCloudCoverInput eoCloudCover
The structure representing EoCloudCover property filter containing a lower bound and upper bound.
LandsatCloudCoverLandInput landsatCloudCoverLand
The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.
PlatformInput platform
The structure representing Platform property filter consisting of value and comparison operator.
ViewOffNadirInput viewOffNadir
The structure representing ViewOffNadir property filter containing a lower bound and upper bound.
ViewSunAzimuthInput viewSunAzimuth
The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.
ViewSunElevationInput viewSunElevation
The structure representing ViewSunElevation property filter containing a lower bound and upper bound.
Property property
Represents a single property to match with when searching a raster data collection.
String arn
The Amazon Resource Name (ARN) of the raster data collection.
String description
A description of the raster data collection.
String descriptionPageUrl
The description URL of the raster data collection.
String name
The name of the raster data collection.
List<E> supportedFilters
The list of filters supported by the raster data collection.
Map<K,V> tags
Each tag consists of a key and a value.
String type
The type of raster data collection.
AreaOfInterest areaOfInterest
The area of interest being queried for the raster data collection.
PropertyFilters propertyFilters
The list of Property filters used in the Raster Data Collection Query.
String rasterDataCollectionArn
The Amazon Resource Name (ARN) of the raster data collection.
TimeRangeFilterInput timeRangeFilter
The TimeRange Filter used in the RasterDataCollection Query.
AreaOfInterest areaOfInterest
The Area of Interest used in the search.
PropertyFilters propertyFilters
Property filters used in the search.
String rasterDataCollectionArn
The ARN of the Raster Data Collection against which the search is done.
String rasterDataCollectionName
The name of the raster data collection.
TimeRangeFilterOutput timeRangeFilter
The TimeRange filter used in the search.
AreaOfInterest areaOfInterest
The Area of interest to be used in the search query.
List<E> bandFilter
The list of Bands to be displayed in the result for each item.
PropertyFilters propertyFilters
The Property Filters used in the search query.
TimeRangeFilterInput timeRangeFilter
The TimeRange Filter used in the search query.
String algorithmName
The name of the algorithm used for resampling.
OutputResolutionResamplingInput outputResolution
The structure representing output resolution (in target georeferenced units) of the result of resampling operation.
List<E> targetBands
Bands used in the operation. If no target bands are specified, it uses all bands available in the input.
String resourceId
Identifier of the resource that was not found.
String arn
The Amazon Resource Name (ARN) of the raster data collection.
String nextToken
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
RasterDataCollectionQueryWithBandFilterInput rasterDataCollectionQuery
RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.
Integer approximateResultCount
Approximate number of results in the response.
List<E> items
List of items matching the Raster DataCollectionQuery.
String nextToken
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
String resourceId
Identifier of the resource affected.
OutputResolutionStackInput outputResolution
The structure representing output resolution (in target georeferenced units) of the result of stacking operation.
List<E> targetBands
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 clientToken
A unique token that guarantees that the call to this API is idempotent.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
InputConfigInput inputConfig
Input configuration information for the Earth Observation job.
JobConfigInput jobConfig
An object containing information about the job configuration.
String kmsKeyId
The Key Management Service key ID for server-side encryption.
String name
The name of the Earth Observation job.
Map<K,V> tags
Each tag consists of a key and a value.
String arn
The Amazon Resource Name (ARN) of the Earth Observation job.
Date creationTime
The creation time.
Integer durationInSeconds
The duration of the session, in seconds.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
InputConfigOutput inputConfig
Input configuration information for the Earth Observation job.
JobConfigInput jobConfig
An object containing information about the job configuration.
String kmsKeyId
The Key Management Service key ID for server-side encryption.
String name
The name of the Earth Observation job.
String status
The status of the Earth Observation job.
Map<K,V> tags
Each tag consists of a key and a value.
String clientToken
A unique token that guarantees that the call to this API is idempotent.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
VectorEnrichmentJobInputConfig inputConfig
Input configuration information for the Vector Enrichment job.
VectorEnrichmentJobConfig jobConfig
An object containing information about the job configuration.
String kmsKeyId
The Key Management Service key ID for server-side encryption.
String name
The name of the Vector Enrichment job.
Map<K,V> tags
Each tag consists of a key and a value.
String arn
The Amazon Resource Name (ARN) of the Vector Enrichment job.
Date creationTime
The creation time.
Integer durationInSeconds
The duration of the Vector Enrichment job, in seconds.
String executionRoleArn
The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
VectorEnrichmentJobInputConfig inputConfig
Input configuration information for starting the Vector Enrichment job.
VectorEnrichmentJobConfig jobConfig
An object containing information about the job configuration.
String kmsKeyId
The Key Management Service key ID for server-side encryption.
String name
The name of the Vector Enrichment job.
String status
The status of the Vector Enrichment job being started.
Map<K,V> tags
Each tag consists of a key and a value.
String type
The type of the Vector Enrichment job.
String arn
The Amazon Resource Name (ARN) of the Earth Observation job being stopped.
String arn
The Amazon Resource Name (ARN) of the Vector Enrichment job.
String resourceId
String resourceId
MapMatchingConfig mapMatchingConfig
The input structure for Map Matching operation type.
ReverseGeocodingConfig reverseGeocodingConfig
The input structure for Reverse Geocoding operation type.
VectorEnrichmentJobS3Data s3Data
The input structure for the Amazon S3 data that represents the Amazon S3 location of the input data objects.
VectorEnrichmentJobDataSourceConfigInput dataSourceConfig
The input structure for the data source that represents the storage type of the input data objects.
String documentType
The input structure that defines the data source file type.
Float lowerBound
The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.
Float upperBound
The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.
Float lowerBound
The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.
Float upperBound
The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.
List<E> statistics
List of zonal statistics to compute.
List<E> targetBands
Bands used in the operation. If no target bands are specified, it uses all bands available input.
String zoneS3Path
The Amazon S3 path pointing to the GeoJSON containing the polygonal zones.
String zoneS3PathKmsKeyId
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.
Copyright © 2023. All rights reserved.