Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon SageMaker geospatial capabilities can respond with.

Structs

AssetValue

The structure containing the asset properties.

BandMathConfigInput

Input structure for the BandMath operation type. Defines Predefined and CustomIndices to be computed using BandMath.

CloudMaskingConfigInput

Input structure for CloudMasking operation type.

CloudRemovalConfigInput

Input structure for Cloud Removal Operation type

CustomIndicesInput

Input object defining the custom BandMath indices to compute.

EarthObservationJobErrorDetails

The structure representing the errors in an EarthObservationJob.

EoCloudCoverInput

The structure representing the EoCloudCover filter.

ExportErrorDetails

The structure for returning the export error details in a GetEarthObservationJob.

ExportErrorDetailsOutput

The structure representing the errors in an export EarthObservationJob operation.

ExportS3DataInput

The structure containing the Amazon S3 path to export the Earth Observation job output.

ExportVectorEnrichmentJobOutputConfig

An object containing information about the output file.

Filter

The structure representing the filters supported by a RasterDataCollection.

GeoMosaicConfigInput

Input configuration information for the geomosaic.

Geometry

The structure representing a Geometry in terms of Type and Coordinates as per GeoJson spec.

InputConfigInput

Input configuration information.

InputConfigOutput

The InputConfig for an EarthObservationJob response.

ItemSource

The structure representing the items in the response for SearchRasterDataCollection.

LandCoverSegmentationConfigInput

The input structure for Land Cover Operation type.

LandsatCloudCoverLandInput

The structure representing Land Cloud Cover property for Landsat data collection.

ListEarthObservationJobOutputConfig

An object containing information about the output file.

ListVectorEnrichmentJobOutputConfig

An object containing information about the output file.

MapMatchingConfig

The input structure for Map Matching operation type.

MultiPolygonGeometryInput

The structure representing Polygon Geometry based on the GeoJson spec.

Operation

Represents an arithmetic operation to compute spectral index.

OutputBand

A single EarthObservationJob output band.

OutputConfigInput

The response structure for an OutputConfig returned by an ExportEarthObservationJob.

OutputResolutionResamplingInput

OutputResolution Configuration indicating the target resolution for the output of Resampling operation.

OutputResolutionStackInput

The input structure representing Output Resolution for Stacking Operation.

PlatformInput

The input structure for specifying Platform. 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.

PolygonGeometryInput

The structure representing Polygon Geometry based on the GeoJson spec.

Properties

Properties associated with the Item.

PropertyFilter

The structure representing a single PropertyFilter.

PropertyFilters

A list of PropertyFilter objects.

RasterDataCollectionMetadata

Response object containing details for a specific RasterDataCollection.

RasterDataCollectionQueryInput

The input structure for Raster Data Collection Query containing the Area of Interest, TimeRange Filters, and Property Filters.

RasterDataCollectionQueryOutput

The output structure contains the Raster Data Collection Query input along with some additional metadata.

RasterDataCollectionQueryWithBandFilterInput

This is a RasterDataCollectionQueryInput containing AreaOfInterest, Time Range filter and Property filters.

ResamplingConfigInput

The structure representing input for resampling operation.

ReverseGeocodingConfig

The input structure for Reverse Geocoding operation type.

StackConfigInput

The input structure for Stacking Operation.

TemporalStatisticsConfigInput

The structure representing the configuration for Temporal Statistics operation.

TimeRangeFilterInput

The input for the time-range filter.

TimeRangeFilterOutput

The output structure of the time range filter.

UserDefined

The output resolution (in target georeferenced units) of the result of the operation

VectorEnrichmentJobErrorDetails

VectorEnrichmentJob error details in response from GetVectorEnrichmentJob.

VectorEnrichmentJobExportErrorDetails

VectorEnrichmentJob export error details in response from GetVectorEnrichmentJob.

VectorEnrichmentJobInputConfig

The input structure for the InputConfig in a VectorEnrichmentJob.

VectorEnrichmentJobS3Data

The Amazon S3 data for the Vector Enrichment job.

ViewOffNadirInput

The input structure for specifying ViewOffNadir property filter. ViewOffNadir refers to the angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).

ViewSunAzimuthInput

The input structure for specifying ViewSunAzimuth property filter. ViewSunAzimuth refers to 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).

ViewSunElevationInput

The input structure for specifying ViewSunElevation angle property filter.

ZonalStatisticsConfigInput

The structure representing input configuration of ZonalStatistics operation.

Enums

AlgorithmNameCloudRemoval

When writing a match expression against AlgorithmNameCloudRemoval, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AlgorithmNameGeoMosaic

When writing a match expression against AlgorithmNameGeoMosaic, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AlgorithmNameResampling

When writing a match expression against AlgorithmNameResampling, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AreaOfInterest

The geographic extent of the Earth Observation job.

AreaOfInterestGeometry

A GeoJSON object representing the geographic extent in the coordinate space.

ComparisonOperator

When writing a match expression against ComparisonOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DataCollectionType

When writing a match expression against DataCollectionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EarthObservationJobErrorType

When writing a match expression against EarthObservationJobErrorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EarthObservationJobExportStatus

When writing a match expression against EarthObservationJobExportStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EarthObservationJobStatus

When writing a match expression against EarthObservationJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExportErrorType

When writing a match expression against ExportErrorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GroupBy

When writing a match expression against GroupBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

JobConfigInput

The input structure for the JobConfig in an EarthObservationJob.

LogicalOperator

When writing a match expression against LogicalOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OutputType

When writing a match expression against OutputType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PredefinedResolution

When writing a match expression against PredefinedResolution, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Property

Represents a single searchable property to search on.

SortOrder

When writing a match expression against SortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TargetOptions

When writing a match expression against TargetOptions, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TemporalStatistics

When writing a match expression against TemporalStatistics, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Unit

When writing a match expression against Unit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VectorEnrichmentJobConfig

It contains configs such as ReverseGeocodingConfig and MapMatchingConfig.

VectorEnrichmentJobDataSourceConfigInput

The input structure for the data source that represents the storage type of the input data objects.

VectorEnrichmentJobDocumentType

When writing a match expression against VectorEnrichmentJobDocumentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VectorEnrichmentJobErrorType

When writing a match expression against VectorEnrichmentJobErrorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VectorEnrichmentJobExportErrorType

When writing a match expression against VectorEnrichmentJobExportErrorType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VectorEnrichmentJobExportStatus

When writing a match expression against VectorEnrichmentJobExportStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VectorEnrichmentJobStatus

When writing a match expression against VectorEnrichmentJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VectorEnrichmentJobType

When writing a match expression against VectorEnrichmentJobType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ZonalStatistics

When writing a match expression against ZonalStatistics, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.