SDK de mapas SageMaker geoespaciales de Amazon - Amazon SageMaker AI
API add_datasetAPI update_datasetAPI add_layerAPI update_layerAPI visualize_eoj_aoiAPI visualize_eoj_inputAPI visualize_eoj_output

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

SDK de mapas SageMaker geoespaciales de Amazon

Puede utilizar las capacidades SageMaker geoespaciales de Amazon para visualizar mapas dentro de la interfaz de usuario SageMaker geoespacial, así como SageMaker blocs de notas con una imagen geoespacial. Estas visualizaciones son compatibles con la biblioteca de visualización de mapas denominada Foursquare Studio

Puede utilizar lo que APIs proporciona el SDK de mapas SageMaker geoespaciales para visualizar sus datos geoespaciales, incluidas la entrada, la salida y el AoI de la EOJ.

API add_dataset

Agrega un objeto de conjunto de datos de ráster o vectoriales al mapa.

Sintaxis de la solicitud

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

Parámetros de solicitud

La solicitud acepta los siguientes parámetros.

Argumentos de posición

Argumento

Tipo

Descripción

dataset

Union[Dataset, Dict, None]

Datos utilizados para crear un conjunto de datos, en formato CSV, JSON o GeoJSON (para conjuntos de datos locales) o en una cadena de UUID.

Argumentos de palabras clave

Argumento

Tipo

Descripción

auto_create_layers

Booleano

Si se debe intentar crear nuevas capas al agregar un conjunto de datos. El valor predeterminado es False.

center_map

Booleano

Si se debe centrar el mapa en el conjunto de datos creado. El valor predeterminado es True.

id

Cadena

Identificador único del conjunto de datos. Si no lo proporciona, se genera un ID aleatorio.

label

Cadena

Etiqueta del conjunto de datos que se muestra.

color

Tuple[float, float, float]

Etiqueta de color del conjunto de datos.

metadata

Diccionario

Objeto que contiene metadatos de conjuntos de mosaicos (para conjuntos de datos en mosaico).

Respuesta

Esta API devuelve el objeto de Conjunto de datos que se agregó al mapa.

API update_dataset

Actualiza la configuración de un conjunto de datos existente.

Sintaxis de la solicitud

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

Parámetros de solicitud

La solicitud acepta los siguientes parámetros.

Argumentos de posición

Argumento

Tipo

Descripción

dataset_id

Cadena

El identificador del conjunto de datos que se va a actualizar.

values

Union [_DatasetUpdateProps, dict, None]

Los valores que se van a actualizar.

Argumentos de palabras clave

Argumento

Tipo

Descripción

label

Cadena

Etiqueta del conjunto de datos que se muestra.

color

RGBColor

Etiqueta de color del conjunto de datos.

Respuesta

Esta API devuelve el objeto del conjunto de datos actualizado para mapas interactivos o None para entornos HTML no interactivos.

API add_layer

Agrega una nueva capa al mapa. Esta función requiere al menos una configuración de capa válida.

Sintaxis de la solicitud

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

Parámetros de solicitud

La solicitud acepta los siguientes parámetros.

Argumentos

Argumento

Tipo

Descripción

layer

Unión [LayerCreationProps, dictado, ninguno]

Conjunto de propiedades que se utilizan para crear una capa.

Respuesta

El objeto de capa que se agregó al mapa.

API update_layer

Actualizar una capa existente con los valores dados.

Sintaxis de la solicitud

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

Parámetros de solicitud

La solicitud acepta los siguientes parámetros.

Argumentos

Argumento de posición

Tipo

Descripción

layer_id

Cadena

El ID de la capa que se va a actualizar.

values

Unión [LayerUpdateProps, dictado, ninguno]

Los valores que se van a actualizar.

Argumentos de palabras clave

Argumento

Tipo

Descripción

type

LayerType

Tipo de capa.

data_id

Cadena

Identificador único del conjunto de datos que visualiza esta capa.

fields

Dict [string, Optional[string]]

Diccionario que asigna los campos que la capa requiere para su visualización a los campos correspondientes del conjunto de datos.

label

Cadena

Etiqueta canónica de esta capa.

is_visible

Booleano

Si la capa es visible o no.

config

LayerConfig

Configuración de capas específica para su tipo.

Respuesta

Devuelve el objeto de capa actualizado.

API visualize_eoj_aoi

Visualización del AoI del ARN del trabajo dado.

Parámetros de solicitud

La solicitud acepta los siguientes parámetros.

Argumentos

Argumento

Tipo

Descripción

Arn

Cadena

El ARN del trabajo.

config

Diccionario

config = { label: <string> etiqueta personalizada de la capa de AoI agregado, AoI predeterminado}

Una opción para pasar las propiedades de la capa.

Respuesta

Referencia del objeto de la capa de entrada agregado.

API visualize_eoj_input

Visualización de la entrada del ARN del EOJ dado.

Parámetros de solicitud

La solicitud acepta los siguientes parámetros.

Argumentos

Argumento

Tipo

Descripción

Arn

Cadena

El ARN del trabajo.

time_range_filter

Diccionario

time_range_filter = {

start_date: <string> fecha en formato ISO

end_date: <string> fecha en formato ISO

}

Una opción para proporcionar la hora de inicio y finalización. El valor predeterminado es la fecha de inicio y finalización de la búsqueda de la recopilación de datos ráster.

config

Diccionario

config = { label: <string> etiqueta personalizada de la capa de salida agregada, entrada predeterminada }

Una opción para pasar las propiedades de la capa.

Respuesta

Referencia del objeto de la capa de entrada agregado.

API visualize_eoj_output

Visualización de la salida del ARN del EOJ dado

Parámetros de solicitud

La solicitud acepta los siguientes parámetros.

Argumentos

Argumento

Tipo

Descripción

Arn

Cadena

El ARN del trabajo.

time_range_filter

Diccionario

time_range_filter = {

start_date: <string> fecha en formato ISO

end_date: <string> fecha en formato ISO

}

Una opción para proporcionar la hora de inicio y finalización. El valor predeterminado es la fecha de inicio y finalización de la búsqueda de la recopilación de datos ráster.

config

Diccionario

config = {

label: <string> etiqueta personalizada de la capa de salida agregada, salida predeterminada

prestablecido: <string> singleBand o trueColor,

band_name: <string>, solo se requiere para el prestablecido 'singleBand’. Bandas permitidas para un EOJ

}

Una opción para pasar las propiedades de la capa.

Respuesta

Referencia del objeto de salida Layer agregado.

Para obtener más información sobre la visualización de sus datos geoespaciales, consulte Visualización mediante Amazon SageMaker geospatial.