Amazon SageMaker Geospatial Map SDK

Sie können die SageMaker Geospatial-Funktionen von Amazon verwenden, um Karten innerhalb der SageMaker Geospatial-Benutzeroberfläche sowie SageMaker Notizbücher mit einem Geodatenbild zu visualisieren. Diese Visualisierungen werden von der Kartenvisualisierungsbibliothek namens Foursquare Studio unterstützt

Sie können die vom SageMaker Geospatial Map SDK bereitgestellten APIs verwenden, um Ihre Geodaten zu visualisieren, einschließlich Eingabe, Ausgabe und AoI für EOJ.

add_dataset-API

Fügt der Karte ein Raster- oder Vektor-Datensatz-Objekt hinzu.

Erforderliche Syntax

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

Anfrageparameter

Die Anfrage akzeptiert die folgenden Parameter.

Positionale Argumente

Argument	Typ	Beschreibung
dataset	Union [Datensatz, Diktat, Keine]	Daten, die zur Erstellung eines Datensatzes verwendet werden, im CSV-, JSON- oder GeoJSON-Format (für lokale Datensätze) oder in einer UUID-Zeichenfolge.

Schlüsselwort-Argumente

Argument	Typ	Beschreibung
auto_create_layers	Boolesch	Ob versucht werden soll, beim Hinzufügen eines Datensatzes neue Ebenen zu erstellen. Der Standardwert ist False.
center_map	Boolesch	Ob die Karte auf dem erstellten Datensatz zentriert werden soll. Der Standardwert ist True.
id	String	Eindeutige Kennung des Datensatzes. Wenn Sie ihn nicht angeben, wird eine zufällige ID generiert.
label	String	Datensatz-Bezeichnung, die angezeigt wird.
color	Tupel [Float, Float, Float]	Farbbezeichnung des Datensatzes.
metadata	Dictionary	Objekt, das Tileset-Metadaten enthält (für gekachelte Datensätze).

Antwort

Diese API gibt das Datensatz-Objekt zurück, das der Map hinzugefügt wurde.

update_dataset-API

Aktualisiert die bestehenden Datensatzeinstellungen.

Erforderliche Syntax

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

Anfrageparameter

Die Anfrage akzeptiert die folgenden Parameter.

Positionale Argumente

Argument	Typ	Beschreibung
dataset_id	String	Die Kennung des zu aktualisierenden Datensatzes.
values	Union [_ DatasetUpdate Props, dict, None]	Die zu aktualisierenden Werte.

Schlüsselwort-Argumente

Argument	Typ	Beschreibung
label	String	Datensatz-Bezeichnung, die angezeigt wird.
color	RGB-Farbe	Farbbezeichnung des Datensatzes.

Antwort

Diese API gibt das aktualisierte Datensatzobjekt für interaktive Karten oder None für nicht interaktive HTML-Umgebungen zurück.

add_layer-API

Fügt der Karte eine neue Ebene hinzu. Diese Funktion erfordert mindestens eine gültige Layer-Konfiguration.

Erforderliche Syntax

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

Anfrageparameter

Die Anfrage akzeptiert die folgenden Parameter.

Argumente

Argument	Typ	Beschreibung
layer	Union [LayerCreationRequisiten, Diktat, Keine]	Eine Reihe von Eigenschaften, die zum Erstellen einer Ebene verwendet werden.

Antwort

Das Ebenenobjekt, das der Karte hinzugefügt wurde.

update_layer-API

Aktualisieren Sie eine bestehende Ebene mit den angegebenen Werten.

Erforderliche Syntax

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

Anfrageparameter

Die Anfrage akzeptiert die folgenden Parameter.

Argumente

Positionale Argumente	Typ	Beschreibung
layer_id	String	Die ID der zu aktualisierenden Ebene.
values	Union [LayerUpdateRequisiten, Diktat, Keine]	Die zu aktualisierenden Werte.

Schlüsselwort-Argumente

Argument	Typ	Beschreibung
type	LayerType	Der Ebenentyp.
data_id	String	Eindeutige Kennung für den Datensatz, den dieser Layer visualisiert.
fields	Diktat [Zeichenfolge, optional [Zeichenfolge]]	Wörterbuch, das Felder, die der Layer für die Visualisierung benötigt, entsprechenden Datensatzfeldern zuordnet.
label	String	Kanonische Bezeichnung dieser Ebene.
is_visible	Boolesch	Ob die Ebene sichtbar ist oder nicht.
config	LayerConfig	Typspezifische Layer-Konfiguration.

Antwort

Gibt das aktualisierte Ebenenobjekt zurück.

visualize_eoj_aoi API

Visualisieren Sie die AoI des angegebenen Auftrags-ARN.

Anfrageparameter

Die Anfrage akzeptiert die folgenden Parameter.

Argumente

Argument	Typ	Beschreibung
Arn	String	Der ARN des Auftrags.
config	Dictionary config = {label: <string>benutzerdefiniertes Label der hinzugefügten AoI-Ebene, Standard-AoI}	Eine Option zum Übergeben von Ebeneneigenschaften.

Antwort

Referenz des hinzugefügten Eingabe-Layer-Objekts.

visualize_eoj_input API

Visualisieren Sie die Eingabe des angegebenen EOJ ARN.

Anfrageparameter

Die Anfrage akzeptiert die folgenden Parameter.

Argumente

Argument	Typ	Beschreibung
Arn	String	Der ARN des Auftrags.
time_range_filter	Dictionary time_range_filter = { <string>start_date: Datum im ISO-Format <string>end_date: Datum im ISO-Format }	Eine Option zur Angabe der Start- und Endzeit. Standardmäßig wird das Start- und Enddatum der Suche für die Raster-Datenerfassung verwendet.
config	Dictionary config = {label: <string>benutzerdefinierte Bezeichnung des hinzugefügten Ausgabe-Layers, Standardeingabe}	Eine Option zum Übergeben von Layer-Eigenschaften.

Antwort

Referenz des hinzugefügten Eingabe-Layer-Objekts.

visualize_eoj_output API

Visualisieren Sie die Ausgabe des angegebenen EOJ ARN.

Anfrageparameter

Die Anfrage akzeptiert die folgenden Parameter.

Argumente

Argument	Typ	Beschreibung
Arn	String	Der ARN des Auftrags.
time_range_filter	Dictionary time_range_filter = { <string>start_date: Datum im ISO-Format <string>end_date: Datum im ISO-Format }	Eine Option zur Angabe der Start- und Endzeit. Standardmäßig wird das Start- und Enddatum der Suche für die Raster-Datenerfassung verwendet.
config	Dictionary config = { label: <string>benutzerdefinierte Bezeichnung des hinzugefügten Ausgabe-Layers, Standardausgabe Voreinstellung: <string>SingleBand oder TrueColor, band_name:<string>, nur für die Voreinstellung 'SingleBand' erforderlich. Zulässige Bänder für ein EOJ }	Eine Option zum Übergeben von Layer-Eigenschaften.

Antwort

Referenz des hinzugefügten Ausgabe-Layer-Objekts.

Weitere Informationen zur Visualisierung Ihrer Geodaten finden Sie unter Visualization Using Amazon SageMaker Geospatial.