AWS.Tools.ControlTower.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ControlTower</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ACT.AddACTResourceTagCmdlet"> <summary> Applies tags to a resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.AddACTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to be tagged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.AddACTResourceTagCmdlet.Tag"> <summary> <para> <para>Tags to be applied to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.AddACTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.AddACTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.AddACTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.DisableACTBaselineCmdlet"> <summary> Disable an <c>EnabledBaseline</c> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTBaselineCmdlet.EnabledBaselineIdentifier"> <summary> <para> <para>Identifier of the <c>EnabledBaseline</c> resource to be deactivated, in ARN format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.DisableBaselineResponse). Specifying the name of a property of type Amazon.ControlTower.Model.DisableBaselineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnabledBaselineIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^EnabledBaselineIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTBaselineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.DisableACTControlCmdlet"> <summary> This API call turns off a control. It starts an asynchronous operation that deletes AWS 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 <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTControlCmdlet.ControlIdentifier"> <summary> <para> <para>The ARN of the control. Only <b>Strongly recommended</b> and <b>Elective</b> controls are permitted, with the exception of the <b>Region deny</b> control. For information on how to find the <c>controlIdentifier</c>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTControlCmdlet.TargetIdentifier"> <summary> <para> <para>The ARN of the organizational unit. For information on how to find the <c>targetIdentifier</c>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.DisableControlResponse). Specifying the name of a property of type Amazon.ControlTower.Model.DisableControlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^TargetIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.DisableACTControlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet"> <summary> Enable (apply) a <c>Baseline</c> to a Target. This API starts an asynchronous operation to deploy resources specified by the <c>Baseline</c> to the specified Target. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.BaselineIdentifier"> <summary> <para> <para>The ARN of the baseline to be enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.BaselineVersion"> <summary> <para> <para>The specific version to be enabled of the specified baseline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.Parameter"> <summary> <para> <para>A list of <c>key-value</c> objects that specify enablement parameters, where <c>key</c> is a string and <c>value</c> is a document of any type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.Tag"> <summary> <para> <para>Tags associated with input to <c>EnableBaseline</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.TargetIdentifier"> <summary> <para> <para>The ARN of the target on which the baseline will be enabled. Only OUs are supported as targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.EnableBaselineResponse). Specifying the name of a property of type Amazon.ControlTower.Model.EnableBaselineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^TargetIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTBaselineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet"> <summary> 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 <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet.ControlIdentifier"> <summary> <para> <para>The ARN of the control. Only <b>Strongly recommended</b> and <b>Elective</b> controls are permitted, with the exception of the <b>Region deny</b> control. For information on how to find the <c>controlIdentifier</c>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet.Parameter"> <summary> <para> <para>A list of input parameter values, which are specified to configure the control when you enable it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet.Tag"> <summary> <para> <para>Tags to be applied to the <c>EnabledControl</c> resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet.TargetIdentifier"> <summary> <para> <para>The ARN of the organizational unit. For information on how to find the <c>targetIdentifier</c>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.EnableControlResponse). Specifying the name of a property of type Amazon.ControlTower.Model.EnableControlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^TargetIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.EnableACTControlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineCmdlet"> <summary> Retrieve details about an existing <c>Baseline</c> resource by specifying its identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineCmdlet.BaselineIdentifier"> <summary> <para> <para>The ARN of the <c>Baseline</c> resource to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.GetBaselineResponse). Specifying the name of a property of type Amazon.ControlTower.Model.GetBaselineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BaselineIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^BaselineIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineListCmdlet"> <summary> Returns a summary list of all available baselines. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be shown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineListCmdlet.NextToken"> <summary> <para> <para>A pagination token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Baselines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.ListBaselinesResponse). Specifying the name of a property of type Amazon.ControlTower.Model.ListBaselinesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineOperationCmdlet"> <summary> Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: <c>EnableBaseline</c>, <c>DisableBaseline</c>, <c>UpdateEnabledBaseline</c>, <c>ResetEnabledBaseline</c>. A status message is displayed in case of operation failure. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineOperationCmdlet.OperationIdentifier"> <summary> <para> <para>The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BaselineOperation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.GetBaselineOperationResponse). Specifying the name of a property of type Amazon.ControlTower.Model.GetBaselineOperationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTBaselineOperationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OperationIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^OperationIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTControlOperationCmdlet"> <summary> Returns the status of a particular <c>EnableControl</c> or <c>DisableControl</c> operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTControlOperationCmdlet.OperationIdentifier"> <summary> <para> <para>The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTControlOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ControlOperation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.GetControlOperationResponse). Specifying the name of a property of type Amazon.ControlTower.Model.GetControlOperationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTControlOperationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OperationIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^OperationIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineCmdlet"> <summary> Retrieve details of an <c>EnabledBaseline</c> resource by specifying its identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineCmdlet.EnabledBaselineIdentifier"> <summary> <para> <para>Identifier of the <c>EnabledBaseline</c> resource to be retrieved, in ARN format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnabledBaselineDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.GetEnabledBaselineResponse). Specifying the name of a property of type Amazon.ControlTower.Model.GetEnabledBaselineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnabledBaselineIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^EnabledBaselineIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineListCmdlet"> <summary> Returns a list of summaries describing <c>EnabledBaseline</c> resources. You can filter the list by the corresponding <c>Baseline</c> or <c>Target</c> of the <c>EnabledBaseline</c> resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineListCmdlet.Filter_BaselineIdentifier"> <summary> <para> <para>Identifiers for the <c>Baseline</c> objects returned as part of the filter operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineListCmdlet.Filter_TargetIdentifier"> <summary> <para> <para>Identifiers for the targets of the <c>Baseline</c> filter operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to be shown.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineListCmdlet.NextToken"> <summary> <para> <para>A pagination token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledBaselineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnabledBaselines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.ListEnabledBaselinesResponse). Specifying the name of a property of type Amazon.ControlTower.Model.ListEnabledBaselinesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlCmdlet"> <summary> Retrieves details about an enabled control. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlCmdlet.EnabledControlIdentifier"> <summary> <para> <para>The <c>controlIdentifier</c> of the enabled control.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnabledControlDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.GetEnabledControlResponse). Specifying the name of a property of type Amazon.ControlTower.Model.GetEnabledControlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnabledControlIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^EnabledControlIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlListCmdlet"> <summary> Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlListCmdlet.TargetIdentifier"> <summary> <para> <para>The ARN of the organizational unit. For information on how to find the <c>targetIdentifier</c>, see <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html">the overview page</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlListCmdlet.MaxResult"> <summary> <para> <para>How many results to return per API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlListCmdlet.NextToken"> <summary> <para> <para>The token to continue the list from a previous API call with the same parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EnabledControls'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.ListEnabledControlsResponse). Specifying the name of a property of type Amazon.ControlTower.Model.ListEnabledControlsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTEnabledControlListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^TargetIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneCmdlet"> <summary> Returns details about the landing zone. Displays a message in case of error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneCmdlet.LandingZoneIdentifier"> <summary> <para> <para>The unique identifier of the landing zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LandingZone'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.GetLandingZoneResponse). Specifying the name of a property of type Amazon.ControlTower.Model.GetLandingZoneResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LandingZoneIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LandingZoneIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneListCmdlet"> <summary> 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. <para> Returns one landing zone ARN. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of returned landing zone ARNs, which is one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneListCmdlet.NextToken"> <summary> <para> <para>The token to continue the list from a previous API call with the same parameters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LandingZones'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.ListLandingZonesResponse). Specifying the name of a property of type Amazon.ControlTower.Model.ListLandingZonesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneOperationCmdlet"> <summary> Returns the status of the specified landing zone operation. Details for an operation are available for 60 days. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneOperationCmdlet.OperationIdentifier"> <summary> <para> <para>A unique identifier assigned to a landing zone operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.GetLandingZoneOperationResponse). Specifying the name of a property of type Amazon.ControlTower.Model.GetLandingZoneOperationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTLandingZoneOperationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the OperationIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^OperationIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.GetACTResourceTagCmdlet"> <summary> Returns a list of tags associated with the resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ControlTower.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.GetACTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.NewACTLandingZoneCmdlet"> <summary> Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.NewACTLandingZoneCmdlet.Manifest"> <summary> <para> <para>The manifest.yaml file is a text file that describes your Amazon Web Services resources. For examples, review <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.NewACTLandingZoneCmdlet.Tag"> <summary> <para> <para>Tags to be applied to the landing zone. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.NewACTLandingZoneCmdlet.Version"> <summary> <para> <para>The landing zone version, for example, 3.0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.NewACTLandingZoneCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.CreateLandingZoneResponse). Specifying the name of a property of type Amazon.ControlTower.Model.CreateLandingZoneResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.NewACTLandingZoneCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Version parameter. The -PassThru parameter is deprecated, use -Select '^Version' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.NewACTLandingZoneCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.RemoveACTLandingZoneCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTLandingZoneCmdlet.LandingZoneIdentifier"> <summary> <para> <para>The unique identifier of the landing zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTLandingZoneCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.DeleteLandingZoneResponse). Specifying the name of a property of type Amazon.ControlTower.Model.DeleteLandingZoneResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTLandingZoneCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LandingZoneIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LandingZoneIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTLandingZoneCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.RemoveACTResourceTagCmdlet"> <summary> Removes tags from a resource. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTResourceTagCmdlet.TagKey"> <summary> <para> <para>Tag keys to be removed from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.RemoveACTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.ResetACTEnabledBaselineCmdlet"> <summary> Re-enables an <c>EnabledBaseline</c> resource. For example, this API can re-apply the existing <c>Baseline</c> after a new member account is moved to the target OU. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTEnabledBaselineCmdlet.EnabledBaselineIdentifier"> <summary> <para> <para>Specifies the ID of the <c>EnabledBaseline</c> resource to be re-enabled, in ARN format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTEnabledBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.ResetEnabledBaselineResponse). Specifying the name of a property of type Amazon.ControlTower.Model.ResetEnabledBaselineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTEnabledBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnabledBaselineIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^EnabledBaselineIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTEnabledBaselineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.ResetACTLandingZoneCmdlet"> <summary> This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTLandingZoneCmdlet.LandingZoneIdentifier"> <summary> <para> <para>The unique identifier of the landing zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTLandingZoneCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.ResetLandingZoneResponse). Specifying the name of a property of type Amazon.ControlTower.Model.ResetLandingZoneResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTLandingZoneCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LandingZoneIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LandingZoneIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.ResetACTLandingZoneCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledBaselineCmdlet"> <summary> Updates an <c>EnabledBaseline</c> resource's applied parameters or version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledBaselineCmdlet.BaselineVersion"> <summary> <para> <para>Specifies the new <c>Baseline</c> version, to which the <c>EnabledBaseline</c> should be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledBaselineCmdlet.EnabledBaselineIdentifier"> <summary> <para> <para>Specifies the <c>EnabledBaseline</c> resource to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledBaselineCmdlet.Parameter"> <summary> <para> <para>Parameters to apply when making an update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledBaselineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.UpdateEnabledBaselineResponse). Specifying the name of a property of type Amazon.ControlTower.Model.UpdateEnabledBaselineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledBaselineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnabledBaselineIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^EnabledBaselineIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledBaselineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledControlCmdlet"> <summary> Updates the configuration of an already enabled control. <para> If the enabled control shows an <c>EnablementStatus</c> of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request. </para><para> If the enabled control shows an <c>EnablementStatus</c> of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply. </para><para> If the <c>DriftSummary</c> status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling <c>DisableControl</c> and again calling <c>EnableControl</c>, or you can run an extending governance operation. For usage examples, see <a href="https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html"><i>the Amazon Web Services Control Tower User Guide</i></a></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledControlCmdlet.EnabledControlIdentifier"> <summary> <para> <para> The ARN of the enabled control that will be updated. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledControlCmdlet.Parameter"> <summary> <para> <para>A key/value pair, where <c>Key</c> is of type <c>String</c> and <c>Value</c> is of type <c>Document</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledControlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.UpdateEnabledControlResponse). Specifying the name of a property of type Amazon.ControlTower.Model.UpdateEnabledControlResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnabledControlIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^EnabledControlIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTEnabledControlCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ACT.UpdateACTLandingZoneCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTLandingZoneCmdlet.LandingZoneIdentifier"> <summary> <para> <para>The unique identifier of the landing zone.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTLandingZoneCmdlet.Manifest"> <summary> <para> <para>The <c>manifest.yaml</c> file is a text file that describes your Amazon Web Services resources. For examples, review <a href="https://docs.aws.amazon.com/controltower/latest/userguide/the-manifest-file">The manifest file</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTLandingZoneCmdlet.Version"> <summary> <para> <para>The landing zone version, for example, 3.2.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTLandingZoneCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OperationIdentifier'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlTower.Model.UpdateLandingZoneResponse). Specifying the name of a property of type Amazon.ControlTower.Model.UpdateLandingZoneResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTLandingZoneCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LandingZoneIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^LandingZoneIdentifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACT.UpdateACTLandingZoneCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |