Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# SDK de cartes SageMaker géospatiales Amazon
<a name="geospatial-notebook-sdk"></a>

Vous pouvez utiliser les fonctionnalités SageMaker géospatiales d'Amazon pour visualiser des cartes dans l'interface utilisateur SageMaker géospatiale ainsi que dans des SageMaker blocs-notes contenant une image géospatiale. Ces visualisations sont prises en charge par la bibliothèque de visualisation de cartes appelée [Foursquare Studio](https://studio.foursquare.com/home).

Vous pouvez utiliser les informations APIs fournies par le SDK de cartes SageMaker géospatiales pour visualiser vos données géospatiales, y compris les entrées, les sorties et l'AoI pour 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 visualise\_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>

Ajoute un objet de jeu de données matriciel ou vectoriel à la carte.

**Syntaxe de demande**

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

**Paramètres de requête**

La requête accepte les paramètres suivants.

Arguments positionnels


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `dataset` | Union[Dataset, Dict, None] | Données utilisées pour créer un jeu de données, au format CSV, JSON ou GeoJSON (pour les jeux de données locaux) ou sous forme de chaîne UUID. | 

Arguments de mots-clés


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `auto_create_layers` | Booléen | S'il faut essayer de créer de nouvelles couches lors de l'ajout d'un jeu de données. La valeur par défaut est `False`. | 
| `center_map` | Booléen | Indique si la carte doit être centrée sur le jeu de données créé. La valeur par défaut est `True`. | 
| `id` | String | Identifiant unique du jeu de données. Si vous ne le fournissez pas, un identifiant aléatoire est généré. | 
| `label` | String | Étiquette du jeu de données qui s'affiche. | 
| `color` | Tuple[float, float, float] | Étiquette de couleur du jeu de données. | 
| `metadata` | Dictionnaire | Objet contenant les métadonnées des jeux de tuiles (pour les jeux de données tuilés). | 

**Réponse**

Cette API renvoie l'objet [Dataset](https://location.foursquare.com/developer/docs/studio-map-sdk-types#dataset) (Jeu de données) qui a été ajouté à la carte.

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

Met à jour les paramètres d'un jeu de données existant.

**Syntaxe de demande**

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

**Paramètres de requête**

La requête accepte les paramètres suivants.

Arguments positionnels


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `dataset_id` | String | Identifiant du jeu de données à mettre à jour. | 
| `values` | Union [[\_ DatasetUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#datasetupdateprops), dict, Aucune] | Les valeurs à mettre à jour. | 

Arguments de mots-clés


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `label` | String | Étiquette du jeu de données qui s'affiche. | 
| `color` | [RGBColor](https://location.foursquare.com/developer/docs/studio-map-sdk-types#rgbcolor) | Étiquette de couleur du jeu de données. | 

**Réponse**

Cette API renvoie l'objet du jeu de données mis à jour pour les cartes interactives ou `None` pour les environnements HTML non interactifs. 

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

Ajoute une nouvelle couche à la carte. Cette fonction nécessite au moins une configuration de couche valide.

**Syntaxe de demande**

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

**Paramètres de requête**

La requête accepte les paramètres suivants.

Arguments


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `layer` | Union [[LayerCreationProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layercreationprops), dict, Aucune] | Un jeu de propriétés utilisé pour créer une couche. | 

**Réponse**

L'objet de couche qui a été ajouté à la carte.

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

Mettre à jour une couche existante avec des valeurs données.

**Syntaxe de demande**

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

**Paramètres de requête**

La requête accepte les paramètres suivants.

Arguments


| Argument positionnel |  Type  |  Description  | 
| --- | --- | --- | 
| `layer_id` | String | L'ID de la tâche à mettre à jour. | 
| `values` | Union [[LayerUpdateProps](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerupdateprops), dict, Aucune] | Les valeurs à mettre à jour. | 

Arguments de mots-clés


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `type` | [LayerType](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layertype) | Le type de couche. | 
| `data_id` | String | Identifiant unique du jeu de données visualisé par cette couche. | 
| `fields` | Dict [string, Optional[string]] | Dictionnaire qui mappe les champs dont la couche a besoin pour la visualisation avec les champs de jeu de données appropriés. | 
| `label` | String | Étiquette canonique de cette couche. | 
| `is_visible` | Booléen | Si la couche est visible ou non. | 
| `config` | [LayerConfig](https://location.foursquare.com/developer/docs/studio-map-sdk-types#layerconfig) | Configuration de couche spécifique à son type.  | 

**Réponse**

Renvoie l'objet de couche mis à jour.

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

Visualiser la zone d'intérêt de l'ARN de la tâche donnée.

**Paramètres de requête**

La requête accepte les paramètres suivants.

Arguments


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `Arn` | String | ARN de la tâche. | 
| `config` | Dictionnaire<br />config = { label: <string> custom label of the added AoI layer, default AoI } | Option permettant de transmettre les propriétés des couches. | 

**Réponse**

Référence de l'objet de couche d'entrée ajouté.

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

Visualiser l'entrée de l'ARN de la tâche d'observation de la Terre donnée.

**Paramètres de requête**

La requête accepte les paramètres suivants.

Arguments


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `Arn` | String | ARN de la tâche. | 
| `time_range_filter` | Dictionnaire<br />time\_range\_filter = {<br />start\_date: <string> date in ISO format<br />end\_date: <string> date in ISO format<br />} | Option permettant de fournir l'heure de début et de fin. La valeur par défaut est la date de début et de fin de la recherche dans la collecte de données matricielles. | 
| `config` | Dictionnaire<br />config = { label: <string> custom label of the added output layer, default Input } | Option permettant de transmettre les propriétés des couches. | 

**Réponse**

Référence de l'objet de couche d'entrée ajouté.

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

Visualiser la sortie de l'ARN de la tâche d'observation de la Terre donnée.

**Paramètres de requête**

La requête accepte les paramètres suivants.

Arguments


| Argument |  Type  |  Description  | 
| --- | --- | --- | 
| `Arn` | String | ARN de la tâche. | 
| `time_range_filter` | Dictionnaire<br />time\_range\_filter = {<br />start\_date: <string> date in ISO format<br />end\_date: <string> date in ISO format<br />} | Option permettant de fournir l'heure de début et de fin. La valeur par défaut est la date de début et de fin de la recherche dans la collecte de données matricielles. | 
| `config` | Dictionnaire<br />config = {<br />label: <string> custom label of the added output layer, default Output<br />preset: <string> singleBand or trueColor,<br />band\_name: <string>, only required for 'singleBand' preset. Bandes autorisées pour une tâche d'observation de la Terre<br />} | Option permettant de transmettre les propriétés des couches. | 

**Réponse**

Référence de l'objet de couche de sortie ajouté.

Pour en savoir plus sur la visualisation de vos données géospatiales, consultez [Visualisation à l'aide d'Amazon SageMaker ](https://docs.aws.amazon.com/sagemaker/latest/dg/geospatial-visualize.html) geospatial.