Amazon SageMaker 地理空間マップ SDK - Amazon SageMaker AI
add_dataset APIupdate_dataset APIadd_layer APIupdate_layer APIvisualize_eoj_aoi APIvisualize_eoj_input APIvisualize_eoj_output API

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

Amazon SageMaker 地理空間マップ SDK

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

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

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

String

データセットの一意の識別子。指定しない場合、ID がランダムに生成されます。

label

String

表示されるデータセットラベル。

color

Tuple[float、float、float]

データセットのカラーラベル。

metadata

辞書

タイルセットメタデータを含むオブジェクト (タイルデータセット用)。

レスポンス

この API は、マップに追加された Dataset オブジェクトを返します。

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

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

リクエストの構文

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

String

このレイヤーが視覚化するデータセットの一意の識別子。

fields

Dict [string、Optional[string]]

レイヤーの視覚化に必要なフィールドを適切なデータセットフィールドにマップするディクショナリ。

label

String

このレイヤーの標準ラベル。

is_visible

ブール値

レイヤーを表示するかどうか。

config

LayerConfig

そのタイプに固有のレイヤー設定。

レスポンス

更新されたレイヤーオブジェクトを返します。

visualize_eoj_aoi API

指定したジョブ ARN の AoI を視覚化します。

リクエストパラメータ

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

引数

引数

タイプ

説明

Arn

文字列

ジョブの ARN。

config

辞書

config = { label: <string> 追加された AoI レイヤーのカスタムラベル、デフォルト AoI }

レイヤープロパティを渡すオプション。

レスポンス

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

visualize_eoj_input API

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

リクエストパラメータ

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

引数

引数

タイプ

説明

Arn

文字列

ジョブの ARN。

time_range_filter

辞書

time_range_filter = {

start_date: <string> ISO 形式の日付

end_date: <string> ISO 形式の日付

}

開始時刻と終了時刻を指定するオプション。デフォルトはラスターデータコレクションの検索開始日と終了日です。

config

辞書

config = { label: <string> 追加された出力レイヤーのカスタムラベル、デフォルト入力 }

レイヤープロパティを渡すオプション。

レスポンス

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

visualize_eoj_output API

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

リクエストパラメータ

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

引数

引数

タイプ

説明

Arn

文字列

ジョブの ARN。

time_range_filter

辞書

time_range_filter = {

start_date: <string> ISO 形式の日付

end_date: <string> ISO 形式の日付

}

開始時刻と終了時刻を指定するオプション。デフォルトはラスターデータコレクションの検索開始日と終了日です。

config

辞書

config = {

label: <string> 追加された出力レイヤーのカスタムラベル、デフォルト出力 }

preset: <string> singleBand または trueColor,

band_name: <string>, 'singleBand' プリセットのみで必須. EOJ で使用できるバンド

}

レイヤープロパティを渡すオプション。

レスポンス

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

地理空間データの視覚化の詳細については、「Visualization Using Amazon SageMaker geospatial」を参照してください。