SageMakergeospatialcapabilities / Client / search_raster_data_collection

search_raster_data_collection

SageMakergeospatialcapabilities.Client.search_raster_data_collection(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.search_raster_data_collection(
    Arn='string',
    NextToken='string',
    RasterDataCollectionQuery={
        'AreaOfInterest': {
            'AreaOfInterestGeometry': {
                'MultiPolygonGeometry': {
                    'Coordinates': [
                        [
                            [
                                [
                                    123.0,
                                ],
                            ],
                        ],
                    ]
                },
                'PolygonGeometry': {
                    'Coordinates': [
                        [
                            [
                                123.0,
                            ],
                        ],
                    ]
                }
            }
        },
        'BandFilter': [
            'string',
        ],
        'PropertyFilters': {
            'LogicalOperator': 'AND',
            'Properties': [
                {
                    'Property': {
                        'EoCloudCover': {
                            'LowerBound': ...,
                            'UpperBound': ...
                        },
                        'LandsatCloudCoverLand': {
                            'LowerBound': ...,
                            'UpperBound': ...
                        },
                        'Platform': {
                            'ComparisonOperator': 'EQUALS'|'NOT_EQUALS'|'STARTS_WITH',
                            'Value': 'string'
                        },
                        'ViewOffNadir': {
                            'LowerBound': ...,
                            'UpperBound': ...
                        },
                        'ViewSunAzimuth': {
                            'LowerBound': ...,
                            'UpperBound': ...
                        },
                        'ViewSunElevation': {
                            'LowerBound': ...,
                            'UpperBound': ...
                        }
                    }
                },
            ]
        },
        'TimeRangeFilter': {
            'EndTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1)
        }
    }
)

Parameters:

• Arn (string) –

  [REQUIRED]

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

• NextToken (string) – If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

• RasterDataCollectionQuery (dict) –

  [REQUIRED]

  • AreaOfInterest (dict) –

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: AreaOfInterestGeometry.

    • AreaOfInterestGeometry (dict) –

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: MultiPolygonGeometry, PolygonGeometry.

      • MultiPolygonGeometry (dict) –

        • Coordinates (list) – [REQUIRED]

          The coordinates of the multipolygon geometry.

          • (list) –

            • (list) –

              • (list) –

                • (float) –

      • PolygonGeometry (dict) –

        • Coordinates (list) – [REQUIRED]

          • (list) –

            • (list) –

              • (float) –

  • BandFilter (list) –

    • (string) –

  • PropertyFilters (dict) –

    • LogicalOperator (string) –

    • Properties (list) –

      • (dict) –

        • Property (dict) – [REQUIRED]

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: EoCloudCover, LandsatCloudCoverLand, Platform, ViewOffNadir, ViewSunAzimuth, ViewSunElevation.

          • EoCloudCover (dict) –

            • LowerBound (float) – [REQUIRED]

            • UpperBound (float) – [REQUIRED]

          • LandsatCloudCoverLand (dict) –

            • LowerBound (float) – [REQUIRED]

            • UpperBound (float) – [REQUIRED]

          • Platform (dict) –

            • ComparisonOperator (string) –

            • Value (string) – [REQUIRED]

              The value of the platform.

          • ViewOffNadir (dict) –

            • LowerBound (float) – [REQUIRED]

            • UpperBound (float) – [REQUIRED]

          • ViewSunAzimuth (dict) –

            • LowerBound (float) – [REQUIRED]

            • UpperBound (float) – [REQUIRED]

          • ViewSunElevation (dict) –

            • LowerBound (float) – [REQUIRED]

              The lower bound to view the sun elevation.

            • UpperBound (float) – [REQUIRED]

              The upper bound to view the sun elevation.

  • TimeRangeFilter (dict) – [REQUIRED]

    • EndTime (datetime) – [REQUIRED]

      The end time for the time-range filter.

    • StartTime (datetime) – [REQUIRED]

      The start time for the time-range filter.

Return type:

dict

Returns:

Response Syntax

{
    'ApproximateResultCount': 123,
    'Items': [
        {
            'Assets': {
                'string': {
                    'Href': 'string'
                }
            },
            'DateTime': datetime(2015, 1, 1),
            'Geometry': {
                'Coordinates': [
                    [
                        [
                            123.0,
                        ],
                    ],
                ],
                'Type': 'string'
            },
            'Id': 'string',
            'Properties': {
                'EoCloudCover': ...,
                'LandsatCloudCoverLand': ...,
                'Platform': 'string',
                'ViewOffNadir': ...,
                'ViewSunAzimuth': ...,
                'ViewSunElevation': ...
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ApproximateResultCount (integer) –

  • Items (list) –

    • (dict) –

      Structure representing the items in the response for SearchRasterDataCollection.

      • Assets (dict) –

        • (string) –

          • (dict) –

            • Href (string) –

      • DateTime (datetime) –

      • Geometry (dict) –

        • Coordinates (list) –

          • (list) –

            • (list) –

              • (float) –

        • Type (string) –

      • Id (string) –

        A unique Id for the source item.

      • Properties (dict) –

        • EoCloudCover (float) –

        • LandsatCloudCoverLand (float) –

        • Platform (string) –

        • ViewOffNadir (float) –

        • ViewSunAzimuth (float) –

        • ViewSunElevation (float) –

  • NextToken (string) –

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

Exceptions

• SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException

• SageMakergeospatialcapabilities.Client.exceptions.ValidationException

• SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException

• SageMakergeospatialcapabilities.Client.exceptions.InternalServerException

• SageMakergeospatialcapabilities.Client.exceptions.ResourceNotFoundException