Catalogs-API

• Katalogstruktur

• CatalogInput Struktur

• TargetRedshiftCatalog Struktur

• CatalogProperties Struktur

• CatalogPropertiesOutput Struktur

• DataLakeAccessProperties Struktur

• IcebergOptimizationProperties Struktur

• DataLakeAccessPropertiesOutput Struktur

• IcebergOptimizationPropertiesOutput Struktur

• FederatedCatalog Struktur

Felder

• CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die ID des Katalogs. Um Zugriff auf den Standardkatalog zu gewähren, sollte dieses Feld nicht angegeben werden.

• Name— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 64 Byte lang, die dem Custom string pattern #30 entspricht.

  Der Name des Katalogs. Kann nicht mit der Konto-ID identisch sein.

• ResourceArn— UTF-8 Zeichenfolge.

  Der Amazon-Ressourcenname (ARN), der der Katalogressource zugewiesen ist.

• Description – Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.

  Beschreibende Zeichenfolge mit maximal 2.048 Bytes an, entsprechend der mehrzeiligen Zeichenfolgenmuster für URI-Adressen. Eine Beschreibung des Katalogs.

• Parameters – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Ein Map-Array von Schlüssel-Wert-Paaren, die Parameter und Eigenschaften des Katalogs definieren.

• CreateTime – Zeitstempel.

  Die Uhrzeit, zu der der Katalog erstellt wurde.

• UpdateTime – Zeitstempel.

  Die Uhrzeit, zu der der Katalog zuletzt aktualisiert wurde.

• TargetRedshiftCatalog – Ein TargetRedshiftCatalog-Objekt.

  Ein TargetRedshiftCatalog-Objekt, das einen Zielkatalog für die Verknüpfung von Datenbankressourcen beschreibt.

• FederatedCatalog – Ein FederatedCatalog-Objekt.

  Ein FederatedCatalog Objekt, das auf eine Entität außerhalb des AWS Glue Datenkatalogs verweist.

• CatalogProperties – Ein CatalogPropertiesOutput-Objekt.

  Ein CatalogProperties-Objekt, das die Eigenschaften für den Zugriff auf Data Lake und andere benutzerdefinierte Eigenschaften angibt.

• CreateTableDefaultPermissions – Ein Array mit PrincipalPermissions-Objekten.

  Ein Array von PrincipalPermissions-Objekten. Erstellt einen Satz von Standardberechtigungen für die Tabelle(n) für Prinzipale. Wird verwendet von AWS Lake Formation. Wird im normalen AWS Glue Betriebsablauf nicht verwendet.

• CreateDatabaseDefaultPermissions – Ein Array mit PrincipalPermissions-Objekten.

  Ein Array von PrincipalPermissions-Objekten. Erstellt einen Satz von Standardberechtigungen für die Datenbank(en) für Prinzipale. Wird verwendet von AWS Lake Formation. Wird im normalen AWS Glue Betriebsablauf nicht verwendet.

• AllowFullTableExternalDataAccess— UTF-8 Zeichenfolge (gültige Werte: True |False).

  Ermöglicht Engines von Drittanbietern den Zugriff auf Daten Amazon S3 an Orten, die bei Lake Formation registriert sind.

Felder

• Description – Beschreibende Zeichenfolge, nicht mehr als 2048 Bytes lang, passend zum URI address multi-line string pattern.

  Beschreibende Zeichenfolge mit maximal 2.048 Bytes an, entsprechend der mehrzeiligen Zeichenfolgenmuster für URI-Adressen. Eine Beschreibung des Katalogs.

• FederatedCatalog – Ein FederatedCatalog-Objekt.

  Ein FederatedCatalog-Objekt. Eine FederatedCatalog Struktur, die auf eine Entität außerhalb des AWS Glue Datenkatalogs verweist, beispielsweise eine Redshift-Datenbank.

• Parameters – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Ein Map-Array von Schlüssel-Wert-Paaren, die die Parameter und Eigenschaften des Katalogs definieren.

• TargetRedshiftCatalog – Ein TargetRedshiftCatalog-Objekt.

  Ein TargetRedshiftCatalog-Objekt, das einen Zielkatalog für die Verknüpfung von Ressourcen beschreibt.

• CatalogProperties – Ein CatalogProperties-Objekt.

  Ein CatalogProperties-Objekt, das die Eigenschaften für den Zugriff auf Data Lake und andere benutzerdefinierte Eigenschaften angibt.

