DisableBaseline EnableBaseline GetBaseline GetBaselineOperation GetEnabledBaseline ListBaselines ListEnabledBaselines ResetEnabledBaseline UpdateEnabledBaseline

Esempi di utilizzo delle API di base

Questa sezione contiene esempi di parametri di input e output per la baseline APIs di AWS Control Tower.

`DisableBaseline`

Per ulteriori informazioni su questo funzionamento dell'API, consulta DisableBaseline.

DisableBaselineingresso:


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

DisableBaselineuscita:


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

DisableBaselineEsempio di CLI:


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

`EnableBaseline`

Per ulteriori informazioni su questo funzionamento dell'API, consulta EnableBaseline.

EnableBaselineingresso:


{
    "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"
        }
    ]
}

EnableBaselineoutput, restituendo una nuova risorsa:


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

EnableBaselineEsempio di CLI:

Questo esempio mostra l'abilitazione di una linea di base per un' AWS Organizations organizzazione che ha la landing zone abilitata all'accesso a AWS IAM Identity Center, gestito da AWS Control Tower. Per recuperare l'EnabledBaselineidentificatore dell'Identity Center, puoi chiamare l'ListEnabledBaselinesAPI, filtrando in base alla linea di base di 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 risposta mostrerà il EnabledBaseline dettaglio, che mostra il relativo identificatore.


{
    "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"
            }
        }
    ]
}

Nota

Prendi nota del valore ARN della risposta e passa questo valore come parametro per abilitare la linea di base predefinita.


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

Per un'organizzazione con la landing zone disattivata dalla gestione di AWS Control Tower di IAM Identity Center, abilita la linea di base senza il parametro.


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`

Per ulteriori informazioni su questo funzionamento dell'API, consulta. GetBaseline

GetBaselineingresso:


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

GetBaselineuscita:


{
    "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.",
}

GetBaselineEsempio di CLI:


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

`GetBaselineOperation`

Per ulteriori informazioni su questo funzionamento dell'API, consulta GetBaselineOperation.

GetBaselineOperationingresso:


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

GetBaselineOperationuscita:


{
    "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"
    }
}

GetBaselineOperationEsempio di CLI:


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

`GetEnabledBaseline`

Per ulteriori informazioni su questo funzionamento dell'API, consulta GetEnabledBaseline.

GetEnabledBaselineingresso:


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

GetEnabledBaselineuscita:


{
    "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"
            }
        ]
    }
}

GetEnabledBaselineEsempio di CLI:


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

`ListBaselines`

Per ulteriori informazioni su questo funzionamento dell'API, consulta ListBaselines.

ListBaselinesinput (utilizzando input opzionali):


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

ListBaselinesuscita:


{
    "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."
        }
    ]
}

ListBaselinesEsempio di CLI:


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

`ListEnabledBaselines`

L'ListEnabledBaselinesAPI dispone di un parametro opzionale che consente di visualizzare le linee di base applicate agli account membri di un'unità organizzativa. Gli esempi che seguono mostrano alcuni comandi CLI che è possibile utilizzare per visualizzare le linee di base di un account. AWS Control Tower fa riferimento a queste linee di base, che sono abilitate sull'unità organizzativa, ma si applicano a ciascun account all'interno dell'unità organizzativa, come linee di base abilitate ai bambini, poiché derivano la loro configurazione di governance dalle linee di base applicate all'unità organizzativa.

Per ulteriori informazioni sul funzionamento di questa API, consulta. ListEnabledBaselines

ListEnabledBaselinesinput per mostrare le linee di base abilitate ai bambini:


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

ListEnabledBaselinesoutput per visualizzare le linee di base abilitate ai bambini:


{
    "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"
        }
]

Nota

Nell'esempio precedente, il parentIdentifier campo mostra la linea di base abilitata dell'unità organizzativa principale per questa baseline abilitata al figlio.

Visualizza tutte le linee di base applicate a un obiettivo specifico (unità organizzativa o account):


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

Visualizza tutti quelli OUs che hanno una linea di base specifica:


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

Visualizza tutti OUs gli account che hanno una linea di base specifica:


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

Visualizza tutti gli account in un'unità organizzativa con Baseline B abilitata:


### 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

Ulteriori informazioni sulle linee di base abilitate ai bambini

È possibile utilizzare l'GetEnabledBaselineAPI per visualizzare informazioni dettagliate su una specifica baseline abilitata ai bambini
È possibile utilizzare l'GetBaselineOperationAPI per visualizzare un'operazione eseguita sulla baseline abilitata ai figli
Non è possibile richiamare direttamente alcuna scrittura APIs, ad esempio ResetEnabledBaseline o EnableBaseline UpdateEnabledBaselineDisableBaseline, su una baseline abilitata per i figli.
Le risorse di base abilitate ai bambini possono essere modificate solo tramite il servizio AWS Control Tower, tramite operazioni eseguite sull'unità organizzativa principale o tramite Account Factory.

Esempi di utilizzo dei filtri:

ListEnabledBaselinesinput (senza filtri):


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

ListEnabledBaselinesinput (solo baselineIdentifiers filtro):


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

ListEnabledBaselinesinput (solo targetIdentifiers filtro):


{
    "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
}

ListEnabledBaselinesinput (baselineIdentifierse targetIdentifiers filtri):


{
    "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
}

ListEnabledBaselinesuscita:


{
    "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"
}

Esempio di CLI con un tipo di filtro (baselineIdentifiersfiltro):


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

Esempio di CLI che utilizza più filtri (baselineIdentifierse targetIdentifiers filtri):


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`

Per ulteriori informazioni su questo funzionamento dell'API, vedere ResetEnabledBaseline.

ResetEnabledbaselineingresso:


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

ResetEnabledBaselineuscita:


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

ResetEnabledBaselineEsempio di CLI:


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

`UpdateEnabledBaseline`

Per ulteriori informazioni su questo funzionamento dell'API, consulta UpdateEnabledBaseline.

UpdateEnabledBaselineingresso:


{
    "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"
        }
    ] 
}

UpdateEnabledBaselineuscita:


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

UpdateEnabledBaselineEsempio di 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

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Esempi: registra un'unità organizzativa AWS Control Tower APIs solo con

Informazioni aggiuntive