Skip to content

Search Raster Data Collection

sagemakergeospatialcapabilities_search_raster_data_collection R Documentation

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

Description

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

Usage

sagemakergeospatialcapabilities_search_raster_data_collection(Arn,
  NextToken, RasterDataCollectionQuery)

Arguments

Arn

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

NextToken

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

RasterDataCollectionQuery

[required] RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in search_raster_data_collection.

Value

A list with the following syntax:

list(
  ApproximateResultCount = 123,
  Items = list(
    list(
      Assets = list(
        list(
          Href = "string"
        )
      ),
      DateTime = as.POSIXct(
        "2015-01-01"
      ),
      Geometry = list(
        Coordinates = list(
          list(
            list(
              123.0
            )
          )
        ),
        Type = "string"
      ),
      Id = "string",
      Properties = list(
        EoCloudCover = 123.0,
        LandsatCloudCoverLand = 123.0,
        Platform = "string",
        ViewOffNadir = 123.0,
        ViewSunAzimuth = 123.0,
        ViewSunElevation = 123.0
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$search_raster_data_collection(
  Arn = "string",
  NextToken = "string",
  RasterDataCollectionQuery = list(
    AreaOfInterest = list(
      AreaOfInterestGeometry = list(
        MultiPolygonGeometry = list(
          Coordinates = list(
            list(
              list(
                list(
                  123.0
                )
              )
            )
          )
        ),
        PolygonGeometry = list(
          Coordinates = list(
            list(
              list(
                123.0
              )
            )
          )
        )
      )
    ),
    BandFilter = list(
      "string"
    ),
    PropertyFilters = list(
      LogicalOperator = "AND",
      Properties = list(
        list(
          Property = list(
            EoCloudCover = list(
              LowerBound = 123.0,
              UpperBound = 123.0
            ),
            LandsatCloudCoverLand = list(
              LowerBound = 123.0,
              UpperBound = 123.0
            ),
            Platform = list(
              ComparisonOperator = "EQUALS"|"NOT_EQUALS"|"STARTS_WITH",
              Value = "string"
            ),
            ViewOffNadir = list(
              LowerBound = 123.0,
              UpperBound = 123.0
            ),
            ViewSunAzimuth = list(
              LowerBound = 123.0,
              UpperBound = 123.0
            ),
            ViewSunElevation = list(
              LowerBound = 123.0,
              UpperBound = 123.0
            )
          )
        )
      )
    ),
    TimeRangeFilter = list(
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)