API de catalogues

• Structure du catalogue

• CatalogInput structure

• TargetRedshiftCatalog structure

• CatalogProperties structure

• CatalogPropertiesOutput structure

• DataLakeAccessProperties structure

• DataLakeAccessPropertiesOutput structure

• FederatedCatalog structure

Champs

• CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  L'ID du catalogue. Pour autoriser l'accès au catalogue par défaut, ce champ ne doit pas être fourni.

• Name— Obligatoire : chaîne UTF-8, d'au moins 1 ou plus de 64 octets, correspondant au. Custom string pattern #25

  Le nom du catalogue. Il ne peut pas être identique à l'identifiant du compte.

• ResourceArn – Chaîne UTF-8.

  Le nom de ressource Amazon (ARN) attribué à la ressource du catalogue.

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au modèle de chaîne multiligne de l'adresse URI. Description du catalogue.

• Parameters – Tableau de mappage de paires valeur-clé.

  Chaque clé est une chaîne de clé, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 512 000 octets.

  Tableau cartographique de paires clé-valeur qui définissent les paramètres et les propriétés du catalogue.

• CreateTime – Horodatage.

  Heure à laquelle le catalogue a été créé.

• UpdateTime – Horodatage.

  Heure à laquelle le catalogue a été mis à jour pour la dernière fois.

• TargetRedshiftCatalog – Un objet TargetRedshiftCatalog.

  TargetRedshiftCatalogObjet qui décrit un catalogue cible pour la liaison de ressources de base de données.

• FederatedCatalog – Un objet FederatedCatalog.

  Un FederatedCatalog objet qui pointe vers une entité en dehors du catalogue de AWS Glue données.

• CatalogProperties – Un objet CatalogPropertiesOutput.

  CatalogPropertiesObjet qui spécifie les propriétés d'accès au lac de données et d'autres propriétés personnalisées.

• CreateTableDefaultPermissions – Un tableau d'objets PrincipalPermissions.

  Tableau d’objets PrincipalPermissions. Crée un ensemble d'autorisations par défaut sur la ou les tables pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des AWS Glue opérations.

• CreateDatabaseDefaultPermissions – Un tableau d'objets PrincipalPermissions.

  Tableau d’objets PrincipalPermissions. Crée un ensemble d'autorisations par défaut sur la ou les bases de données pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des AWS Glue opérations.

Champs

• Description – Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

  Chaîne de description, d'une longueur maximale de 2 048 octets, correspondant au modèle de chaîne multiligne de l'adresse URI. Description du catalogue.

• FederatedCatalog – Un objet FederatedCatalog.

  Un objet FederatedCatalog. FederatedCatalogStructure qui fait référence à une entité extérieure au catalogue de AWS Glue données, par exemple une base de données Redshift.

• Parameters – Tableau de mappage de paires valeur-clé.

  Chaque clé est une chaîne de clé, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 512 000 octets.

  Tableau cartographique de paires clé-valeur qui définissent les paramètres et les propriétés du catalogue.

• TargetRedshiftCatalog – Un objet TargetRedshiftCatalog.

  TargetRedshiftCatalogObjet qui décrit un catalogue cible pour la liaison de ressources.

• CatalogProperties – Un objet CatalogProperties.

  CatalogPropertiesObjet qui spécifie les propriétés d'accès au lac de données et d'autres propriétés personnalisées.

• CreateTableDefaultPermissions – Un tableau d'objets PrincipalPermissions.

  Tableau d’objets PrincipalPermissions. Crée un ensemble d'autorisations par défaut sur la ou les tables pour les principaux. Utilisé par AWS Lake Formation. Il doit généralement être défini explicitement sous forme de liste vide.

• CreateDatabaseDefaultPermissions – Un tableau d'objets PrincipalPermissions.

  Tableau d’objets PrincipalPermissions. Crée un ensemble d'autorisations par défaut sur la ou les bases de données pour les principaux. Utilisé par AWS Lake Formation. Il doit généralement être défini explicitement sous forme de liste vide.

Champs

• CatalogArn – Obligatoire : chaîne UTF-8.

  Le nom de ressource Amazon (ARN) de la ressource du catalogue.

Champs

• DataLakeAccessProperties – Un objet DataLakeAccessProperties.

  DataLakeAccessPropertiesObjet qui spécifie les propriétés permettant de configurer l'accès au lac de données pour la ressource de votre catalogue dans le catalogue de AWS Glue données.

• CustomProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une chaîne de clé, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 512 000 octets.

  Propriétés clé-valeur supplémentaires pour le catalogue, telles que l'optimisation des statistiques des colonnes.

Champs

• DataLakeAccessProperties – Un objet DataLakeAccessPropertiesOutput.

  DataLakeAccessPropertiesObjet doté de propriétés d'entrée permettant de configurer l'accès au lac de données pour les ressources de votre catalogue dans le catalogue de AWS Glue données.

• CustomProperties – Tableau de mappage de paires valeur-clé.

  Chaque clé est une chaîne de clé, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 512 000 octets.

  Propriétés clé-valeur supplémentaires pour le catalogue, telles que l'optimisation des statistiques des colonnes.

Champs

• DataLakeAccess – Booléen.

  Active ou désactive l'accès aux lacs de données pour les applications Apache Spark qui accèdent aux bases de données Amazon Redshift dans le catalogue de données à partir d'un moteur autre que Redshift, tel qu'Amazon Athena, Amazon EMR ou ETL. AWS Glue

• DataTransferRole – Chaîne UTF-8, correspondant au Custom string pattern #51.

  Rôle qui sera assumé par le transfert AWS Glue de données vers/depuis le compartiment intermédiaire lors d'une requête.

• KmsKey – Chaîne UTF-8.

  Une clé de chiffrement qui sera utilisée pour le bucket intermédiaire qui sera créé avec le catalogue.

• CatalogType – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Spécifie un type de catalogue fédéré pour la ressource de catalogue native. Le type actuellement pris en charge estaws:redshift.

Champs

• DataLakeAccess – Booléen.

  Active ou désactive l'accès au lac de données pour les applications Apache Spark qui accèdent aux bases de données Amazon Redshift dans le catalogue de données.

• DataTransferRole – Chaîne UTF-8, correspondant au Custom string pattern #51.

  Rôle qui sera assumé par le transfert AWS Glue de données vers/depuis le compartiment intermédiaire lors d'une requête.

• KmsKey – Chaîne UTF-8.

  Une clé de chiffrement qui sera utilisée pour le bucket intermédiaire qui sera créé avec le catalogue.

• ManagedWorkgroupName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Le nom de calcul Redshift Serverless géré créé pour votre ressource de catalogue.

• ManagedWorkgroupStatus – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  État du calcul Redshift Serverless géré.

• RedshiftDatabaseName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Nom de la ressource de base de données Redshift par défaut dans le calcul géré.

• StatusMessage – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Message qui fournit des informations plus détaillées sur l'état du groupe de travail géré.

• CatalogType – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Spécifie un type de catalogue fédéré pour la ressource de catalogue native. Le type actuellement pris en charge estaws:redshift.

Champs

• Identifier – Chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets, correspondant au Single-line string pattern.

  Identifiant unique pour le catalogue fédéré.

• ConnectionName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Nom de la connexion à une source de données externe, par exemple un catalogue fédéré par Redshift.

• CreateCatalog action (Python : create_catalog)

• UpdateCatalog action (Python : update_catalog)

• DeleteCatalog action (Python : supprimer_catalogue)

• GetCatalog action (Python : get_catalog)

• GetCatalogs action (Python : get_catalogs)

Demande

• Name— Obligatoire : chaîne UTF-8, d'au moins 1 ou plus de 64 octets, correspondant au. Custom string pattern #25

  Nom du catalogue à créer.

• CatalogInput – Obligatoire : un objet CatalogInput.

  CatalogInputObjet qui définit les métadonnées du catalogue.

• Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets.

  Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 256 octets.

  Un tableau cartographique de paires clé-valeur, pas plus de 50 paires. Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets. Chaque valeur est une chaîne UTF-8, d'une longueur maximale de 256 octets. Les tags que vous attribuez au catalogue.

Réponse

• Paramètres d'absence de réponse.

Erreurs

• InvalidInputException

• AlreadyExistsException

• ResourceNumberLimitExceededException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• EntityNotFoundException

• FederatedResourceAlreadyExistsException

• FederationSourceException

Demande

• CatalogId – Obligatoire : Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  L'ID du catalogue.

• CatalogInput – Obligatoire : un objet CatalogInput.

  CatalogInputObjet spécifiant les nouvelles propriétés d'un catalogue existant.

Réponse

• Paramètres d'absence de réponse.

Erreurs

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• FederationSourceException

Demande

• CatalogId – Obligatoire : Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  L'ID du catalogue.

Réponse

• Paramètres d'absence de réponse.

Erreurs

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• ConcurrentModificationException

• AccessDeniedException

• FederationSourceException

Demande

• CatalogId – Obligatoire : Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  ID du catalogue parent dans lequel réside le catalogue. Si aucun numéro n'est fourni, le numéro de AWS compte est utilisé par défaut.

Réponse

• Catalog – Un objet Catalogue.

  Un objet Catalog. Définition du catalogue spécifié dans le catalogue de AWS Glue données.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• AccessDeniedException

• EntityNotFoundException

• FederationSourceException

• FederationSourceRetryableException

Demande

• ParentCatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  ID du catalogue parent dans lequel réside le catalogue. Si aucun numéro n'est fourni, le numéro de AWS compte est utilisé par défaut.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, s'il s'agit d'un appel de continuation.

• MaxResults – Nombre (entier), compris entre 1 et 1 000.

  Le nombre maximum de catalogues à renvoyer en une seule réponse.

• Recursive – Booléen.

  Lorsque cette valeur est définie sur true, parcourt le compte et renvoie toutes les ressources du catalogue (y compris les ressources de haut niveau et les ressources secondaires)

Réponse

• CatalogList – Obligatoire : Un tableau d'objets Catalogue.

  Tableau d’objets Catalog. Liste des Catalog objets du catalogue parent spécifié.

• NextToken – Chaîne UTF-8.

  Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n'est pas le dernier.

Erreurs

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

• AccessDeniedException

• EntityNotFoundException

• FederationSourceException

• FederationSourceRetryableException