翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

Amazon SageMaker の地理空間機能を使用すると、SageMaker 地理空間 UI 内のマップを視覚化できるほか、地理空間画像を含む SageMaker ノートブックも視覚化できます。これらの視覚化は [Foursquare Studio](https://studio.foursquare.com/home) というマップビジュアライゼーションライブラリによってサポートされています。

SageMaker 地理空間マップ SDK が提供する API を使用して、入力、出力、AoI 用の EOJ などの地理空間データを視覚化できます。

**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]
```

**リクエストパラメータ**

リクエストは、次のパラメータを受け付けます。

位置引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `dataset` | Union[Dataset、Dict、None] | データセットの作成に使用されるデータ。CSV、JSON、GeoJSON 形式 (ローカルデータセットの場合)、または UUID 文字列。 | 

キーワード引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `auto_create_layers` | ブール値 | データセットを追加する際に新しいレイヤーの作成を試みるかどうか。デフォルト値は `False` です。 | 
| `center_map` | ブール値 | 作成したデータセットでマップをセンタリングするかどうか。デフォルト値は `True` です。 | 
| `id` | String | データセットの一意の識別子。指定しない場合、ID がランダムに生成されます。 | 
| `label` | String | 表示されるデータセットラベル。 | 
| `color` | Tuple[float、float、float] | データセットのカラーラベル。 | 
| `metadata` | 辞書 | タイルセットメタデータを含むオブジェクト (タイルデータセット用)。 | 

**レスポンス**

この API は、マップに追加された [Dataset](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
```

**リクエストパラメータ**

リクエストは、次のパラメータを受け付けます。

位置引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `dataset_id` | 文字列 | 更新するデータセットの識別子。 | 
| `values` | Union[[\_DatasetUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#datasetupdateprops)、dict、None] | 更新する値。 | 

キーワード引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `label` | 文字列 | 表示されるデータセットラベル。 | 
| `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>

新しいレイヤーをマップに追加します。この機能では、少なくとも 1 つの有効なレイヤー構成が必要です。

**リクエストの構文**

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

**リクエストパラメータ**

リクエストは、次のパラメータを受け付けます。

引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `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
```

**リクエストパラメータ**

リクエストは、次のパラメータを受け付けます。

引数


| 位置引数 |  型  |  説明  | 
| --- | --- | --- | 
| `layer_id` | 文字列 | 更新するレイヤーの ID。 | 
| `values` | Union[[LayerUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerupdateprops)、dict、None] | 更新する値。 | 

キーワード引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `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` | ブール値 | レイヤーを表示するかどうか。 | 
| `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 を視覚化します。

**リクエストパラメータ**

リクエストは、次のパラメータを受け付けます。

引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `Arn` | 文字列 | ジョブの ARN。 | 
| `config` | 辞書<br />config = { label: <string> 追加された AoI レイヤーのカスタムラベル、デフォルト AoI } | レイヤープロパティを渡すオプション。 | 

**レスポンス**

追加された入力レイヤーオブジェクトの参照。

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

指定した EOJ ARN の入力を視覚化します。

**リクエストパラメータ**

リクエストは、次のパラメータを受け付けます。

引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `Arn` | 文字列 | ジョブの ARN。 | 
| `time_range_filter` | 辞書<br />time\_range\_filter = {<br />start\_date: <string> ISO 形式の日付<br />end\_date: <string> ISO 形式の日付<br />} | 開始時刻と終了時刻を指定するオプション。デフォルトはラスターデータコレクションの検索開始日と終了日です。 | 
| `config` | 辞書<br />config = { label: <string> 追加された出力レイヤーのカスタムラベル、デフォルト入力 } | レイヤープロパティを渡すオプション。 | 

**レスポンス**

追加された入力レイヤーオブジェクトの参照。

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

指定した EOJ ARN の出力を視覚化します。

**リクエストパラメータ**

リクエストは、次のパラメータを受け付けます。

引数


| 引数 |  型  |  説明  | 
| --- | --- | --- | 
| `Arn` | 文字列 | ジョブの 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 />} | レイヤープロパティを渡すオプション。 | 

**レスポンス**

追加された出力レイヤーオブジェクトの参照。

地理空間データの視覚化の詳細については、「[Visualization Using Amazon SageMaker geospatial](https://docs.aws.amazon.com/sagemaker/latest/dg/geospatial-visualize.html)」を参照してください。