amazonka-sagemaker-geospatial-2.0: Amazon SageMaker geospatial capabilities SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMakerGeoSpatial.Lens

Contents

Description

 
Synopsis

Operations

DeleteEarthObservationJob

deleteEarthObservationJob_arn :: Lens' DeleteEarthObservationJob Text Source #

The Amazon Resource Name (ARN) of the Earth Observation job being deleted.

deleteEarthObservationJobResponse_httpStatus :: Lens' DeleteEarthObservationJobResponse Int Source #

The response's http status code.

DeleteVectorEnrichmentJob

deleteVectorEnrichmentJob_arn :: Lens' DeleteVectorEnrichmentJob Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.

deleteVectorEnrichmentJobResponse_httpStatus :: Lens' DeleteVectorEnrichmentJobResponse Int Source #

The response's http status code.

ExportEarthObservationJob

exportEarthObservationJob_exportSourceImages :: Lens' ExportEarthObservationJob (Maybe Bool) Source #

The source images provided to the Earth Observation job being exported.

exportEarthObservationJob_arn :: Lens' ExportEarthObservationJob Text Source #

The input Amazon Resource Name (ARN) of the Earth Observation job being exported.

exportEarthObservationJob_executionRoleArn :: Lens' ExportEarthObservationJob Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

exportEarthObservationJob_outputConfig :: Lens' ExportEarthObservationJob OutputConfigInput Source #

An object containing information about the output file.

exportEarthObservationJobResponse_exportSourceImages :: Lens' ExportEarthObservationJobResponse (Maybe Bool) Source #

The source images provided to the Earth Observation job being exported.

exportEarthObservationJobResponse_httpStatus :: Lens' ExportEarthObservationJobResponse Int Source #

The response's http status code.

exportEarthObservationJobResponse_arn :: Lens' ExportEarthObservationJobResponse Text Source #

The output Amazon Resource Name (ARN) of the Earth Observation job being exported.

exportEarthObservationJobResponse_creationTime :: Lens' ExportEarthObservationJobResponse UTCTime Source #

The creation time.

exportEarthObservationJobResponse_executionRoleArn :: Lens' ExportEarthObservationJobResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

exportEarthObservationJobResponse_exportStatus :: Lens' ExportEarthObservationJobResponse EarthObservationJobExportStatus Source #

The status of the results of the Earth Observation job being exported.

exportEarthObservationJobResponse_outputConfig :: Lens' ExportEarthObservationJobResponse OutputConfigInput Source #

An object containing information about the output file.

ExportVectorEnrichmentJob

exportVectorEnrichmentJob_arn :: Lens' ExportVectorEnrichmentJob Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job.

exportVectorEnrichmentJob_executionRoleArn :: Lens' ExportVectorEnrichmentJob Text Source #

The Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.

exportVectorEnrichmentJob_outputConfig :: Lens' ExportVectorEnrichmentJob ExportVectorEnrichmentJobOutputConfig Source #

Output location information for exporting Vector Enrichment Job results.

exportVectorEnrichmentJobResponse_httpStatus :: Lens' ExportVectorEnrichmentJobResponse Int Source #

The response's http status code.

exportVectorEnrichmentJobResponse_arn :: Lens' ExportVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.

exportVectorEnrichmentJobResponse_creationTime :: Lens' ExportVectorEnrichmentJobResponse UTCTime Source #

The creation time.

exportVectorEnrichmentJobResponse_executionRoleArn :: Lens' ExportVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.

exportVectorEnrichmentJobResponse_exportStatus :: Lens' ExportVectorEnrichmentJobResponse VectorEnrichmentJobExportStatus Source #

The status of the results the Vector Enrichment job being exported.

exportVectorEnrichmentJobResponse_outputConfig :: Lens' ExportVectorEnrichmentJobResponse ExportVectorEnrichmentJobOutputConfig Source #

Output location information for exporting Vector Enrichment Job results.

GetEarthObservationJob

getEarthObservationJob_arn :: Lens' GetEarthObservationJob Text Source #

The Amazon Resource Name (ARN) of the Earth Observation job.

getEarthObservationJobResponse_errorDetails :: Lens' GetEarthObservationJobResponse (Maybe EarthObservationJobErrorDetails) Source #

Details about the errors generated during the Earth Observation job.

getEarthObservationJobResponse_executionRoleArn :: Lens' GetEarthObservationJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

getEarthObservationJobResponse_exportErrorDetails :: Lens' GetEarthObservationJobResponse (Maybe ExportErrorDetails) Source #

Details about the errors generated during ExportEarthObservationJob.

getEarthObservationJobResponse_exportStatus :: Lens' GetEarthObservationJobResponse (Maybe EarthObservationJobExportStatus) Source #

The status of the Earth Observation job.

getEarthObservationJobResponse_kmsKeyId :: Lens' GetEarthObservationJobResponse (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

getEarthObservationJobResponse_outputBands :: Lens' GetEarthObservationJobResponse (Maybe [OutputBand]) Source #

getEarthObservationJobResponse_tags :: Lens' GetEarthObservationJobResponse (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

getEarthObservationJobResponse_httpStatus :: Lens' GetEarthObservationJobResponse Int Source #

The response's http status code.

getEarthObservationJobResponse_arn :: Lens' GetEarthObservationJobResponse Text Source #

The Amazon Resource Name (ARN) of the Earth Observation job.

getEarthObservationJobResponse_creationTime :: Lens' GetEarthObservationJobResponse UTCTime Source #

The creation time of the initiated Earth Observation job.

getEarthObservationJobResponse_durationInSeconds :: Lens' GetEarthObservationJobResponse Int Source #

The duration of Earth Observation job, in seconds.

getEarthObservationJobResponse_inputConfig :: Lens' GetEarthObservationJobResponse InputConfigOutput Source #

Input data for the Earth Observation job.

getEarthObservationJobResponse_jobConfig :: Lens' GetEarthObservationJobResponse JobConfigInput Source #

An object containing information about the job configuration.

getEarthObservationJobResponse_name :: Lens' GetEarthObservationJobResponse Text Source #

The name of the Earth Observation job.

getEarthObservationJobResponse_status :: Lens' GetEarthObservationJobResponse EarthObservationJobStatus Source #

The status of a previously initiated Earth Observation job.

GetRasterDataCollection

getRasterDataCollection_arn :: Lens' GetRasterDataCollection Text Source #

The Amazon Resource Name (ARN) of the raster data collection.

getRasterDataCollectionResponse_tags :: Lens' GetRasterDataCollectionResponse (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

getRasterDataCollectionResponse_httpStatus :: Lens' GetRasterDataCollectionResponse Int Source #

The response's http status code.

getRasterDataCollectionResponse_arn :: Lens' GetRasterDataCollectionResponse Text Source #

The Amazon Resource Name (ARN) of the raster data collection.

getRasterDataCollectionResponse_description :: Lens' GetRasterDataCollectionResponse Text Source #

A description of the raster data collection.

getRasterDataCollectionResponse_descriptionPageUrl :: Lens' GetRasterDataCollectionResponse Text Source #

The URL of the description page.

getRasterDataCollectionResponse_imageSourceBands :: Lens' GetRasterDataCollectionResponse [Text] Source #

getRasterDataCollectionResponse_name :: Lens' GetRasterDataCollectionResponse Text Source #

The name of the raster data collection.

getRasterDataCollectionResponse_supportedFilters :: Lens' GetRasterDataCollectionResponse [Filter] Source #

The filters supported by the raster data collection.

getRasterDataCollectionResponse_type :: Lens' GetRasterDataCollectionResponse DataCollectionType Source #

The raster data collection type.

GetTile

getTile_imageMask :: Lens' GetTile (Maybe Bool) Source #

Determines whether or not to return a valid data mask.

getTile_outputDataType :: Lens' GetTile (Maybe OutputType) Source #

The output data type of the tile operation.

getTile_outputFormat :: Lens' GetTile (Maybe Text) Source #

The data format of the output tile. The formats include .npy, .png and .jpg.

getTile_propertyFilters :: Lens' GetTile (Maybe Text) Source #

Property filters for the imagery to tile.

getTile_timeRangeFilter :: Lens' GetTile (Maybe Text) Source #

Time range filter applied to imagery to find the images to tile.

getTile_arn :: Lens' GetTile Text Source #

The Amazon Resource Name (ARN) of the tile operation.

getTile_imageAssets :: Lens' GetTile (NonEmpty Text) Source #

The particular assets or bands to tile.

getTile_target :: Lens' GetTile TargetOptions Source #

Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.

getTile_x :: Lens' GetTile Int Source #

The x coordinate of the tile input.

getTile_y :: Lens' GetTile Int Source #

The y coordinate of the tile input.

getTile_z :: Lens' GetTile Int Source #

The z coordinate of the tile input.

getTileResponse_httpStatus :: Lens' GetTileResponse Int Source #

The response's http status code.

getTileResponse_binaryFile :: Lens' GetTileResponse ResponseBody Source #

The output binary file.

GetVectorEnrichmentJob

getVectorEnrichmentJob_arn :: Lens' GetVectorEnrichmentJob Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job.

getVectorEnrichmentJobResponse_errorDetails :: Lens' GetVectorEnrichmentJobResponse (Maybe VectorEnrichmentJobErrorDetails) Source #

Details about the errors generated during the Vector Enrichment job.

getVectorEnrichmentJobResponse_exportErrorDetails :: Lens' GetVectorEnrichmentJobResponse (Maybe VectorEnrichmentJobExportErrorDetails) Source #

Details about the errors generated during the ExportVectorEnrichmentJob.

getVectorEnrichmentJobResponse_exportStatus :: Lens' GetVectorEnrichmentJobResponse (Maybe VectorEnrichmentJobExportStatus) Source #

The export status of the Vector Enrichment job being initiated.

getVectorEnrichmentJobResponse_kmsKeyId :: Lens' GetVectorEnrichmentJobResponse (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

getVectorEnrichmentJobResponse_tags :: Lens' GetVectorEnrichmentJobResponse (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

getVectorEnrichmentJobResponse_httpStatus :: Lens' GetVectorEnrichmentJobResponse Int Source #

The response's http status code.

getVectorEnrichmentJobResponse_arn :: Lens' GetVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job.

getVectorEnrichmentJobResponse_creationTime :: Lens' GetVectorEnrichmentJobResponse UTCTime Source #

The creation time.

getVectorEnrichmentJobResponse_durationInSeconds :: Lens' GetVectorEnrichmentJobResponse Int Source #

The duration of the Vector Enrichment job, in seconds.

getVectorEnrichmentJobResponse_executionRoleArn :: Lens' GetVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

getVectorEnrichmentJobResponse_inputConfig :: Lens' GetVectorEnrichmentJobResponse VectorEnrichmentJobInputConfig Source #

