DisableBaseline EnableBaseline GetBaseline GetBaselineOperation GetEnabledBaseline ListBaselines ListEnabledBaselines ResetEnabledBaseline UpdateEnabledBaseline

Exemples d'utilisation de base de l'API

Cette section contient des exemples de paramètres d'entrée et de sortie pour les API de base d'AWS Control Tower.

`DisableBaseline`

Pour plus d'informations sur cette opération d'API, consultez DisableBaseline.

DisableBaselineentrée :


{
    "enabledBaselineIdentifier": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/AB12CD34EF56GH789"
}

DisableBaselinesortie :


{
    "operationIdentifier": "58f12232-26be-4735-a3e9-dd30d90f021f"
}

Exemple de commande DisableBaseline CLI :


aws controltower disable-baseline \
    --enabled-baseline-identifier arn:aws:controltower:us-west-2:123456789012:enabledbaseline/AB12CD34EF56GH789 \
    --region us-west-2

`EnableBaseline`

Pour plus d'informations sur cette opération d'API, consultez EnableBaseline.

EnableBaselineentrée :


{
    "baselineIdentifier": "arn:aws:controltower:us-west-2::baseline:17BSJV3IGJ2QSGA2",
    "targetIdentifier": "arn:aws:organizations::123456789012:ou/o-kgj0txdhpa/ou-r9mj-4j3mzjql",
    "baselineVersion": "3.0",
    "parameters": [
        {
            "key": "IdentityCenterEnabledBaselineArn",
            "value": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHCR4CJTSI4W07MZ"
        }
    ]
}

EnableBaselinesortie, renvoyant une nouvelle ressource :


{
    "operationIdentifier": "58f12232-26be-4735-a3e9-dd30d90f021f",
    "arn": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAGF7TNOHRD7ES5VV"
}

Exemple de commande EnableBaseline CLI :

Cet exemple montre comment activer une base de référence pour une AWS Organizations organisation dont la zone de destination a activé l'accès à AWS IAM Identity Center, géré par AWS Control Tower. Pour récupérer votre EnabledBaseline identifiant Identity Center, vous pouvez appeler l'ListEnabledBaselinesAPI en filtrant sur la base de référence Identity Center : (arn:aws:controltower:Region::baseline/LN25R72TTG6IGPTQ)


aws controltower list-enabled-baselines \
    --filter baselineIdentifiers=arn:aws:controltower:us-west-2::baseline/LN25R72TTG6IGPTQ \
    --region us-west-2

La réponse affichera le EnabledBaseline détail, qui indique son identifiant.


{
    "enabledBaselines": [
        {
            "arn": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHXS7P6C4I453EZC",
            "baselineIdentifier": "arn:aws:controltower:us-west-2::baseline/LN25R72TTG6IGPTQ",
            "targetIdentifier": "arn:aws:organizations::123456789012:account/o-aq21sw43de5/123456789012",
            "statusSummary": {
                "status": "SUCCEEDED"
            }
        }
    ]
}

Note

Prenez note de la valeur ARN de la réponse et transmettez-la en tant que paramètre pour activer la référence par défaut.


aws controltower enable-baseline \
    --baseline-identifier arn:aws:controltower:us-west-2::baseline/17BSJV3IGJ2QSGA2 \
    --baseline-version 3.0 \
    --target-identifier arn:aws:organizations::123456789012:ou/o-aq21sw43de5/ou-po90-lk87jh65 \
    --parameters '[{"key":"IdentityCenterEnabledBaselineArn","value":"arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHXS7P6C4I453EZC"}]' \
    --region us-west-2

Pour une organisation dont la zone d'atterrissage a été supprimée de la gestion d'IAM Identity Center par AWS Control Tower, activez la base de référence sans le paramètre.


