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
<a name="geospatial-notebook-sdk"></a>

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](https://studio.foursquare.com/home)

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.

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

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

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  |  Description (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](https://location.foursquare.com/developer/docs/studio-map-sdk-types#dataset) que se agregó al mapa.

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

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  |  Description (Descripción)  | 
| --- | --- | --- | 
| `dataset_id` | Cadena | El identificador del conjunto de datos que se va a actualizar. | 
| `values` | Union [[\_DatasetUpdateProps, dict, None](https://location.foursquare.com/developer/docs/studio-map-sdk-types#datasetupdateprops)] | Los valores que se van a actualizar. | 

Argumentos de palabras clave


| Argumento |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
| `label` | Cadena | Etiqueta del conjunto de datos que se muestra. | 
| `color` | [RGBColor](https://location.foursquare.com/developer/docs/studio-map-sdk-types#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
<a name="geo-add-layer"></a>

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  |  Description (Descripción)  | 
| --- | --- | --- | 
| `layer` | Unión [[LayerCreationProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#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
<a name="geo-update-layer"></a>

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  |  Description (Descripción)  | 
| --- | --- | --- | 
| `layer_id` | Cadena | El ID de la capa que se va a actualizar. | 
| `values` | Unión [[LayerUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerupdateprops), dictado, ninguno] | Los valores que se van a actualizar. | 

Argumentos de palabras clave


| Argumento |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
| `type` | [LayerType](https://location.foursquare.com/developer/docs/studio-map-sdk-types#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](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerconfig) | Configuración de capas específica para su tipo.  | 

**Respuesta**

Devuelve el objeto de capa actualizado.

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

Visualización del AoI del ARN del trabajo dado.

**Parámetros de solicitud**

La solicitud acepta los siguientes parámetros.

Argumentos


| Argumento |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
| `Arn` | Cadena | El ARN del trabajo. | 
| `config` | Diccionario<br />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
<a name="geo-visualize-eoj-input"></a>

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

**Parámetros de solicitud**

La solicitud acepta los siguientes parámetros.

Argumentos


| Argumento |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
| `Arn` | Cadena | El ARN del trabajo. | 
| `time_range_filter` | Diccionario<br />time\_range\_filter = {<br />start\_date: <string> fecha en formato ISO<br />end\_date: <string> fecha en formato ISO<br />} | 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<br />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
<a name="geo-visualize-eoj-output"></a>

Visualización de la salida del ARN del EOJ dado

**Parámetros de solicitud**

La solicitud acepta los siguientes parámetros.

Argumentos


| Argumento |  Tipo  |  Description (Descripción)  | 
| --- | --- | --- | 
| `Arn` | Cadena | El ARN del trabajo. | 
| `time_range_filter` | Diccionario<br />time\_range\_filter = {<br />start\_date: <string> fecha en formato ISO<br />end\_date: <string> fecha en formato ISO<br />} | 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<br />config = {<br />label: <string> etiqueta personalizada de la capa de salida agregada, salida predeterminada<br />prestablecido: <string> singleBand o trueColor,<br />band\_name: <string>, solo se requiere para el prestablecido 'singleBand’. Bandas permitidas para un EOJ<br />} | 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 ](https://docs.aws.amazon.com/sagemaker/latest/dg/geospatial-visualize.html) geospatial.