• CreateTableDefaultPermissions – Ein Array mit PrincipalPermissions-Objekten.

  Ein Array von PrincipalPermissions-Objekten. Erstellt einen Satz von Standardberechtigungen für die Tabelle(n) für Prinzipale. Wird verwendet von AWS Lake Formation. Sollte normalerweise explizit als leere Liste festgelegt werden.

• CreateDatabaseDefaultPermissions – Ein Array mit PrincipalPermissions-Objekten.

  Ein Array von PrincipalPermissions-Objekten. Erstellt einen Satz von Standardberechtigungen für die Datenbank(en) für Prinzipale. Verwendet von AWS Lake Formation. Sollte normalerweise explizit als leere Liste festgelegt werden.

• AllowFullTableExternalDataAccess— UTF-8 Zeichenfolge (gültige Werte: True |False).

  Ermöglicht Engines von Drittanbietern den Zugriff auf Daten Amazon S3 an Orten, die bei Lake Formation registriert sind.

• OverwriteChildResourcePermissionsWithDefault— UTF-8 Zeichenfolge (gültige Werte: Accept |Deny).

  Überschreibt bestehende AWS Lake Formation Berechtigungen mit CatalogInput$CreateTableDefaultPermissions und CatalogInput$CreateDatabaseDefaultPermissions für alle untergeordneten Ressourcen.

Felder

• CatalogArn— Erforderlich: UTF-8 Zeichenfolge.

  Der Amazon-Ressourcenname (ARN) der Katalogressource.

Felder

• DataLakeAccessProperties – Ein DataLakeAccessProperties-Objekt.

  Ein DataLakeAccessProperties Objekt, das Eigenschaften zur Konfiguration des Data Lake-Zugriffs für Ihre Katalogressource im AWS Glue Datenkatalog angibt.

• IcebergOptimizationProperties – Ein IcebergOptimizationProperties-Objekt.

  Eine Struktur, die die Iceberg-Tabellenoptimierungseigenschaften für den Katalog festlegt. Dazu gehört die Konfiguration für Vorgänge zum Komprimieren, Aufbewahren und Löschen verwaister Dateien, die auf Iceberg-Tabellen in diesem Katalog angewendet werden können.

• CustomProperties – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Zusätzliche Schlüssel-Wert-Eigenschaften für den Katalog, beispielsweise Optimierungen der Spaltenstatistiken.

Felder

• DataLakeAccessProperties – Ein DataLakeAccessPropertiesOutput-Objekt.

  Ein DataLakeAccessProperties Objekt mit Eingabeeigenschaften zur Konfiguration des Data Lake-Zugriffs für Ihre Katalogressource im AWS Glue Datenkatalog.

• IcebergOptimizationProperties – Ein IcebergOptimizationPropertiesOutput-Objekt.

  Ein IcebergOptimizationPropertiesOutput-Objekt, das die Iceberg-Tabellenoptimierungseinstellungen für den Katalog festlegt, einschließlich Konfigurationen für Vorgänge zum Komprimieren, Aufbewahren und Löschen verwaister Dateien.

• CustomProperties – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Zusätzliche Schlüssel-Wert-Eigenschaften für den Katalog, beispielsweise Optimierungen der Spaltenstatistiken.

Felder

• DataLakeAccess – Boolesch.

  Aktiviert oder deaktiviert den Data Lake-Zugriff für Apache Spark-Anwendungen, die von einer Nicht-Redshift-Engine wie Amazon Athena, Amazon EMR oder ETL auf Amazon Redshift-Datenbanken im Datenkatalog zugreifen. AWS Glue

• DataTransferRole— Zeichenfolge UTF-8 , die dem entspricht. Custom string pattern #50

  Eine Rolle, die von AWS Glue für die Übertragung into/out von Daten aus dem Staging-Bucket während einer Abfrage übernommen wird.

• KmsKey— UTF-8 Zeichenfolge.

  Ein Verschlüsselungsschlüssel, der für den Staging-Bucket verwendet wird, der zusammen mit dem Katalog erstellt wird.

• CatalogType— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Gibt einen Verbundkatalogtyp für die systemeigene Katalogressource an. Der derzeit unterstützte Typ ist aws:redshift.

Felder

• RoleArn— UTF-8 Zeichenfolge, die dem entsprichtCustom string pattern #50.

  Der Amazon-Ressourcenname (ARN) der IAM-Rolle, von der angenommen wird, dass sie Vorgänge zur Iceberg-Tabellenoptimierung ausführt.

• Compaction – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Eine Zuordnung von Schlüssel-Wert-Paaren, die Konfigurationsparameter für Vorgänge zur Iceberg-Tabellenkomprimierung angeben, die das Layout von Datendateien optimieren, um die Abfrageleistung zu verbessern.

• Retention – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Eine Zuordnung von Schlüssel-Wert-Paaren, die Konfigurationsparameter für Vorgänge zur Iceberg-Tabellenaufbewahrung angeben, die den Lebenszyklus von Tabellen-Snapshots verwalten, um die Speicherkosten zu kontrollieren.

• OrphanFileDeletion – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Eine Zuordnung von Schlüssel-Wert-Paaren, die Konfigurationsparameter für Iceberg-Vorgänge zum Löschen verwaister Dateien angeben, mit denen Dateien identifiziert und entfernt werden, auf die in den Tabellenmetadaten nicht mehr verwiesen wird.

Felder

• DataLakeAccess – Boolesch.

  Aktiviert oder deaktiviert den Data-Lake-Zugriff für Apache Spark-Anwendungen, die auf Amazon-Redshift-Datenbanken im Datenkatalog zugreifen.

• DataTransferRole— UTF-8 Zeichenfolge, die dem entsprichtCustom string pattern #50.

  Eine Rolle, die von AWS Glue für die Übertragung into/out von Daten aus dem Staging-Bucket während einer Abfrage übernommen wird.

• KmsKey— UTF-8 Zeichenfolge.

  Ein Verschlüsselungsschlüssel, der für den Staging-Bucket verwendet wird, der zusammen mit dem Katalog erstellt wird.

• ManagedWorkgroupName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Der verwaltete Redshift-Serverless-Name der Datenverarbeitungsumgebung, der für Ihre Katalogressource erstellt wurde.

• ManagedWorkgroupStatus— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Der verwaltete Redshift-Serverless-Status der Datenverarbeitungsumgebung.

• RedshiftDatabaseName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Der Standardname der Redshift-Datenbankressource in der verwalteten Datenverarbeitungsumgebung.

• StatusMessage— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Eine Nachricht mit detaillierteren Informationen zum Status der verwalteten Arbeitsgruppe.

• CatalogType— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Gibt einen Verbundkatalogtyp für die systemeigene Katalogressource an. Der derzeit unterstützte Typ ist aws:redshift.

Felder

• RoleArn— UTF-8 Zeichenfolge, die dem Custom string pattern #50 entspricht.

  Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die verwendet wird, um Vorgänge zur Iceberg-Tabellenoptimierung auszuführen.

• Compaction – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Eine Zuordnung von Schlüssel-Wert-Paaren, die Konfigurationsparameter für Vorgänge zur Iceberg-Tabellenkomprimierung angeben, die das Layout von Datendateien optimieren, um die Abfrageleistung zu verbessern.

• Retention – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Eine Zuordnung von Schlüssel-Wert-Paaren, die Konfigurationsparameter für Vorgänge zur Iceberg-Tabellenaufbewahrung angeben, die den Lebenszyklus von Tabellen-Snapshots verwalten, um die Speicherkosten zu kontrollieren.

• OrphanFileDeletion – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine Schlüsselzeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang und entspricht dem Single-line string pattern.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 512000 Byte ist.

  Eine Zuordnung von Schlüssel-Wert-Paaren, die Konfigurationsparameter für Iceberg-Vorgänge zum Löschen verwaister Dateien angeben, mit denen Dateien identifiziert und entfernt werden, auf die in den Tabellenmetadaten nicht mehr verwiesen wird.

• LastUpdatedTime – Zeitstempel.

  Der Zeitstempel der letzten Aktualisierung der Eigenschaften zur Iceberg-Optimierung.

Felder

• Identifier— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 512 Byte lang ist und dem entsprichtSingle-line string pattern.

  Eine eindeutige Kennung für den Verbundkatalog.

• ConnectionName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Der Name der Verbindung zu einer externen Datenquelle, z. B. einem Redshift-federated Katalog.

• ConnectionType— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

  Der Typ der Verbindung, die für den Zugriff auf den Verbundkatalog verwendet wird, wobei das Protokoll oder die Methode für die Verbindung mit der externen Datenquelle angegeben wird.

• CreateCatalog Aktion (Python: create_catalog)