aws controltower enable-baseline \
    --baseline-identifier arn:aws:controltower:us-west-2::baseline/17BSJV3IGJ2QSGA2 \
    --baseline-version 3.0 \
    --target-identifier arn:aws:organizations::123456789012:ou/o-aq21sw43de5/ou-po90-lk87jh65 \
    --region us-west-2

`GetBaseline`

Pour plus d'informations sur cette opération d'API, consultez GetBaseline.

GetBaselineentrée :


{
    "baselineIdentifier": "arn:aws:controltower:us-west-2::baseline/17BSJV3IGJ2QSGA2"
}

GetBaselinesortie :


{
    "arn": "arn:aws:controltower:us-west-2::baseline/17BSJV3IGJ2QSGA2",
    "name": "AWSControlTowerBaseline",
    "description": "Sets up resources and mandatory controls for member accounts within the target OU, required for AWS Control Tower governance.",
}

Exemple de commande GetBaseline CLI :


aws controltower get-baseline \
    --baseline-identifier arn:aws:controltower:us-west-2::baseline/17BSJV3IGJ2QSGA2 \
    --region us-west-2

`GetBaselineOperation`

Pour plus d'informations sur cette opération d'API, consultez GetBaselineOperation.

GetBaselineOperationentrée :


{
    "operationIdentifier": "58f12232-26be-4735-a3e9-dd30d90f021f"
}

GetBaselineOperationsortie :


{
    "baselineOperation": {
        "operationIdentifier": "58f12232-26be-4735-a3e9-dd30d90f021f",
        "operationType": "DISABLE_BASELINE",
        "status": "FAILED",
        "startTime": "2023-01-12T19:05:00Z",
        "endTime": "2023-01-12T19:45:00Z",
        "statusMessage": "Can't perform DisableBaseline on a parent target with governed child OUs"
    }
}

Exemple de commande GetBaselineOperation CLI :


aws controltower get-baseline-operation \
    --operation-identifier 58f12232-26be-4735-a3e9-dd30d90f021f \
    --region us-west-2

`GetEnabledBaseline`

Pour plus d'informations sur cette opération d'API, consultez GetEnabledBaseline.

GetEnabledBaselineentrée :


{
    "enabledBaselineIdentifier": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHCR4CJTSI4W07MZ"
}

GetEnabledBaselinesortie :


{
    "enabledBaselineDetails": {
        "arn": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHCR4CJTSI4W07MZ",
        "baselineIdentifier": "arn:aws:controltower:us-west-2::baseline:17BSJV3IGJ2QSGA2",
        "baselineVersion": "3.0",
        "targetIdentifier": "arn:aws:organizations::123456789012:ou/o-kgj0txdhpa/ou-r9mj-4j3mzjql",
        "statusSummary": {
            "status": "SUCCEEDED",
            "lastOperationIdentifier": "58f12232-26be-4735-a3e9-dd30d90f021f"
        },
        "parameters": [
            {
                "key": "IdentityCenterEnabledBaselineArn",
                "value": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHCR4CJTSI4W07MZ"
            }
        ]
    }
}

Exemple de commande GetEnabledBaseline CLI :


aws controltower get-enabled-baseline \
    --enabled-baseline-identifier arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHXS7P6C4I453EZC \
    --region us-west-2

`ListBaselines`

Pour plus d'informations sur cette opération d'API, consultez ListBaselines.

ListBaselinesentrée (à l'aide d'entrées facultatives) :


{
    "nextToken": "AbCd1234",
    "maxResults": "4"
}

ListBaselinessortie :