Input configuration information for the Vector Enrichment job.

getVectorEnrichmentJobResponse_jobConfig :: Lens' GetVectorEnrichmentJobResponse VectorEnrichmentJobConfig Source #

An object containing information about the job configuration.

getVectorEnrichmentJobResponse_name :: Lens' GetVectorEnrichmentJobResponse Text Source #

The name of the Vector Enrichment job.

getVectorEnrichmentJobResponse_status :: Lens' GetVectorEnrichmentJobResponse VectorEnrichmentJobStatus Source #

The status of the initiated Vector Enrichment job.

getVectorEnrichmentJobResponse_type :: Lens' GetVectorEnrichmentJobResponse VectorEnrichmentJobType Source #

The type of the Vector Enrichment job being initiated.

ListEarthObservationJobs

listEarthObservationJobs_maxResults :: Lens' ListEarthObservationJobs (Maybe Natural) Source #

The total number of items to return.

listEarthObservationJobs_nextToken :: Lens' ListEarthObservationJobs (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listEarthObservationJobs_sortBy :: Lens' ListEarthObservationJobs (Maybe Text) Source #

The parameter by which to sort the results.

listEarthObservationJobs_sortOrder :: Lens' ListEarthObservationJobs (Maybe SortOrder) Source #

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

listEarthObservationJobs_statusEquals :: Lens' ListEarthObservationJobs (Maybe EarthObservationJobStatus) Source #

A filter that retrieves only jobs with a specific status.

listEarthObservationJobsResponse_nextToken :: Lens' ListEarthObservationJobsResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listEarthObservationJobsResponse_httpStatus :: Lens' ListEarthObservationJobsResponse Int Source #

The response's http status code.

listEarthObservationJobsResponse_earthObservationJobSummaries :: Lens' ListEarthObservationJobsResponse [ListEarthObservationJobOutputConfig] Source #

Contains summary information about the Earth Observation jobs.

ListRasterDataCollections

listRasterDataCollections_maxResults :: Lens' ListRasterDataCollections (Maybe Natural) Source #

The total number of items to return.

listRasterDataCollections_nextToken :: Lens' ListRasterDataCollections (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listRasterDataCollectionsResponse_nextToken :: Lens' ListRasterDataCollectionsResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listRasterDataCollectionsResponse_httpStatus :: Lens' ListRasterDataCollectionsResponse Int Source #

The response's http status code.

listRasterDataCollectionsResponse_rasterDataCollectionSummaries :: Lens' ListRasterDataCollectionsResponse [RasterDataCollectionMetadata] Source #

Contains summary information about the raster data collection.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource you want to tag.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListVectorEnrichmentJobs

listVectorEnrichmentJobs_maxResults :: Lens' ListVectorEnrichmentJobs (Maybe Natural) Source #

The maximum number of items to return.

listVectorEnrichmentJobs_nextToken :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listVectorEnrichmentJobs_sortBy :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #

The parameter by which to sort the results.

listVectorEnrichmentJobs_sortOrder :: Lens' ListVectorEnrichmentJobs (Maybe SortOrder) Source #

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

listVectorEnrichmentJobs_statusEquals :: Lens' ListVectorEnrichmentJobs (Maybe Text) Source #

A filter that retrieves only jobs with a specific status.

listVectorEnrichmentJobsResponse_nextToken :: Lens' ListVectorEnrichmentJobsResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listVectorEnrichmentJobsResponse_httpStatus :: Lens' ListVectorEnrichmentJobsResponse Int Source #

The response's http status code.

listVectorEnrichmentJobsResponse_vectorEnrichmentJobSummaries :: Lens' ListVectorEnrichmentJobsResponse [ListVectorEnrichmentJobOutputConfig] Source #

Contains summary information about the Vector Enrichment jobs.

SearchRasterDataCollection

searchRasterDataCollection_nextToken :: Lens' SearchRasterDataCollection (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

searchRasterDataCollection_arn :: Lens' SearchRasterDataCollection Text Source #

The Amazon Resource Name (ARN) of the raster data collection.

searchRasterDataCollection_rasterDataCollectionQuery :: Lens' SearchRasterDataCollection RasterDataCollectionQueryWithBandFilterInput Source #

searchRasterDataCollectionResponse_items :: Lens' SearchRasterDataCollectionResponse (Maybe [ItemSource]) Source #

searchRasterDataCollectionResponse_nextToken :: Lens' SearchRasterDataCollectionResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

searchRasterDataCollectionResponse_httpStatus :: Lens' SearchRasterDataCollectionResponse Int Source #

The response's http status code.

searchRasterDataCollectionResponse_approximateResultCount :: Lens' SearchRasterDataCollectionResponse Int Source #

StartEarthObservationJob

startEarthObservationJob_clientToken :: Lens' StartEarthObservationJob (Maybe Text) Source #

A unique token that guarantees that the call to this API is idempotent.

startEarthObservationJob_executionRoleArn :: Lens' StartEarthObservationJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

startEarthObservationJob_kmsKeyId :: Lens' StartEarthObservationJob (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

startEarthObservationJob_tags :: Lens' StartEarthObservationJob (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

startEarthObservationJob_inputConfig :: Lens' StartEarthObservationJob InputConfigInput Source #

Input configuration information for the Earth Observation job.

startEarthObservationJob_jobConfig :: Lens' StartEarthObservationJob JobConfigInput Source #

