本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 亚马逊 SageMaker 地理空间地图 SDK
<a name="geospatial-notebook-sdk"></a>

您可以使用 Amazon SageMaker 地理空间功能在地理空间 UI 中对地图进行可视化，也可以使用 SageMaker 地理空间图像对 SageMaker 笔记本进行可视化。这些可视化由名为 [Foursquare Studio](https://studio.foursquare.com/home) 的地图可视化库支持

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

**Topics**
+ [add\$1dataset API](#geo-add-dataset)
+ [update\$1dataset API](#geo-update-dataset)
+ [add\$1layer API](#geo-add-layer)
+ [update\$1layer API](#geo-update-layer)
+ [visualize\$1eoj\$1aoi API](#geo-visualize-eoj-aoi)
+ [visualize\$1eoj\$1input API](#geo-visualize-eoj-input)
+ [visualize\$1eoj\$1output API](#geo-visualize-eoj-output)

## add\$1dataset API
<a name="geo-add-dataset"></a>

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

**请求语法**

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

**请求参数**

请求接受以下参数。

位置参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
| `dataset` | Union[Dataset, Dict, None] | 用于创建数据集的数据，采用 CSV、JSON 或 GeoJSON 格式（用于本地数据集）或 UUID 字符串。 | 

关键字参数


| 参数 |  Type  |  描述  | 
| --- | --- | --- | 
| `auto_create_layers` | 布尔值 | 添加数据集时是否尝试创建新图层。默认值为 `False`。 | 
| `center_map` | 布尔值 | 是否将地图居中显示在创建的数据集上。默认值为 `True`。 | 
| `id` | 字符串 | 数据集的唯一标识符。如果未提供，则将生成一个随机 ID。 | 
| `label` | 字符串 | 显示的数据集标签。 | 
| `color` | Tuple[float, float, float] | 数据集的颜色标签。 | 
| `metadata` | 字典 | 包含平铺数据集元数据的对象（用于平铺数据集）。 | 

**响应**

此 API 返回已添加到地图的[数据集](https://location.foursquare.com/developer/docs/studio-map-sdk-types#dataset)对象。

## update\$1dataset API
<a name="geo-update-dataset"></a>

更新现有数据集的设置。

**请求语法**

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

**请求参数**

请求接受以下参数。

位置参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
| `dataset_id` | 字符串 | 要更新的数据集的标识符。 | 
| `values` | 联合 [[\$1 DatasetUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#datasetupdateprops)，dict，无] | 要更新的值。 | 

关键字参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
| `label` | 字符串 | 显示的数据集标签。 | 
| `color` | [RGBColor](https://location.foursquare.com/developer/docs/studio-map-sdk-types#rgbcolor) | 数据集的颜色标签。 | 

**响应**

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

## add\$1layer API
<a name="geo-add-layer"></a>

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

**请求语法**

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

**请求参数**

请求接受以下参数。

参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
| `layer` | 联盟 [[LayerCreationProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layercreationprops)，字典，无] | 一组用于创建图层的属性。 | 

**响应**

添加到地图的图层对象。

## update\$1layer API
<a name="geo-update-layer"></a>

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

**请求语法**

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

**请求参数**

请求接受以下参数。

参数


| 位置参数 |  Type  |  说明  | 
| --- | --- | --- | 
| `layer_id` | 字符串 | 要更新的图层的 ID。 | 
| `values` | 联盟 [[LayerUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerupdateprops)，字典，无] | 要更新的值。 | 

关键字参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
| `type` | [LayerType](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layertype) | 图层的类型。 | 
| `data_id` | 字符串 | 此图层可视化的数据集的唯一标识符。 | 
| `fields` | Dict [string, Optional[string]] | 将图层可视化所需的字段映射到相应的数据集字段的字典。 | 
| `label` | 字符串 | 此图层的规范标签。 | 
| `is_visible` | 布尔值 | 图层是否可见。 | 
| `config` | [LayerConfig](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerconfig) | 特定于其类型的图层配置。 | 

**响应**

返回更新后的图层对象。

## visualize\$1eoj\$1aoi API
<a name="geo-visualize-eoj-aoi"></a>

可视化给定作业 ARN 的 AoI。

**请求参数**

请求接受以下参数。

参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
|  `Arn`  |  字符串  |  作业的 ARN。  | 
|  `config`  |  字典 config = \$1 label: <string> custom label of the added AoI layer, default AoI \$1  |  用于传递图层属性的选项。  | 

**响应**

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

## visualize\$1eoj\$1input API
<a name="geo-visualize-eoj-input"></a>

可视化给定 EOJ ARN 的输入。

**请求参数**

请求接受以下参数。

参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
| `Arn` | 字符串 | 作业的 ARN。 | 
| `time_range_filter` |  字典 time\$1range\$1filter = \$1 start\$1date: <string> date in ISO format end\$1date: <string> date in ISO format \$1  | 提供开始和结束时间的选项。默认为栅格数据集合搜索的开始和结束日期。 | 
| `config` |  字典 config = \$1 label: <string> custom label of the added output layer, default Input \$1  | 用于传递图层属性的选项。 | 

**响应**

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

## visualize\$1eoj\$1output API
<a name="geo-visualize-eoj-output"></a>

可视化给定 EOJ ARN 的输出。

**请求参数**

请求接受以下参数。

参数


| 参数 |  Type  |  说明  | 
| --- | --- | --- | 
|  `Arn`  |  字符串  |  作业的 ARN。  | 
|  `time_range_filter`  |  字典 time\$1range\$1filter = \$1 start\$1date: <string> date in ISO format end\$1date: <string> date in ISO format \$1  | 提供开始和结束时间的选项。默认为栅格数据集合搜索的开始和结束日期。 | 
| `config` |  字典 config = \$1 label: <string> custom label of the added output layer, default Output preset: <string> singleBand or trueColor, band\$1name: <string>, only required for 'singleBand' preset. EOJ 允许的波段 \$1  | 用于传递图层属性的选项。 | 

**响应**

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

要了解有关可视化地理空间数据的更多信息，请参阅使用 [Ama SageMaker zon 地理空间进行可视化](https://docs.aws.amazon.com/sagemaker/latest/dg/geospatial-visualize.html)。