Automation is a feature within Amazon Web Services Compute Optimizer that enables you to apply optimization recommendations to your Amazon Web Services resources, reducing costs and improving performance. You can apply recommended actions directly or create automation rules that implement recommendations on a recurring schedule when they match your specified criteria. With automation rules, set criteria such as Amazon Web Services Region and Resource Tags to target specific geographies and workloads. Configure rules to run daily, weekly, or monthly, and Compute Optimizer continuously evaluates new recommendations against your criteria. Track automation events over time, examine detailed step history, estimate savings achieved, and reverse actions directly from Compute Optimizer when needed.
", "operations": { "AssociateAccounts": "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.
Only the management account or a delegated administrator can perform this action.
Creates a new automation rule to apply recommended actions to resources based on specified criteria.
", "DeleteAutomationRule": "Deletes an existing automation rule.
", "DisassociateAccounts": "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.
Only the management account or a delegated administrator can perform this action.
Retrieves details about a specific automation event.
", "GetAutomationRule": "Retrieves details about a specific automation rule.
", "GetEnrollmentConfiguration": "Retrieves the current enrollment configuration for Compute Optimizer Automation.
", "ListAccounts": "Lists the accounts in your organization that are enrolled in Compute Optimizer and whether they have enabled Automation.
Only the management account or a delegated administrator can perform this action.
Lists the steps for a specific automation event. You can only list steps for events created within the past year.
", "ListAutomationEventSummaries": "Provides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.
", "ListAutomationEvents": "Lists automation events based on specified filters. You can retrieve events that were created within the past year.
", "ListAutomationRulePreview": "Returns a preview of the recommended actions that match your Automation rule's configuration and criteria.
", "ListAutomationRulePreviewSummaries": "Returns a summary of the recommended actions that match your rule preview configuration and criteria.
", "ListAutomationRules": "Lists the automation rules that match specified filters.
", "ListRecommendedActionSummaries": "Provides a summary of recommended actions based on specified filters.
Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts.
Lists the recommended actions based that match specified filters.
Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts.
Lists the tags for a specified resource.
", "RollbackAutomationEvent": "Initiates a rollback for a completed automation event.
Management accounts and delegated administrators can only initiate a rollback for events belonging to associated member accounts. You can associate a member account using AssociateAccounts.
Initiates a one-time, on-demand automation for the specified recommended action.
Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using AssociateAccounts.
Adds tags to the specified resource.
", "UntagResource": "Removes tags from the specified resource.
", "UpdateAutomationRule": "Updates an existing automation rule.
", "UpdateEnrollmentConfiguration": "Updates your account’s Compute Optimizer Automation enrollment configuration.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient permissions to perform this action.
", "refs": {} }, "AccountId": { "base": null, "refs": { "AccountIdList$member": null, "AccountInfo$accountId": "The ID of the Amazon Web Services account.
", "AutomationEvent$accountId": "The Amazon Web Services account ID associated with the automation event.
", "AutomationRule$accountId": "The 12-digit Amazon Web Services account ID that owns this automation rule.
", "GetAutomationEventResponse$accountId": "The Amazon Web Services account ID associated with the automation event.
", "GetAutomationRuleResponse$accountId": "The 12-digit Amazon Web Services account ID that owns this automation rule.
", "OrganizationConfigurationAccountIds$member": null, "PreviewResult$accountId": "The Amazon Web Services account ID associated with the resource.
", "RecommendedAction$accountId": "The Amazon Web Services account ID that owns the resource.
" } }, "AccountIdList": { "base": null, "refs": { "AssociateAccountsRequest$accountIds": "The IDs of the member accounts to associate. You can specify up to 50 account IDs.
", "AssociateAccountsResponse$accountIds": "The IDs of the member accounts that were successfully associated.
", "DisassociateAccountsRequest$accountIds": "The IDs of the member accounts to disassociate.
", "DisassociateAccountsResponse$accountIds": "The IDs of the member accounts that were successfully disassociated.
" } }, "AccountInfo": { "base": "Contains information about an Amazon Web Services account's enrollment and association status with Compute Optimizer Automation.
", "refs": { "AccountInfoList$member": null } }, "AccountInfoList": { "base": null, "refs": { "ListAccountsResponse$accounts": "The list of accounts in your organization enrolled in Compute Optimizer
" } }, "AssociateAccountsRequest": { "base": null, "refs": {} }, "AssociateAccountsResponse": { "base": null, "refs": {} }, "AutomationEvent": { "base": "Contains information about an automation event.
", "refs": { "AutomationEvents$member": null } }, "AutomationEventFilter": { "base": "A filter to apply when listing automation events.
", "refs": { "AutomationEventFilterList$member": null } }, "AutomationEventFilterList": { "base": null, "refs": { "ListAutomationEventSummariesRequest$filters": "The filters to apply to the list of automation event summaries.
", "ListAutomationEventsRequest$filters": "The filters to apply to the list of automation events.
" } }, "AutomationEventFilterName": { "base": null, "refs": { "AutomationEventFilter$name": "The name of the filter to apply.
" } }, "AutomationEventStep": { "base": "Contains information about a step in an automation event.
", "refs": { "AutomationEventSteps$member": null } }, "AutomationEventSteps": { "base": null, "refs": { "ListAutomationEventStepsResponse$automationEventSteps": "The list of steps for the specified automation event.
" } }, "AutomationEventSummary": { "base": "A summary of automation events grouped by specified dimensions.
", "refs": { "AutomationEventSummaryList$member": null } }, "AutomationEventSummaryList": { "base": null, "refs": { "ListAutomationEventSummariesResponse$automationEventSummaries": "The list of automation event summaries that match the specified criteria.
" } }, "AutomationEvents": { "base": null, "refs": { "ListAutomationEventsResponse$automationEvents": "The list of automation events that match the specified criteria.
" } }, "AutomationRule": { "base": "Represents a complete automation rule configuration including criteria, schedule, and execution settings.
", "refs": { "AutomationRules$member": null } }, "AutomationRuleFilterName": { "base": null, "refs": { "Filter$name": "The name of the filter field to apply.
" } }, "AutomationRules": { "base": null, "refs": { "ListAutomationRulesResponse$automationRules": "The list of automation rules that match the specified criteria.
" } }, "Boolean": { "base": null, "refs": { "PreviewResult$restartNeeded": "Indicates whether implementing the recommended action requires a resource restart.
", "RecommendedAction$restartNeeded": "Indicates whether implementing the recommended action requires a resource restart.
" } }, "ClientToken": { "base": null, "refs": { "AssociateAccountsRequest$clientToken": "A unique identifier to ensure idempotency of the request. Valid for 24 hours after creation.
", "CreateAutomationRuleRequest$clientToken": "A unique identifier to ensure idempotency of the request.
", "DeleteAutomationRuleRequest$clientToken": "A unique identifier to ensure idempotency of the request.
", "DisassociateAccountsRequest$clientToken": "A unique identifier to ensure idempotency of the request.
", "RollbackAutomationEventRequest$clientToken": "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.
", "StartAutomationEventRequest$clientToken": "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.
", "TagResourceRequest$clientToken": "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.
", "UntagResourceRequest$clientToken": "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.
", "UpdateAutomationRuleRequest$clientToken": "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.
", "UpdateEnrollmentConfigurationRequest$clientToken": "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.
" } }, "ComparisonOperator": { "base": null, "refs": { "DoubleCriteriaCondition$comparison": "The comparison operator to use, such as equals, greater than, less than, etc.
", "IntegerCriteriaCondition$comparison": "The comparison operator to use, such as equals, greater than, less than, etc.
", "ResourceTagsCriteriaCondition$comparison": "The comparison operator used to evaluate the tag criteria, such as equals, not equals, or contains.
", "StringCriteriaCondition$comparison": "The comparison operator used to evaluate the string criteria, such as equals, not equals, or contains.
" } }, "CreateAutomationRuleRequest": { "base": null, "refs": {} }, "CreateAutomationRuleResponse": { "base": null, "refs": {} }, "Criteria": { "base": "A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.
", "refs": { "CreateAutomationRuleRequest$criteria": "A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.
", "CreateAutomationRuleResponse$criteria": null, "GetAutomationRuleResponse$criteria": null, "ListAutomationRulePreviewRequest$criteria": "A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.
", "ListAutomationRulePreviewSummariesRequest$criteria": null, "UpdateAutomationRuleRequest$criteria": null, "UpdateAutomationRuleResponse$criteria": null } }, "DeleteAutomationRuleRequest": { "base": null, "refs": {} }, "DeleteAutomationRuleResponse": { "base": null, "refs": {} }, "DisassociateAccountsRequest": { "base": null, "refs": {} }, "DisassociateAccountsResponse": { "base": null, "refs": {} }, "Double": { "base": null, "refs": { "DoubleList$member": null, "EstimatedMonthlySavings$beforeDiscountSavings": "The estimated monthly savings before applying any discounts.
", "EstimatedMonthlySavings$afterDiscountSavings": "The estimated monthly savings after applying any discounts.
" } }, "DoubleCriteriaCondition": { "base": "Defines a condition for filtering based on double/floating-point numeric values with comparison operators.
", "refs": { "DoubleCriteriaConditionList$member": null } }, "DoubleCriteriaConditionList": { "base": null, "refs": { "Criteria$estimatedMonthlySavings": "Filter criteria for estimated monthly cost savings from the recommended action.
" } }, "DoubleList": { "base": null, "refs": { "DoubleCriteriaCondition$values": "The list of double values to compare against using the specified comparison operator.
" } }, "EbsVolume": { "base": "Represents an Amazon EBS volume with its configuration and snapshot usage information.
", "refs": { "ResourceDetails$ebsVolume": "Detailed configuration information specific to EBS volumes, including volume type, size, IOPS, and throughput settings.
" } }, "EbsVolumeConfiguration": { "base": "Configuration details for an Amazon EBS volume.
", "refs": { "EbsVolume$configuration": "The configuration details of the EBS volume, including type, size, IOPS, and throughput.
" } }, "EnrollmentStatus": { "base": null, "refs": { "AccountInfo$status": "The enrollment status of the account: Active, Inactive, Pending, or Failed.
", "GetEnrollmentConfigurationResponse$status": "The current enrollment status.
", "UpdateEnrollmentConfigurationRequest$status": "The desired enrollment status.
Active - Enables the Automation feature for your account.
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.
The Pending and Failed 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.
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.
The updated enrollment status.
" } }, "EstimatedMonthlySavings": { "base": "Contains information about estimated monthly cost savings.
", "refs": { "AutomationEvent$estimatedMonthlySavings": "The estimated monthly cost savings associated with this automation event.
", "AutomationEventStep$estimatedMonthlySavings": null, "GetAutomationEventResponse$estimatedMonthlySavings": null, "PreviewResult$estimatedMonthlySavings": null, "RecommendedAction$estimatedMonthlySavings": null, "RecommendedActionTotal$estimatedMonthlySavings": null, "RulePreviewTotal$estimatedMonthlySavings": null, "SummaryTotals$estimatedMonthlySavings": null } }, "EventId": { "base": null, "refs": { "AutomationEvent$eventId": "The unique identifier for the automation event.
", "AutomationEventStep$eventId": "The ID of the automation event this step belongs to.
", "GetAutomationEventRequest$eventId": "The ID of the automation event to retrieve.
", "GetAutomationEventResponse$eventId": "The ID of the automation event to retrieve.
", "ListAutomationEventStepsRequest$eventId": "The ID of the automation event.
", "RollbackAutomationEventRequest$eventId": "The ID of the automation event to roll back.
", "RollbackAutomationEventResponse$eventId": "The ID of the automation event being rolled back.
", "StartAutomationEventResponse$eventId": "The ID of the automation event.
" } }, "EventStatus": { "base": null, "refs": { "AutomationEvent$eventStatus": "The current status of the automation event.
", "GetAutomationEventResponse$eventStatus": "The current status of the automation event.
", "RollbackAutomationEventResponse$eventStatus": "The current status of the rollback operation.
", "StartAutomationEventResponse$eventStatus": "The current status of the automation event.
" } }, "EventType": { "base": "Event type enumeration
", "refs": { "AutomationEvent$eventType": "The type of automation event.
", "GetAutomationEventResponse$eventType": "The type of automation event.
" } }, "Filter": { "base": "A filter used to narrow down results based on specific criteria.
", "refs": { "FilterList$member": null } }, "FilterList": { "base": null, "refs": { "ListAutomationRulesRequest$filters": "The filters to apply to the list of automation rules.
" } }, "FilterValue": { "base": null, "refs": { "FilterValues$member": null } }, "FilterValues": { "base": null, "refs": { "AutomationEventFilter$values": "The values to use for the specified filter.
", "Filter$values": "The list of values to filter by for the specified filter field.
", "RecommendedActionFilter$values": "List of filter values to match against the specified filter name. Used to narrow down recommended actions based on specific criteria.
" } }, "ForbiddenException": { "base": "You are not authorized to perform this action.
", "refs": {} }, "GetAutomationEventRequest": { "base": null, "refs": {} }, "GetAutomationEventResponse": { "base": null, "refs": {} }, "GetAutomationRuleRequest": { "base": null, "refs": {} }, "GetAutomationRuleResponse": { "base": null, "refs": {} }, "GetEnrollmentConfigurationRequest": { "base": null, "refs": {} }, "GetEnrollmentConfigurationResponse": { "base": null, "refs": {} }, "IdempotencyTokenInUseException": { "base": "The specified client token is already in use.
", "refs": {} }, "IdempotentParameterMismatchException": { "base": "Exception thrown when the same client token is used with different parameters, indicating a mismatch in idempotent request parameters.
", "refs": {} }, "Integer": { "base": null, "refs": { "EbsVolumeConfiguration$sizeInGib": "The size of the EBS volume in gibibytes (GiB).
", "EbsVolumeConfiguration$iops": "The number of I/O operations per second (IOPS) provisioned for the volume.
", "EbsVolumeConfiguration$throughput": "The throughput in MiB/s provisioned for the volume (applicable to gp3, io1, and io2bx volumes).
", "IntegerList$member": null, "PreviewResult$lookBackPeriodInDays": "The number of days of historical data used to analyze the resource.
", "RecommendedAction$lookBackPeriodInDays": "The number of days of historical data used to generate the recommendation.
", "RecommendedActionTotal$recommendedActionCount": "The total number of recommended actions in this group.
", "RulePreviewTotal$recommendedActionCount": "The total number of recommended actions matching the rule preview configuration.
", "SummaryTotals$automationEventCount": "The total number of automation events in this summary group.
" } }, "IntegerCriteriaCondition": { "base": "Defines a condition for filtering based on integer values with comparison operators.
", "refs": { "IntegerCriteriaConditionList$member": null } }, "IntegerCriteriaConditionList": { "base": null, "refs": { "Criteria$ebsVolumeSizeInGib": "Filter criteria for EBS volume sizes in gibibytes (GiB).
", "Criteria$lookBackPeriodInDays": "Filter criteria for the lookback period in days used to analyze resource utilization.
" } }, "IntegerList": { "base": null, "refs": { "IntegerCriteriaCondition$values": "The list of integer values to compare against using the specified comparison operator.
" } }, "InternalServerException": { "base": "An internal error occurred while processing the request.
", "refs": {} }, "InvalidParameterValueException": { "base": "One or more parameter values are not valid.
", "refs": {} }, "ListAccountsRequest": { "base": null, "refs": {} }, "ListAccountsRequestMaxResultsInteger": { "base": null, "refs": { "ListAccountsRequest$maxResults": "The maximum number of results to return in a single call.
" } }, "ListAccountsResponse": { "base": null, "refs": {} }, "ListAutomationEventStepsRequest": { "base": null, "refs": {} }, "ListAutomationEventStepsRequestMaxResultsInteger": { "base": null, "refs": { "ListAutomationEventStepsRequest$maxResults": "The maximum number of automation event steps to return in a single response. Valid range is 1-1000.
" } }, "ListAutomationEventStepsResponse": { "base": null, "refs": {} }, "ListAutomationEventSummariesRequest": { "base": null, "refs": {} }, "ListAutomationEventSummariesRequestMaxResultsInteger": { "base": null, "refs": { "ListAutomationEventSummariesRequest$maxResults": "The maximum number of automation event summaries to return in a single response. Valid range is 1-1000.
" } }, "ListAutomationEventSummariesResponse": { "base": null, "refs": {} }, "ListAutomationEventsRequest": { "base": null, "refs": {} }, "ListAutomationEventsRequestMaxResultsInteger": { "base": null, "refs": { "ListAutomationEventsRequest$maxResults": "The maximum number of results to return in a single call.
" } }, "ListAutomationEventsResponse": { "base": null, "refs": {} }, "ListAutomationRulePreviewRequest": { "base": null, "refs": {} }, "ListAutomationRulePreviewRequestMaxResultsInteger": { "base": null, "refs": { "ListAutomationRulePreviewRequest$maxResults": "The maximum number of automation rule preview results to return in a single response. Valid range is 1-1000.
" } }, "ListAutomationRulePreviewResponse": { "base": null, "refs": {} }, "ListAutomationRulePreviewSummariesRequest": { "base": null, "refs": {} }, "ListAutomationRulePreviewSummariesRequestMaxResultsInteger": { "base": null, "refs": { "ListAutomationRulePreviewSummariesRequest$maxResults": "The maximum number of automation rule preview summaries to return in a single response. Valid range is 1-1000.
" } }, "ListAutomationRulePreviewSummariesResponse": { "base": null, "refs": {} }, "ListAutomationRulesRequest": { "base": null, "refs": {} }, "ListAutomationRulesRequestMaxResultsInteger": { "base": null, "refs": { "ListAutomationRulesRequest$maxResults": "The maximum number of automation rules to return in a single response. Valid range is 1-1000.
" } }, "ListAutomationRulesResponse": { "base": null, "refs": {} }, "ListRecommendedActionSummariesRequest": { "base": null, "refs": {} }, "ListRecommendedActionSummariesRequestMaxResultsInteger": { "base": null, "refs": { "ListRecommendedActionSummariesRequest$maxResults": "The maximum number of recommended action summaries to return in a single response. Valid range is 1-1000.
" } }, "ListRecommendedActionSummariesResponse": { "base": null, "refs": {} }, "ListRecommendedActionsRequest": { "base": null, "refs": {} }, "ListRecommendedActionsRequestMaxResultsInteger": { "base": null, "refs": { "ListRecommendedActionsRequest$maxResults": "The maximum number of recommended actions to return in a single response. Valid range is 1-1000.
" } }, "ListRecommendedActionsResponse": { "base": null, "refs": {} }, "ListTagsForResourceRequest": { "base": null, "refs": {} }, "ListTagsForResourceResponse": { "base": null, "refs": {} }, "Long": { "base": null, "refs": { "AutomationRule$ruleRevision": "The revision number of the automation rule.
", "CreateAutomationRuleResponse$ruleRevision": "The revision number of the automation rule. This is incremented each time the rule is updated.
", "DeleteAutomationRuleRequest$ruleRevision": "The revision number of the rule to delete.
", "GetAutomationRuleResponse$ruleRevision": "The revision number of the automation rule.
", "TagResourceRequest$ruleRevision": "The revision number of the automation rule to tag. This ensures you're tagging the correct version of the rule.
", "UntagResourceRequest$ruleRevision": "The revision number of the automation rule to untag. This ensures you're untagging the correct version of the rule.
", "UpdateAutomationRuleRequest$ruleRevision": "The revision number of the rule to update.
", "UpdateAutomationRuleResponse$ruleRevision": "The new revision number of the updated rule.
" } }, "NextToken": { "base": null, "refs": { "ListAccountsRequest$nextToken": "The token for the next page of results.
", "ListAccountsResponse$nextToken": "The token to use to retrieve the next page of results.
", "ListAutomationEventStepsRequest$nextToken": "A token used for pagination to retrieve the next set of results when the response is truncated.
", "ListAutomationEventStepsResponse$nextToken": "A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
", "ListAutomationEventSummariesRequest$nextToken": "A token used for pagination to retrieve the next set of results when the response is truncated.
", "ListAutomationEventSummariesResponse$nextToken": "A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
", "ListAutomationEventsRequest$nextToken": "The token for the next page of results.
", "ListAutomationEventsResponse$nextToken": "The token to use to retrieve the next page of results.
", "ListAutomationRulePreviewRequest$nextToken": "A token used for pagination to retrieve the next set of results when the response is truncated.
", "ListAutomationRulePreviewResponse$nextToken": "A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
", "ListAutomationRulePreviewSummariesRequest$nextToken": "A token used for pagination to retrieve the next set of results when the response is truncated.
", "ListAutomationRulePreviewSummariesResponse$nextToken": "A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
", "ListAutomationRulesRequest$nextToken": "A token used for pagination to retrieve the next set of results when the response is truncated.
", "ListAutomationRulesResponse$nextToken": "A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
", "ListRecommendedActionSummariesRequest$nextToken": "A token used for pagination to retrieve the next set of results when the response is truncated.
", "ListRecommendedActionSummariesResponse$nextToken": "A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
", "ListRecommendedActionsRequest$nextToken": "A token used for pagination to retrieve the next set of results when the response is truncated.
", "ListRecommendedActionsResponse$nextToken": "A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.
" } }, "NotManagementAccountException": { "base": "The operation can only be performed by a management account.
", "refs": {} }, "OptInRequiredException": { "base": "The account must be opted in to Compute Optimizer Automation before performing this action.
", "refs": {} }, "OrganizationConfiguration": { "base": "Configuration settings for organization-wide automation rules.
", "refs": { "AutomationRule$organizationConfiguration": "Configuration settings for organization-wide rules.
", "CreateAutomationRuleRequest$organizationConfiguration": "Configuration for organization-level rules. Required for OrganizationRule type.
", "CreateAutomationRuleResponse$organizationConfiguration": "Configuration settings for organization-wide rules, including rule application order and target account IDs.
", "GetAutomationRuleResponse$organizationConfiguration": null, "UpdateAutomationRuleRequest$organizationConfiguration": "Updated configuration settings for organization-wide rules, including rule application order and target account IDs.
", "UpdateAutomationRuleResponse$organizationConfiguration": "The updated organization configuration settings.
" } }, "OrganizationConfigurationAccountIds": { "base": null, "refs": { "OrganizationConfiguration$accountIds": "List of specific Amazon Web Services account IDs where the organization rule should be applied.
", "OrganizationScope$accountIds": "List of Amazon Web Services account IDs to include in the organization scope.
" } }, "OrganizationRuleMode": { "base": null, "refs": { "AccountInfo$organizationRuleMode": "Specifies whether the management account can create Automation rules that implement optimization actions for this account.
", "GetEnrollmentConfigurationResponse$organizationRuleMode": "Specifies whether the management account can create Automation rules that implement optimization actions for this account.
" } }, "OrganizationScope": { "base": "Defines the scope for organization-level rules when previewing matching actions.
", "refs": { "ListAutomationRulePreviewRequest$organizationScope": "The organizational scope for the rule preview.
", "ListAutomationRulePreviewSummariesRequest$organizationScope": "The organizational scope for the rule preview.
" } }, "PreviewResult": { "base": "Contains the results of previewing an automation rule against available recommendations.
", "refs": { "PreviewResults$member": null } }, "PreviewResultSummaries": { "base": null, "refs": { "ListAutomationRulePreviewSummariesResponse$previewResultSummaries": "The list of automation rule preview summaries that match the specified criteria.
" } }, "PreviewResultSummary": { "base": "Contains a summary of preview results for an automation rule.
", "refs": { "PreviewResultSummaries$member": null } }, "PreviewResults": { "base": null, "refs": { "ListAutomationRulePreviewResponse$previewResults": "The list of actions that would be taken based on the specified criteria.
" } }, "RecommendedAction": { "base": "Contains information about a recommended action that can be applied to optimize an Amazon Web Services resource.
", "refs": { "RecommendedActions$member": null } }, "RecommendedActionFilter": { "base": "A filter used to narrow down recommended action results based on specific criteria.
", "refs": { "RecommendedActionFilterList$member": null } }, "RecommendedActionFilterList": { "base": null, "refs": { "ListRecommendedActionSummariesRequest$filters": "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.
", "ListRecommendedActionsRequest$filters": "The filters to apply to the list of recommended actions.
" } }, "RecommendedActionFilterName": { "base": null, "refs": { "RecommendedActionFilter$name": "The name of the filter field to apply.
" } }, "RecommendedActionId": { "base": null, "refs": { "AutomationEvent$recommendedActionId": "The ID of the recommended action associated with this automation event.
", "GetAutomationEventResponse$recommendedActionId": "The ID of the recommended action associated with this automation event.
", "PreviewResult$recommendedActionId": "The ID of the recommended action being previewed.
", "RecommendedAction$recommendedActionId": "The unique identifier of the recommended action.
", "StartAutomationEventRequest$recommendedActionId": "The ID of the recommended action to automate.
", "StartAutomationEventResponse$recommendedActionId": "The ID of the recommended action being automated.
" } }, "RecommendedActionSummaries": { "base": null, "refs": { "ListRecommendedActionSummariesResponse$recommendedActionSummaries": "The summary of recommended actions that match the specified criteria.
" } }, "RecommendedActionSummary": { "base": "Summary information about recommended actions, grouped by specific criteria with totals and counts.
", "refs": { "RecommendedActionSummaries$member": null } }, "RecommendedActionTotal": { "base": "Aggregate totals for a group of recommended actions, including count and estimated monthly savings.
", "refs": { "RecommendedActionSummary$total": "Aggregate totals for the recommended actions in this group, including count and estimated savings.
" } }, "RecommendedActionType": { "base": "Recommended action type enumeration
", "refs": { "PreviewResult$recommendedActionType": "The type of recommended action being previewed.
", "RecommendedAction$recommendedActionType": "The type of action being recommended.
", "RecommendedActionTypeList$member": null } }, "RecommendedActionTypeList": { "base": null, "refs": { "AutomationRule$recommendedActionTypes": "List of recommended action types that this rule can execute.
", "CreateAutomationRuleRequest$recommendedActionTypes": "The types of recommended actions this rule will automate.
", "CreateAutomationRuleResponse$recommendedActionTypes": "List of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.
", "GetAutomationRuleResponse$recommendedActionTypes": "List of recommended action types that this rule can execute.
", "ListAutomationRulePreviewRequest$recommendedActionTypes": "The types of recommended actions to include in the preview.
", "ListAutomationRulePreviewSummariesRequest$recommendedActionTypes": "The types of recommended actions to include in the preview.
", "UpdateAutomationRuleRequest$recommendedActionTypes": "Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.
", "UpdateAutomationRuleResponse$recommendedActionTypes": "The updated list of recommended action types.
" } }, "RecommendedActions": { "base": null, "refs": { "ListRecommendedActionsResponse$recommendedActions": "The list of recommended actions that match the specified criteria.
" } }, "ResourceArn": { "base": null, "refs": { "AutomationEvent$resourceArn": "The Amazon Resource Name (ARN) of the resource affected by the automation event.
", "GetAutomationEventResponse$resourceArn": "The Amazon Resource Name (ARN) of the resource affected by the automation event.
", "PreviewResult$resourceArn": "The Amazon Resource Name (ARN) of the resource affected by the recommended action.
", "RecommendedAction$resourceArn": "The Amazon Resource Name (ARN) of the resource that the recommendation applies to.
" } }, "ResourceDetails": { "base": "Detailed configuration information for a specific Amazon Web Services resource, with type-specific details.
", "refs": { "PreviewResult$currentResourceDetails": null, "PreviewResult$recommendedResourceDetails": null, "RecommendedAction$currentResourceDetails": null, "RecommendedAction$recommendedResourceDetails": null } }, "ResourceId": { "base": null, "refs": { "AutomationEvent$resourceId": "The ID of the resource affected by the automation event.
", "AutomationEventStep$resourceId": "The unique identifier of the resource being acted upon in this step.
", "GetAutomationEventResponse$resourceId": "The ID of the resource affected by the automation event.
", "PreviewResult$resourceId": "The ID of the resource affected by the recommended action.
", "RecommendedAction$resourceId": "The ID of the resource that the recommendation applies to.
" } }, "ResourceNotFoundException": { "base": "The specified resource was not found.
", "refs": {} }, "ResourceTagsCriteriaCondition": { "base": "Criteria condition for filtering resources based on their tags, including comparison operators and values.
", "refs": { "ResourceTagsCriteriaConditionList$member": null } }, "ResourceTagsCriteriaConditionList": { "base": null, "refs": { "Criteria$resourceTag": "Filter criteria for resource tags, allowing filtering by tag key and value combinations.
" } }, "ResourceType": { "base": null, "refs": { "AutomationEvent$resourceType": "The type of resource affected by the automation event.
", "GetAutomationEventResponse$resourceType": "The type of resource affected by the automation event.
", "PreviewResult$resourceType": "The type of resource being evaluated.
", "RecommendedAction$resourceType": "The type of resource being evaluated.
" } }, "RollbackAutomationEventRequest": { "base": null, "refs": {} }, "RollbackAutomationEventResponse": { "base": null, "refs": {} }, "RuleApplyOrder": { "base": null, "refs": { "OrganizationConfiguration$ruleApplyOrder": "Specifies when organization rules should be applied relative to account rules.
" } }, "RuleArn": { "base": null, "refs": { "AutomationRule$ruleArn": "The Amazon Resource Name (ARN) of the automation rule.
", "CreateAutomationRuleResponse$ruleArn": "The Amazon Resource Name (ARN) of the created rule.
", "DeleteAutomationRuleRequest$ruleArn": "The ARN of the rule to delete.
", "GetAutomationRuleRequest$ruleArn": "The ARN of the rule to retrieve.
", "GetAutomationRuleResponse$ruleArn": "The Amazon Resource Name (ARN) of the automation rule.
", "ListTagsForResourceRequest$resourceArn": "The ARN of the resource to list tags for.
", "TagResourceRequest$resourceArn": "The ARN of the resource to tag.
", "UntagResourceRequest$resourceArn": "The ARN of the resource to untag.
", "UpdateAutomationRuleRequest$ruleArn": "The ARN of the rule to update.
", "UpdateAutomationRuleResponse$ruleArn": "The ARN of the updated rule.
" } }, "RuleDescription": { "base": null, "refs": { "CreateAutomationRuleRequest$description": "A description of the automation rule.
", "UpdateAutomationRuleRequest$description": "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.
" } }, "RuleId": { "base": null, "refs": { "AutomationEvent$ruleId": "The ID of the automation rule that triggered this event.
", "AutomationRule$ruleId": "The unique identifier of the automation rule.
", "CreateAutomationRuleResponse$ruleId": "The unique identifier of the created rule.
", "GetAutomationEventResponse$ruleId": "The ID of the automation rule that triggered this event.
", "GetAutomationRuleResponse$ruleId": "The unique identifier of the automation rule.
" } }, "RuleName": { "base": null, "refs": { "AutomationRule$name": "The name of the automation rule.
", "CreateAutomationRuleRequest$name": "The name of the automation rule.
", "CreateAutomationRuleResponse$name": "The name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.
", "GetAutomationRuleResponse$name": "The name of the automation rule.
", "UpdateAutomationRuleRequest$name": "The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.
", "UpdateAutomationRuleResponse$name": "The updated name of the automation rule.
" } }, "RulePreviewTotal": { "base": "Aggregate totals for automation rule preview results, including count and estimated savings.
", "refs": { "PreviewResultSummary$total": null } }, "RuleStatus": { "base": null, "refs": { "AutomationRule$status": "The current status of the automation rule (Active or Inactive).
", "CreateAutomationRuleRequest$status": "The status of the rule
", "CreateAutomationRuleResponse$status": "The current status of the automation rule. Can be Active or Inactive.
", "GetAutomationRuleResponse$status": "The current status of the automation rule (Active or Inactive).
", "UpdateAutomationRuleRequest$status": "The updated status of the automation rule. Can be Active or Inactive.
", "UpdateAutomationRuleResponse$status": "The updated status of the automation rule.
" } }, "RuleType": { "base": null, "refs": { "AutomationRule$ruleType": "The type of automation rule (OrganizationRule or AccountRule).
", "CreateAutomationRuleRequest$ruleType": "The type of rule.
Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.
The type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.
", "GetAutomationRuleResponse$ruleType": "The type of automation rule.
", "ListAutomationRulePreviewRequest$ruleType": "The type of rule.
Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.
The type of rule.
", "UpdateAutomationRuleRequest$ruleType": "The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.
", "UpdateAutomationRuleResponse$ruleType": "The updated type of automation rule.
" } }, "SavingsEstimationMode": { "base": null, "refs": { "EstimatedMonthlySavings$savingsEstimationMode": "The mode used to calculate savings, either BeforeDiscount or AfterDiscount.
" } }, "Schedule": { "base": "Configuration for scheduling when automation rules should execute, including timing and execution windows.
", "refs": { "AutomationRule$schedule": "The schedule configuration for when the automation rule should execute.
", "CreateAutomationRuleRequest$schedule": "The schedule for when the rule should run.
", "CreateAutomationRuleResponse$schedule": "The schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.
", "GetAutomationRuleResponse$schedule": null, "UpdateAutomationRuleRequest$schedule": "The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.
", "UpdateAutomationRuleResponse$schedule": "The updated schedule configuration.
" } }, "ScheduleExecutionWindowInMinutesInteger": { "base": null, "refs": { "Schedule$executionWindowInMinutes": "The time window in minutes during which the automation rule can start implementing recommended actions.
" } }, "ServiceQuotaExceededException": { "base": "The request would exceed service quotas.
", "refs": {} }, "ServiceUnavailableException": { "base": "The service is temporarily unavailable.
", "refs": {} }, "StartAutomationEventRequest": { "base": null, "refs": {} }, "StartAutomationEventResponse": { "base": null, "refs": {} }, "StepId": { "base": null, "refs": { "AutomationEventStep$stepId": "The unique identifier for this step.
" } }, "StepStatus": { "base": null, "refs": { "AutomationEventStep$stepStatus": "The current status of the step.
" } }, "StepType": { "base": null, "refs": { "AutomationEventStep$stepType": "The type of step.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "AccountInfo$statusReason": "The reason for the current Automation enrollment status.
", "AutomationEvent$eventDescription": "A description of the automation event.
", "AutomationEvent$eventStatusReason": "The reason for the current event status.
", "AutomationEvent$region": "The Amazon Web Services Region where the automation event occurred.
", "AutomationEventSummary$key": "The key identifier for this summary grouping.
", "AutomationRule$description": "A description of the automation rule.
", "AutomationRule$priority": "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.
", "CreateAutomationRuleRequest$priority": "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.
", "CreateAutomationRuleResponse$description": "A description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.
", "CreateAutomationRuleResponse$priority": "The priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.
", "EbsVolumeConfiguration$type": "The EBS volume type, such as gp2, gp3, io1, io2, st1, or sc1.
", "EstimatedMonthlySavings$currency": "The currency of the estimated savings.
", "ForbiddenException$message": null, "GetAutomationEventResponse$eventDescription": "A description of the automation event.
", "GetAutomationEventResponse$eventStatusReason": "The reason for the current event status.
", "GetAutomationEventResponse$region": "The Amazon Web Services Region where the automation event occurred.
", "GetAutomationRuleResponse$description": "A description of the automation rule.
", "GetAutomationRuleResponse$priority": "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.
", "GetEnrollmentConfigurationResponse$statusReason": "The reason for the current enrollment status.
", "IdempotencyTokenInUseException$message": null, "IdempotentParameterMismatchException$message": null, "InternalServerException$message": null, "InvalidParameterValueException$message": null, "ListAutomationEventSummariesRequest$startDateInclusive": "The start date for filtering automation event summaries, inclusive. Events created on or after this date will be included.
", "ListAutomationEventSummariesRequest$endDateExclusive": "The end date for filtering automation event summaries, exclusive. Events created before this date will be included.
", "NotManagementAccountException$message": null, "OptInRequiredException$message": null, "PreviewResult$region": "The Amazon Web Services Region where the resource is located.
", "PreviewResult$currentResourceSummary": "A summary of the resource's current configuration.
", "PreviewResult$recommendedResourceSummary": "A summary of the resource's recommended configuration.
", "PreviewResultSummary$key": "The key identifier for this preview result summary.
", "RecommendedAction$region": "The Amazon Web Services Region where the resource is located.
", "RecommendedAction$currentResourceSummary": "A summary of the resource's current configuration.
", "RecommendedAction$recommendedResourceSummary": "A summary of the resource's recommended configuration.
", "RecommendedActionSummary$key": "The grouping key used to categorize the recommended actions in this summary.
", "ResourceNotFoundException$message": null, "Schedule$scheduleExpression": "The expression that defines when the schedule runs. cron expression is supported. A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year)
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: (30 12 * * *) runs daily at 12:30 PM UTC.
The timezone to use when interpreting the schedule expression.
", "ServiceQuotaExceededException$message": null, "ServiceUnavailableException$message": null, "StringList$member": null, "SummaryDimension$value": "The specific value for this dimension key used in the summary grouping.
", "TagKeyList$member": null, "ThrottlingException$message": null, "UpdateAutomationRuleRequest$priority": "The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.
", "UpdateAutomationRuleResponse$description": "The updated description of the automation rule.
", "UpdateAutomationRuleResponse$priority": "The updated priority level of the automation rule.
", "UpdateEnrollmentConfigurationResponse$statusReason": "The reason for the updated enrollment status.
" } }, "StringCriteriaCondition": { "base": "Criteria condition for filtering based on string values, including comparison operators and target values.
", "refs": { "StringCriteriaConditionList$member": null } }, "StringCriteriaConditionList": { "base": null, "refs": { "Criteria$region": "Filter criteria for Amazon Web Services regions where resources must be located.
", "Criteria$resourceArn": "Filter criteria for specific resource ARNs to include or exclude.
", "Criteria$ebsVolumeType": "Filter criteria for EBS volume types, such as gp2, gp3, io1, io2, st1, or sc1.
", "Criteria$restartNeeded": "Filter criteria indicating whether the recommended action requires a resource restart.
" } }, "StringCriteriaValue": { "base": null, "refs": { "ResourceTagsCriteriaCondition$key": "The tag key to use for comparison when filtering resources.
", "StringCriteriaValues$member": null } }, "StringCriteriaValues": { "base": null, "refs": { "ResourceTagsCriteriaCondition$values": "List of tag values to compare against when filtering resources.
", "StringCriteriaCondition$values": "List of string values to compare against when applying the criteria condition.
" } }, "StringList": { "base": null, "refs": { "AssociateAccountsResponse$errors": "Any errors that occurred during the association process.
", "DisassociateAccountsResponse$errors": "Any errors that occurred during the disassociation process.
" } }, "SummaryDimension": { "base": "A key-value pair used to categorize and group summary data for analysis and reporting.
", "refs": { "SummaryDimensions$member": null } }, "SummaryDimensionKey": { "base": null, "refs": { "SummaryDimension$key": "The dimension key used for categorizing summary data.
" } }, "SummaryDimensions": { "base": null, "refs": { "AutomationEventSummary$dimensions": "The dimensions used to group this summary, such as event status.
" } }, "SummaryTotals": { "base": "Aggregate totals for automation events, including counts and estimated savings.
", "refs": { "AutomationEventSummary$total": "The aggregated totals for this summary, including event count and estimated savings.
" } }, "Tag": { "base": "A key-value pair used to categorize and organize Amazon Web Services resources and automation rules.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The tag key, which can be up to 128 characters long.
" } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The keys of the tags to remove from the resource.
" } }, "TagList": { "base": null, "refs": { "CreateAutomationRuleRequest$tags": "The tags to associate with the rule.
", "CreateAutomationRuleResponse$tags": "A list of key-value pairs used to categorize and organize the automation rule. Maximum of 200 tags allowed.
", "GetAutomationRuleResponse$tags": "The tags associated with the automation rule.
", "ListTagsForResourceResponse$tags": "The list of tags associated with the specified resource.
", "PreviewResult$resourceTags": "The tags associated with the resource.
", "RecommendedAction$resourceTags": "The tags associated with the resource.
", "TagResourceRequest$tags": "The tags to add to the resource.
" } }, "TagResourceRequest": { "base": null, "refs": {} }, "TagResourceResponse": { "base": null, "refs": {} }, "TagValue": { "base": null, "refs": { "Tag$value": "The tag value, which can be up to 256 characters long.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": {} }, "TimePeriod": { "base": "Defines a time range with inclusive start time and exclusive end time for filtering and analysis.
", "refs": { "AutomationEventSummary$timePeriod": "The time period covered by this summary, with inclusive start time and exclusive end time.
" } }, "Timestamp": { "base": null, "refs": { "AccountInfo$lastUpdatedTimestamp": "The timestamp when the account's Automation enrollment status was last updated.
", "AutomationEvent$createdTimestamp": "The timestamp when the automation event was created.
", "AutomationEvent$completedTimestamp": "The timestamp when the automation event completed.
", "AutomationEventStep$startTimestamp": "The timestamp when this automation event step started execution.
", "AutomationEventStep$completedTimestamp": "The timestamp when this automation event step completed execution.
", "AutomationRule$createdTimestamp": "The timestamp when the automation rule was created.
", "AutomationRule$lastUpdatedTimestamp": "The timestamp when the automation rule was last updated.
", "CreateAutomationRuleResponse$createdTimestamp": "The timestamp when the automation rule was created.
", "GetAutomationEventResponse$createdTimestamp": "The timestamp when the automation event was created.
", "GetAutomationEventResponse$completedTimestamp": "The timestamp when the automation event completed.
", "GetAutomationRuleResponse$createdTimestamp": "The timestamp when the automation rule was created.
", "GetAutomationRuleResponse$lastUpdatedTimestamp": "The timestamp when the automation rule was last updated.
", "GetEnrollmentConfigurationResponse$lastUpdatedTimestamp": "The timestamp of the last update to the enrollment configuration.
", "ListAutomationEventsRequest$startTimeInclusive": "The start of the time range to query for events.
", "ListAutomationEventsRequest$endTimeExclusive": "The end of the time range to query for events.
", "TimePeriod$startTimeInclusive": "The start time of the period, inclusive. Events at or after this time are included.
", "TimePeriod$endTimeExclusive": "The end time of the period, exclusive. Events before this time are included.
", "UpdateAutomationRuleResponse$createdTimestamp": "The timestamp when the automation rule was originally created.
", "UpdateAutomationRuleResponse$lastUpdatedTimestamp": "The timestamp when the automation rule was last updated.
", "UpdateEnrollmentConfigurationResponse$lastUpdatedTimestamp": "The timestamp when the enrollment configuration was last updated.
" } }, "UntagResourceRequest": { "base": null, "refs": {} }, "UntagResourceResponse": { "base": null, "refs": {} }, "UpdateAutomationRuleRequest": { "base": null, "refs": {} }, "UpdateAutomationRuleResponse": { "base": null, "refs": {} }, "UpdateEnrollmentConfigurationRequest": { "base": null, "refs": {} }, "UpdateEnrollmentConfigurationResponse": { "base": null, "refs": {} } } }