An object containing information about the job configuration.

startEarthObservationJob_name :: Lens' StartEarthObservationJob Text Source #

The name of the Earth Observation job.

startEarthObservationJobResponse_executionRoleArn :: Lens' StartEarthObservationJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

startEarthObservationJobResponse_inputConfig :: Lens' StartEarthObservationJobResponse (Maybe InputConfigOutput) Source #

Input configuration information for the Earth Observation job.

startEarthObservationJobResponse_kmsKeyId :: Lens' StartEarthObservationJobResponse (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

startEarthObservationJobResponse_tags :: Lens' StartEarthObservationJobResponse (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

startEarthObservationJobResponse_httpStatus :: Lens' StartEarthObservationJobResponse Int Source #

The response's http status code.

startEarthObservationJobResponse_arn :: Lens' StartEarthObservationJobResponse Text Source #

The Amazon Resource Name (ARN) of the Earth Observation job.

startEarthObservationJobResponse_creationTime :: Lens' StartEarthObservationJobResponse UTCTime Source #

The creation time.

startEarthObservationJobResponse_durationInSeconds :: Lens' StartEarthObservationJobResponse Int Source #

The duration of the session, in seconds.

startEarthObservationJobResponse_jobConfig :: Lens' StartEarthObservationJobResponse JobConfigInput Source #

An object containing information about the job configuration.

startEarthObservationJobResponse_name :: Lens' StartEarthObservationJobResponse Text Source #

The name of the Earth Observation job.

startEarthObservationJobResponse_status :: Lens' StartEarthObservationJobResponse EarthObservationJobStatus Source #

The status of the Earth Observation job.

StartVectorEnrichmentJob

startVectorEnrichmentJob_clientToken :: Lens' StartVectorEnrichmentJob (Maybe Text) Source #

A unique token that guarantees that the call to this API is idempotent.

startVectorEnrichmentJob_kmsKeyId :: Lens' StartVectorEnrichmentJob (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

startVectorEnrichmentJob_tags :: Lens' StartVectorEnrichmentJob (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

startVectorEnrichmentJob_executionRoleArn :: Lens' StartVectorEnrichmentJob Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

startVectorEnrichmentJob_inputConfig :: Lens' StartVectorEnrichmentJob VectorEnrichmentJobInputConfig Source #

Input configuration information for the Vector Enrichment job.

startVectorEnrichmentJob_jobConfig :: Lens' StartVectorEnrichmentJob VectorEnrichmentJobConfig Source #

An object containing information about the job configuration.

startVectorEnrichmentJob_name :: Lens' StartVectorEnrichmentJob Text Source #

The name of the Vector Enrichment job.

startVectorEnrichmentJobResponse_kmsKeyId :: Lens' StartVectorEnrichmentJobResponse (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

startVectorEnrichmentJobResponse_tags :: Lens' StartVectorEnrichmentJobResponse (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

startVectorEnrichmentJobResponse_httpStatus :: Lens' StartVectorEnrichmentJobResponse Int Source #

The response's http status code.

startVectorEnrichmentJobResponse_arn :: Lens' StartVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job.

startVectorEnrichmentJobResponse_creationTime :: Lens' StartVectorEnrichmentJobResponse UTCTime Source #

The creation time.

startVectorEnrichmentJobResponse_durationInSeconds :: Lens' StartVectorEnrichmentJobResponse Int Source #

The duration of the Vector Enrichment job, in seconds.

startVectorEnrichmentJobResponse_executionRoleArn :: Lens' StartVectorEnrichmentJobResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

startVectorEnrichmentJobResponse_inputConfig :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobInputConfig Source #

Input configuration information for starting the Vector Enrichment job.

startVectorEnrichmentJobResponse_jobConfig :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobConfig Source #

An object containing information about the job configuration.

startVectorEnrichmentJobResponse_name :: Lens' StartVectorEnrichmentJobResponse Text Source #

The name of the Vector Enrichment job.

startVectorEnrichmentJobResponse_status :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobStatus Source #

The status of the Vector Enrichment job being started.

startVectorEnrichmentJobResponse_type :: Lens' StartVectorEnrichmentJobResponse VectorEnrichmentJobType Source #

The type of the Vector Enrichment job.

StopEarthObservationJob

stopEarthObservationJob_arn :: Lens' StopEarthObservationJob Text Source #

The Amazon Resource Name (ARN) of the Earth Observation job being stopped.

stopEarthObservationJobResponse_httpStatus :: Lens' StopEarthObservationJobResponse Int Source #

The response's http status code.

StopVectorEnrichmentJob

stopVectorEnrichmentJob_arn :: Lens' StopVectorEnrichmentJob Text Source #

The Amazon Resource Name (ARN) of the Vector Enrichment job.

stopVectorEnrichmentJobResponse_httpStatus :: Lens' StopVectorEnrichmentJobResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource you want to tag.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Each tag consists of a key and a value.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource you want to untag.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

Keys of the tags you want to remove.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

Types

AreaOfInterest

areaOfInterest_areaOfInterestGeometry :: Lens' AreaOfInterest (Maybe AreaOfInterestGeometry) Source #

AreaOfInterestGeometry

areaOfInterestGeometry_multiPolygonGeometry :: Lens' AreaOfInterestGeometry (Maybe MultiPolygonGeometryInput) Source #

areaOfInterestGeometry_polygonGeometry :: Lens' AreaOfInterestGeometry (Maybe PolygonGeometryInput) Source #

