Exemples d'API Guardrail - AWS Control Tower

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.

Exemples d'API Guardrail

Exemple de saisie pour EnableControl :

Cet exemple montre comment spécifier le contrôle de garde-corps que vous souhaitez activer et activer ce contrôle pour l'unité d'organisation cible que vous identifiez.

{ controlIdentifier: "arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED", targetIdentifier: "arn:aws:organizations::123456789123:ou/o-kg8aXXXXXX/ou-prlj-a5kXXXXX" }

Exemple de sortie pour EnableControl :

À titre d'exemple d'utilisation de ce paramètre de sortie, vous pouvez transmettre leIdentifiant d'opérationparamètre en tant qu'entrée duGetControlOperationAPI, pour suivre l'état de vosEnableControlTâche.

{ "operationIdentifier":"e2bXXXXX-6cab-XXXX-bde7-XX0c6fXXXXXX" }

Exemple de commande de la CLI

aws controltower enable-control \ --control-identifier arn:aws:controltower:us-west-2::control/AWS-GR_AUDIT_BUCKET_POLICY_CHANGES_PROHIBITED \ --target-identifier arn:aws:organizations::123456789123:ou/o-qnilXXXXXX/ou-vwxu-qqlXXXXX \ --region us-west-2

Exemple de saisie pour DisableControl :

{ controlIdentifier: "arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED", targetIdentifier: "arn:aws:organizations::123456789123:ou/o-kg8aXXXXXX/ou-prlj-a5kXXXXX" }

Exemple de sortie pour DisableControl :

{ "operationIdentifier":"e2bXXXXX-8xai-XXXX-bde7-XX0c6fXXXXXX" }

Exemple de saisie pour GetControlOperation :

Lorsque vous donnez unIdentifiant d'opérationen entrée, vous recevez un message d'état en sortie.

{ operationIdentifier: "e2bXXXXX-6cab-XXXX-bde7-XX0c6fXXXXXX" }

Exemple de sortie pour GetControlOperation :

{ "ControlOperationStatus":{ "OperationType": "ENABLE_CONTROL", "StartTime": "2022-02-02T20:52:08.034Z", "Status": "IN_PROGRESS" } }

Exemple de sortie pour GetControlOperation :

{ "ControlOperationStatus": { "EndTime": "2022-04-28T19:36:31Z", "OperationType": "DISABLE_CONTROL", "StartTime": "2022-04-28T19:35:00Z", "Status": "SUCCEEDED" } }
{ "ControlOperationStatus": { "EndTime": "2022-04-28T19:36:31Z", "OperationType": "DISABLE_CONTROL", "StartTime": "2022-04-28T19:35:00Z", "Status": "FAILED", "StatusMessage": "AWS Control Tower cannot add the SCP because the IAM user or role does not have permission to perform the requested operation in AWS Organizations. To continue, update your access permissions for AWS Organizations. For more information, see Access Management in the IAM User Guide." } }

Exemple de saisie pour ListEnabledControls :

Cet exemple montre comment spécifier l'unité d'organisation cible en entrée, afin que vous puissiez recevoir une liste de contrôles en sortie.

{ targetIdentifier: "arn:aws:organizations::123456789123:ou/o-kg8aXXXXXX/ou-prlj-a5kXXXXX", nextToken: "bde7-XX0c6fXXXXXX", maxResults: 2 }

Exemple de sortie pour ListEnabledControls :

{ "enabledControls": [ { "controlIdentifier": "arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED" }, { "controlIdentifier": "arn:aws:controltower:us-west-2::control/AWS-GR_RESTRICT_ROOT_USER" } ], "nextToken": "e2bXXXXX-6cab-XXXX" }