API de sécurité dans AWS Glue
L'API de sécurité décrit les types de données de sécurité et l'API lié à la sécurité dans AWS Glue.
Types de données
Structure DataCatalogEncryptionSettings
Contient des informations de configuration sur le maintien de la sécurité du catalogue de données.
Champs
-
EncryptionAtRest: un objet EncryptionAtRest.Spécifie la configuration de chiffrage-au-repos pour le Catalogue de données.
-
ConnectionPasswordEncryption– Un objet ChiffrageMotDePasseConnexion.Lorsque la protection par mot de passe de connexion est activée, le Catalogue de données utilise une clé fournie par le client pour chiffrer le mot de passe dans le cadre de
CreateConnectionouUpdateConnectionet le stocke dans le champENCRYPTED_PASSWORDdes propriétés de connexion. Vous pouvez activer le chiffrage de catalogue ou uniquement le chiffrage de mot de passe.
Structure EncryptionAtRest
Spécifie la configuration de chiffrage-au-repos pour le Catalogue de données.
Champs
-
CatalogEncryptionMode– Obligatoire : Chaîne UTF-8 (valeurs valides :DISABLED|SSE-KMS="SSEKMS"|SSE-KMS-WITH-SERVICE-ROLE="SSEKMSWITHSERVICEROLE").Mode encryption-at-rest pour le chiffrement des données du catalogue de données.
-
SseAwsKmsKeyId– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.ID de la clé AWS KMS utilisée pour le chiffrement au repos.
-
CatalogEncryptionServiceRole– Chaîne UTF-8, correspondant au Custom string pattern #51.Rôle qu’AWS Glue endosse pour chiffrer et déchiffrer les objets du catalogue de données pour le compte de l’appelant.
Structure ConnectionPasswordEncryption
La structure des données utilisée par le Catalogue de données pour chiffrer le mot de passe dans le cadre de CreateConnection ou UpdateConnection et le stocker dans le champ ENCRYPTED_PASSWORD des propriétés de connexion. Vous pouvez activer le chiffrage de catalogue ou uniquement le chiffrage de mot de passe.
Lorsqu'une demande CreationConnection est envoyée avec un mot de passe, Data Catalog chiffre d'abord le mot de passe à l'aide de votre clé AWS KMS. Il chiffre de nouveau l'objet de connexion entier si le chiffrage de catalogue est également activé.
Ce chiffrement nécessite le réglage d'autorisations de clé AWS KMS pour activer ou restreindre l'accès à la clé de mot de passe selon vos exigences de sécurité. Par exemple, vous pourriez vouloir autoriser uniquement des administrateurs à disposer des autorisations de déchiffrement de la clé de mot de passe.
Champs
-
ReturnConnectionPasswordEncrypted– obligatoire : booléen.Lorsque le signalement
ReturnConnectionPasswordEncryptedest réglé sur « vrai », les mots de passe restent chiffrés dans les réponses deGetConnectionet deGetConnections. Ce chiffrage prend effet indépendamment du chiffrage de catalogue. -
AwsKmsKeyId– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Une clé AWS KMS utilisée pour chiffrer le mot de passe de connexion.
Si la protection de mot de passe de connexion est activée, l'utilisateur qui appelle
CreateConnectionetUpdateConnectiona au moins besoin de l'autorisationkms:Encryptsur la clé AWS KMS spécifiée pour chiffrer des mots de passe avant de les stocker dans Data Catalog.Vous pouvez régler l'autorisation de déchiffrage pour activer ou restreindre l'accès à la clé de mot de passe selon vos exigences de sécurité.
Structure EncryptionConfiguration
Spécifie une configuration de chiffrement.
Champs
-
S3Encryption: un tableau d’objets S3Encryption.Configuration de chiffrement pour les données Amazon Simple Storage Service (Amazon S3).
-
CloudWatchEncryption– Un objet CloudWatchEncryption.Configuration de chiffrement pour Amazon CloudWatch.
-
JobBookmarksEncryption– Un objet JobBookmarksEncryption.Configuration de chiffrement pour les signets de tâche.
-
DataQualityEncryption– Un objet DataQualityEncryption.Configuration du chiffrement pour les ressources de Qualité des données d’AWS Glue.
Structure S3Encryption
Spécifie la façon dont les données Amazon Simple Storage Service (Amazon S3) doivent être chiffrées.
Champs
-
S3EncryptionMode– Chaîne UTF-8 (valeurs valides :DISABLED|SSE-KMS="SSEKMS"|SSE-S3="SSES3").Mode de chiffrement à utiliser pour les données Amazon S3.
-
KmsKeyArn– Chaîne UTF-8, correspondant au Custom string pattern #29.L'Amazon Resource Name (ARN) de la clé KMS à utiliser pour chiffrer les données.
Structure CloudWatchEncryption
Spécifie la manière dont les données Amazon CloudWatch doivent être chiffrées.
Champs
-
CloudWatchEncryptionMode– Chaîne UTF-8 (valeurs valides :DISABLED|SSE-KMS="SSEKMS").Mode de chiffrement à utiliser pour les données CloudWatch.
-
KmsKeyArn– Chaîne UTF-8, correspondant au Custom string pattern #29.L'Amazon Resource Name (ARN) de la clé KMS à utiliser pour chiffrer les données.
Structure JobBookmarksEncryption
Spécifie la manière dont les données de signet de tâche doivent être chiffrées.
Champs
-
JobBookmarksEncryptionMode– Chaîne UTF-8 (valeurs valides :DISABLED|CSE-KMS="CSEKMS").Mode de chiffrement à utiliser pour les données de signet de tâche.
-
KmsKeyArn– Chaîne UTF-8, correspondant au Custom string pattern #29.L'Amazon Resource Name (ARN) de la clé KMS à utiliser pour chiffrer les données.
Structure SecurityConfiguration
Spécifie une configuration de sécurité.
Champs
-
Name– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Nom de la configuration de sécurité.
-
CreatedTimeStamp– Horodatage.Horodatage de la création de la configuration de sécurité.
-
EncryptionConfiguration: un objet EncryptionConfiguration.Configuration de chiffrement associée à cette configuration de sécurité.
Structure GluePolicy
Structure pour le renvoi d'une politique de ressources.
Champs
-
PolicyInJson— Chaîne UTF-8, d'une longueur minimale de 2 octets.Contient le document de politique demandé, au format JSON.
-
PolicyHash– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Contient la valeur de hachage associée à cette politique.
-
CreateTime– Horodatage.Date et heure de création de la politique.
-
UpdateTime– Horodatage.Date et heure de dernière mise à jour de la politique.
Structure DataQualityEncryption
Spécifie la manière dont les ressources de qualité des données de votre compte doivent être chiffrées.
Champs
-
DataQualityEncryptionMode– Chaîne UTF-8 (valeurs valides :DISABLED|SSE-KMS="SSEKMS").Mode de chiffrement à utiliser pour chiffrer les ressources de qualité des données. Ces ressources incluent des ensembles de règles de qualité des données, des résultats, des statistiques, des modèles de détection des anomalies et des observations.
Les valeurs valides sont
SSEKMSpour le chiffrement à l’aide d’une clé KMS gérée par le client, ouDISABLED. -
KmsKeyArn– Chaîne UTF-8, correspondant au Custom string pattern #29.L'Amazon Resource Name (ARN) de la clé KMS à utiliser pour chiffrer les données.
Opérations
Action GetDataCatalogEncryptionSettings (Python : get_data_catalog_encryption_settings)
Action PutDataCatalogEncryptionSettings (Python : put_data_catalog_encryption_settings)
DeleteResourcePolicy Action (Python: delete_resource_policy)
Action CreateSecurityConfiguration (Python : create_security_configuration)
Action DeleteSecurityConfiguration (Python : delete_security_configuration)
Action GetSecurityConfiguration (Python : get_security_configuration)
Action GetSecurityConfigurations (Python : get_security_configurations)
Action GetDataCatalogEncryptionSettings (Python : get_data_catalog_encryption_settings)
Récupère la configuration de sécurité d'un catalogue spécifié.
Demande
-
CatalogId– Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.ID du catalogue de données pour lequel extraire la configuration de sécurité. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.
Réponse
-
DataCatalogEncryptionSettings– Un objet DataCatalogEncryptionSettings.Configuration de sécurité demandée.
Erreurs
InternalServiceExceptionInvalidInputExceptionOperationTimeoutException
Action PutDataCatalogEncryptionSettings (Python : put_data_catalog_encryption_settings)
Définit la configuration de sécurité d'un catalogue spécifié. Une fois la configuration définie, le chiffrement spécifié est appliqué à chaque écriture ultérieure dans le catalogue.
Demande
-
CatalogId– Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.ID du catalogue de données pour lequel définir la configuration de sécurité. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.
-
DataCatalogEncryptionSettings– Obligatoire : un objet DataCatalogEncryptionSettings.Configuration de sécurité à définir.
Réponse
Paramètres d’absence de réponse.
Erreurs
InternalServiceExceptionInvalidInputExceptionOperationTimeoutException
PutResourcePolicy Action (Python: put_resource_policy)
Définit la politique de ressources du catalogue de données pour le contrôle d'accès.
Demande
-
PolicyInJson– Obligatoire : Chaîne UTF-8, d'une longueur minimale de 2 octets.Contient le document de politique à définir, au format JSON.
-
ResourceArn– chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant à Custom string pattern #49.Ne pas utiliser. Pour utilisation interne uniquement.
-
PolicyHashCondition– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.La valeur de hachage renvoyée lors de la définition de la politique précédente à l'aide de
PutResourcePolicy. Son objectif est d'empêcher les modifications simultanées d'une politique. N'utilisez pas ce paramètre si aucune politique précédente n'a été définie. -
PolicyExistsCondition– Chaîne UTF-8 (valeurs valides :MUST_EXIST|NOT_EXIST|NONE).La valeur
MUST_EXISTest utilisée pour mettre à jour une politique. La valeurNOT_EXISTest utilisée pour créer une politique. Si une valeurNONEou null est utilisée, l'appel ne dépend pas de l'existence d'une politique. -
EnableHybrid– Chaîne UTF-8 (valeurs valides :TRUE|FALSE).Si la valeur est
'TRUE', cela indique que vous utilisez les deux méthodes pour accorder un accès entre comptes aux ressources Data Catalog :-
En mettant directement à jour la politique de ressources avec
PutResourePolicy -
En utilisant la commande Grant persmissions (Accorder des autorisations) sur la AWS Management Console.
Doit être défini sur
'TRUE'si vous avez déjà utilisé la console de gestion pour accorder l'accès entre comptes, sinon l'appel échoue. La valeur par défaut est 'FALSE'. -
Réponse
-
PolicyHash– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Un hachage de la politique vient d'être défini. Cela doit être inclus dans un appel ultérieur qui remplace ou met à jour cette politique.
Erreurs
EntityNotFoundExceptionInternalServiceExceptionOperationTimeoutExceptionInvalidInputExceptionConditionCheckFailureException
GetResourcePolicy Action (Python: get_resource_policy)
Extrait une politique de ressource spécifiée.
Demande
-
ResourceArn– chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant à Custom string pattern #49.L'ARN de la ressource AWS Glue pour laquelle récupérer la politique de ressources. Si elle n'est pas fournie, la politique de ressources Data Catalog est renvoyée. Utilisez
GetResourcePoliciespour afficher toutes les politiques de ressources existantes. Pour plus d'informations, consultez Spécification des ARN de ressources AWS Glue.
Réponse
-
PolicyInJson— Chaîne UTF-8, d'une longueur minimale de 2 octets.Contient le document de politique demandé, au format JSON.
-
PolicyHash– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Contient la valeur de hachage associée à cette politique.
-
CreateTime– Horodatage.Date et heure de création de la politique.
-
UpdateTime– Horodatage.Date et heure de dernière mise à jour de la politique.
Erreurs
EntityNotFoundExceptionInternalServiceExceptionOperationTimeoutExceptionInvalidInputException
DeleteResourcePolicy Action (Python: delete_resource_policy)
Supprime une politique spécifiée.
Demande
-
PolicyHashCondition– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Valeur de hachage renvoyée lorsque cette politique a été définie.
-
ResourceArn– chaîne UTF-8, d'une longueur comprise entre 1 et 10 240 octets, correspondant à Custom string pattern #49.L'ARN de la ressource AWS Glue pour la politique de ressources à supprimer.
Réponse
Paramètres d’absence de réponse.
Erreurs
EntityNotFoundExceptionInternalServiceExceptionOperationTimeoutExceptionInvalidInputExceptionConditionCheckFailureException
Action CreateSecurityConfiguration (Python : create_security_configuration)
Crée une nouvelle configuration de sécurité. Une configuration de sécurité est un ensemble de paramètres de sécurité pouvant être utilisées par AWS Glue. Vous pouvez utiliser une configuration de sécurité pour chiffrer les données au repos. Pour plus d'informations sur l'utilisation des configurations de sécurité dans AWS Glue, consultez Chiffrement des données écrites par les crawlers, les tâches et les points de terminaison de développement.
Demande
-
Name– Obligatoire : Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Nom de la nouvelle configuration de sécurité.
-
EncryptionConfiguration– Obligatoire : un objet EncryptionConfiguration.Configuration de chiffrement associée à la nouvelle configuration de sécurité.
Réponse
-
Name– Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Nom affecté à la nouvelle configuration de sécurité.
-
CreatedTimestamp– Horodatage.Horodatage de la création de la nouvelle configuration de sécurité.
Erreurs
AlreadyExistsExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionResourceNumberLimitExceededException
Action DeleteSecurityConfiguration (Python : delete_security_configuration)
Supprime une configuration de sécurité spécifiée.
Demande
-
Name– Obligatoire : Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Nom de la configuration de sécurité à supprimer.
Réponse
Paramètres d’absence de réponse.
Erreurs
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutException
Action GetSecurityConfiguration (Python : get_security_configuration)
Extrait une configuration de sécurité spécifiée.
Demande
-
Name– Obligatoire : Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.Nom de la configuration de sécurité à récupérer.
Réponse
-
SecurityConfiguration– Un objet SecurityConfiguration.Configuration de sécurité demandée.
Erreurs
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutException
Action GetSecurityConfigurations (Python : get_security_configurations)
Extrait une liste de toutes les configurations de sécurité.
Demande
-
MaxResults– Nombre (entier), compris entre 1 et 1 000.Nombre maximal de résultats à renvoyer.
-
NextToken– Chaîne UTF-8.Jeton de continuation, s’il s’agit d’un appel de continuation.
Réponse
-
SecurityConfigurations: un tableau d’objets SecurityConfiguration.Liste de configurations de sécurité.
-
NextToken– Chaîne UTF-8.Jeton de liaison, s'il y a des configurations de sécurité supplémentaires à renvoyer.
Erreurs
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutException
GetResourcePolicies Action (Python: get_resource_policies)
Récupère les politiques de ressources définies sur les ressources individuelles par AWS Resource Access Manager lors de l'octroi d'autorisations entre comptes. Récupère également la politique de ressources Data Catalog.
Si vous avez activé le chiffrement des métadonnées dans les paramètres de Data Catalog et que vous n'avez pas d'autorisation sur la clé AWS KMS, l'opération ne peut pas renvoyer la politique de ressources Data Catalog.
Demande
-
NextToken– Chaîne UTF-8.Jeton de continuation, s’il s’agit d’une requête de continuation.
-
MaxResults– Nombre (entier), compris entre 1 et 1 000.La taille maximale d’une liste à renvoyer.
Réponse
-
GetResourcePoliciesResponseList: un tableau d’objets GluePolicy.Liste répertoriant chacune des politiques de ressources et politique de ressources au niveau du compte.
-
NextToken– Chaîne UTF-8.Un jeton de continuation, si la liste renvoyée ne contient pas la dernière politique de ressources disponible.
Erreurs
InternalServiceExceptionOperationTimeoutExceptionInvalidInputExceptionGlueEncryptionException