AssetValue

assetValue_href :: Lens' AssetValue (Maybe Text) Source #

BandMathConfigInput

bandMathConfigInput_customIndices :: Lens' BandMathConfigInput (Maybe CustomIndicesInput) Source #

bandMathConfigInput_predefinedIndices :: Lens' BandMathConfigInput (Maybe (NonEmpty Text)) Source #

CloudMaskingConfigInput

CloudRemovalConfigInput

cloudRemovalConfigInput_algorithmName :: Lens' CloudRemovalConfigInput (Maybe AlgorithmNameCloudRemoval) Source #

The name of the algorithm used for cloud removal.

cloudRemovalConfigInput_interpolationValue :: Lens' CloudRemovalConfigInput (Maybe Text) Source #

The interpolation value you provide for cloud removal.

cloudRemovalConfigInput_targetBands :: Lens' CloudRemovalConfigInput (Maybe (NonEmpty Text)) Source #

CustomIndicesInput

customIndicesInput_operations :: Lens' CustomIndicesInput (Maybe (NonEmpty Operation)) Source #

EarthObservationJobErrorDetails

earthObservationJobErrorDetails_message :: Lens' EarthObservationJobErrorDetails (Maybe Text) Source #

earthObservationJobErrorDetails_type :: Lens' EarthObservationJobErrorDetails (Maybe EarthObservationJobErrorType) Source #

EoCloudCoverInput

eoCloudCoverInput_lowerBound :: Lens' EoCloudCoverInput Double Source #

eoCloudCoverInput_upperBound :: Lens' EoCloudCoverInput Double Source #

EojDataSourceConfigInput

eojDataSourceConfigInput_s3Data :: Lens' EojDataSourceConfigInput (Maybe S3DataInput) Source #

ExportErrorDetails

exportErrorDetails_exportResults :: Lens' ExportErrorDetails (Maybe ExportErrorDetailsOutput) Source #

exportErrorDetails_exportSourceImages :: Lens' ExportErrorDetails (Maybe ExportErrorDetailsOutput) Source #

ExportErrorDetailsOutput

exportErrorDetailsOutput_message :: Lens' ExportErrorDetailsOutput (Maybe Text) Source #

exportErrorDetailsOutput_type :: Lens' ExportErrorDetailsOutput (Maybe ExportErrorType) Source #

ExportS3DataInput

exportS3DataInput_kmsKeyId :: Lens' ExportS3DataInput (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

exportS3DataInput_s3Uri :: Lens' ExportS3DataInput Text Source #

The URL to the Amazon S3 data input.

ExportVectorEnrichmentJobOutputConfig

exportVectorEnrichmentJobOutputConfig_s3Data :: Lens' ExportVectorEnrichmentJobOutputConfig VectorEnrichmentJobS3Data Source #

Filter

filter_maximum :: Lens' Filter (Maybe Double) Source #

The maximum value of the filter.

filter_minimum :: Lens' Filter (Maybe Double) Source #

The minimum value of the filter.

filter_name :: Lens' Filter Text Source #

The name of the filter.

filter_type :: Lens' Filter Text Source #

The type of the filter being used.

GeoMosaicConfigInput

geoMosaicConfigInput_algorithmName :: Lens' GeoMosaicConfigInput (Maybe AlgorithmNameGeoMosaic) Source #

The name of the algorithm being used for geomosaic.

geoMosaicConfigInput_targetBands :: Lens' GeoMosaicConfigInput (Maybe (NonEmpty Text)) Source #

The target bands for geomosaic.

Geometry

geometry_coordinates :: Lens' Geometry (NonEmpty (NonEmpty (NonEmpty Double))) Source #

geometry_type :: Lens' Geometry Text Source #

InputConfigInput

inputConfigInput_dataSourceConfig :: Lens' InputConfigInput (Maybe EojDataSourceConfigInput) Source #

The location of the input data.>

inputConfigInput_previousEarthObservationJobArn :: Lens' InputConfigInput (Maybe Text) Source #

The Amazon Resource Name (ARN) of the previous Earth Observation job.

inputConfigInput_rasterDataCollectionQuery :: Lens' InputConfigInput (Maybe RasterDataCollectionQueryInput) Source #

InputConfigOutput

inputConfigOutput_dataSourceConfig :: Lens' InputConfigOutput (Maybe EojDataSourceConfigInput) Source #

The location of the input data.

inputConfigOutput_previousEarthObservationJobArn :: Lens' InputConfigOutput (Maybe Text) Source #

The Amazon Resource Name (ARN) of the previous Earth Observation job.

inputConfigOutput_rasterDataCollectionQuery :: Lens' InputConfigOutput (Maybe RasterDataCollectionQueryOutput) Source #

ItemSource

itemSource_assets :: Lens' ItemSource (Maybe (HashMap Text AssetValue)) Source #

itemSource_properties :: Lens' ItemSource (Maybe Properties) Source #

itemSource_dateTime :: Lens' ItemSource UTCTime Source #

itemSource_geometry :: Lens' ItemSource Geometry Source #

itemSource_id :: Lens' ItemSource Text Source #

A unique Id for the source item.

JobConfigInput

jobConfigInput_bandMathConfig :: Lens' JobConfigInput (Maybe BandMathConfigInput) Source #

jobConfigInput_cloudMaskingConfig :: Lens' JobConfigInput (Maybe CloudMaskingConfigInput) Source #

