AWS SDK for PHP 3.x (original) (raw)

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request was denied due to request throttling.

DeleteLandingZone

result=result = result=client->deleteLandingZone([/* ... /]); promise=promise = promise=client->deleteLandingZoneAsync([/ ... */]);

Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.

Parameter Syntax

result=result = result=client->deleteLandingZone([ 'landingZoneIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

landingZoneIdentifier

Required: Yes

Type: string

The unique identifier of the landing zone.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

>A unique identifier assigned to a DeleteLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

DisableBaseline

result=result = result=client->disableBaseline([/* ... /]); promise=promise = promise=client->disableBaselineAsync([/ ... */]);

Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->disableBaseline([ 'enabledBaselineIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

enabledBaselineIdentifier

Required: Yes

Type: string

Identifier of the EnabledBaseline resource to be deactivated, in ARN format.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

The ID (in UUID format) of the asynchronous DisableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

DisableControl

result=result = result=client->disableControl([/* ... /]); promise=promise = promise=client->disableControlAsync([/ ... */]);

This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->disableControl([ 'controlIdentifier' => '', // REQUIRED 'targetIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

controlIdentifier

Required: Yes

Type: string

The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.

targetIdentifier

Required: Yes

Type: string

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

EnableBaseline

result=result = result=client->enableBaseline([/* ... /]); promise=promise = promise=client->enableBaselineAsync([/ ... */]);

Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->enableBaseline([ 'baselineIdentifier' => '', // REQUIRED 'baselineVersion' => '', // REQUIRED 'parameters' => [ [ 'key' => '', // REQUIRED 'value' => [ // REQUIRED ], ], // ... ], 'tags' => ['', ...], 'targetIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

baselineIdentifier

Required: Yes

Type: string

The ARN of the baseline to be enabled.

baselineVersion

Required: Yes

Type: string

The specific version to be enabled of the specified baseline.

parameters

Type: Array of EnabledBaselineParameter structures

A list of key-value objects that specify enablement parameters, where key is a string and value is a document of any type.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags associated with input to EnableBaseline.

targetIdentifier

Required: Yes

Type: string

The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.

Result Syntax

[ 'arn' => '', 'operationIdentifier' => '', ]

Result Details

Members

arn

Required: Yes

Type: string

The ARN of the EnabledBaseline resource.

operationIdentifier

Required: Yes

Type: string

The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

EnableControl

result=result = result=client->enableControl([/* ... /]); promise=promise = promise=client->enableControlAsync([/ ... */]);

This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->enableControl([ 'controlIdentifier' => '', // REQUIRED 'parameters' => [ [ 'key' => '', // REQUIRED 'value' => [ // REQUIRED ], ], // ... ], 'tags' => ['', ...], 'targetIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

controlIdentifier

Required: Yes

Type: string

parameters

Type: Array of EnabledControlParameter structures

A list of input parameter values, which are specified to configure the control when you enable it.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags to be applied to the EnabledControl resource.

targetIdentifier

Required: Yes

Type: string

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Result Syntax

[ 'arn' => '', 'operationIdentifier' => '', ]

Result Details

Members

arn

The ARN of the EnabledControl resource.

operationIdentifier

Required: Yes

Type: string

The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

GetBaseline

result=result = result=client->getBaseline([/* ... /]); promise=promise = promise=client->getBaselineAsync([/ ... */]);

Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->getBaseline([ 'baselineIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

baselineIdentifier

Required: Yes

Type: string

The ARN of the Baseline resource to be retrieved.

Result Syntax

[ 'arn' => '', 'description' => '', 'name' => '', ]

Result Details

Members

arn

Required: Yes

Type: string

The baseline ARN.

description

A description of the baseline.

name

Required: Yes

Type: string

A user-friendly name for the baseline.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

GetBaselineOperation

result=result = result=client->getBaselineOperation([/* ... /]); promise=promise = promise=client->getBaselineOperationAsync([/ ... */]);

Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->getBaselineOperation([ 'operationIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

operationIdentifier

Required: Yes

Type: string

The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).

Result Syntax

[ 'baselineOperation' => [ 'endTime' => , 'operationIdentifier' => '', 'operationType' => 'ENABLE_BASELINE|DISABLE_BASELINE|UPDATE_ENABLED_BASELINE|RESET_ENABLED_BASELINE', 'startTime' => , 'status' => 'SUCCEEDED|FAILED|IN_PROGRESS', 'statusMessage' => '', ], ]

Result Details

Members

baselineOperation

Required: Yes

Type: BaselineOperation structure

A baselineOperation object that shows information about the specified operation ID.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

GetControlOperation

result=result = result=client->getControlOperation([/* ... /]); promise=promise = promise=client->getControlOperationAsync([/ ... */]);

Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->getControlOperation([ 'operationIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

operationIdentifier

Required: Yes

Type: string

The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.

Result Syntax

[ 'controlOperation' => [ 'controlIdentifier' => '', 'enabledControlIdentifier' => '', 'endTime' => , 'operationIdentifier' => '', 'operationType' => 'ENABLE_CONTROL|DISABLE_CONTROL|UPDATE_ENABLED_CONTROL|RESET_ENABLED_CONTROL', 'startTime' => , 'status' => 'SUCCEEDED|FAILED|IN_PROGRESS', 'statusMessage' => '', 'targetIdentifier' => '', ], ]

Result Details

Members

controlOperation

Required: Yes

Type: ControlOperation structure

An operation performed by the control.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

GetEnabledBaseline

result=result = result=client->getEnabledBaseline([/* ... /]); promise=promise = promise=client->getEnabledBaselineAsync([/ ... */]);

Retrieve details of an EnabledBaseline resource by specifying its identifier.

Parameter Syntax

result=result = result=client->getEnabledBaseline([ 'enabledBaselineIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

enabledBaselineIdentifier

Required: Yes

Type: string

Identifier of the EnabledBaseline resource to be retrieved, in ARN format.

Result Syntax

[ 'enabledBaselineDetails' => [ 'arn' => '', 'baselineIdentifier' => '', 'baselineVersion' => '', 'driftStatusSummary' => [ 'types' => [ 'inheritance' => [ 'status' => 'IN_SYNC|DRIFTED', ], ], ], 'parameters' => [ [ 'key' => '', 'value' => [ ], ], // ... ], 'parentIdentifier' => '', 'statusSummary' => [ 'lastOperationIdentifier' => '', 'status' => 'SUCCEEDED|FAILED|UNDER_CHANGE', ], 'targetIdentifier' => '', ], ]

Result Details

Members

enabledBaselineDetails

Type: EnabledBaselineDetails structure

Details of the EnabledBaseline resource.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

GetEnabledControl

result=result = result=client->getEnabledControl([/* ... /]); promise=promise = promise=client->getEnabledControlAsync([/ ... */]);

Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->getEnabledControl([ 'enabledControlIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

enabledControlIdentifier

Required: Yes

Type: string

The controlIdentifier of the enabled control.

Result Syntax

[ 'enabledControlDetails' => [ 'arn' => '', 'controlIdentifier' => '', 'driftStatusSummary' => [ 'driftStatus' => 'DRIFTED|IN_SYNC|NOT_CHECKING|UNKNOWN', ], 'parameters' => [ [ 'key' => '', 'value' => [ ], ], // ... ], 'statusSummary' => [ 'lastOperationIdentifier' => '', 'status' => 'SUCCEEDED|FAILED|UNDER_CHANGE', ], 'targetIdentifier' => '', 'targetRegions' => [ [ 'name' => '', ], // ... ], ], ]

Result Details

Members

enabledControlDetails

Required: Yes

Type: EnabledControlDetails structure

Information about the enabled control.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

GetLandingZone

result=result = result=client->getLandingZone([/* ... /]); promise=promise = promise=client->getLandingZoneAsync([/ ... */]);

Returns details about the landing zone. Displays a message in case of error.

Parameter Syntax

result=result = result=client->getLandingZone([ 'landingZoneIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

landingZoneIdentifier

Required: Yes

Type: string

The unique identifier of the landing zone.

Result Syntax

[ 'landingZone' => [ 'arn' => '', 'driftStatus' => [ 'status' => 'DRIFTED|IN_SYNC', ], 'latestAvailableVersion' => '', 'manifest' => [ ], 'status' => 'ACTIVE|PROCESSING|FAILED', 'version' => '', ], ]

Result Details

Members

landingZone

Required: Yes

Type: LandingZoneDetail structure

Information about the landing zone.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

GetLandingZoneOperation

result=result = result=client->getLandingZoneOperation([/* ... /]); promise=promise = promise=client->getLandingZoneOperationAsync([/ ... */]);

Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.

Parameter Syntax

result=result = result=client->getLandingZoneOperation([ 'operationIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

operationIdentifier

Required: Yes

Type: string

A unique identifier assigned to a landing zone operation.

Result Syntax

Result Details

Members

operationDetails

Required: Yes

Type: LandingZoneOperationDetail structure

Details about a landing zone operation.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

ListBaselines

result=result = result=client->listBaselines([/* ... /]); promise=promise = promise=client->listBaselinesAsync([/ ... */]);

Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->listBaselines([ 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

maxResults

The maximum number of results to be shown.

nextToken

A pagination token.

Result Syntax

[ 'baselines' => [ [ 'arn' => '', 'description' => '', 'name' => '', ], // ... ], 'nextToken' => '', ]

Result Details

Members

baselines

Required: Yes

Type: Array of BaselineSummary structures

A list of Baseline object details.

nextToken

A pagination token.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request was denied due to request throttling.

ListControlOperations

result=result = result=client->listControlOperations([/* ... /]); promise=promise = promise=client->listControlOperationsAsync([/ ... */]);

Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.

Parameter Syntax

result=result = result=client->listControlOperations([ 'filter' => [ 'controlIdentifiers' => ['', ...], 'controlOperationTypes' => ['', ...], 'enabledControlIdentifiers' => ['', ...], 'statuses' => ['', ...], 'targetIdentifiers' => ['', ...], ], 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

filter

Type: ControlOperationFilter structure

An input filter for the ListControlOperations API that lets you select the types of control operations to view.

maxResults

The maximum number of results to be shown.

nextToken

A pagination token.

Result Syntax

[ 'controlOperations' => [ [ 'controlIdentifier' => '', 'enabledControlIdentifier' => '', 'endTime' => , 'operationIdentifier' => '', 'operationType' => 'ENABLE_CONTROL|DISABLE_CONTROL|UPDATE_ENABLED_CONTROL|RESET_ENABLED_CONTROL', 'startTime' => , 'status' => 'SUCCEEDED|FAILED|IN_PROGRESS', 'statusMessage' => '', 'targetIdentifier' => '', ], // ... ], 'nextToken' => '', ]

Result Details

Members

controlOperations

Required: Yes

Type: Array of ControlOperationSummary structures

Returns a list of output from control operations.

nextToken

A pagination token.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request was denied due to request throttling.

ListEnabledBaselines

result=result = result=client->listEnabledBaselines([/* ... /]); promise=promise = promise=client->listEnabledBaselinesAsync([/ ... */]);

Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->listEnabledBaselines([ 'filter' => [ 'baselineIdentifiers' => ['', ...], 'inheritanceDriftStatuses' => ['', ...], 'parentIdentifiers' => ['', ...], 'statuses' => ['', ...], 'targetIdentifiers' => ['', ...], ], 'includeChildren' => true || false, 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

filter

Type: EnabledBaselineFilter structure

A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers. The filter can be applied for either, or both.

includeChildren

A value that can be set to include the child enabled baselines in responses. The default value is false.

maxResults

The maximum number of results to be shown.

nextToken

A pagination token.

Result Syntax

[ 'enabledBaselines' => [ [ 'arn' => '', 'baselineIdentifier' => '', 'baselineVersion' => '', 'driftStatusSummary' => [ 'types' => [ 'inheritance' => [ 'status' => 'IN_SYNC|DRIFTED', ], ], ], 'parentIdentifier' => '', 'statusSummary' => [ 'lastOperationIdentifier' => '', 'status' => 'SUCCEEDED|FAILED|UNDER_CHANGE', ], 'targetIdentifier' => '', ], // ... ], 'nextToken' => '', ]

Result Details

Members

enabledBaselines

Required: Yes

Type: Array of EnabledBaselineSummary structures

Retuens a list of summaries of EnabledBaseline resources.

nextToken

A pagination token.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request was denied due to request throttling.

ListEnabledControls

result=result = result=client->listEnabledControls([/* ... /]); promise=promise = promise=client->listEnabledControlsAsync([/ ... */]);

Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->listEnabledControls([ 'filter' => [ 'controlIdentifiers' => ['', ...], 'driftStatuses' => ['', ...], 'statuses' => ['', ...], ], 'maxResults' => , 'nextToken' => '', 'targetIdentifier' => '', ]);

Parameter Details

Members

filter

Type: EnabledControlFilter structure

An input filter for the ListEnabledControls API that lets you select the types of control operations to view.

maxResults

How many results to return per API call.

nextToken

The token to continue the list from a previous API call with the same parameters.

targetIdentifier

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Result Syntax

[ 'enabledControls' => [ [ 'arn' => '', 'controlIdentifier' => '', 'driftStatusSummary' => [ 'driftStatus' => 'DRIFTED|IN_SYNC|NOT_CHECKING|UNKNOWN', ], 'statusSummary' => [ 'lastOperationIdentifier' => '', 'status' => 'SUCCEEDED|FAILED|UNDER_CHANGE', ], 'targetIdentifier' => '', ], // ... ], 'nextToken' => '', ]

Result Details

Members

enabledControls

Required: Yes

Type: Array of EnabledControlSummary structures

Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.

nextToken

Retrieves the next page of results. If the string is empty, the response is the end of the results.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

ListLandingZoneOperations

result=result = result=client->listLandingZoneOperations([/* ... /]); promise=promise = promise=client->listLandingZoneOperationsAsync([/ ... */]);

Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.

Parameter Syntax

result=result = result=client->listLandingZoneOperations([ 'filter' => [ 'statuses' => ['', ...], 'types' => ['', ...], ], 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

filter

Type: LandingZoneOperationFilter structure

An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.

maxResults

How many results to return per API call.

nextToken

The token to continue the list from a previous API call with the same parameters.

Result Syntax

Result Details

Members

landingZoneOperations

Required: Yes

Type: Array of LandingZoneOperationSummary structures

Lists landing zone operations.

nextToken

Retrieves the next page of results. If the string is empty, the response is the end of the results.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request was denied due to request throttling.

ListLandingZones

result=result = result=client->listLandingZones([/* ... /]); promise=promise = promise=client->listLandingZonesAsync([/ ... */]);

Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.

Returns one landing zone ARN.

Parameter Syntax

result=result = result=client->listLandingZones([ 'maxResults' => , 'nextToken' => '', ]);

Parameter Details

Members

maxResults

The maximum number of returned landing zone ARNs, which is one.

nextToken

The token to continue the list from a previous API call with the same parameters.

Result Syntax

[ 'landingZones' => [ [ 'arn' => '', ], // ... ], 'nextToken' => '', ]

Result Details

Members

landingZones

Required: Yes

Type: Array of LandingZoneSummary structures

The ARN of the landing zone.

nextToken

Retrieves the next page of results. If the string is empty, the response is the end of the results.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request was denied due to request throttling.

ListTagsForResource

result=result = result=client->listTagsForResource([/* ... /]); promise=promise = promise=client->listTagsForResourceAsync([/ ... */]);

Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->listTagsForResource([ 'resourceArn' => '', // REQUIRED ]);

Parameter Details

Members

resourceArn

Required: Yes

Type: string

The ARN of the resource.

Result Syntax

[ 'tags' => ['', ...], ]

Result Details

Members

tags

Required: Yes

Type: Associative array of custom strings keys (TagKey) to strings

A list of tags, as key:value strings.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

The request references a resource that does not exist.

ResetEnabledBaseline

result=result = result=client->resetEnabledBaseline([/* ... /]); promise=promise = promise=client->resetEnabledBaselineAsync([/ ... */]);

Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->resetEnabledBaseline([ 'enabledBaselineIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

enabledBaselineIdentifier

Required: Yes

Type: string

Specifies the ID of the EnabledBaseline resource to be re-enabled, in ARN format.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

ResetEnabledControl

result=result = result=client->resetEnabledControl([/* ... /]); promise=promise = promise=client->resetEnabledControlAsync([/ ... */]);

Resets an enabled control.

Parameter Syntax

result=result = result=client->resetEnabledControl([ 'enabledControlIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

enabledControlIdentifier

Required: Yes

Type: string

The ARN of the enabled control to be reset.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

The operation identifier for this ResetEnabledControl operation.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

ResetLandingZone

result=result = result=client->resetLandingZone([/* ... /]); promise=promise = promise=client->resetLandingZoneAsync([/ ... */]);

This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.

Parameter Syntax

result=result = result=client->resetLandingZone([ 'landingZoneIdentifier' => '', // REQUIRED ]);

Parameter Details

Members

landingZoneIdentifier

Required: Yes

Type: string

The unique identifier of the landing zone.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

TagResource

result=result = result=client->tagResource([/* ... /]); promise=promise = promise=client->tagResourceAsync([/ ... */]);

Applies tags to a resource. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->tagResource([ 'resourceArn' => '', // REQUIRED 'tags' => ['', ...], // REQUIRED ]);

Parameter Details

Members

resourceArn

Required: Yes

Type: string

The ARN of the resource to be tagged.

tags

Required: Yes

Type: Associative array of custom strings keys (TagKey) to strings

Tags to be applied to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

The request references a resource that does not exist.

UntagResource

result=result = result=client->untagResource([/* ... /]); promise=promise = promise=client->untagResourceAsync([/ ... */]);

Removes tags from a resource. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->untagResource([ 'resourceArn' => '', // REQUIRED 'tagKeys' => ['', ...], // REQUIRED ]);

Parameter Details

Members

resourceArn

Required: Yes

Type: string

The ARN of the resource.

tagKeys

Required: Yes

Type: Array of strings

Tag keys to be removed from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

The request references a resource that does not exist.

UpdateEnabledBaseline

result=result = result=client->updateEnabledBaseline([/* ... /]); promise=promise = promise=client->updateEnabledBaselineAsync([/ ... */]);

Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .

Parameter Syntax

result=result = result=client->updateEnabledBaseline([ 'baselineVersion' => '', // REQUIRED 'enabledBaselineIdentifier' => '', // REQUIRED 'parameters' => [ [ 'key' => '', // REQUIRED 'value' => [ // REQUIRED ], ], // ... ], ]);

Parameter Details

Members

baselineVersion

Required: Yes

Type: string

Specifies the new Baseline version, to which the EnabledBaseline should be updated.

enabledBaselineIdentifier

Required: Yes

Type: string

Specifies the EnabledBaseline resource to be updated.

parameters

Type: Array of EnabledBaselineParameter structures

Parameters to apply when making an update.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

UpdateEnabledControl

result=result = result=client->updateEnabledControl([/* ... /]); promise=promise = promise=client->updateEnabledControlAsync([/ ... */]);

Updates the configuration of an already enabled control.

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling the ResetEnabledControl API. Alternatively, you can call DisableControl and then call EnableControl again. Also, you can run an extending governance operation to repair drift. For usage examples, see the Controls Reference Guide .

Parameter Syntax

result=result = result=client->updateEnabledControl([ 'enabledControlIdentifier' => '', // REQUIRED 'parameters' => [ // REQUIRED [ 'key' => '', // REQUIRED 'value' => [ // REQUIRED ], ], // ... ], ]);

Parameter Details

Members

enabledControlIdentifier

Required: Yes

Type: string

The ARN of the enabled control that will be updated.

parameters

Required: Yes

Type: Array of EnabledControlParameter structures

A key/value pair, where Key is of type String and Value is of type Document.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

The operation identifier for this UpdateEnabledControl operation.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.

The request was denied due to request throttling.

UpdateLandingZone

result=result = result=client->updateLandingZone([/* ... /]); promise=promise = promise=client->updateLandingZoneAsync([/ ... */]);

This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.

Parameter Syntax

result=result = result=client->updateLandingZone([ 'landingZoneIdentifier' => '', // REQUIRED 'manifest' => [ // REQUIRED ], 'version' => '', // REQUIRED ]);

Parameter Details

Members

landingZoneIdentifier

Required: Yes

Type: string

The unique identifier of the landing zone.

manifest

Required: Yes

Type: document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documents

The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.

version

Required: Yes

Type: string

The landing zone version, for example, 3.2.

Result Syntax

[ 'operationIdentifier' => '', ]

Result Details

Members

operationIdentifier

Required: Yes

Type: string

A unique identifier assigned to a UpdateLandingZone operation. You can use this identifier as an input of GetLandingZoneOperation to check the operation's status.

Errors

Updating or deleting the resource can cause an inconsistent state.

The input does not satisfy the constraints specified by an Amazon Web Services service.

An unexpected error occurred during processing of a request.

You do not have sufficient access to perform this action.

The request references a resource that does not exist.