SearchRasterDataCollection
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
Request Syntax
POST /search-raster-data-collection HTTP/1.1
Content-type: application/json
{
"Arn": "string",
"NextToken": "string",
"RasterDataCollectionQuery": {
"AreaOfInterest": { ... },
"BandFilter": [ "string" ],
"PropertyFilters": {
"LogicalOperator": "string",
"Properties": [
{
"Property": { ... }
}
]
},
"TimeRangeFilter": {
"EndTime": number,
"StartTime": number
}
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Arn
-
The Amazon Resource Name (ARN) of the raster data collection.
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,}$Required: Yes
- NextToken
-
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Required: No
- RasterDataCollectionQuery
-
RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.
Type: RasterDataCollectionQueryWithBandFilterInput object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ApproximateResultCount": number,
"Items": [
{
"Assets": {
"string" : {
"Href": "string"
}
},
"DateTime": number,
"Geometry": {
"Coordinates": [
[
[ number ]
]
],
"Type": "string"
},
"Id": "string",
"Properties": {
"EoCloudCover": number,
"LandsatCloudCoverLand": number,
"Platform": "string",
"ViewOffNadir": number,
"ViewSunAzimuth": number,
"ViewSunElevation": number
}
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ApproximateResultCount
-
Approximate number of results in the response.
Type: Integer
- Items
-
List of items matching the Raster DataCollectionQuery.
Type: Array of ItemSource objects
- NextToken
-
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
