AWS.Tools.ComputeOptimizerAutomation.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ComputeOptimizerAutomation</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.COA.AddCOAAccountCmdlet"> <summary> Associates one or more member accounts with your organization's management account, enabling centralized implementation of optimization actions across those accounts. Once associated, the management account (or a delegated administrator) can apply recommended actions to the member account. When you associate a member account, its organization rule mode is automatically set to "Any allowed," which permits the management account to create Automation rules that automatically apply actions to that account. If the member account has not previously enabled the Automation feature, the association process automatically enables it. <note><para> Only the management account or a delegated administrator can perform this action. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAAccountCmdlet.AccountId"> <summary> <para> <para> The IDs of the member accounts to associate. You can specify up to 50 account IDs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAAccountCmdlet.ClientToken"> <summary> <para> <para> A unique identifier to ensure idempotency of the request. Valid for 24 hours after creation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAAccountCmdlet.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.ComputeOptimizerAutomation.Model.AssociateAccountsResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.AssociateAccountsResponse 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.COA.AddCOAAccountCmdlet.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.COA.AddCOAResourceTagCmdlet"> <summary> Adds tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The ARN of the resource to tag. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAResourceTagCmdlet.RuleRevision"> <summary> <para> <para>The revision number of the automation rule to tag. This ensures you're tagging the correct version of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAResourceTagCmdlet.Tag"> <summary> <para> <para> The tags to add to the resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAResourceTagCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAResourceTagCmdlet.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.ComputeOptimizerAutomation.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.AddCOAResourceTagCmdlet.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.COA.GetCOAAccountListCmdlet"> <summary> Lists the accounts in your organization that are enrolled in Compute Optimizer and whether they have enabled Automation. <note><para> Only the management account or a delegated administrator can perform this action. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAccountListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to return in a single call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAccountListCmdlet.NextToken"> <summary> <para> <para> The token for the next page of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAccountListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Accounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListAccountsResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListAccountsResponse 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.COA.GetCOAAccountListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventCmdlet"> <summary> Retrieves details about a specific automation event. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventCmdlet.EventId"> <summary> <para> <para> The ID of the automation event to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventCmdlet.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.ComputeOptimizerAutomation.Model.GetAutomationEventResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.GetAutomationEventResponse 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.COA.GetCOAAutomationEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventId parameter. The -PassThru parameter is deprecated, use -Select '^EventId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventListCmdlet"> <summary> Lists automation events based on specified filters. You can retrieve events that were created within the past year.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventListCmdlet.EndTimeExclusive"> <summary> <para> <para> The end of the time range to query for events. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventListCmdlet.Filter"> <summary> <para> <para> The filters to apply to the list of automation events. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventListCmdlet.StartTimeInclusive"> <summary> <para> <para> The start of the time range to query for events. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of results to return in a single call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventListCmdlet.NextToken"> <summary> <para> <para> The token for the next page of results. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationEvents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListAutomationEventsResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListAutomationEventsResponse 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.COA.GetCOAAutomationEventListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventStepListCmdlet"> <summary> Lists the steps for a specific automation event. You can only list steps for events created within the past year.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventStepListCmdlet.EventId"> <summary> <para> <para> The ID of the automation event. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventStepListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of automation event steps to return in a single response. Valid range is 1-1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventStepListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination to retrieve the next set of results when the response is truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventStepListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationEventSteps'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListAutomationEventStepsResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListAutomationEventStepsResponse 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.COA.GetCOAAutomationEventStepListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventId parameter. The -PassThru parameter is deprecated, use -Select '^EventId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventStepListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventSummaryListCmdlet"> <summary> Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventSummaryListCmdlet.EndDateExclusive"> <summary> <para> <para>The end date for filtering automation event summaries, exclusive. Events created before this date will be included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventSummaryListCmdlet.Filter"> <summary> <para> <para> The filters to apply to the list of automation event summaries. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventSummaryListCmdlet.StartDateInclusive"> <summary> <para> <para>The start date for filtering automation event summaries, inclusive. Events created on or after this date will be included.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventSummaryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of automation event summaries to return in a single response. Valid range is 1-1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventSummaryListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination to retrieve the next set of results when the response is truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationEventSummaryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationEventSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListAutomationEventSummariesResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListAutomationEventSummariesResponse 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.COA.GetCOAAutomationEventSummaryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleCmdlet"> <summary> Retrieves details about a specific automation rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleCmdlet.RuleArn"> <summary> <para> <para> The ARN of the rule to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleCmdlet.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.ComputeOptimizerAutomation.Model.GetAutomationRuleResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.GetAutomationRuleResponse 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.COA.GetCOAAutomationRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleArn parameter. The -PassThru parameter is deprecated, use -Select '^RuleArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleListCmdlet"> <summary> Lists the automation rules that match specified filters.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleListCmdlet.Filter"> <summary> <para> <para> The filters to apply to the list of automation rules. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of automation rules to return in a single response. Valid range is 1-1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination to retrieve the next set of results when the response is truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AutomationRules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListAutomationRulesResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListAutomationRulesResponse 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.COA.GetCOAAutomationRuleListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet"> <summary> Returns a preview of the recommended actions that match your Automation rule's configuration and criteria.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.OrganizationScope_AccountId"> <summary> <para> <para>List of Amazon Web Services account IDs to include in the organization scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_EbsVolumeSizeInGib"> <summary> <para> <para>Filter criteria for EBS volume sizes in gibibytes (GiB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_EbsVolumeType"> <summary> <para> <para>Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_EstimatedMonthlySaving"> <summary> <para> <para>Filter criteria for estimated monthly cost savings from the recommended action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_LookBackPeriodInDay"> <summary> <para> <para>Filter criteria for the lookback period in days used to analyze resource utilization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.RecommendedActionType"> <summary> <para> <para> The types of recommended actions to include in the preview. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_Region"> <summary> <para> <para>Filter criteria for Amazon Web Services regions where resources must be located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_ResourceArn"> <summary> <para> <para>Filter criteria for specific resource ARNs to include or exclude.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_ResourceTag"> <summary> <para> <para>Filter criteria for resource tags, allowing filtering by tag key and value combinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Criteria_RestartNeeded"> <summary> <para> <para>Filter criteria indicating whether the recommended action requires a resource restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.RuleType"> <summary> <para> <para> The type of rule. </para><note><para>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of automation rule preview results to return in a single response. Valid range is 1-1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination to retrieve the next set of results when the response is truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PreviewResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListAutomationRulePreviewResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListAutomationRulePreviewResponse 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.COA.GetCOAAutomationRulePreviewListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleType parameter. The -PassThru parameter is deprecated, use -Select '^RuleType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet"> <summary> Returns a summary of the recommended actions that match your rule preview configuration and criteria.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.OrganizationScope_AccountId"> <summary> <para> <para>List of Amazon Web Services account IDs to include in the organization scope.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_EbsVolumeSizeInGib"> <summary> <para> <para>Filter criteria for EBS volume sizes in gibibytes (GiB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_EbsVolumeType"> <summary> <para> <para>Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_EstimatedMonthlySaving"> <summary> <para> <para>Filter criteria for estimated monthly cost savings from the recommended action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_LookBackPeriodInDay"> <summary> <para> <para>Filter criteria for the lookback period in days used to analyze resource utilization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.RecommendedActionType"> <summary> <para> <para>The types of recommended actions to include in the preview.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_Region"> <summary> <para> <para>Filter criteria for Amazon Web Services regions where resources must be located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_ResourceArn"> <summary> <para> <para>Filter criteria for specific resource ARNs to include or exclude.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_ResourceTag"> <summary> <para> <para>Filter criteria for resource tags, allowing filtering by tag key and value combinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Criteria_RestartNeeded"> <summary> <para> <para>Filter criteria indicating whether the recommended action requires a resource restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.RuleType"> <summary> <para> <para>The type of rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of automation rule preview summaries to return in a single response. Valid range is 1-1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination to retrieve the next set of results when the response is truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PreviewResultSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListAutomationRulePreviewSummariesResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListAutomationRulePreviewSummariesResponse 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.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleType parameter. The -PassThru parameter is deprecated, use -Select '^RuleType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAAutomationRulePreviewSummaryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAEnrollmentConfigurationCmdlet"> <summary> Retrieves the current enrollment configuration for Compute Optimizer Automation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAEnrollmentConfigurationCmdlet.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.ComputeOptimizerAutomation.Model.GetEnrollmentConfigurationResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.GetEnrollmentConfigurationResponse 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.COA.GetCOARecommendedActionListCmdlet"> <summary> Lists the recommended actions based that match specified filters. <note><para> Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using <c>AssociateAccounts</c>. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionListCmdlet.Filter"> <summary> <para> <para> The filters to apply to the list of recommended actions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recommended actions to return in a single response. Valid range is 1-1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination to retrieve the next set of results when the response is truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommendedActions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListRecommendedActionsResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListRecommendedActionsResponse 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.COA.GetCOARecommendedActionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionSummaryListCmdlet"> <summary> Provides a summary of recommended actions based on specified filters. <note><para> Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using <c>AssociateAccounts</c>. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionSummaryListCmdlet.Filter"> <summary> <para> <para>A list of filters to apply when retrieving recommended action summaries. Filters can be based on resource type, action type, account ID, and other criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionSummaryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of recommended action summaries to return in a single response. Valid range is 1-1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionSummaryListCmdlet.NextToken"> <summary> <para> <para>A token used for pagination to retrieve the next set of results when the response is truncated.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOARecommendedActionSummaryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RecommendedActionSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizerAutomation.Model.ListRecommendedActionSummariesResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.ListRecommendedActionSummariesResponse 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.COA.GetCOARecommendedActionSummaryListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.COA.GetCOAResourceTagCmdlet"> <summary> Lists the tags for a specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The ARN of the resource to list tags for. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.GetCOAResourceTagCmdlet.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.ComputeOptimizerAutomation.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.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.COA.GetCOAResourceTagCmdlet.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.COA.NewCOAAutomationRuleCmdlet"> <summary> Creates a new automation rule to apply recommended actions to resources based on specified criteria. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.OrganizationConfiguration_AccountId"> <summary> <para> <para>List of specific Amazon Web Services account IDs where the organization rule should be applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Description"> <summary> <para> <para> A description of the automation rule. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_EbsVolumeSizeInGib"> <summary> <para> <para>Filter criteria for EBS volume sizes in gibibytes (GiB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_EbsVolumeType"> <summary> <para> <para>Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_EstimatedMonthlySaving"> <summary> <para> <para>Filter criteria for estimated monthly cost savings from the recommended action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Schedule_ExecutionWindowInMinute"> <summary> <para> <para>The time window in minutes during which the automation rule can start implementing recommended actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_LookBackPeriodInDay"> <summary> <para> <para>Filter criteria for the lookback period in days used to analyze resource utilization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Name"> <summary> <para> <para> The name of the automation rule. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Priority"> <summary> <para> <para>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.RecommendedActionType"> <summary> <para> <para> The types of recommended actions this rule will automate. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_Region"> <summary> <para> <para>Filter criteria for Amazon Web Services regions where resources must be located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_ResourceArn"> <summary> <para> <para>Filter criteria for specific resource ARNs to include or exclude.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_ResourceTag"> <summary> <para> <para>Filter criteria for resource tags, allowing filtering by tag key and value combinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Criteria_RestartNeeded"> <summary> <para> <para>Filter criteria indicating whether the recommended action requires a resource restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.OrganizationConfiguration_RuleApplyOrder"> <summary> <para> <para>Specifies when organization rules should be applied relative to account rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.RuleType"> <summary> <para> <para> The type of rule. </para><note><para>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Schedule_ScheduleExpression"> <summary> <para> <para>The expression that defines when the schedule runs. <c>cron</c> expression is supported. A <c>cron</c> expression consists of six fields separated by white spaces: (<c>minutes</c><c>hours</c><c>day_of_month</c><c>month</c><c>day_of_week</c><c>year</c>)</para><note><para>You can schedule rules to run at most once per day. Your cron expression must use specific values (not wildcards) for the minutes and hours fields. For example: (<c>30 12 * * *</c>) runs daily at 12:30 PM UTC.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Schedule_ScheduleExpressionTimezone"> <summary> <para> <para>The timezone to use when interpreting the schedule expression.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Status"> <summary> <para> <para>The status of the rule </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.Tag"> <summary> <para> <para> The tags to associate with the rule. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.ClientToken"> <summary> <para> <para> A unique identifier to ensure idempotency of the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.NewCOAAutomationRuleCmdlet.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.ComputeOptimizerAutomation.Model.CreateAutomationRuleResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.CreateAutomationRuleResponse 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.COA.NewCOAAutomationRuleCmdlet.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.COA.RemoveCOAAccountCmdlet"> <summary> Disassociates member accounts from your organization's management account, removing centralized automation capabilities. Once disassociated, organization rules no longer apply to the member account, and the management account (or delegated administrator) cannot create Automation rules for that account. <note><para> Only the management account or a delegated administrator can perform this action. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAccountCmdlet.AccountId"> <summary> <para> <para> The IDs of the member accounts to disassociate. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAccountCmdlet.ClientToken"> <summary> <para> <para> A unique identifier to ensure idempotency of the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAccountCmdlet.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.ComputeOptimizerAutomation.Model.DisassociateAccountsResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.DisassociateAccountsResponse 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.COA.RemoveCOAAccountCmdlet.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.COA.RemoveCOAAutomationRuleCmdlet"> <summary> Deletes an existing automation rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAutomationRuleCmdlet.RuleArn"> <summary> <para> <para> The ARN of the rule to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAutomationRuleCmdlet.RuleRevision"> <summary> <para> <para> The revision number of the rule to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAutomationRuleCmdlet.ClientToken"> <summary> <para> <para> A unique identifier to ensure idempotency of the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAutomationRuleCmdlet.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.ComputeOptimizerAutomation.Model.DeleteAutomationRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAAutomationRuleCmdlet.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.COA.RemoveCOAResourceTagCmdlet"> <summary> Removes tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAResourceTagCmdlet.ResourceArn"> <summary> <para> <para> The ARN of the resource to untag. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAResourceTagCmdlet.RuleRevision"> <summary> <para> <para>The revision number of the automation rule to untag. This ensures you're untagging the correct version of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAResourceTagCmdlet.TagKey"> <summary> <para> <para> The keys of the tags to remove from the resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAResourceTagCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAResourceTagCmdlet.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.ComputeOptimizerAutomation.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RemoveCOAResourceTagCmdlet.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.COA.RestoreCOAAutomationEventCmdlet"> <summary> Initiates a rollback for a completed automation event. <note><para> Management accounts and delegated administrators can only initiate a rollback for events belonging to associated member accounts. You can associate a member account using <c>AssociateAccounts</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RestoreCOAAutomationEventCmdlet.EventId"> <summary> <para> <para> The ID of the automation event to roll back. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RestoreCOAAutomationEventCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RestoreCOAAutomationEventCmdlet.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.ComputeOptimizerAutomation.Model.RollbackAutomationEventResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.RollbackAutomationEventResponse 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.COA.RestoreCOAAutomationEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventId parameter. The -PassThru parameter is deprecated, use -Select '^EventId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.RestoreCOAAutomationEventCmdlet.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.COA.StartCOAAutomationEventCmdlet"> <summary> Initiates a one-time, on-demand automation for the specified recommended action. <note><para> Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using <c>AssociateAccounts</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.StartCOAAutomationEventCmdlet.RecommendedActionId"> <summary> <para> <para> The ID of the recommended action to automate. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.StartCOAAutomationEventCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.StartCOAAutomationEventCmdlet.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.ComputeOptimizerAutomation.Model.StartAutomationEventResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.StartAutomationEventResponse 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.COA.StartCOAAutomationEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RecommendedActionId parameter. The -PassThru parameter is deprecated, use -Select '^RecommendedActionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.StartCOAAutomationEventCmdlet.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.COA.UpdateCOAAutomationRuleCmdlet"> <summary> Updates an existing automation rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.OrganizationConfiguration_AccountId"> <summary> <para> <para>List of specific Amazon Web Services account IDs where the organization rule should be applied.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Description"> <summary> <para> <para>The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_EbsVolumeSizeInGib"> <summary> <para> <para>Filter criteria for EBS volume sizes in gibibytes (GiB).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_EbsVolumeType"> <summary> <para> <para>Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_EstimatedMonthlySaving"> <summary> <para> <para>Filter criteria for estimated monthly cost savings from the recommended action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Schedule_ExecutionWindowInMinute"> <summary> <para> <para>The time window in minutes during which the automation rule can start implementing recommended actions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_LookBackPeriodInDay"> <summary> <para> <para>Filter criteria for the lookback period in days used to analyze resource utilization.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Name"> <summary> <para> <para>The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Priority"> <summary> <para> <para>The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.RecommendedActionType"> <summary> <para> <para>Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_Region"> <summary> <para> <para>Filter criteria for Amazon Web Services regions where resources must be located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_ResourceArn"> <summary> <para> <para>Filter criteria for specific resource ARNs to include or exclude.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_ResourceTag"> <summary> <para> <para>Filter criteria for resource tags, allowing filtering by tag key and value combinations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Criteria_RestartNeeded"> <summary> <para> <para>Filter criteria indicating whether the recommended action requires a resource restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.OrganizationConfiguration_RuleApplyOrder"> <summary> <para> <para>Specifies when organization rules should be applied relative to account rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.RuleArn"> <summary> <para> <para> The ARN of the rule to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.RuleRevision"> <summary> <para> <para> The revision number of the rule to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.RuleType"> <summary> <para> <para>The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Schedule_ScheduleExpression"> <summary> <para> <para>The expression that defines when the schedule runs. <c>cron</c> expression is supported. A <c>cron</c> expression consists of six fields separated by white spaces: (<c>minutes</c><c>hours</c><c>day_of_month</c><c>month</c><c>day_of_week</c><c>year</c>)</para><note><para>You can schedule rules to run at most once per day. Your cron expression must use specific values (not wildcards) for the minutes and hours fields. For example: (<c>30 12 * * *</c>) runs daily at 12:30 PM UTC.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Schedule_ScheduleExpressionTimezone"> <summary> <para> <para>The timezone to use when interpreting the schedule expression.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.Status"> <summary> <para> <para>The updated status of the automation rule. Can be Active or Inactive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAAutomationRuleCmdlet.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.ComputeOptimizerAutomation.Model.UpdateAutomationRuleResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.UpdateAutomationRuleResponse 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.COA.UpdateCOAAutomationRuleCmdlet.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.COA.UpdateCOAEnrollmentConfigurationCmdlet"> <summary> Updates your account’s Compute Optimizer Automation enrollment configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAEnrollmentConfigurationCmdlet.Status"> <summary> <para> <para>The desired enrollment status. </para><ul><li><para>Active - Enables the Automation feature for your account.</para></li><li><para>Inactive - Disables the Automation feature for your account and stops all of your automation rules. If you opt in again later, all rules will be inactive, and you must enable the rules you want to run. You must wait at least 24 hours after opting out to opt in again.</para></li></ul><note><para>The <c>Pending</c> and <c>Failed</c> options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.</para><para>If you are a member account, your account must be disassociated from your organization’s management account before you can disable Automation. Contact your administrator to make this change.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAEnrollmentConfigurationCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAEnrollmentConfigurationCmdlet.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.ComputeOptimizerAutomation.Model.UpdateEnrollmentConfigurationResponse). Specifying the name of a property of type Amazon.ComputeOptimizerAutomation.Model.UpdateEnrollmentConfigurationResponse 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.COA.UpdateCOAEnrollmentConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Status parameter. The -PassThru parameter is deprecated, use -Select '^Status' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.COA.UpdateCOAEnrollmentConfigurationCmdlet.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> |