Amazon SageMaker 地理空间地图 SDK - Amazon SageMaker
add_dataset APIupdate_dataset APIadd_layer APIupdate_layer APIvisualize_eoj_aoi APIvisualize_eoj_input APIvisualize_eoj_output API
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

Amazon SageMaker 地理空间地图 SDK

您可以使用 Amazon SageMaker 的地理空间功能，在 SageMaker 地理空间用户界面以及带有地理空间映像的 SageMaker 笔记本中将地图可视化。这些可视化由名为 Foursquare Studio 的地图可视化库支持

您可以使用 SageMaker 地理空间地图 SDK 提供的 API 来可视化地理空间数据，包括 EOJ 的输入、输出和 AoI。

add_dataset API

向地图添加栅格或矢量数据集对象。

请求语法

Request = 
    add_dataset(
      self,
      dataset: Union[Dataset, Dict, None] = None,
      *,
      auto_create_layers: bool = True,
      center_map: bool = True,
      **kwargs: Any,
    ) -> Optional[Dataset]

请求参数

请求接受以下参数。

位置参数

参数

类型

描述

dataset

Union[Dataset, Dict, None]

用于创建数据集的数据，采用 CSV、JSON 或 GeoJSON 格式（用于本地数据集）或 UUID 字符串。

关键字参数

参数

类型

描述

auto_create_layers

布尔值

添加数据集时是否尝试创建新图层。默认值为 False。

center_map

布尔值

是否将地图居中显示在创建的数据集上。默认值为 True。

id

字符串

数据集的唯一标识符。如果未提供，则将生成一个随机 ID。

label

字符串

显示的数据集标签。

color

Tuple[float, float, float]

数据集的颜色标签。

metadata

字典

包含平铺数据集元数据的对象（用于平铺数据集）。

响应

此 API 返回已添加到地图的数据集对象。

update_dataset API

更新现有数据集的设置。

请求语法

Request = 
    update_dataset(
    self,
    dataset_id: str,
    values: Union[_DatasetUpdateProps, dict, None] = None,
    **kwargs: Any,
) -> Dataset

请求参数

请求接受以下参数。

位置参数

参数

类型

描述

dataset_id

字符串

要更新的数据集的标识符。

values

Union[_DatasetUpdateProps, dict, None]

要更新的值。

关键字参数

参数

类型

描述

label

字符串

显示的数据集标签。

color

RGBColor

数据集的颜色标签。

响应

对于交互式地图，此 API 返回更新后的数据集对象；对于非交互式 HTML 环境，返回 None。

add_layer API

向地图添加新图层。此功能需要至少一个有效的图层配置。

请求语法

Request = 
    add_layer(
    self,
    layer: Union[LayerCreationProps, dict, None] = None,
    **kwargs: Any
) -> Layer

请求参数

请求接受以下参数。

参数

参数

类型

描述

layer

Union[LayerCreationProps, dict, None]

一组用于创建图层的属性。

响应

添加到地图的图层对象。

update_layer API

使用给定值更新现有图层。

请求语法

Request = 
    update_layer(
  self,
  layer_id: str,
  values: Union[LayerUpdateProps, dict, None],
  **kwargs: Any
) -> Layer

请求参数

请求接受以下参数。

参数

位置参数

类型

描述

layer_id

字符串

要更新的图层的 ID。

values

Union[LayerUpdateProps, dict, None]

要更新的值。

关键字参数

参数

类型

描述

type

LayerType

图层的类型。

data_id

字符串

此图层可视化的数据集的唯一标识符。

fields

Dict [string, Optional[string]]

将图层可视化所需的字段映射到相应的数据集字段的字典。

label

字符串

此图层的规范标签。

is_visible

布尔值

图层是否可见。

config

LayerConfig

特定于其类型的图层配置。

响应

返回更新后的图层对象。

visualize_eoj_aoi API

可视化给定作业 ARN 的 AoI。

请求参数

请求接受以下参数。

参数

参数

类型

描述

Arn

字符串

作业的 ARN。

config

字典

config = { label: <string> custom label of the added AoI layer, default AoI }

用于传递图层属性的选项。

响应

已添加的输入层对象的引用。

visualize_eoj_input API

可视化给定 EOJ ARN 的输入。

请求参数

请求接受以下参数。

参数

参数

类型

描述

Arn

字符串

作业的 ARN。

time_range_filter

字典

time_range_filter = {

start_date: <string> date in ISO format

end_date: <string> date in ISO format

}

提供开始和结束时间的选项。默认为栅格数据集合搜索的开始和结束日期。

config

字典

config = { label: <string> custom label of the added output layer, default Input }

用于传递图层属性的选项。

响应

已添加的输入层对象的引用。

visualize_eoj_output API

可视化给定 EOJ ARN 的输出。

请求参数

请求接受以下参数。

参数

参数

类型

描述

Arn

字符串

作业的 ARN。

time_range_filter

字典

time_range_filter = {

start_date: <string> date in ISO format

end_date: <string> date in ISO format

}

提供开始和结束时间的选项。默认为栅格数据集合搜索的开始和结束日期。

config

字典

config = {

label: <string> custom label of the added output layer, default Output

preset: <string> singleBand or trueColor,

band_name: <string>, only required for 'singleBand' preset. EOJ 允许的波段

}

用于传递图层属性的选项。

响应

已添加的输出图层对象的引用。

要了解有关可视化地理空间数据的更多信息，请参阅使用 Amazon SageMaker 地理空间进行可视化。