An object containing information about the job configuration for cloud masking.

jobConfigInput_cloudRemovalConfig :: Lens' JobConfigInput (Maybe CloudRemovalConfigInput) Source #

An object containing information about the job configuration for cloud removal.

jobConfigInput_geoMosaicConfig :: Lens' JobConfigInput (Maybe GeoMosaicConfigInput) Source #

An object containing information about the job configuration for geomosaic.

jobConfigInput_landCoverSegmentationConfig :: Lens' JobConfigInput (Maybe LandCoverSegmentationConfigInput) Source #

An object containing information about the job configuration for land cover segmentation.

jobConfigInput_resamplingConfig :: Lens' JobConfigInput (Maybe ResamplingConfigInput) Source #

An object containing information about the job configuration for resampling.

jobConfigInput_stackConfig :: Lens' JobConfigInput (Maybe StackConfigInput) Source #

jobConfigInput_temporalStatisticsConfig :: Lens' JobConfigInput (Maybe TemporalStatisticsConfigInput) Source #

An object containing information about the job configuration for temporal statistics.

jobConfigInput_zonalStatisticsConfig :: Lens' JobConfigInput (Maybe ZonalStatisticsConfigInput) Source #

An object containing information about the job configuration for zonal statistics.

LandCoverSegmentationConfigInput

LandsatCloudCoverLandInput

landsatCloudCoverLandInput_lowerBound :: Lens' LandsatCloudCoverLandInput Double Source #

landsatCloudCoverLandInput_upperBound :: Lens' LandsatCloudCoverLandInput Double Source #

ListEarthObservationJobOutputConfig

listEarthObservationJobOutputConfig_tags :: Lens' ListEarthObservationJobOutputConfig (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

listEarthObservationJobOutputConfig_arn :: Lens' ListEarthObservationJobOutputConfig Text Source #

The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.

listEarthObservationJobOutputConfig_creationTime :: Lens' ListEarthObservationJobOutputConfig UTCTime Source #

The creation time.

listEarthObservationJobOutputConfig_durationInSeconds :: Lens' ListEarthObservationJobOutputConfig Int Source #

The duration of the session, in seconds.

listEarthObservationJobOutputConfig_name :: Lens' ListEarthObservationJobOutputConfig Text Source #

The names of the Earth Observation jobs in the list.

listEarthObservationJobOutputConfig_operationType :: Lens' ListEarthObservationJobOutputConfig Text Source #

listEarthObservationJobOutputConfig_status :: Lens' ListEarthObservationJobOutputConfig EarthObservationJobStatus Source #

The status of the list of the Earth Observation jobs.

ListVectorEnrichmentJobOutputConfig

listVectorEnrichmentJobOutputConfig_tags :: Lens' ListVectorEnrichmentJobOutputConfig (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

listVectorEnrichmentJobOutputConfig_arn :: Lens' ListVectorEnrichmentJobOutputConfig Text Source #

The Amazon Resource Name (ARN) of the list of the Vector Enrichment jobs.

listVectorEnrichmentJobOutputConfig_creationTime :: Lens' ListVectorEnrichmentJobOutputConfig UTCTime Source #

The creation time.

listVectorEnrichmentJobOutputConfig_durationInSeconds :: Lens' ListVectorEnrichmentJobOutputConfig Int Source #

The duration of the session, in seconds.

listVectorEnrichmentJobOutputConfig_name :: Lens' ListVectorEnrichmentJobOutputConfig Text Source #

The names of the Vector Enrichment jobs in the list.

listVectorEnrichmentJobOutputConfig_status :: Lens' ListVectorEnrichmentJobOutputConfig VectorEnrichmentJobStatus Source #

The status of the Vector Enrichment jobs list.

listVectorEnrichmentJobOutputConfig_type :: Lens' ListVectorEnrichmentJobOutputConfig VectorEnrichmentJobType Source #

The type of the list of Vector Enrichment jobs.

MapMatchingConfig

mapMatchingConfig_idAttributeName :: Lens' MapMatchingConfig Text Source #

mapMatchingConfig_timestampAttributeName :: Lens' MapMatchingConfig Text Source #

The name of the timestamp attribute.

mapMatchingConfig_xAttributeName :: Lens' MapMatchingConfig Text Source #

The name of the X-attribute

mapMatchingConfig_yAttributeName :: Lens' MapMatchingConfig Text Source #

The name of the Y-attribute

MultiPolygonGeometryInput

multiPolygonGeometryInput_coordinates :: Lens' MultiPolygonGeometryInput [NonEmpty (NonEmpty (NonEmpty Double))] Source #

The coordinates of the multipolygon geometry.

Operation

operation_outputType :: Lens' Operation (Maybe OutputType) Source #

The type of the operation.

operation_equation :: Lens' Operation Text Source #

operation_name :: Lens' Operation Text Source #

The name of the operation.

OutputBand

outputBand_bandName :: Lens' OutputBand Text Source #

The name of the band.

outputBand_outputDataType :: Lens' OutputBand OutputType Source #

The datatype of the output band.

OutputConfigInput

outputConfigInput_s3Data :: Lens' OutputConfigInput ExportS3DataInput Source #

Path to Amazon S3 storage location for the output configuration file.

OutputResolutionResamplingInput

outputResolutionResamplingInput_userDefined :: Lens' OutputResolutionResamplingInput UserDefined Source #

OutputResolutionStackInput