{
    "baselines": [
        {
            "arn": "arn:aws:controltower:us-east-1::baseline/4T4HA1KMO10S6311",
            "name": "AuditBaseline",
            "description": "Sets up resources to monitor security and compliance of accounts in your organization."
        },
        {
            "arn": "arn:aws:controltower:us-east-1::baseline/J8HX46AHS5MIKQPD",
            "name": "LogArchiveBaseline",
            "description": "Sets up a central repository for logs of API activities and resource configurations from accounts in your organization."
        },
        {
            "arn": "arn:aws:controltower:us-east-1::baseline/LN25R72TTG6IGPTQ",
            "name": "IdentityCenterBaseline",
            "description": "Sets up shared resources for AWS Identity Center, which prepares the AWSControlTowerBaseline to set up Identity Center access for accounts."
        },
        {
            "arn": "arn:aws:controltower:us-east-1::baseline/17BSJV3IGJ2QSGA2",
            "name": "AWSControlTowerBaseline",
            "description": "Sets up resources and mandatory controls for member accounts within the target OU, required for AWS Control Tower governance."
        },
        {
            "arn": "arn:aws:controltower:us-east-1::baseline/3WPD0NA6TJ9AOMU2",
            "name": "BackupCentralVaultBaseline",
            "description": "Sets up central AWS Backup vault in your organization."
        },
        {
            "arn": "arn:aws:controltower:us-east-1::baseline/H6C5JFCJJ3CPU3J5",
            "name": "BackupManagerBaseline",
            "description": "Sets up delegated admin and AWS Backup Audit Manager."
        },
        {
            "arn": "arn:aws:controltower:us-east-1::baseline/APO9ATVPBKFRRGLK",
            "name": "BackupBaseline",
            "description": "Sets up local Backup vault and attach Backup policy."
        }
    ]
}

Exemple de commande ListBaselines CLI :


aws controltower list-baselines \
    --region us-west-2

`ListEnabledBaselines`

L'ListEnabledBaselinesAPI possède un paramètre facultatif qui vous permet de visualiser les lignes de base telles qu'elles s'appliquent aux comptes membres d'une unité d'organisation. Les exemples suivants présentent certaines commandes de l'interface de ligne de commande que vous pouvez utiliser pour afficher les lignes de base d'un compte. AWS Control Tower fait référence à ces lignes de base, qui sont activées sur l'unité d'organisation, mais s'appliquent à chaque compte de l'unité d'organisation, en tant que lignes de base activées pour les enfants, car elles tirent leur configuration de gouvernance des lignes de base appliquées à l'unité d'organisation.

Pour plus d'informations sur cette opération d'API, consultez ListEnabledBaselines.

ListEnabledBaselinesentrée pour afficher les lignes de base activées pour les enfants :


aws controltower list-enabled-baselines --include-children

ListEnabledBaselinessortie pour afficher les lignes de base activées pour les enfants :


{
    "enabledBaselines": [
        {
            "arn": "arn:aws:controltower:us-east-1:666355521292:enabledbaseline/XO2UQ1PC6BB5085S5",
            "baselineIdentifier": "arn:aws:controltower:us-east-1::baseline/APO9ATVPBKFRRGLK",
            "baselineVersion": "1.0",
            "statusSummary": {
                "lastOperationIdentifier": "07d6d2b8-e357-4f96-ba00-98ea88143445",
                "status": "SUCCEEDED"
            },
            "targetIdentifier": "arn:aws:organizations::666355521292:ou/o-vaex10vaey/ou-k86y-ld9k8vpu"
        },
        {
            "arn": "arn:aws:controltower:us-east-1:666355521292:enabledbaseline/XAFPKQQXOJB50ZWQH",
            "baselineIdentifier": "arn:aws:controltower:us-east-1::baseline/APO9ATVPBKFRRGLK",
            "baselineVersion": "1.0",
            "parentIdentifier": "arn:aws:controltower:us-east-1:666355521292:enabledbaseline/XOIZ4G08CWB50ZWON",
            "statusSummary": {
                "lastOperationIdentifier": "3508793e-48c8-4895-965b-3dc6abd52b6b",
                "status": "SUCCEEDED"
            },
            "targetIdentifier": "arn:aws:organizations::666355521292:account/o-vaex10vaey/183295447314"
        }
]

Note

Dans l'exemple précédent, le parentIdentifier champ indique la référence activée de l'unité d'organisation parent pour cette ligne de base activée pour les enfants.

Afficher toutes les valeurs de référence appliquées à une cible spécifique (UO ou compte) :


aws controltower list-enabled-baselines \
    --filter '{
        "targetIdentifiers": ["TARGET_ARN"]
    }

