raster_data_collections

Creates, updates, deletes, gets or lists a raster_data_collections resource.

Overview

Name	raster_data_collections
Type	Resource
Id	aws.sagemaker_geospatial.raster_data_collections

Fields

The following fields are returned by SELECT queries:

get_raster_data_collection

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the raster data collection. (pattern: <code>^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,}$</code>)
description	string	A description of the raster data collection.
description_page_url	string	The URL of the description page.
image_source_bands	array	The list of image source bands in the raster data collection.
name	string	The name of the raster data collection.
supported_filters	array	The filters supported by the raster data collection.
tags	object	Each tag consists of a key and a value.
type	string	The raster data collection type. (PUBLIC, PREMIUM, USER)

search_raster_data_collection

Name	Datatype	Description
approximate_result_count	integer	Approximate number of results in the response.
items	array	List of items matching the Raster DataCollectionQuery.
next_token	string	If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

list_raster_data_collections

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the raster data collection. (pattern: <code>^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,}$</code>)
description	string	A description of the raster data collection.
description_page_url	string	The description URL of the raster data collection.
name	string	The name of the raster data collection.
supported_filters	array	The list of filters supported by the raster data collection.
tags	object	Each tag consists of a key and a value.
type	string	The type of raster data collection. (PUBLIC, PREMIUM, USER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_raster_data_collection	select	arn, region		Use this operation to get details of a specific raster data collection.
search_raster_data_collection	select	region		Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
list_raster_data_collections	select	region	MaxResults, NextToken	Use this operation to get raster data collections.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the raster data collection.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The total number of items to return.
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.

SELECT examples

get_raster_data_collection

Use this operation to get details of a specific raster data collection.

SELECT
arn,
description,
description_page_url,
image_source_bands,
name,
supported_filters,
tags,
type
FROM aws.sagemaker_geospatial.raster_data_collections
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

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.

SELECT
approximate_result_count,
items,
next_token
FROM aws.sagemaker_geospatial.raster_data_collections
WHERE region = '{{ region }}' -- required
;

list_raster_data_collections

Use this operation to get raster data collections.

SELECT
arn,
description,
description_page_url,
name,
supported_filters,
tags,
type
FROM aws.sagemaker_geospatial.raster_data_collections
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;