---
title: "POST /search-raster-data-collection"
method: POST
path: "/search-raster-data-collection"
---

# POST /search-raster-data-collection

`POST /search-raster-data-collection`

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

## Request body

- object
  - `Arn` string, required — The Amazon Resource Name (ARN) of the raster data collection.
  - `NextToken` string, password — If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
  - `RasterDataCollectionQuery` object, required — This is a RasterDataCollectionQueryInput containing AreaOfInterest, Time Range filter and Property filters.
    - `AreaOfInterest` object — The Area of interest to be used in the search query.
      - `AreaOfInterestGeometry` object — A GeoJSON object representing the geographic extent in the coordinate space.
        - `MultiPolygonGeometry` object — The structure representing the MultiPolygon Geometry.
          - `Coordinates` LinearRings[], required — The coordinates of the multipolygon geometry.
            - LinearRing[]
              - …
        - `PolygonGeometry` object — The structure representing Polygon Geometry.
          - `Coordinates` LinearRing[], required — Coordinates representing a Polygon based on the <a href="https://www.rfc-editor.org/rfc/rfc7946#section-3.1.6">GeoJson spec</a>.
            - Position[]
              - …
    - `BandFilter` String[] — The list of Bands to be displayed in the result for each item.
    - `PropertyFilters` object — The Property Filters used in the search query.
      - `LogicalOperator` 'AND' — The Logical Operator used to combine the Property Filters.
      - `Properties` PropertyFilter[] — A list of Property Filters.
        - `Property` object, required — Represents a single property to match with when searching a raster data collection.
          - `EoCloudCover` object — The structure representing EoCloudCover property filter containing a lower bound and upper bound.
            - `LowerBound` number, float, required — Lower bound for EoCloudCover.
            - `UpperBound` number, float, required — Upper bound for EoCloudCover.
          - `LandsatCloudCoverLand` object — The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.
            - `LowerBound` number, float, required — The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.
            - `UpperBound` number, float, required — The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.
          - `Platform` object — The structure representing Platform property filter consisting of value and comparison operator.
            - `ComparisonOperator` 'EQUALS' | 'NOT_EQUALS' | 'STARTS_WITH' — The ComparisonOperator to use with PlatformInput.
            - `Value` string, required — The value of the platform.
          - `ViewOffNadir` object — The structure representing ViewOffNadir property filter containing a lower bound and upper bound.
            - `LowerBound` number, float, required — The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.
            - `UpperBound` number, float, required — The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.
          - `ViewSunAzimuth` object — The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.
            - `LowerBound` number, float, required — The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.
            - `UpperBound` number, float, required — The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.
          - `ViewSunElevation` object — The structure representing ViewSunElevation property filter containing a lower bound and upper bound.
            - `LowerBound` number, float, required — The lower bound to view the sun elevation.
            - `UpperBound` number, float, required — The upper bound to view the sun elevation.
    - `TimeRangeFilter` object — The TimeRange Filter used in the search query.
      - `EndTime` string, date-time, required — The end time for the time-range filter.
      - `StartTime` string, date-time, required — The start time for the time-range filter.

## Response `200`

Success

- SearchRasterDataCollectionOutput
  - `ApproximateResultCount` integer, required — Approximate number of results in the response.
  - `Items` ItemSource[] — List of items matching the Raster DataCollectionQuery.
    - `Assets` object — This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.
    - `DateTime` string, date-time, required — The searchable date and time of the item, in UTC.
    - `Geometry` object, required — The item Geometry in GeoJson format.
      - `Coordinates` LinearRing[], required — The coordinates of the GeoJson Geometry.
        - Position[]
          - Double[]
      - `Type` string, required — GeoJson Geometry types like Polygon and MultiPolygon.
    - `Id` string, required — A unique Id for the source item.
    - `Properties` object — This field contains additional properties of the item.
      - `EoCloudCover` number, float — Estimate of cloud cover.
      - `LandsatCloudCoverLand` number, float — Land cloud cover for Landsat Data Collection.
      - `Platform` string — Platform property. Platform refers to the unique name of the specific platform the instrument is attached to. For satellites it is the name of the satellite, eg. landsat-8 (Landsat-8), sentinel-2a.
      - `ViewOffNadir` number, float — The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).
      - `ViewSunAzimuth` number, float — The sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).
      - `ViewSunElevation` number, float — The sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° means the data was captured during <a href="https://www.timeanddate.com/astronomy/different-types-twilight.html">nautical twilight</a>.
  - `NextToken` string, password — If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

## Other responses

- `480` — AccessDeniedException
- `481` — ValidationException
- `482` — ThrottlingException
- `483` — InternalServerException
- `484` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/sagemaker-geospatial.md) · [All operations](https://skmtc.net/aws/apis/sagemaker-geospatial/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/sagemaker-geospatial/versions/cfc9ba4ca4d8/schema)