本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Amazon SageMaker 地理空間地圖 SDK
<a name="geospatial-notebook-sdk"></a>

您可以使用 Amazon SageMaker 地理空間功能，在 SageMaker 地理空間使用者介面中，以及具有地理空間影像的 SageMaker 筆記本中視覺化地圖。這些視覺化是由稱為 [Foursquare Studio](https://studio.foursquare.com/home) 的地圖視覺化程式庫提供支援

您可以使用 SageMaker 地理空間地圖 SDK 提供的 API 來視覺化您的地理空間資料，包括 EOJ 的輸入、輸出和 AoI。

**Topics**
+ [add\_dataset API](#geo-add-dataset)
+ [update\_dataset API](#geo-update-dataset)
+ [add\_layer API](#geo-add-layer)
+ [update\_layer API](#geo-update-layer)
+ [visualize\_eoj\_aoi API](#geo-visualize-eoj-aoi)
+ [visualize\_eoj\_input API](#geo-visualize-eoj-input)
+ [visualize\_eoj\_output API](#geo-visualize-eoj-output)

## add\_dataset 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` | Boolean | 是否在新增資料集時嘗試建立新圖層。預設值為 `False`。 | 
| `center_map` | Boolean | 是否在建立的資料集中讓地圖置中。預設值為 `True`。 | 
| `id` | String | 資料集的唯一識別碼。如果您未提供，將會產生隨機 ID。 | 
| `label` | String | 顯示的資料集標籤。 | 
| `color` | Tuple[float, float, float] | 資料集的色彩標籤。 | 
| `metadata` | 字典 | 包含圖塊集中繼資料的物件 (適用於並排資料集)。 | 

**回應**

此 API 會傳回已新增至地圖的[資料集](https://location.foursquare.com/developer/docs/studio-map-sdk-types#dataset)物件。

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

更新現有資料集的設定。

**請求語法**

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

**請求參數**

該請求接受下列參數。

定位引數


| 引數 |  Type  |  Description  | 
| --- | --- | --- | 
| `dataset_id` | String | 要更新的資料集的識別碼。 | 
| `values` | Union[[\_DatasetUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#datasetupdateprops), dict, None] | 要更新的值。 | 

關鍵字引數


| 引數 |  Type  |  Description  | 
| --- | --- | --- | 
| `label` | String | 顯示的資料集標籤。 | 
| `color` | [RGBColor](https://location.foursquare.com/developer/docs/studio-map-sdk-types#rgbcolor) | 資料集的色彩標籤。 | 

**回應**

此 API 會傳回互動式地圖的已更新資料集物件，或是傳回非互動式 HTML 環境的 `None`。

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

將新圖層加入至地圖。此功能至少需要一個有效的圖層配置。

**請求語法**

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

**請求參數**

該請求接受下列參數。

引數


| 引數 |  Type  |  說明  | 
| --- | --- | --- | 
| `layer` | Union[[LayerCreationProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layercreationprops), dict, None] | 用於建立圖層的一組屬性。 | 

**回應**

加入至地圖的圖層物件。

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

使用指定的值更新現有圖層。

**請求語法**

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

**請求參數**

該請求接受下列參數。

引數


| 定位引數 |  Type  |  Description  | 
| --- | --- | --- | 
| `layer_id` | String | 欲更新的圖層 ID。 | 
| `values` | Union[[LayerUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerupdateprops), dict, None] | 要更新的值。 | 

關鍵字引數


| 引數 |  Type  |  說明  | 
| --- | --- | --- | 
| `type` | [LayerType](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layertype) | 圖層類型。 | 
| `data_id` | String | 此層視覺化的資料集的唯一識別碼。 | 
| `fields` | Dict [string, Optional[string]] | 將圖層視覺化所需的欄位對應到適當的資料集欄位的字典。 | 
| `label` | String | 此圖層的正式標籤。 | 
| `is_visible` | Boolean | 圖層是否可見。 | 
| `config` | [LayerConfig](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerconfig) | 特定於其類型的圖層配置。 | 

**回應**

傳回更新的圖層物件。

## visualize\_eoj\_aoi API
<a name="geo-visualize-eoj-aoi"></a>

視覺化特定任務 ARN 的 AoI。

**請求參數**

該請求接受下列參數。

引數


| 引數 |  Type  |  Description  | 
| --- | --- | --- | 
| `Arn` | String | 工作的 ARN。 | 
| `config` | 字典<br />config = { label: <string> custom label of the added AoI layer, default AoI } | 傳遞圖層屬性的選項。 | 

**回應**

新增的輸入圖層物件的參考。

## visualize\_eoj\_input API
<a name="geo-visualize-eoj-input"></a>

視覺化特定 EOJ ARN 的輸入。

**請求參數**

該請求接受下列參數。

引數


| 引數 |  Type  |  Description  | 
| --- | --- | --- | 
| `Arn` | String | 工作的 ARN。 | 
| `time_range_filter` | 字典<br />time\_range\_filter = {<br />start\_date: <string> ISO 格式的日期<br />end\_date: <string> ISO 格式的日期<br />} | 提供開始和結束時間的選項。預設為點陣式資料集合搜尋開始和結束日期。 | 
| `config` | 字典<br />config = { label: <string> custom label of the added output layer, default Input } | 傳遞圖層屬性的選項。 | 

**回應**

新增的輸入圖層物件的參考。

## visualize\_eoj\_output API
<a name="geo-visualize-eoj-output"></a>

視覺化特定 EOJ ARN 的輸出。

**請求參數**

該請求接受下列參數。

引數


| 引數 |  Type  |  Description  | 
| --- | --- | --- | 
| `Arn` | String | 工作的 ARN。 | 
| `time_range_filter` | 字典<br />time\_range\_filter = {<br />start\_date: <string> ISO 格式的日期<br />end\_date: <string> ISO 格式的日期<br />} | 提供開始和結束時間的選項。預設為點陣式資料集合搜尋開始和結束日期。 | 
| `config` | 字典<br />config = {<br />label: <string> 新增的輸出圖層的自訂標籤，預設輸出<br />preset: <string> singleBand 或 trueColor,<br />band\_name: <string>，僅 'singleBand' 預設需要。EOJ 允許的頻帶<br />} | 傳遞圖層屬性的選項。 | 

**回應**

新增的輸出圖層物件的參考。

若要進一步了解如何視覺化地理空間資料，請參閱[使用 Amazon SageMaker 地理空間視覺化](https://docs.aws.amazon.com/sagemaker/latest/dg/geospatial-visualize.html)。