{ "version":"2.0", "metadata":{ "apiVersion":"2020-05-27", "endpointPrefix":"sagemaker-geospatial", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"Amazon SageMaker geospatial capabilities", "serviceId":"SageMaker Geospatial", "signatureVersion":"v4", "signingName":"sagemaker-geospatial", "uid":"sagemaker-geospatial-2020-05-27" }, "operations":{ "DeleteEarthObservationJob":{ "name":"DeleteEarthObservationJob", "http":{ "method":"DELETE", "requestUri":"/earth-observation-jobs/{Arn}", "responseCode":200 }, "input":{"shape":"DeleteEarthObservationJobInput"}, "output":{"shape":"DeleteEarthObservationJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Use this operation to delete an Earth Observation job.

", "idempotent":true }, "DeleteVectorEnrichmentJob":{ "name":"DeleteVectorEnrichmentJob", "http":{ "method":"DELETE", "requestUri":"/vector-enrichment-jobs/{Arn}", "responseCode":200 }, "input":{"shape":"DeleteVectorEnrichmentJobInput"}, "output":{"shape":"DeleteVectorEnrichmentJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Use this operation to delete a Vector Enrichment job.

", "idempotent":true }, "ExportEarthObservationJob":{ "name":"ExportEarthObservationJob", "http":{ "method":"POST", "requestUri":"/export-earth-observation-job", "responseCode":200 }, "input":{"shape":"ExportEarthObservationJobInput"}, "output":{"shape":"ExportEarthObservationJobOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an S3 location.

" }, "ExportVectorEnrichmentJob":{ "name":"ExportVectorEnrichmentJob", "http":{ "method":"POST", "requestUri":"/export-vector-enrichment-jobs", "responseCode":200 }, "input":{"shape":"ExportVectorEnrichmentJobInput"}, "output":{"shape":"ExportVectorEnrichmentJobOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Use this operation to copy results of a Vector Enrichment job to an S3 location.

" }, "GetEarthObservationJob":{ "name":"GetEarthObservationJob", "http":{ "method":"GET", "requestUri":"/earth-observation-jobs/{Arn}", "responseCode":200 }, "input":{"shape":"GetEarthObservationJobInput"}, "output":{"shape":"GetEarthObservationJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Get the details for a previously initiated Earth Observation job.

" }, "GetRasterDataCollection":{ "name":"GetRasterDataCollection", "http":{ "method":"GET", "requestUri":"/raster-data-collection/{Arn}", "responseCode":200 }, "input":{"shape":"GetRasterDataCollectionInput"}, "output":{"shape":"GetRasterDataCollectionOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Use this operation to get details of a specific raster data collection.

" }, "GetTile":{ "name":"GetTile", "http":{ "method":"GET", "requestUri":"/tile/{z}/{x}/{y}", "responseCode":200 }, "input":{"shape":"GetTileInput"}, "output":{"shape":"GetTileOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets a web mercator tile for the given Earth Observation job.

" }, "GetVectorEnrichmentJob":{ "name":"GetVectorEnrichmentJob", "http":{ "method":"GET", "requestUri":"/vector-enrichment-jobs/{Arn}", "responseCode":200 }, "input":{"shape":"GetVectorEnrichmentJobInput"}, "output":{"shape":"GetVectorEnrichmentJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).

" }, "ListEarthObservationJobs":{ "name":"ListEarthObservationJobs", "http":{ "method":"POST", "requestUri":"/list-earth-observation-jobs", "responseCode":200 }, "input":{"shape":"ListEarthObservationJobInput"}, "output":{"shape":"ListEarthObservationJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.

" }, "ListRasterDataCollections":{ "name":"ListRasterDataCollections", "http":{ "method":"GET", "requestUri":"/raster-data-collections", "responseCode":200 }, "input":{"shape":"ListRasterDataCollectionsInput"}, "output":{"shape":"ListRasterDataCollectionsOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Use this operation to get raster data collections.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists the tags attached to the resource.

" }, "ListVectorEnrichmentJobs":{ "name":"ListVectorEnrichmentJobs", "http":{ "method":"POST", "requestUri":"/list-vector-enrichment-jobs", "responseCode":200 }, "input":{"shape":"ListVectorEnrichmentJobInput"}, "output":{"shape":"ListVectorEnrichmentJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves a list of vector enrichment jobs.

" }, "SearchRasterDataCollection":{ "name":"SearchRasterDataCollection", "http":{ "method":"POST", "requestUri":"/search-raster-data-collection", "responseCode":200 }, "input":{"shape":"SearchRasterDataCollectionInput"}, "output":{"shape":"SearchRasterDataCollectionOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.

" }, "StartEarthObservationJob":{ "name":"StartEarthObservationJob", "http":{ "method":"POST", "requestUri":"/earth-observation-jobs", "responseCode":200 }, "input":{"shape":"StartEarthObservationJobInput"}, "output":{"shape":"StartEarthObservationJobOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Use this operation to create an Earth observation job.

", "idempotent":true }, "StartVectorEnrichmentJob":{ "name":"StartVectorEnrichmentJob", "http":{ "method":"POST", "requestUri":"/vector-enrichment-jobs", "responseCode":200 }, "input":{"shape":"StartVectorEnrichmentJobInput"}, "output":{"shape":"StartVectorEnrichmentJobOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.

", "idempotent":true }, "StopEarthObservationJob":{ "name":"StopEarthObservationJob", "http":{ "method":"POST", "requestUri":"/earth-observation-jobs/stop", "responseCode":200 }, "input":{"shape":"StopEarthObservationJobInput"}, "output":{"shape":"StopEarthObservationJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Use this operation to stop an existing earth observation job.

" }, "StopVectorEnrichmentJob":{ "name":"StopVectorEnrichmentJob", "http":{ "method":"POST", "requestUri":"/vector-enrichment-jobs/stop", "responseCode":200 }, "input":{"shape":"StopVectorEnrichmentJobInput"}, "output":{"shape":"StopVectorEnrichmentJobOutput"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Stops the Vector Enrichment job for a given job ARN.

", "idempotent":true }, "TagResource":{ "name":"TagResource", "http":{ "method":"PUT", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

The resource you want to tag.

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

The resource you want to untag.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

You do not have sufficient access to perform this action.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AlgorithmNameCloudRemoval":{ "type":"string", "enum":["INTERPOLATION"] }, "AlgorithmNameGeoMosaic":{ "type":"string", "enum":[ "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM" ] }, "AlgorithmNameResampling":{ "type":"string", "enum":[ "NEAR", "BILINEAR", "CUBIC", "CUBICSPLINE", "LANCZOS", "AVERAGE", "RMS", "MODE", "MAX", "MIN", "MED", "Q1", "Q3", "SUM" ] }, "AreaOfInterest":{ "type":"structure", "members":{ "AreaOfInterestGeometry":{ "shape":"AreaOfInterestGeometry", "documentation":"

" } }, "documentation":"

", "union":true }, "AreaOfInterestGeometry":{ "type":"structure", "members":{ "MultiPolygonGeometry":{ "shape":"MultiPolygonGeometryInput", "documentation":"

" }, "PolygonGeometry":{ "shape":"PolygonGeometryInput", "documentation":"

" } }, "documentation":"

", "union":true }, "Arn":{ "type":"string", "max":2048, "min":1 }, "AssetValue":{ "type":"structure", "members":{ "Href":{ "shape":"String", "documentation":"

" } }, "documentation":"

" }, "AssetsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"AssetValue"} }, "BandMathConfigInput":{ "type":"structure", "members":{ "CustomIndices":{ "shape":"CustomIndicesInput", "documentation":"

" }, "PredefinedIndices":{ "shape":"StringListInput", "documentation":"

" } }, "documentation":"

" }, "BinaryFile":{ "type":"blob", "streaming":true }, "Boolean":{ "type":"boolean", "box":true }, "CloudMaskingConfigInput":{ "type":"structure", "members":{ }, "documentation":"

" }, "CloudRemovalConfigInput":{ "type":"structure", "members":{ "AlgorithmName":{ "shape":"AlgorithmNameCloudRemoval", "documentation":"

The name of the algorithm used for cloud removal.

" }, "InterpolationValue":{ "shape":"String", "documentation":"

The interpolation value you provide for cloud removal.

" }, "TargetBands":{ "shape":"StringListInput", "documentation":"

" } }, "documentation":"

" }, "ComparisonOperator":{ "type":"string", "enum":[ "EQUALS", "NOT_EQUALS", "STARTS_WITH" ] }, "ConflictException":{ "type":"structure", "required":[ "Message", "ResourceId" ], "members":{ "Message":{"shape":"String"}, "ResourceId":{ "shape":"String", "documentation":"

" } }, "documentation":"

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CustomIndicesInput":{ "type":"structure", "members":{ "Operations":{ "shape":"OperationsListInput", "documentation":"

" } }, "documentation":"

" }, "DataCollectionArn":{ "type":"string", "pattern":"^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:raster-data-collection/(public|premium|user)/[a-z0-9]{12,}$" }, "DataCollectionType":{ "type":"string", "enum":[ "PUBLIC", "PREMIUM", "USER" ] }, "DataCollectionsList":{ "type":"list", "member":{"shape":"RasterDataCollectionMetadata"} }, "DeleteEarthObservationJobInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"EarthObservationJobArn", "documentation":"

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

", "location":"uri", "locationName":"Arn" } } }, "DeleteEarthObservationJobOutput":{ "type":"structure", "members":{ } }, "DeleteVectorEnrichmentJobInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"VectorEnrichmentJobArn", "documentation":"

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

", "location":"uri", "locationName":"Arn" } } }, "DeleteVectorEnrichmentJobOutput":{ "type":"structure", "members":{ } }, "Double":{ "type":"double", "box":true }, "EarthObservationJobArn":{ "type":"string", "pattern":"^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:earth-observation-job/[a-z0-9]{12,}$" }, "EarthObservationJobErrorDetails":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

" }, "Type":{ "shape":"EarthObservationJobErrorType", "documentation":"

" } }, "documentation":"

The structure representing the errors in an EarthObservationJob.

" }, "EarthObservationJobErrorType":{ "type":"string", "enum":[ "CLIENT_ERROR", "SERVER_ERROR" ] }, "EarthObservationJobExportStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "SUCCEEDED", "FAILED" ] }, "EarthObservationJobList":{ "type":"list", "member":{"shape":"ListEarthObservationJobOutputConfig"} }, "EarthObservationJobOutputBands":{ "type":"list", "member":{"shape":"OutputBand"} }, "EarthObservationJobStatus":{ "type":"string", "enum":[ "INITIALIZING", "IN_PROGRESS", "STOPPING", "COMPLETED", "STOPPED", "FAILED", "DELETING", "DELETED" ] }, "EoCloudCoverInput":{ "type":"structure", "required":[ "LowerBound", "UpperBound" ], "members":{ "LowerBound":{ "shape":"Float", "documentation":"

" }, "UpperBound":{ "shape":"Float", "documentation":"

" } }, "documentation":"

" }, "EojDataSourceConfigInput":{ "type":"structure", "members":{ "S3Data":{ "shape":"S3DataInput", "documentation":"

" } }, "documentation":"

", "union":true }, "ExportEarthObservationJobInput":{ "type":"structure", "required":[ "Arn", "ExecutionRoleArn", "OutputConfig" ], "members":{ "Arn":{ "shape":"EarthObservationJobArn", "documentation":"

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

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "ExportSourceImages":{ "shape":"Boolean", "documentation":"

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

" }, "OutputConfig":{ "shape":"OutputConfigInput", "documentation":"

An object containing information about the output file.

" } } }, "ExportEarthObservationJobOutput":{ "type":"structure", "required":[ "Arn", "CreationTime", "ExecutionRoleArn", "ExportStatus", "OutputConfig" ], "members":{ "Arn":{ "shape":"EarthObservationJobArn", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time.

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "ExportSourceImages":{ "shape":"Boolean", "documentation":"

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

" }, "ExportStatus":{ "shape":"EarthObservationJobExportStatus", "documentation":"

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

" }, "OutputConfig":{ "shape":"OutputConfigInput", "documentation":"

An object containing information about the output file.

" } } }, "ExportErrorDetails":{ "type":"structure", "members":{ "ExportResults":{ "shape":"ExportErrorDetailsOutput", "documentation":"

" }, "ExportSourceImages":{ "shape":"ExportErrorDetailsOutput", "documentation":"

" } }, "documentation":"

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

" }, "ExportErrorDetailsOutput":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

" }, "Type":{ "shape":"ExportErrorType", "documentation":"

" } }, "documentation":"

" }, "ExportErrorType":{ "type":"string", "enum":[ "CLIENT_ERROR", "SERVER_ERROR" ] }, "ExportS3DataInput":{ "type":"structure", "required":["S3Uri"], "members":{ "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "S3Uri":{ "shape":"String", "documentation":"

The URL to the Amazon S3 data input.

" } }, "documentation":"

" }, "ExportVectorEnrichmentJobInput":{ "type":"structure", "required":[ "Arn", "ExecutionRoleArn", "OutputConfig" ], "members":{ "Arn":{ "shape":"VectorEnrichmentJobArn", "documentation":"

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

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "OutputConfig":{ "shape":"ExportVectorEnrichmentJobOutputConfig", "documentation":"

Output location information for exporting Vector Enrichment Job results.

" } } }, "ExportVectorEnrichmentJobOutput":{ "type":"structure", "required":[ "Arn", "CreationTime", "ExecutionRoleArn", "ExportStatus", "OutputConfig" ], "members":{ "Arn":{ "shape":"VectorEnrichmentJobArn", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time.

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "ExportStatus":{ "shape":"VectorEnrichmentJobExportStatus", "documentation":"

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

" }, "OutputConfig":{ "shape":"ExportVectorEnrichmentJobOutputConfig", "documentation":"

Output location information for exporting Vector Enrichment Job results.

" } } }, "ExportVectorEnrichmentJobOutputConfig":{ "type":"structure", "required":["S3Data"], "members":{ "S3Data":{ "shape":"VectorEnrichmentJobS3Data", "documentation":"

" } }, "documentation":"

An object containing information about the output file.

" }, "Filter":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "Maximum":{ "shape":"Float", "documentation":"

The maximum value of the filter.

" }, "Minimum":{ "shape":"Float", "documentation":"

The minimum value of the filter.

" }, "Name":{ "shape":"String", "documentation":"

The name of the filter.

" }, "Type":{ "shape":"String", "documentation":"

The type of the filter being used.

" } }, "documentation":"

The structure representing the filters supported by a RasterDataCollection.

" }, "FilterList":{ "type":"list", "member":{"shape":"Filter"} }, "Float":{ "type":"float", "box":true }, "GeoMosaicConfigInput":{ "type":"structure", "members":{ "AlgorithmName":{ "shape":"AlgorithmNameGeoMosaic", "documentation":"

The name of the algorithm being used for geomosaic.

" }, "TargetBands":{ "shape":"StringListInput", "documentation":"

The target bands for geomosaic.

" } }, "documentation":"

Input configuration information for the geomosaic.

" }, "Geometry":{ "type":"structure", "required":[ "Coordinates", "Type" ], "members":{ "Coordinates":{ "shape":"LinearRings", "documentation":"

" }, "Type":{ "shape":"String", "documentation":"

" } }, "documentation":"

" }, "GetEarthObservationJobInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"EarthObservationJobArn", "documentation":"

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

", "location":"uri", "locationName":"Arn" } } }, "GetEarthObservationJobOutput":{ "type":"structure", "required":[ "Arn", "CreationTime", "DurationInSeconds", "InputConfig", "JobConfig", "Name", "Status" ], "members":{ "Arn":{ "shape":"String", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time of the initiated Earth Observation job.

" }, "DurationInSeconds":{ "shape":"Integer", "documentation":"

The duration of Earth Observation job, in seconds.

" }, "ErrorDetails":{ "shape":"EarthObservationJobErrorDetails", "documentation":"

Details about the errors generated during the Earth Observation job.

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "ExportErrorDetails":{ "shape":"ExportErrorDetails", "documentation":"

Details about the errors generated during ExportEarthObservationJob.

" }, "ExportStatus":{ "shape":"EarthObservationJobExportStatus", "documentation":"

The status of the Earth Observation job.

" }, "InputConfig":{ "shape":"InputConfigOutput", "documentation":"

Input data for the Earth Observation job.

" }, "JobConfig":{ "shape":"JobConfigInput", "documentation":"

An object containing information about the job configuration.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "Name":{ "shape":"String", "documentation":"

The name of the Earth Observation job.

" }, "OutputBands":{ "shape":"EarthObservationJobOutputBands", "documentation":"

" }, "Status":{ "shape":"EarthObservationJobStatus", "documentation":"

The status of a previously initiated Earth Observation job.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" } } }, "GetRasterDataCollectionInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"DataCollectionArn", "documentation":"

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

", "location":"uri", "locationName":"Arn" } } }, "GetRasterDataCollectionOutput":{ "type":"structure", "required":[ "Arn", "Description", "DescriptionPageUrl", "ImageSourceBands", "Name", "SupportedFilters", "Type" ], "members":{ "Arn":{ "shape":"DataCollectionArn", "documentation":"

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

" }, "Description":{ "shape":"String", "documentation":"

A description of the raster data collection.

" }, "DescriptionPageUrl":{ "shape":"String", "documentation":"

The URL of the description page.

" }, "ImageSourceBands":{ "shape":"ImageSourceBandList", "documentation":"

" }, "Name":{ "shape":"String", "documentation":"

The name of the raster data collection.

" }, "SupportedFilters":{ "shape":"FilterList", "documentation":"

The filters supported by the raster data collection.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" }, "Type":{ "shape":"DataCollectionType", "documentation":"

The raster data collection type.

" } } }, "GetTileInput":{ "type":"structure", "required":[ "Arn", "ImageAssets", "Target", "x", "y", "z" ], "members":{ "Arn":{ "shape":"EarthObservationJobArn", "documentation":"

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

", "location":"querystring", "locationName":"Arn" }, "ImageAssets":{ "shape":"StringListInput", "documentation":"

The particular assets or bands to tile.

", "location":"querystring", "locationName":"ImageAssets" }, "ImageMask":{ "shape":"Boolean", "documentation":"

Determines whether or not to return a valid data mask.

", "location":"querystring", "locationName":"ImageMask" }, "OutputDataType":{ "shape":"OutputType", "documentation":"

The output data type of the tile operation.

", "location":"querystring", "locationName":"OutputDataType" }, "OutputFormat":{ "shape":"String", "documentation":"

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

", "location":"querystring", "locationName":"OutputFormat" }, "PropertyFilters":{ "shape":"String", "documentation":"

Property filters for the imagery to tile.

", "location":"querystring", "locationName":"PropertyFilters" }, "Target":{ "shape":"TargetOptions", "documentation":"

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

", "location":"querystring", "locationName":"Target" }, "TimeRangeFilter":{ "shape":"String", "documentation":"

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

", "location":"querystring", "locationName":"TimeRangeFilter" }, "x":{ "shape":"Integer", "documentation":"

The x coordinate of the tile input.

", "location":"uri", "locationName":"x" }, "y":{ "shape":"Integer", "documentation":"

The y coordinate of the tile input.

", "location":"uri", "locationName":"y" }, "z":{ "shape":"Integer", "documentation":"

The z coordinate of the tile input.

", "location":"uri", "locationName":"z" } } }, "GetTileOutput":{ "type":"structure", "members":{ "BinaryFile":{ "shape":"BinaryFile", "documentation":"

The output binary file.

" } }, "payload":"BinaryFile" }, "GetVectorEnrichmentJobInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"VectorEnrichmentJobArn", "documentation":"

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

", "location":"uri", "locationName":"Arn" } } }, "GetVectorEnrichmentJobOutput":{ "type":"structure", "required":[ "Arn", "CreationTime", "DurationInSeconds", "ExecutionRoleArn", "InputConfig", "JobConfig", "Name", "Status", "Type" ], "members":{ "Arn":{ "shape":"String", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time.

" }, "DurationInSeconds":{ "shape":"Integer", "documentation":"

The duration of the Vector Enrichment job, in seconds.

" }, "ErrorDetails":{ "shape":"VectorEnrichmentJobErrorDetails", "documentation":"

Details about the errors generated during the Vector Enrichment job.

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "ExportErrorDetails":{ "shape":"VectorEnrichmentJobExportErrorDetails", "documentation":"

Details about the errors generated during the ExportVectorEnrichmentJob.

" }, "ExportStatus":{ "shape":"VectorEnrichmentJobExportStatus", "documentation":"

The export status of the Vector Enrichment job being initiated.

" }, "InputConfig":{ "shape":"VectorEnrichmentJobInputConfig", "documentation":"

Input configuration information for the Vector Enrichment job.

" }, "JobConfig":{ "shape":"VectorEnrichmentJobConfig", "documentation":"

An object containing information about the job configuration.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "Name":{ "shape":"String", "documentation":"

The name of the Vector Enrichment job.

" }, "Status":{ "shape":"VectorEnrichmentJobStatus", "documentation":"

The status of the initiated Vector Enrichment job.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" }, "Type":{ "shape":"VectorEnrichmentJobType", "documentation":"

The type of the Vector Enrichment job being initiated.

" } } }, "GroupBy":{ "type":"string", "enum":[ "ALL", "YEARLY" ] }, "ImageSourceBandList":{ "type":"list", "member":{"shape":"String"} }, "InputConfigInput":{ "type":"structure", "members":{ "DataSourceConfig":{ "shape":"EojDataSourceConfigInput", "documentation":"

The location of the input data.>

" }, "PreviousEarthObservationJobArn":{ "shape":"String", "documentation":"

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

" }, "RasterDataCollectionQuery":{ "shape":"RasterDataCollectionQueryInput", "documentation":"

" } }, "documentation":"

Input configuration information.

" }, "InputConfigOutput":{ "type":"structure", "members":{ "DataSourceConfig":{ "shape":"EojDataSourceConfigInput", "documentation":"

The location of the input data.

" }, "PreviousEarthObservationJobArn":{ "shape":"String", "documentation":"

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

" }, "RasterDataCollectionQuery":{ "shape":"RasterDataCollectionQueryOutput", "documentation":"

" } }, "documentation":"

The InputConfig for an EarthObservationJob response.

" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "required":[ "Message", "ResourceId" ], "members":{ "Message":{"shape":"String"}, "ResourceId":{ "shape":"String", "documentation":"

" } }, "documentation":"

The request processing has failed because of an unknown error, exception, or failure.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "ItemSource":{ "type":"structure", "required":[ "DateTime", "Geometry", "Id" ], "members":{ "Assets":{ "shape":"AssetsMap", "documentation":"

" }, "DateTime":{ "shape":"Timestamp", "documentation":"

" }, "Geometry":{ "shape":"Geometry", "documentation":"

" }, "Id":{ "shape":"String", "documentation":"

A unique Id for the source item.

" }, "Properties":{ "shape":"Properties", "documentation":"

" } }, "documentation":"

Structure representing the items in the response for SearchRasterDataCollection.

" }, "ItemSourceList":{ "type":"list", "member":{"shape":"ItemSource"} }, "JobConfigInput":{ "type":"structure", "members":{ "BandMathConfig":{ "shape":"BandMathConfigInput", "documentation":"

" }, "CloudMaskingConfig":{ "shape":"CloudMaskingConfigInput", "documentation":"

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

" }, "CloudRemovalConfig":{ "shape":"CloudRemovalConfigInput", "documentation":"

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

" }, "GeoMosaicConfig":{ "shape":"GeoMosaicConfigInput", "documentation":"

An object containing information about the job configuration for geomosaic.

" }, "LandCoverSegmentationConfig":{ "shape":"LandCoverSegmentationConfigInput", "documentation":"

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

" }, "ResamplingConfig":{ "shape":"ResamplingConfigInput", "documentation":"

An object containing information about the job configuration for resampling.

" }, "StackConfig":{ "shape":"StackConfigInput", "documentation":"

" }, "TemporalStatisticsConfig":{ "shape":"TemporalStatisticsConfigInput", "documentation":"

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

" }, "ZonalStatisticsConfig":{ "shape":"ZonalStatisticsConfigInput", "documentation":"

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

" } }, "documentation":"

The input structure for the JobConfig in an EarthObservationJob.

", "union":true }, "LandCoverSegmentationConfigInput":{ "type":"structure", "members":{ }, "documentation":"

" }, "LandsatCloudCoverLandInput":{ "type":"structure", "required":[ "LowerBound", "UpperBound" ], "members":{ "LowerBound":{ "shape":"Float", "documentation":"

" }, "UpperBound":{ "shape":"Float", "documentation":"

" } }, "documentation":"

" }, "LinearRing":{ "type":"list", "member":{"shape":"Position"}, "min":4 }, "LinearRings":{ "type":"list", "member":{"shape":"LinearRing"}, "min":1 }, "LinearRingsList":{ "type":"list", "member":{"shape":"LinearRings"} }, "ListEarthObservationJobInput":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListEarthObservationJobInputMaxResultsInteger", "documentation":"

The total number of items to return.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "SortBy":{ "shape":"String", "documentation":"

The parameter by which to sort the results.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

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

" }, "StatusEquals":{ "shape":"EarthObservationJobStatus", "documentation":"

A filter that retrieves only jobs with a specific status.

" } } }, "ListEarthObservationJobInputMaxResultsInteger":{ "type":"integer", "box":true, "max":20, "min":1 }, "ListEarthObservationJobOutput":{ "type":"structure", "required":["EarthObservationJobSummaries"], "members":{ "EarthObservationJobSummaries":{ "shape":"EarthObservationJobList", "documentation":"

Contains summary information about the Earth Observation jobs.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ListEarthObservationJobOutputConfig":{ "type":"structure", "required":[ "Arn", "CreationTime", "DurationInSeconds", "Name", "OperationType", "Status" ], "members":{ "Arn":{ "shape":"String", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time.

" }, "DurationInSeconds":{ "shape":"Integer", "documentation":"

The duration of the session, in seconds.

" }, "Name":{ "shape":"String", "documentation":"

The names of the Earth Observation jobs in the list.

" }, "OperationType":{ "shape":"String", "documentation":"

" }, "Status":{ "shape":"EarthObservationJobStatus", "documentation":"

The status of the list of the Earth Observation jobs.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" } }, "documentation":"

An object containing information about the output file.

" }, "ListRasterDataCollectionsInput":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListRasterDataCollectionsInputMaxResultsInteger", "documentation":"

The total number of items to return.

", "location":"querystring", "locationName":"MaxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

", "location":"querystring", "locationName":"NextToken" } } }, "ListRasterDataCollectionsInputMaxResultsInteger":{ "type":"integer", "box":true, "max":20, "min":1 }, "ListRasterDataCollectionsOutput":{ "type":"structure", "required":["RasterDataCollectionSummaries"], "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "RasterDataCollectionSummaries":{ "shape":"DataCollectionsList", "documentation":"

Contains summary information about the raster data collection.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

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

", "location":"uri", "locationName":"ResourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" } } }, "ListVectorEnrichmentJobInput":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListVectorEnrichmentJobInputMaxResultsInteger", "documentation":"

The maximum number of items to return.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "SortBy":{ "shape":"String", "documentation":"

The parameter by which to sort the results.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

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

" }, "StatusEquals":{ "shape":"String", "documentation":"

A filter that retrieves only jobs with a specific status.

" } } }, "ListVectorEnrichmentJobInputMaxResultsInteger":{ "type":"integer", "box":true, "max":20, "min":1 }, "ListVectorEnrichmentJobOutput":{ "type":"structure", "required":["VectorEnrichmentJobSummaries"], "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "VectorEnrichmentJobSummaries":{ "shape":"VectorEnrichmentJobList", "documentation":"

Contains summary information about the Vector Enrichment jobs.

" } } }, "ListVectorEnrichmentJobOutputConfig":{ "type":"structure", "required":[ "Arn", "CreationTime", "DurationInSeconds", "Name", "Status", "Type" ], "members":{ "Arn":{ "shape":"VectorEnrichmentJobArn", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time.

" }, "DurationInSeconds":{ "shape":"Integer", "documentation":"

The duration of the session, in seconds.

" }, "Name":{ "shape":"String", "documentation":"

The names of the Vector Enrichment jobs in the list.

" }, "Status":{ "shape":"VectorEnrichmentJobStatus", "documentation":"

The status of the Vector Enrichment jobs list.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" }, "Type":{ "shape":"VectorEnrichmentJobType", "documentation":"

The type of the list of Vector Enrichment jobs.

" } }, "documentation":"

An object containing information about the output file.

" }, "LogicalOperator":{ "type":"string", "enum":["AND"] }, "MapMatchingConfig":{ "type":"structure", "required":[ "IdAttributeName", "TimestampAttributeName", "XAttributeName", "YAttributeName" ], "members":{ "IdAttributeName":{ "shape":"String", "documentation":"

" }, "TimestampAttributeName":{ "shape":"String", "documentation":"

The name of the timestamp attribute.

" }, "XAttributeName":{ "shape":"String", "documentation":"

The name of the X-attribute

" }, "YAttributeName":{ "shape":"String", "documentation":"

The name of the Y-attribute

" } }, "documentation":"

" }, "MetadataProvider":{ "type":"string", "enum":["PLANET_ORDER"] }, "MultiPolygonGeometryInput":{ "type":"structure", "required":["Coordinates"], "members":{ "Coordinates":{ "shape":"LinearRingsList", "documentation":"

The coordinates of the multipolygon geometry.

" } }, "documentation":"

" }, "NextToken":{ "type":"string", "max":8192, "min":0, "sensitive":true }, "Operation":{ "type":"structure", "required":[ "Equation", "Name" ], "members":{ "Equation":{ "shape":"String", "documentation":"

" }, "Name":{ "shape":"String", "documentation":"

The name of the operation.

" }, "OutputType":{ "shape":"OutputType", "documentation":"

The type of the operation.

" } }, "documentation":"

" }, "OperationsListInput":{ "type":"list", "member":{"shape":"Operation"}, "min":1 }, "OutputBand":{ "type":"structure", "required":[ "BandName", "OutputDataType" ], "members":{ "BandName":{ "shape":"String", "documentation":"

The name of the band.

" }, "OutputDataType":{ "shape":"OutputType", "documentation":"

The datatype of the output band.

" } }, "documentation":"

A single EarthObservationJob output band.

" }, "OutputConfigInput":{ "type":"structure", "required":["S3Data"], "members":{ "S3Data":{ "shape":"ExportS3DataInput", "documentation":"

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

" } }, "documentation":"

The response structure for an OutputConfig returned by an ExportEarthObservationJob.

" }, "OutputResolutionResamplingInput":{ "type":"structure", "required":["UserDefined"], "members":{ "UserDefined":{ "shape":"UserDefined", "documentation":"

" } }, "documentation":"

" }, "OutputResolutionStackInput":{ "type":"structure", "members":{ "Predefined":{ "shape":"PredefinedResolution", "documentation":"

" }, "UserDefined":{ "shape":"UserDefined", "documentation":"

" } }, "documentation":"

" }, "OutputType":{ "type":"string", "enum":[ "INT32", "FLOAT32", "INT16", "FLOAT64", "UINT16" ] }, "PlatformInput":{ "type":"structure", "required":["Value"], "members":{ "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

" }, "Value":{ "shape":"String", "documentation":"

The value of the platform.

" } }, "documentation":"

" }, "PolygonGeometryInput":{ "type":"structure", "required":["Coordinates"], "members":{ "Coordinates":{ "shape":"LinearRings", "documentation":"

" } }, "documentation":"

" }, "Position":{ "type":"list", "member":{"shape":"Double"}, "max":2, "min":2, "sensitive":true }, "PredefinedResolution":{ "type":"string", "enum":[ "HIGHEST", "LOWEST", "AVERAGE" ] }, "Properties":{ "type":"structure", "members":{ "EoCloudCover":{ "shape":"Float", "documentation":"

" }, "LandsatCloudCoverLand":{ "shape":"Float", "documentation":"

" }, "Platform":{ "shape":"String", "documentation":"

" }, "ViewOffNadir":{ "shape":"Float", "documentation":"

" }, "ViewSunAzimuth":{ "shape":"Float", "documentation":"

" }, "ViewSunElevation":{ "shape":"Float", "documentation":"

" } }, "documentation":"

" }, "Property":{ "type":"structure", "members":{ "EoCloudCover":{ "shape":"EoCloudCoverInput", "documentation":"

" }, "LandsatCloudCoverLand":{ "shape":"LandsatCloudCoverLandInput", "documentation":"

" }, "Platform":{ "shape":"PlatformInput", "documentation":"

" }, "ViewOffNadir":{ "shape":"ViewOffNadirInput", "documentation":"

" }, "ViewSunAzimuth":{ "shape":"ViewSunAzimuthInput", "documentation":"

" }, "ViewSunElevation":{ "shape":"ViewSunElevationInput", "documentation":"

" } }, "documentation":"

", "union":true }, "PropertyFilter":{ "type":"structure", "required":["Property"], "members":{ "Property":{ "shape":"Property", "documentation":"

" } }, "documentation":"

" }, "PropertyFilters":{ "type":"structure", "members":{ "LogicalOperator":{ "shape":"LogicalOperator", "documentation":"

" }, "Properties":{ "shape":"PropertyFiltersList", "documentation":"

" } }, "documentation":"

" }, "PropertyFiltersList":{ "type":"list", "member":{"shape":"PropertyFilter"} }, "RasterDataCollectionMetadata":{ "type":"structure", "required":[ "Arn", "Description", "Name", "SupportedFilters", "Type" ], "members":{ "Arn":{ "shape":"DataCollectionArn", "documentation":"

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

" }, "Description":{ "shape":"String", "documentation":"

A description of the raster data collection.

" }, "DescriptionPageUrl":{ "shape":"String", "documentation":"

The description URL of the raster data collection.

" }, "Name":{ "shape":"String", "documentation":"

The name of the raster data collection.

" }, "SupportedFilters":{ "shape":"FilterList", "documentation":"

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" }, "Type":{ "shape":"DataCollectionType", "documentation":"

The type of raster data collection.

" } }, "documentation":"

Response object containing details for a specific RasterDataCollection.

" }, "RasterDataCollectionQueryInput":{ "type":"structure", "required":[ "RasterDataCollectionArn", "TimeRangeFilter" ], "members":{ "AreaOfInterest":{ "shape":"AreaOfInterest", "documentation":"

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

" }, "PropertyFilters":{ "shape":"PropertyFilters", "documentation":"

" }, "RasterDataCollectionArn":{ "shape":"String", "documentation":"

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

" }, "TimeRangeFilter":{ "shape":"TimeRangeFilterInput", "documentation":"

" } }, "documentation":"

" }, "RasterDataCollectionQueryOutput":{ "type":"structure", "required":[ "RasterDataCollectionArn", "RasterDataCollectionName", "TimeRangeFilter" ], "members":{ "AreaOfInterest":{ "shape":"AreaOfInterest", "documentation":"

" }, "PropertyFilters":{ "shape":"PropertyFilters", "documentation":"

" }, "RasterDataCollectionArn":{ "shape":"String", "documentation":"

" }, "RasterDataCollectionName":{ "shape":"String", "documentation":"

The name of the raster data collection.

" }, "TimeRangeFilter":{ "shape":"TimeRangeFilterInput", "documentation":"

" } }, "documentation":"

" }, "RasterDataCollectionQueryWithBandFilterInput":{ "type":"structure", "required":["TimeRangeFilter"], "members":{ "AreaOfInterest":{ "shape":"AreaOfInterest", "documentation":"

" }, "BandFilter":{ "shape":"StringListInput", "documentation":"

" }, "PropertyFilters":{ "shape":"PropertyFilters", "documentation":"

" }, "TimeRangeFilter":{ "shape":"TimeRangeFilterInput", "documentation":"

" } }, "documentation":"

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

" }, "ResamplingConfigInput":{ "type":"structure", "required":["OutputResolution"], "members":{ "AlgorithmName":{ "shape":"AlgorithmNameResampling", "documentation":"

The name of the algorithm used for resampling.

" }, "OutputResolution":{ "shape":"OutputResolutionResamplingInput", "documentation":"

" }, "TargetBands":{ "shape":"StringListInput", "documentation":"

" } }, "documentation":"

" }, "ResourceNotFoundException":{ "type":"structure", "required":[ "Message", "ResourceId" ], "members":{ "Message":{"shape":"String"}, "ResourceId":{ "shape":"String", "documentation":"

" } }, "documentation":"

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReverseGeocodingConfig":{ "type":"structure", "required":[ "XAttributeName", "YAttributeName" ], "members":{ "XAttributeName":{ "shape":"String", "documentation":"

" }, "YAttributeName":{ "shape":"String", "documentation":"

" } }, "documentation":"

" }, "S3DataInput":{ "type":"structure", "required":[ "MetadataProvider", "S3Uri" ], "members":{ "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "MetadataProvider":{ "shape":"MetadataProvider", "documentation":"

" }, "S3Uri":{ "shape":"String", "documentation":"

The URL to the Amazon S3 input.

" } }, "documentation":"

Path to Amazon S3 storage location for input data.

" }, "SearchRasterDataCollectionInput":{ "type":"structure", "required":[ "Arn", "RasterDataCollectionQuery" ], "members":{ "Arn":{ "shape":"DataCollectionArn", "documentation":"

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

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "RasterDataCollectionQuery":{ "shape":"RasterDataCollectionQueryWithBandFilterInput", "documentation":"

" } } }, "SearchRasterDataCollectionOutput":{ "type":"structure", "required":["ApproximateResultCount"], "members":{ "ApproximateResultCount":{ "shape":"Integer", "documentation":"

" }, "Items":{ "shape":"ItemSourceList", "documentation":"

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "Message", "ResourceId" ], "members":{ "Message":{"shape":"String"}, "ResourceId":{ "shape":"String", "documentation":"

" } }, "documentation":"

You have exceeded the service quota.

", "error":{ "httpStatusCode":402, "senderFault":true }, "exception":true }, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "StackConfigInput":{ "type":"structure", "members":{ "OutputResolution":{ "shape":"OutputResolutionStackInput", "documentation":"

" }, "TargetBands":{ "shape":"StringListInput", "documentation":"

" } }, "documentation":"

" }, "StartEarthObservationJobInput":{ "type":"structure", "required":[ "InputConfig", "JobConfig", "Name" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

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

", "idempotencyToken":true }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "InputConfig":{ "shape":"InputConfigInput", "documentation":"

Input configuration information for the Earth Observation job.

" }, "JobConfig":{ "shape":"JobConfigInput", "documentation":"

An object containing information about the job configuration.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "Name":{ "shape":"String", "documentation":"

The name of the Earth Observation job.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" } } }, "StartEarthObservationJobOutput":{ "type":"structure", "required":[ "Arn", "CreationTime", "DurationInSeconds", "JobConfig", "Name", "Status" ], "members":{ "Arn":{ "shape":"String", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time.

" }, "DurationInSeconds":{ "shape":"Integer", "documentation":"

The duration of the session, in seconds.

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "InputConfig":{ "shape":"InputConfigOutput", "documentation":"

Input configuration information for the Earth Observation job.

" }, "JobConfig":{ "shape":"JobConfigInput", "documentation":"

An object containing information about the job configuration.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "Name":{ "shape":"String", "documentation":"

The name of the Earth Observation job.

" }, "Status":{ "shape":"EarthObservationJobStatus", "documentation":"

The status of the Earth Observation job.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" } } }, "StartVectorEnrichmentJobInput":{ "type":"structure", "required":[ "ExecutionRoleArn", "InputConfig", "JobConfig", "Name" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

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

", "idempotencyToken":true }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "InputConfig":{ "shape":"VectorEnrichmentJobInputConfig", "documentation":"

Input configuration information for the Vector Enrichment job.

" }, "JobConfig":{ "shape":"VectorEnrichmentJobConfig", "documentation":"

An object containing information about the job configuration.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "Name":{ "shape":"String", "documentation":"

The name of the Vector Enrichment job.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" } } }, "StartVectorEnrichmentJobOutput":{ "type":"structure", "required":[ "Arn", "CreationTime", "DurationInSeconds", "ExecutionRoleArn", "InputConfig", "JobConfig", "Name", "Status", "Type" ], "members":{ "Arn":{ "shape":"VectorEnrichmentJobArn", "documentation":"

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

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The creation time.

" }, "DurationInSeconds":{ "shape":"Integer", "documentation":"

The duration of the Vector Enrichment job, in seconds.

" }, "ExecutionRoleArn":{ "shape":"String", "documentation":"

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

" }, "InputConfig":{ "shape":"VectorEnrichmentJobInputConfig", "documentation":"

Input configuration information for starting the Vector Enrichment job.

" }, "JobConfig":{ "shape":"VectorEnrichmentJobConfig", "documentation":"

An object containing information about the job configuration.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "Name":{ "shape":"String", "documentation":"

The name of the Vector Enrichment job.

" }, "Status":{ "shape":"VectorEnrichmentJobStatus", "documentation":"

The status of the Vector Enrichment job being started.

" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" }, "Type":{ "shape":"VectorEnrichmentJobType", "documentation":"

The type of the Vector Enrichment job.

" } } }, "StopEarthObservationJobInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"EarthObservationJobArn", "documentation":"

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

" } } }, "StopEarthObservationJobOutput":{ "type":"structure", "members":{ } }, "StopVectorEnrichmentJobInput":{ "type":"structure", "required":["Arn"], "members":{ "Arn":{ "shape":"VectorEnrichmentJobArn", "documentation":"

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

" } } }, "StopVectorEnrichmentJobOutput":{ "type":"structure", "members":{ } }, "String":{"type":"string"}, "StringListInput":{ "type":"list", "member":{"shape":"String"}, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"String"}, "max":50, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

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

", "location":"uri", "locationName":"ResourceArn" }, "Tags":{ "shape":"Tags", "documentation":"

Each tag consists of a key and a value.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "Tags":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "TargetOptions":{ "type":"string", "enum":[ "INPUT", "OUTPUT" ] }, "TemporalStatistics":{ "type":"string", "enum":[ "MEAN", "MEDIAN", "STANDARD_DEVIATION" ] }, "TemporalStatisticsConfigInput":{ "type":"structure", "required":["Statistics"], "members":{ "GroupBy":{ "shape":"GroupBy", "documentation":"

" }, "Statistics":{ "shape":"TemporalStatisticsListInput", "documentation":"

" }, "TargetBands":{ "shape":"StringListInput", "documentation":"

" } }, "documentation":"

" }, "TemporalStatisticsListInput":{ "type":"list", "member":{"shape":"TemporalStatistics"}, "min":1 }, "ThrottlingException":{ "type":"structure", "required":[ "Message", "ResourceId" ], "members":{ "Message":{"shape":"String"}, "ResourceId":{ "shape":"String", "documentation":"

" } }, "documentation":"

The request was denied due to request throttling.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "TimeRangeFilterInput":{ "type":"structure", "required":[ "EndTime", "StartTime" ], "members":{ "EndTime":{ "shape":"Timestamp", "documentation":"

The end time for the time-range filter.

" }, "StartTime":{ "shape":"Timestamp", "documentation":"

The start time for the time-range filter.

" } }, "documentation":"

The input for the time-range filter.

", "sensitive":true }, "Timestamp":{"type":"timestamp"}, "Unit":{ "type":"string", "enum":["METERS"] }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

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

", "location":"uri", "locationName":"ResourceArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

Keys of the tags you want to remove.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UserDefined":{ "type":"structure", "required":[ "Unit", "Value" ], "members":{ "Unit":{ "shape":"Unit", "documentation":"

" }, "Value":{ "shape":"Float", "documentation":"

" } }, "documentation":"

" }, "ValidationException":{ "type":"structure", "required":[ "Message", "ResourceId" ], "members":{ "Message":{"shape":"String"}, "ResourceId":{ "shape":"String", "documentation":"

" } }, "documentation":"

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "VectorEnrichmentJobArn":{ "type":"string", "pattern":"^arn:aws[a-z-]{0,12}:sagemaker-geospatial:[a-z0-9-]{1,25}:[0-9]{12}:vector-enrichment-job/[a-z0-9]{12,}$" }, "VectorEnrichmentJobConfig":{ "type":"structure", "members":{ "MapMatchingConfig":{ "shape":"MapMatchingConfig", "documentation":"

" }, "ReverseGeocodingConfig":{ "shape":"ReverseGeocodingConfig", "documentation":"

" } }, "documentation":"

It contains configs such as ReverseGeocodingConfig and MapMatchingConfig.

", "union":true }, "VectorEnrichmentJobDataSourceConfigInput":{ "type":"structure", "members":{ "S3Data":{ "shape":"VectorEnrichmentJobS3Data", "documentation":"

" } }, "documentation":"

", "union":true }, "VectorEnrichmentJobDocumentType":{ "type":"string", "enum":["CSV"] }, "VectorEnrichmentJobErrorDetails":{ "type":"structure", "members":{ "ErrorMessage":{ "shape":"String", "documentation":"

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

" }, "ErrorType":{ "shape":"VectorEnrichmentJobErrorType", "documentation":"

The type of error generated during the Vector Enrichment job.

" } }, "documentation":"

VectorEnrichmentJob error details in response from GetVectorEnrichmentJob.

" }, "VectorEnrichmentJobErrorType":{ "type":"string", "enum":[ "CLIENT_ERROR", "SERVER_ERROR" ] }, "VectorEnrichmentJobExportErrorDetails":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

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

" }, "Type":{ "shape":"VectorEnrichmentJobExportErrorType", "documentation":"

" } }, "documentation":"

VectorEnrichmentJob export error details in response from GetVectorEnrichmentJob.

" }, "VectorEnrichmentJobExportErrorType":{ "type":"string", "enum":[ "CLIENT_ERROR", "SERVER_ERROR" ] }, "VectorEnrichmentJobExportStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "SUCCEEDED", "FAILED" ] }, "VectorEnrichmentJobInputConfig":{ "type":"structure", "required":[ "DataSourceConfig", "DocumentType" ], "members":{ "DataSourceConfig":{ "shape":"VectorEnrichmentJobDataSourceConfigInput", "documentation":"

" }, "DocumentType":{ "shape":"VectorEnrichmentJobDocumentType", "documentation":"

" } }, "documentation":"

The input structure for the InputConfig in a VectorEnrichmentJob.

" }, "VectorEnrichmentJobList":{ "type":"list", "member":{"shape":"ListVectorEnrichmentJobOutputConfig"} }, "VectorEnrichmentJobS3Data":{ "type":"structure", "required":["S3Uri"], "members":{ "KmsKeyId":{ "shape":"String", "documentation":"

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

" }, "S3Uri":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

The Amazon S3 data for the Vector Enrichment job.

" }, "VectorEnrichmentJobStatus":{ "type":"string", "enum":[ "INITIALIZING", "IN_PROGRESS", "STOPPING", "STOPPED", "COMPLETED", "FAILED", "DELETING", "DELETED" ] }, "VectorEnrichmentJobType":{ "type":"string", "enum":[ "REVERSE_GEOCODING", "MAP_MATCHING" ] }, "ViewOffNadirInput":{ "type":"structure", "required":[ "LowerBound", "UpperBound" ], "members":{ "LowerBound":{ "shape":"Float", "documentation":"

" }, "UpperBound":{ "shape":"Float", "documentation":"

" } }, "documentation":"

" }, "ViewSunAzimuthInput":{ "type":"structure", "required":[ "LowerBound", "UpperBound" ], "members":{ "LowerBound":{ "shape":"Float", "documentation":"

" }, "UpperBound":{ "shape":"Float", "documentation":"

" } }, "documentation":"

" }, "ViewSunElevationInput":{ "type":"structure", "required":[ "LowerBound", "UpperBound" ], "members":{ "LowerBound":{ "shape":"Float", "documentation":"

The lower bound to view the sun elevation.

" }, "UpperBound":{ "shape":"Float", "documentation":"

The upper bound to view the sun elevation.

" } }, "documentation":"

" }, "ZonalStatistics":{ "type":"string", "enum":[ "MEAN", "MEDIAN", "STANDARD_DEVIATION", "MAX", "MIN", "SUM" ] }, "ZonalStatisticsConfigInput":{ "type":"structure", "required":[ "Statistics", "ZoneS3Path" ], "members":{ "Statistics":{ "shape":"ZonalStatisticsListInput", "documentation":"

" }, "TargetBands":{ "shape":"StringListInput", "documentation":"

" }, "ZoneS3Path":{ "shape":"String", "documentation":"

" } }, "documentation":"

" }, "ZonalStatisticsListInput":{ "type":"list", "member":{"shape":"ZonalStatistics"}, "min":1 } }, "documentation":"

Provides APIs for creating and managing SageMaker geospatial resources.

" }