Afficher toutes les unités d'organisation qui ont une base de référence spécifique :


aws controltower list-enabled-baselines \
    --filter '{
        "baselineIdentifiers": ["BASELINE_ARN"]
    }'

Consultez toutes les unités d'organisation et tous les comptes qui ont une base de référence spécifique :


aws controltower list-enabled-baselines \
    --filter '{
        "baselineIdentifiers": ["BASELINE_ARN"]
    }'  \
    --include-children

Afficher tous les comptes d'une unité d'organisation sur lesquels Baseline B est activé :


### First fetch the enabled baseline record for Baseline B on the OU
 aws controltower list-enabled-baselines \
    --filter '{
        "targetIdentifiers": ["OU_TARGET_ARN"],
        "baselineIdentifiers": ["BASELINE_ARN_FOR_BASELINE_B"]
    }'
    
### Call ListEnabled baseline to fetch all accounts that have their parent as the enabled baseline record on the OU
aws controltower list-enabled-baselines \
    --filter '{
        "parentIdentifiers": ["ENABLED_BASELINE_ARN_FOR_OU"]
    }' \
    --include-children

En savoir plus sur les lignes de base activées pour les enfants

Vous pouvez utiliser l'GetEnabledBaselineAPI pour afficher des informations détaillées sur une référence spécifique activée pour les enfants
Vous pouvez utiliser l'GetBaselineOperationAPI pour afficher une opération effectuée sur la référence activée pour les enfants.
Vous ne pouvez pas appeler directement d'API d'écritureEnableBaseline, telle queUpdateEnabledBaseline, ResetEnabledBaseline ouDisableBaseline, sur une référence activée pour les enfants.
Les ressources de base activées pour les enfants peuvent être modifiées au moyen du service AWS Control Tower uniquement, par le biais d'opérations effectuées sur l'unité d'organisation parente ou via Account Factory.

Exemples d'utilisation de filtres :

ListEnabledBaselinesentrée (aucun filtre) :


{
    "nextToken": "bde7-XX0c6fXXXXXX",
    "maxResults": 5
}

ListEnabledBaselinesentrée (baselineIdentifiersfiltre uniquement) :


{
    "filter": {
        "baselineIdentifiers": ['arn:aws:controltower:us-east-1::baseline/17BSJV3IGJ2QSGA2', 'arn:aws:controltower:us-east-1::baseline/12GZU8CKZKVMS2AW']
    },
    "nextToken": "bde7-XX0c6fXXXXXX",
    "maxResults": 5
}

ListEnabledBaselinesentrée (targetIdentifiersfiltre uniquement) :


{
    "filter": {
        "targetIdentifiers": ['arn:aws:organizations::123456789012:ou/o-s9511vn103/ou-xqj7-fex1u317', 'arn:aws:organizations::123456789012:ou/o-s9511vn103/ou-xqj7-11q6n2cf']
    },
    "nextToken": "bde7-XX0c6fXXXXXX",
    "maxResults": 2
}

ListEnabledBaselinesentrée (baselineIdentifierset targetIdentifiers filtres) :


{
    "filter": {
        "baselineIdentifiers": ['arn:aws:controltower:us-east-1::baseline/17BSJV3IGJ2QSGA2']
        "targetIdentifiers": ['arn:aws:organizations::123456789012:ou/o-s9511vn103/ou-xqj7-fex1u317']
    },
    "nextToken": "bde7-XX0c6fXXXXXX",
    "maxResults": 5
}

ListEnabledBaselinessortie :