outputResolutionStackInput_predefined :: Lens' OutputResolutionStackInput (Maybe PredefinedResolution) Source #

outputResolutionStackInput_userDefined :: Lens' OutputResolutionStackInput (Maybe UserDefined) Source #

PlatformInput

platformInput_comparisonOperator :: Lens' PlatformInput (Maybe ComparisonOperator) Source #

platformInput_value :: Lens' PlatformInput Text Source #

The value of the platform.

PolygonGeometryInput

polygonGeometryInput_coordinates :: Lens' PolygonGeometryInput (NonEmpty (NonEmpty (NonEmpty Double))) Source #

Properties

properties_eoCloudCover :: Lens' Properties (Maybe Double) Source #

properties_landsatCloudCoverLand :: Lens' Properties (Maybe Double) Source #

properties_platform :: Lens' Properties (Maybe Text) Source #

properties_viewOffNadir :: Lens' Properties (Maybe Double) Source #

properties_viewSunAzimuth :: Lens' Properties (Maybe Double) Source #

properties_viewSunElevation :: Lens' Properties (Maybe Double) Source #

Property

property_eoCloudCover :: Lens' Property (Maybe EoCloudCoverInput) Source #

property_landsatCloudCoverLand :: Lens' Property (Maybe LandsatCloudCoverLandInput) Source #

property_platform :: Lens' Property (Maybe PlatformInput) Source #

property_viewOffNadir :: Lens' Property (Maybe ViewOffNadirInput) Source #

property_viewSunAzimuth :: Lens' Property (Maybe ViewSunAzimuthInput) Source #

property_viewSunElevation :: Lens' Property (Maybe ViewSunElevationInput) Source #

PropertyFilter

propertyFilter_property :: Lens' PropertyFilter Property Source #

PropertyFilters

propertyFilters_logicalOperator :: Lens' PropertyFilters (Maybe LogicalOperator) Source #

propertyFilters_properties :: Lens' PropertyFilters (Maybe [PropertyFilter]) Source #

RasterDataCollectionMetadata

rasterDataCollectionMetadata_descriptionPageUrl :: Lens' RasterDataCollectionMetadata (Maybe Text) Source #

The description URL of the raster data collection.

rasterDataCollectionMetadata_tags :: Lens' RasterDataCollectionMetadata (Maybe (HashMap Text Text)) Source #

Each tag consists of a key and a value.

rasterDataCollectionMetadata_arn :: Lens' RasterDataCollectionMetadata Text Source #

The Amazon Resource Name (ARN) of the raster data collection.

rasterDataCollectionMetadata_description :: Lens' RasterDataCollectionMetadata Text Source #

A description of the raster data collection.

rasterDataCollectionMetadata_name :: Lens' RasterDataCollectionMetadata Text Source #

The name of the raster data collection.

rasterDataCollectionMetadata_supportedFilters :: Lens' RasterDataCollectionMetadata [Filter] Source #

rasterDataCollectionMetadata_type :: Lens' RasterDataCollectionMetadata DataCollectionType Source #

The type of raster data collection.

RasterDataCollectionQueryInput

rasterDataCollectionQueryInput_areaOfInterest :: Lens' RasterDataCollectionQueryInput (Maybe AreaOfInterest) Source #

The area of interest being queried for the raster data collection.

rasterDataCollectionQueryInput_propertyFilters :: Lens' RasterDataCollectionQueryInput (Maybe PropertyFilters) Source #

rasterDataCollectionQueryInput_rasterDataCollectionArn :: Lens' RasterDataCollectionQueryInput Text Source #

The Amazon Resource Name (ARN) of the raster data collection.

rasterDataCollectionQueryInput_timeRangeFilter :: Lens' RasterDataCollectionQueryInput TimeRangeFilterInput Source #

RasterDataCollectionQueryOutput

rasterDataCollectionQueryOutput_areaOfInterest :: Lens' RasterDataCollectionQueryOutput (Maybe AreaOfInterest) Source #

rasterDataCollectionQueryOutput_propertyFilters :: Lens' RasterDataCollectionQueryOutput (Maybe PropertyFilters) Source #

rasterDataCollectionQueryOutput_rasterDataCollectionArn :: Lens' RasterDataCollectionQueryOutput Text Source #

rasterDataCollectionQueryOutput_rasterDataCollectionName :: Lens' RasterDataCollectionQueryOutput Text Source #

The name of the raster data collection.

rasterDataCollectionQueryOutput_timeRangeFilter :: Lens' RasterDataCollectionQueryOutput TimeRangeFilterInput Source #

RasterDataCollectionQueryWithBandFilterInput

rasterDataCollectionQueryWithBandFilterInput_areaOfInterest :: Lens' RasterDataCollectionQueryWithBandFilterInput (Maybe AreaOfInterest) Source #

rasterDataCollectionQueryWithBandFilterInput_bandFilter :: Lens' RasterDataCollectionQueryWithBandFilterInput (Maybe (NonEmpty Text)) Source #

rasterDataCollectionQueryWithBandFilterInput_propertyFilters :: Lens' RasterDataCollectionQueryWithBandFilterInput (Maybe PropertyFilters) Source #

rasterDataCollectionQueryWithBandFilterInput_timeRangeFilter :: Lens' RasterDataCollectionQueryWithBandFilterInput TimeRangeFilterInput Source #

ResamplingConfigInput

resamplingConfigInput_algorithmName :: Lens' ResamplingConfigInput (Maybe AlgorithmNameResampling) Source #