• UpdateCatalog Aktion (Python: update_catalog)

• DeleteCatalog Aktion (Python: delete_catalog)

• GetCatalog Aktion (Python: get_catalog)

• GetCatalogs Aktion (Python: get_catalogs)

Anforderung

• Name— Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 64 Byte lang, die dem entsprichtCustom string pattern #30.

  Der Name des zu erstellenden Katalogs.

• CatalogInput – Erforderlich: Ein CatalogInput-Objekt.

  Ein CatalogInput-Objekt, das die Metadaten für den Katalog definiert.

• Tags – Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare.

  Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist.

  Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 256 Byte ist.

  Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 50 Paare. Jeder Schlüssel ist eine UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Byte lang ist. Jeder Wert ist eine UTF-8 Zeichenfolge, die nicht länger als 256 Byte ist. Die Tags, die Sie dem Katalog zuweisen.

Antwort

• Keine Antwortparameter.

Fehler

• InvalidInputException

• AlreadyExistsException

• ResourceNumberLimitExceededException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• EntityNotFoundException

• FederatedResourceAlreadyExistsException

• FederationSourceException

Anforderung

• CatalogId – Erforderlich: Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die ID des Katalogs.

• CatalogInput – Erforderlich: Ein CatalogInput-Objekt.

  Ein CatalogInput-Objekt, das die neuen Eigenschaften eines vorhandenen Katalogs angibt.

Antwort

• Keine Antwortparameter.

Fehler

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• FederationSourceException

Anforderung

• CatalogId – Erforderlich: Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die ID des Katalogs.

Antwort

• Keine Antwortparameter.

Fehler

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• FederationSourceException

Anforderung

• CatalogId – Erforderlich: Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die ID des übergeordneten Katalogs, in dem der Katalog gespeichert ist. Wenn keine angegeben wird, wird standardmäßig die AWS Kontonummer verwendet.

Antwort

• Catalog – Ein Katalog-Objekt.

  Ein Catalog-Objekt. Die Definition des angegebenen Katalogs im AWS Glue Datenkatalog.

Fehler

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• AccessDeniedException

• EntityNotFoundException

• FederationSourceException

• FederationSourceRetryableException

Anforderung

• ParentCatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die ID des übergeordneten Katalogs, in dem der Katalog gespeichert ist. Wenn keine angegeben wird, wird standardmäßig die AWS Kontonummer verwendet.

• NextToken— UTF-8 Zeichenfolge.

  Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.

• MaxResults – Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 1000.

  Die maximale Anzahl der Kataloge, die in einer Antwort zurückgegeben werden können.

• Recursive – Boolesch.

  Gibt an, ob alle Kataloge in der Kataloghierarchie aufgelistet werden sollen, beginnend mit ParentCatalogId. Standardeinstellung: false. Bei true werden alle Katalogobjekte in der ParentCatalogID-Hierarchie in der Antwort aufgezählt.

• IncludeRoot – Boolesch.

  Gibt an, ob der Standardkatalog für das Konto und die Region in der Antwort aufgelistet werden soll. Standardeinstellung: false. Bei true und ParentCatalogId = NULL | AWS Account ID werden alle Kataloge und der Standardkatalog in der Antwort aufgelistet.

  Wenn ParentCatalogId nicht gleich null ist und dieses Attribut als false oder true übergeben wird, wird ein InvalidInputException ausgelöst.

• HasDatabases – Boolesch.

  Wenntrue, enthält die Antwort nur Kataloge, die Datenbanken enthalten können. Bei einigen Katalogen handelt es sich um Organisationscontainer, die nur andere Kataloge, keine Datenbanken enthalten. Wenn dieser Parameter auf festgelegt isttrue, werden diese reinen Container-Kataloge ausgeschlossen, und es werden nur Kataloge zurückgegeben, die Datenbanken enthalten können. Standardeinstellung: false.

Antwort

• CatalogList – Erforderlich: Ein Array mit Katalog-Objekten.

  Ein Array von Catalog-Objekten. Eine Liste von Catalog-Objekten aus dem angegebenen übergeordneten Katalog.

• NextToken— UTF-8 Zeichenfolge.

  Ein Fortsetzungs-Token zum Paginieren der zurückgegebenen Token-Liste. Wird zurückgegeben, wenn das aktuelle Segment der Liste nicht das letzte ist.

Fehler

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• AccessDeniedException

• EntityNotFoundException

• FederationSourceException

• FederationSourceRetryableException