{
    "enabledBaselines": [
        {
            "arn": "arn:aws:controltower:us-east-1:123456789012:enabledbaseline/XAHCR4CJTSI4W07MZ",
            "baselineIdentifier": "arn:aws:controltower:us-east-1::baseline:17BSJV3IGJ2QSGA2",
            "baselineVersion": "3.0",
            "targetIdentifier": "arn:aws:organizations::123456789012:ou/o-kgj0txdhpa/ou-r9mj-4j3mzjql",
            "statusSummary": {
                "status": "SUCCEEDED",
                "lastOperationIdentifier": "58f12232-26be-4735-a3e9-dd30d90f021f"
            }
        },
        {
            "arn": "arn:aws:controltower:us-east-1:123456789012:enabledbaseline/XAJ9NKW88AA4W9CLL",
            "baselineIdentifier": "arn:aws:controltower:us-east-1::baseline:17BSJV3IGJ2QSGA2",
            "baselineVersion": "4.0",
            "targetIdentifier": "arn:aws:organizations::123456789012:ou/o-s9511vn103/ou-xqj7-fex1u317",
            "statusSummary": {
            "status": "FAILED",
                "lastOperationIdentifier": "81e02df1-2b4d-48f0-838f-3833b93dcdc0"
            }
        }
    ],
    "nextToken": "e2bXXXXX6cab"
}

Exemple de CLI avec un type de filtre (baselineIdentifiersfiltre) :


aws controltower list-enabled-baselines \
    --filter baselineIdentifiers=arn:aws:controltower:us-west-2::baseline/17BSJV3IGJ2QSGA2,arn:aws:controltower:us-west-2::baseline/LN25R72TTG6IGPTQ \
    --region us-west-2

Exemple de CLI utilisant plusieurs filtres (baselineIdentifierset targetIdentifiers filtres) :


aws controltower list-enabled-baselines \
    --filter targetIdentifiers=arn:aws:organizations::123456789012:ou/o-aq21sw43de5/ou-po90-lk87jh65,baselineIdentifiers=arn:aws:controltower:us-west-2::baseline/17BSJV3IGJ2QSGA2 \
    --region us-west-2

`ResetEnabledBaseline`

Pour plus d'informations sur cette opération d'API, consultez ResetEnabledBaseline.

ResetEnabledbaselineentrée :


{
    "enabledBaselineIdentifier": "arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAJ9NKW88AA4W9CLL"
}

ResetEnabledBaselinesortie :


{
    "operationIdentifier": "81e02df1-2b4d-48f0-838f-3833b93dcdc0"
}

Exemple de commande ResetEnabledBaseline CLI :


aws controltower reset-enabled-baseline \
    --enabled-baseline-identifier arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHXS7P6C4I453EZC \
    --region us-west-2

`UpdateEnabledBaseline`

Pour plus d'informations sur cette opération d'API, consultez UpdateEnabledBaseline.

UpdateEnabledBaselineentrée :


{
    "enabledBaselineIdentifier": "arn:aws:controltower:us-east-1:123456789012:enabledbaseline/XAJ9NKW88AA4W9CLL",
    "baselineVersion": "4.0",
    "parameters": [
        {
            "key": "IdentityCenterEnabledBaselineArn",
            "value": "arn:aws:controltower:us-east-1:123456789012:enabledbaseline/XAHCR4CJTSI4W07MZ"
        }
    ] 
}

UpdateEnabledBaselinesortie :


{
    "operationIdentifier": "81e02df1-2b4d-48f0-838f-3833b93dcdc0"
}

Exemple de commande UpdateEnabledBaseline CLI :


aws controltower update-enabled-baseline \
    --enabled-baseline-identifier arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHXS7P6C4I453EZC \
    --baseline-version 4.0
    --parameters '[{"key":"IdentityCenterEnabledBaselineArn","value":"arn:aws:controltower:us-west-2:123456789012:enabledbaseline/XAHXS7P6C4I453EZC"}]' \
    --region us-west-2

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Exemples : enregistrer une unité d'organisation AWS Control Tower avec des API uniquement

Informations supplémentaires