Skip to content
AWS for Query.Farm

aws.sagemaker_geospatial.search_raster_data_collection

Example SQL Queries

SELECT * FROM
aws.sagemaker_geospatial.search_raster_data_collection
WHERE
"arn" = 'VALUE'
AND "raster_data_collection_query" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
arn Required Input Column

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

VARCHAR
raster_data_collection_query Required Input Column

RasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.

STRUCT(
    "area_of_interest" STRUCT(
        "area_of_interest_geometry" STRUCT(
            "multi_polygon_geometry" STRUCT(
                "coordinates" DOUBLE[][][][]
            ),
            "polygon_geometry" STRUCT(
                "coordinates" DOUBLE[][][]
            )
        )
    ),
    "band_filter" VARCHAR[],
    "property_filters" STRUCT(
        "logical_operator" VARCHAR,
        "properties" STRUCT(
            "property" STRUCT(
                "eo_cloud_cover" STRUCT(
                    "lower_bound" DOUBLE,
                    "upper_bound" DOUBLE
                ),
                "landsat_cloud_cover_land" STRUCT(
                    "lower_bound" DOUBLE,
                    "upper_bound" DOUBLE
                ),
                "platform" STRUCT(
                    "comparison_operator" VARCHAR,
                    "value" VARCHAR
                ),
                "view_off_nadir" STRUCT(
                    "lower_bound" DOUBLE,
                    "upper_bound" DOUBLE
                ),
                "view_sun_azimuth" STRUCT(
                    "lower_bound" DOUBLE,
                    "upper_bound" DOUBLE
                ),
                "view_sun_elevation" STRUCT(
                    "lower_bound" DOUBLE,
                    "upper_bound" DOUBLE
                )
            )
        )[]
    ),
    "time_range_filter" STRUCT(
        "end_time" TIMESTAMP_S,
        "start_time" TIMESTAMP_S
    )
)
Show child fields
raster_data_collection_query.area_of_interest

The Area of interest to be used in the search query.

Show child fields
raster_data_collection_query.area_of_interest.area_of_interest_geometry

A GeoJSON object representing the geographic extent in the coordinate space.

Show child fields
raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry

The structure representing the MultiPolygon Geometry.

Show child fields
raster_data_collection_query.area_of_interest.area_of_interest_geometry.multi_polygon_geometry.coordinates[][][][]
raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry

The structure representing Polygon Geometry.

Show child fields
raster_data_collection_query.area_of_interest.area_of_interest_geometry.polygon_geometry.coordinates[][][]
raster_data_collection_query.band_filter[]
raster_data_collection_query.property_filters

The Property Filters used in the search query.

Show child fields
raster_data_collection_query.property_filters.logical_operator

The Logical Operator used to combine the Property Filters.

raster_data_collection_query.property_filters.properties[]
Show child fields
raster_data_collection_query.property_filters.properties[].property

Represents a single property to match with when searching a raster data collection.

Show child fields
raster_data_collection_query.property_filters.properties[].property.eo_cloud_cover

The structure representing EoCloudCover property filter containing a lower bound and upper bound.

Show child fields
raster_data_collection_query.property_filters.properties[].property.eo_cloud_cover.lower_bound

Lower bound for EoCloudCover.

raster_data_collection_query.property_filters.properties[].property.eo_cloud_cover.upper_bound

Upper bound for EoCloudCover.

raster_data_collection_query.property_filters.properties[].property.landsat_cloud_cover_land

The structure representing Land Cloud Cover property filter for Landsat collection containing a lower bound and upper bound.

Show child fields
raster_data_collection_query.property_filters.properties[].property.landsat_cloud_cover_land.lower_bound

The minimum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover greater than or equal to this value.

raster_data_collection_query.property_filters.properties[].property.landsat_cloud_cover_land.upper_bound

The maximum value for Land Cloud Cover property filter. This will filter items having Land Cloud Cover less than or equal to this value.

raster_data_collection_query.property_filters.properties[].property.platform

The structure representing Platform property filter consisting of value and comparison operator.

Show child fields
raster_data_collection_query.property_filters.properties[].property.platform.comparison_operator

The ComparisonOperator to use with PlatformInput.

raster_data_collection_query.property_filters.properties[].property.platform.value

The value of the platform.

raster_data_collection_query.property_filters.properties[].property.view_off_nadir

The structure representing ViewOffNadir property filter containing a lower bound and upper bound.

Show child fields
raster_data_collection_query.property_filters.properties[].property.view_off_nadir.lower_bound

The minimum value for ViewOffNadir property filter. This filters items having ViewOffNadir greater than or equal to this value.

raster_data_collection_query.property_filters.properties[].property.view_off_nadir.upper_bound

The maximum value for ViewOffNadir property filter. This filters items having ViewOffNadir lesser than or equal to this value.

raster_data_collection_query.property_filters.properties[].property.view_sun_azimuth

The structure representing ViewSunAzimuth property filter containing a lower bound and upper bound.

Show child fields
raster_data_collection_query.property_filters.properties[].property.view_sun_azimuth.lower_bound

The minimum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth greater than or equal to this value.

raster_data_collection_query.property_filters.properties[].property.view_sun_azimuth.upper_bound

The maximum value for ViewSunAzimuth property filter. This filters items having ViewSunAzimuth lesser than or equal to this value.

raster_data_collection_query.property_filters.properties[].property.view_sun_elevation

The structure representing ViewSunElevation property filter containing a lower bound and upper bound.

Show child fields
raster_data_collection_query.property_filters.properties[].property.view_sun_elevation.lower_bound

The lower bound to view the sun elevation.

raster_data_collection_query.property_filters.properties[].property.view_sun_elevation.upper_bound

The upper bound to view the sun elevation.

raster_data_collection_query.time_range_filter

The TimeRange Filter used in the search query.

Show child fields
raster_data_collection_query.time_range_filter.end_time

The end time for the time-range filter.

raster_data_collection_query.time_range_filter.start_time

The start time for the time-range filter.

next_token Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
approximate_result_count

Approximate number of results in the response.

BIGINT
items

List of items matching the Raster DataCollectionQuery.

STRUCT(
    "assets" MAP(VARCHAR, STRUCT(
            "href" VARCHAR
        )),
    "date_time" TIMESTAMP_S,
    "geometry" STRUCT(
        "coordinates" DOUBLE[][][],
        "type" VARCHAR
    ),
    "id" VARCHAR,
    "properties" STRUCT(
        "eo_cloud_cover" DOUBLE,
        "landsat_cloud_cover_land" DOUBLE,
        "platform" VARCHAR,
        "view_off_nadir" DOUBLE,
        "view_sun_azimuth" DOUBLE,
        "view_sun_elevation" DOUBLE
    )
)[]
Show child fields
items[]
Show child fields
items[].assets

This is a dictionary of Asset Objects data associated with the Item that can be downloaded or streamed, each with a unique key.

items[].date_time

The searchable date and time of the item, in UTC.

items[].geometry

The item Geometry in GeoJson format.

Show child fields
items[].geometry.coordinates[][][]
items[].geometry.type

GeoJson Geometry types like Polygon and MultiPolygon.

items[].id

A unique Id for the source item.

items[].properties

This field contains additional properties of the item.

Show child fields
items[].properties.eo_cloud_cover

Estimate of cloud cover.

items[].properties.landsat_cloud_cover_land

Land cloud cover for Landsat Data Collection.

items[].properties.platform

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.

items[].properties.view_off_nadir

The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).

items[].properties.view_sun_azimuth

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).

items[].properties.view_sun_elevation

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 nautical twilight.