The name of the algorithm used for resampling.

resamplingConfigInput_targetBands :: Lens' ResamplingConfigInput (Maybe (NonEmpty Text)) Source #

resamplingConfigInput_outputResolution :: Lens' ResamplingConfigInput OutputResolutionResamplingInput Source #

ReverseGeocodingConfig

reverseGeocodingConfig_xAttributeName :: Lens' ReverseGeocodingConfig Text Source #

reverseGeocodingConfig_yAttributeName :: Lens' ReverseGeocodingConfig Text Source #

S3DataInput

s3DataInput_kmsKeyId :: Lens' S3DataInput (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

s3DataInput_metadataProvider :: Lens' S3DataInput MetadataProvider Source #

s3DataInput_s3Uri :: Lens' S3DataInput Text Source #

The URL to the Amazon S3 input.

StackConfigInput

stackConfigInput_outputResolution :: Lens' StackConfigInput (Maybe OutputResolutionStackInput) Source #

stackConfigInput_targetBands :: Lens' StackConfigInput (Maybe (NonEmpty Text)) Source #

TemporalStatisticsConfigInput

temporalStatisticsConfigInput_groupBy :: Lens' TemporalStatisticsConfigInput (Maybe GroupBy) Source #

temporalStatisticsConfigInput_targetBands :: Lens' TemporalStatisticsConfigInput (Maybe (NonEmpty Text)) Source #

temporalStatisticsConfigInput_statistics :: Lens' TemporalStatisticsConfigInput (NonEmpty TemporalStatistics) Source #

TimeRangeFilterInput

timeRangeFilterInput_endTime :: Lens' TimeRangeFilterInput UTCTime Source #

The end time for the time-range filter.

timeRangeFilterInput_startTime :: Lens' TimeRangeFilterInput UTCTime Source #

The start time for the time-range filter.

UserDefined

userDefined_unit :: Lens' UserDefined Unit Source #

userDefined_value :: Lens' UserDefined Double Source #

VectorEnrichmentJobConfig

vectorEnrichmentJobConfig_mapMatchingConfig :: Lens' VectorEnrichmentJobConfig (Maybe MapMatchingConfig) Source #

vectorEnrichmentJobConfig_reverseGeocodingConfig :: Lens' VectorEnrichmentJobConfig (Maybe ReverseGeocodingConfig) Source #

VectorEnrichmentJobDataSourceConfigInput

vectorEnrichmentJobDataSourceConfigInput_s3Data :: Lens' VectorEnrichmentJobDataSourceConfigInput (Maybe VectorEnrichmentJobS3Data) Source #

VectorEnrichmentJobErrorDetails

vectorEnrichmentJobErrorDetails_errorMessage :: Lens' VectorEnrichmentJobErrorDetails (Maybe Text) Source #

A message that you define and then is processed and rendered by the Vector Enrichment job when the error occurs.

vectorEnrichmentJobErrorDetails_errorType :: Lens' VectorEnrichmentJobErrorDetails (Maybe VectorEnrichmentJobErrorType) Source #

The type of error generated during the Vector Enrichment job.

VectorEnrichmentJobExportErrorDetails

vectorEnrichmentJobExportErrorDetails_message :: Lens' VectorEnrichmentJobExportErrorDetails (Maybe Text) Source #

The message providing details about the errors generated during the Vector Enrichment job.

vectorEnrichmentJobExportErrorDetails_type :: Lens' VectorEnrichmentJobExportErrorDetails (Maybe VectorEnrichmentJobExportErrorType) Source #

VectorEnrichmentJobInputConfig

vectorEnrichmentJobInputConfig_dataSourceConfig :: Lens' VectorEnrichmentJobInputConfig VectorEnrichmentJobDataSourceConfigInput Source #

vectorEnrichmentJobInputConfig_documentType :: Lens' VectorEnrichmentJobInputConfig VectorEnrichmentJobDocumentType Source #

VectorEnrichmentJobS3Data

vectorEnrichmentJobS3Data_kmsKeyId :: Lens' VectorEnrichmentJobS3Data (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

vectorEnrichmentJobS3Data_s3Uri :: Lens' VectorEnrichmentJobS3Data Text Source #

The URL to the Amazon S3 data for the Vector Enrichment job.

ViewOffNadirInput

viewOffNadirInput_lowerBound :: Lens' ViewOffNadirInput Double Source #

viewOffNadirInput_upperBound :: Lens' ViewOffNadirInput Double Source #

ViewSunAzimuthInput

viewSunAzimuthInput_lowerBound :: Lens' ViewSunAzimuthInput Double Source #

viewSunAzimuthInput_upperBound :: Lens' ViewSunAzimuthInput Double Source #

ViewSunElevationInput

viewSunElevationInput_lowerBound :: Lens' ViewSunElevationInput Double Source #

The lower bound to view the sun elevation.

viewSunElevationInput_upperBound :: Lens' ViewSunElevationInput Double Source #

The upper bound to view the sun elevation.

ZonalStatisticsConfigInput

zonalStatisticsConfigInput_targetBands :: Lens' ZonalStatisticsConfigInput (Maybe (NonEmpty Text)) Source #

zonalStatisticsConfigInput_statistics :: Lens' ZonalStatisticsConfigInput (NonEmpty ZonalStatistics) Source #

zonalStatisticsConfigInput_zoneS3Path :: Lens' ZonalStatisticsConfigInput Text Source #