The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets.
Budgets provide you with a way to see the following information:
How close your plan is to your budgeted amount or to the free tier limits
Your usage-to-date, including how much you've used of your Reserved Instances (RIs)
Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month
How much of your budget has been used
AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:
Cost budgets - Plan how much you want to spend on a service.
Usage budgets - Plan how much you want to use one or more services.
RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.
RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.
Service Endpoint
The AWS Budgets API provides the following endpoint:
https://budgets.amazonaws.com
For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing.
", + "service": "The Amazon Web Services Budgets API enables you to use Amazon Web Services Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Amazon Web Services Budgets.
Budgets provide you with a way to see the following information:
How close your plan is to your budgeted amount or to the free tier limits
Your usage-to-date, including how much you've used of your Reserved Instances (RIs)
Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
How much of your budget has been used
Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:
Cost budgets - Plan how much you want to spend on a service.
Usage budgets - Plan how much you want to use one or more services.
RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.
RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.
Service Endpoint
The Amazon Web Services Budgets API provides the following endpoint:
https://budgets.amazonaws.com
For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.
", "operations": { "CreateBudget": "Creates a budget and, if included, notifications and subscribers.
Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Creates a budget action.
", @@ -20,7 +20,7 @@ "DescribeNotificationsForBudget": "Lists the notifications that are associated with a budget.
", "DescribeSubscribersForNotification": "Lists the subscribers that are associated with a notification.
", "ExecuteBudgetAction": "Executes a budget action.
", - "UpdateBudget": "Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.
Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting.
Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Updates a budget action.
", "UpdateNotification": "Updates a notification.
", "UpdateSubscriber": "Updates a subscriber.
" @@ -32,7 +32,7 @@ } }, "AccountId": { - "base": "The account ID of the user. It should be a 12-digit number.
", + "base": "The account ID of the user. It's a 12-digit number.
", "refs": { "CreateBudgetActionRequest$AccountId": null, "CreateBudgetActionResponse$AccountId": null, @@ -64,9 +64,9 @@ } }, "Action": { - "base": "A budget action resource.
", + "base": "A budget action resource.
", "refs": { - "ActionHistoryDetails$Action": "The budget action resource.
", + "ActionHistoryDetails$Action": "The budget action resource.
", "Actions$member": null, "DeleteBudgetActionResponse$Action": null, "DescribeBudgetActionResponse$Action": "A budget action resource.
", @@ -81,21 +81,21 @@ } }, "ActionHistory": { - "base": "The historical records for a budget action.
", + "base": "The historical records for a budget action.
", "refs": { "ActionHistories$member": null } }, "ActionHistoryDetails": { - "base": "The description of details of the event.
", + "base": "The description of the details for the event.
", "refs": { - "ActionHistory$ActionHistoryDetails": "The description of details of the event.
" + "ActionHistory$ActionHistoryDetails": "The description of the details for the event.
" } }, "ActionId": { "base": null, "refs": { - "Action$ActionId": "A system-generated universally unique identifier (UUID) for the action.
", + "Action$ActionId": "A system-generated universally unique identifier (UUID) for the action.
", "CreateBudgetActionResponse$ActionId": "A system-generated universally unique identifier (UUID) for the action.
", "DeleteBudgetActionRequest$ActionId": "A system-generated universally unique identifier (UUID) for the action.
", "DescribeBudgetActionHistoriesRequest$ActionId": "A system-generated universally unique identifier (UUID) for the action.
", @@ -108,20 +108,20 @@ "ActionStatus": { "base": null, "refs": { - "Action$Status": "The status of action.
", - "ActionHistory$Status": "The status of action at the time of the event.
" + "Action$Status": "The status of the action.
", + "ActionHistory$Status": "The status of action at the time of the event.
" } }, "ActionSubType": { "base": null, "refs": { - "SsmActionDefinition$ActionSubType": "The action subType.
" + "SsmActionDefinition$ActionSubType": "The action subType.
" } }, "ActionThreshold": { - "base": "The trigger threshold of the action.
", + "base": "The trigger threshold of the action.
", "refs": { - "Action$ActionThreshold": "The trigger threshold of the action.
", + "Action$ActionThreshold": "The trigger threshold of the action.
", "CreateBudgetActionRequest$ActionThreshold": null, "UpdateBudgetActionRequest$ActionThreshold": null } @@ -129,7 +129,7 @@ "ActionType": { "base": null, "refs": { - "Action$ActionType": "The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
", + "Action$ActionType": "The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
", "CreateBudgetActionRequest$ActionType": "The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
" } }, @@ -140,16 +140,35 @@ "DescribeBudgetActionsForBudgetResponse$Actions": "A list of the budget action resources information.
" } }, + "AdjustmentPeriod": { + "base": null, + "refs": { + "HistoricalOptions$BudgetAdjustmentPeriod": "The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:
For the DAILY granularity, the maximum value is 60.
For the MONTHLY granularity, the maximum value is 12.
For the QUARTERLY granularity, the maximum value is 4.
For the ANNUALLY granularity, the maximum value is 1.
The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3.
You can’t set your own LookBackAvailablePeriods. The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.
This specifies if the action needs manual or automatic approval.
", + "Action$ApprovalModel": "This specifies if the action needs manual or automatic approval.
", "CreateBudgetActionRequest$ApprovalModel": "This specifies if the action needs manual or automatic approval.
", "UpdateBudgetActionRequest$ApprovalModel": "This specifies if the action needs manual or automatic approval.
" } }, + "AutoAdjustData": { + "base": "The parameters that determine the budget amount for an auto-adjusting budget.
", + "refs": { + "Budget$AutoAdjustData": "The parameters that determine the budget amount for an auto-adjusting budget.
" + } + }, + "AutoAdjustType": { + "base": null, + "refs": { + "AutoAdjustData$AutoAdjustType": "The string that defines whether your budget auto-adjusts based on historical or forecasted data.
" + } + }, "Budget": { - "base": "Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.
This is the ARN pattern for a budget:
arn:aws:budgets::AccountId:budget/budgetName
Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.
This is the Amazon Resource Name (ARN) pattern for a budget:
arn:aws:budgets::AccountId:budget/budgetName
The budget object that you want to create.
", @@ -165,7 +184,7 @@ "BudgetPerformanceHistory$BudgetName": null, "CreateBudgetActionRequest$BudgetName": null, "CreateBudgetActionResponse$BudgetName": null, - "CreateNotificationRequest$BudgetName": "The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.
", + "CreateNotificationRequest$BudgetName": "The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.
", "CreateSubscriberRequest$BudgetName": "The name of the budget that you want to subscribe to. Budget names must be unique within an account.
", "DeleteBudgetActionRequest$BudgetName": null, "DeleteBudgetActionResponse$BudgetName": null, @@ -197,7 +216,7 @@ "BudgetType": { "base": "The type of a budget. It must be one of the following types:
COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.
Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
", + "Budget$BudgetType": "Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
", "BudgetPerformanceHistory$BudgetType": null } }, @@ -210,7 +229,7 @@ "BudgetedAndActualAmountsList": { "base": null, "refs": { - "BudgetPerformanceHistory$BudgetedAndActualAmountsList": "A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.
" + "BudgetPerformanceHistory$BudgetedAndActualAmountsList": "A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.
" } }, "Budgets": { @@ -220,26 +239,26 @@ } }, "CalculatedSpend": { - "base": "The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much you are predicted to spend based on your historical usage profile.
For example, if it is the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.
The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much that you're predicted to spend based on your historical usage profile.
For example, if it's the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.
The actual and forecasted cost or usage that the budget tracks.
" } }, "ComparisonOperator": { - "base": "The comparison operator of a notification. Currently the service supports the following operators:
GREATER_THAN, LESS_THAN, EQUAL_TO
The comparison operator of a notification. Currently, the service supports the following operators:
GREATER_THAN, LESS_THAN, EQUAL_TO
The comparison that is used for this notification.
" + "Notification$ComparisonOperator": "The comparison that's used for this notification.
" } }, "CostFilters": { "base": "A map that represents the cost filters that are applied to the budget.
", "refs": { - "Budget$CostFilters": "The cost filters, such as service or tag, that are applied to a budget.
AWS Budgets supports the following services as a filter for RI budgets:
Amazon Elastic Compute Cloud - Compute
Amazon Redshift
Amazon Relational Database Service
Amazon ElastiCache
Amazon Elasticsearch Service
The cost filters, such as Region, Service, member account, Tag, or Cost Category, that are applied to a budget.
Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:
Amazon EC2
Amazon Redshift
Amazon Relational Database Service
Amazon ElastiCache
Amazon OpenSearch Service
The history of the cost filters for a budget during the specified time period.
" } }, "CostTypes": { - "base": "The types of cost that are included in a COST budget, such as tax and subscriptions.
USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.
The types of cost that are included in a COST budget, such as tax and subscriptions.
USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets don't have CostTypes.
The types of costs that are included in this COST budget.
USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.
The history of the cost types for a budget during the specified time period.
" @@ -291,9 +310,9 @@ } }, "Definition": { - "base": "Specifies all of the type-specific parameters.
", + "base": "Specifies all of the type-specific parameters.
", "refs": { - "Action$Definition": "Where you specify all of the type-specific parameters.
", + "Action$Definition": "Where you specify all of the type-specific parameters.
", "CreateBudgetActionRequest$Definition": null, "UpdateBudgetActionRequest$Definition": null } @@ -442,7 +461,7 @@ "EventType": { "base": null, "refs": { - "ActionHistory$EventType": "This distinguishes between whether the events are triggered by the user or generated by the system.
" + "ActionHistory$EventType": "This distinguishes between whether the events are triggered by the user or are generated by the system.
" } }, "ExecuteBudgetActionRequest": { @@ -491,12 +510,13 @@ } }, "GenericTimestamp": { - "base": " A generic time stamp. In Java, it is transformed to a Date object.
A generic time stamp. In Java, it's transformed to a Date object.
The last time that your budget was auto-adjusted.
", "Budget$LastUpdatedTime": "The last time that you updated this budget.
", - "TimePeriod$Start": "The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget operation.
The end date for a budget. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget operation.
The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
You can change your start date with the UpdateBudget operation.
The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.
A list of groups to be attached. There must be at least one group.
" + "IamActionDefinition$Groups": "A list of groups to be attached. There must be at least one group.
" + } + }, + "HistoricalOptions": { + "base": "The parameters that define or describe the historical data that your auto-adjusting budget is based on.
", + "refs": { + "AutoAdjustData$HistoricalOptions": "The parameters that define or describe the historical data that your auto-adjusting budget is based on.
" } }, "IamActionDefinition": { - "base": "The AWS Identity and Access Management (IAM) action definition details.
", + "base": "The Identity and Access Management (IAM) action definition details.
", "refs": { - "Definition$IamActionDefinition": "The AWS Identity and Access Management (IAM) action definition details.
" + "Definition$IamActionDefinition": "The Identity and Access Management (IAM) action definition details.
" } }, "InstanceId": { @@ -526,7 +552,7 @@ "InstanceIds": { "base": null, "refs": { - "SsmActionDefinition$InstanceIds": "The EC2 and RDS instance IDs.
" + "SsmActionDefinition$InstanceIds": "The EC2 and RDS instance IDs.
" } }, "InternalErrorException": { @@ -562,14 +588,14 @@ } }, "Notification": { - "base": "A notification that is associated with a budget. A budget can have up to ten notifications.
Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:
A notificationType of ACTUAL
A thresholdType of PERCENTAGE
A comparisonOperator of GREATER_THAN
A notification threshold of 80
A notification that's associated with a budget. A budget can have up to ten notifications.
Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:
A notificationType of ACTUAL
A thresholdType of PERCENTAGE
A comparisonOperator of GREATER_THAN
A notification threshold of 80
The notification that you want to create.
", "CreateSubscriberRequest$Notification": "The notification that you want to create a subscriber for.
", "DeleteNotificationRequest$Notification": "The notification that you want to delete.
", "DeleteSubscriberRequest$Notification": "The notification whose subscriber you want to delete.
", "DescribeSubscribersForNotificationRequest$Notification": "The notification whose subscribers you want to list.
", - "NotificationWithSubscribers$Notification": "The notification that is associated with a budget.
", + "NotificationWithSubscribers$Notification": "The notification that's associated with a budget.
", "Notifications$member": null, "UpdateNotificationRequest$OldNotification": "The previous notification that is associated with a budget.
", "UpdateNotificationRequest$NewNotification": "The updated notification to be associated with a budget.
", @@ -579,14 +605,14 @@ "NotificationState": { "base": null, "refs": { - "Notification$NotificationState": "Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.
Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.
The threshold of a notification.
", "refs": { "ActionThreshold$ActionThresholdValue": null, - "Notification$Threshold": "The threshold that is associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.
" + "Notification$Threshold": "The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.
" } }, "NotificationType": { @@ -594,7 +620,7 @@ "refs": { "Action$NotificationType": null, "CreateBudgetActionRequest$NotificationType": null, - "Notification$NotificationType": "Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).
A list of notifications, each with a list of subscribers.
", "refs": { - "CreateBudgetRequest$NotificationsWithSubscribers": "A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.
A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, Amazon Web Services creates the notifications and subscribers for you.
A string that represents a numeric value.
", "refs": { - "Spend$Amount": "The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.
" + "Spend$Amount": "The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.
" } }, "PlannedBudgetLimits": { "base": null, "refs": { - "Budget$PlannedBudgetLimits": "A map containing multiple BudgetLimit, including current or future limits.
PlannedBudgetLimits is available for cost or usage budget and supports monthly and quarterly TimeUnit.
For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.
For quarterly budgets, provide 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.
If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.
After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.
DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
A map containing multiple BudgetLimit, including current or future limits.
PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit.
For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.
For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.
If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.
If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.
After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.
DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don't contain PlannedBudgetLimits.
The Amazon Resource Name (ARN) of the policy to be attached.
" + "IamActionDefinition$PolicyArn": "The Amazon Resource Name (ARN) of the policy to be attached.
" } }, "PolicyId": { "base": null, "refs": { - "ScpActionDefinition$PolicyId": "The policy ID attached.
" + "ScpActionDefinition$PolicyId": "The policy ID attached.
" } }, "Region": { "base": null, "refs": { - "SsmActionDefinition$Region": "The Region to run the SSM document.
" + "SsmActionDefinition$Region": "The Region to run the SSM document.
" } }, "ResourceLockedException": { @@ -676,7 +702,7 @@ "RoleArn": { "base": null, "refs": { - "Action$ExecutionRoleArn": "The role passed for action execution and reversion. Roles and actions must be in the same account.
", + "Action$ExecutionRoleArn": "The role passed for action execution and reversion. Roles and actions must be in the same account.
", "CreateBudgetActionRequest$ExecutionRoleArn": "The role passed for action execution and reversion. Roles and actions must be in the same account.
", "UpdateBudgetActionRequest$ExecutionRoleArn": "The role passed for action execution and reversion. Roles and actions must be in the same account.
" } @@ -684,34 +710,34 @@ "Roles": { "base": null, "refs": { - "IamActionDefinition$Roles": "A list of roles to be attached. There must be at least one role.
" + "IamActionDefinition$Roles": "A list of roles to be attached. There must be at least one role.
" } }, "ScpActionDefinition": { - "base": "The service control policies (SCP) action definition details.
", + "base": "The service control policies (SCP) action definition details.
", "refs": { - "Definition$ScpActionDefinition": "The service control policies (SCPs) action definition details.
" + "Definition$ScpActionDefinition": "The service control policies (SCPs) action definition details.
" } }, "Spend": { - "base": "The amount of cost or usage that is measured for a budget.
For example, a Spend for 3 GB of S3 usage would have the following parameters:
An Amount of 3
A unit of GB
The amount of cost or usage that's measured for a budget.
For example, a Spend for 3 GB of S3 usage has the following parameters:
An Amount of 3
A unit of GB
The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.
BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.
BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
The amount of cost or usage that you created the budget for.
", "BudgetedAndActualAmounts$ActualAmount": "Your actual costs or usage for a budget period.
", - "CalculatedSpend$ActualSpend": "The amount of cost, usage, RI units, or Savings Plans units that you have used.
", - "CalculatedSpend$ForecastedSpend": "The amount of cost, usage, RI units, or Savings Plans units that you are forecasted to use.
", + "CalculatedSpend$ActualSpend": "The amount of cost, usage, RI units, or Savings Plans units that you used.
", + "CalculatedSpend$ForecastedSpend": "The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.
", "PlannedBudgetLimits$value": null } }, "SsmActionDefinition": { - "base": "The AWS Systems Manager (SSM) action definition details.
", + "base": "The Amazon Web Services Systems Manager (SSM) action definition details.
", "refs": { - "Definition$SsmActionDefinition": "The AWS Systems Manager (SSM) action definition details.
" + "Definition$SsmActionDefinition": "The Amazon Web Services Systems Manager (SSM) action definition details.
" } }, "Subscriber": { - "base": "The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
For example, an email subscriber would have the following parameters:
A subscriptionType of EMAIL
An address of example@example.com
The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
For example, an email subscriber has the following parameters:
A subscriptionType of EMAIL
An address of example@example.com
The subscriber that you want to associate with a budget notification.
", "DeleteSubscriberRequest$Subscriber": "The subscriber that you want to delete.
", @@ -723,7 +749,7 @@ "SubscriberAddress": { "base": "A string that contains an email address or SNS topic for the subscriber's address.
", "refs": { - "Subscriber$Address": "The address that AWS sends budget notifications to, either an SNS topic or an email.
When you create a subscriber, the value of Address can't contain line breaks.
The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
When you create a subscriber, the value of Address can't contain line breaks.
The subscription type of the subscriber. It can be SMS or EMAIL.
", "refs": { - "Subscriber$SubscriptionType": "The type of notification that AWS sends to a subscriber.
" + "Subscriber$SubscriptionType": "The type of notification that Amazon Web Services sends to a subscriber.
" } }, "TargetId": { @@ -752,21 +778,21 @@ "TargetIds": { "base": null, "refs": { - "ScpActionDefinition$TargetIds": "A list of target IDs.
" + "ScpActionDefinition$TargetIds": "A list of target IDs.
" } }, "ThresholdType": { "base": "The type of threshold for a notification.
", "refs": { "ActionThreshold$ActionThresholdType": null, - "Notification$ThresholdType": "The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.
The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
", + "base": "The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
", "refs": { - "Budget$TimePeriod": "The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.
If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
You can change either date with the UpdateBudget operation.
After the end date, AWS deletes the budget and all associated notifications and subscribers.
", - "BudgetedAndActualAmounts$TimePeriod": "The time period covered by this budget comparison.
", + "Budget$TimePeriod": "The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.
If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.
You can change either date with the UpdateBudget operation.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
", + "BudgetedAndActualAmounts$TimePeriod": "The time period that's covered by this budget comparison.
", "DescribeBudgetActionHistoriesRequest$TimePeriod": null, "DescribeBudgetPerformanceHistoryRequest$TimePeriod": "Retrieves how often the budget went into an ALARM state for the specified time period.
A string that represents the spend unit of a budget. It can't be null or empty.
", "refs": { - "Spend$Unit": "The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.
" + "Spend$Unit": "The unit of measurement that's used for the budget forecast, actual spend, or budget threshold, such as USD or GBP.
" } }, "UpdateBudgetActionRequest": { @@ -833,7 +859,7 @@ "Users": { "base": null, "refs": { - "IamActionDefinition$Users": "A list of users to be attached. There must be at least one user.
" + "IamActionDefinition$Users": "A list of users to be attached. There must be at least one user.
" } }, "errorMessage": { diff --git a/apis/ce/2017-10-25/api-2.json b/apis/ce/2017-10-25/api-2.json index 402e7ca2e7b..994da86c7be 100644 --- a/apis/ce/2017-10-25/api-2.json +++ b/apis/ce/2017-10-25/api-2.json @@ -966,7 +966,6 @@ "PLATFORM", "SUBSCRIPTION_ID", "LEGAL_ENTITY_NAME", - "INVOICING_ENTITY", "DEPLOYMENT_OPTION", "DATABASE_ENGINE", "CACHE_ENGINE", @@ -979,7 +978,8 @@ "SAVINGS_PLAN_ARN", "PAYMENT_OPTION", "AGREEMENT_END_DATE_TIME_AFTER", - "AGREEMENT_END_DATE_TIME_BEFORE" + "AGREEMENT_END_DATE_TIME_BEFORE", + "INVOICING_ENTITY" ] }, "DimensionValues":{ @@ -2324,7 +2324,7 @@ "type":"string", "max":302, "min":6, - "pattern":"(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+$)" + "pattern":"(^[a-zA-Z0-9.!#$%&'*+=?^_‘{|}~-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$)|(^arn:(aws[a-zA-Z-]*):sns:[a-zA-Z0-9-]+:[0-9]{12}:[a-zA-Z0-9_-]+(\\.fifo)?$)" }, "SubscriberStatus":{ "type":"string", diff --git a/apis/ec2/2016-11-15/api-2.json b/apis/ec2/2016-11-15/api-2.json index a829bc2f492..108d46fcbac 100644 --- a/apis/ec2/2016-11-15/api-2.json +++ b/apis/ec2/2016-11-15/api-2.json @@ -29402,7 +29402,20 @@ "interface", "natGateway", "efa", - "trunk" + "trunk", + "load_balancer", + "network_load_balancer", + "vpc_endpoint", + "branch", + "transit_gateway", + "lambda", + "quicksight", + "global_accelerator_managed", + "api_gateway_managed", + "gateway_load_balancer", + "gateway_load_balancer_endpoint", + "iot_rules_managed", + "aws_codestar_connections_managed" ] }, "NetworkPerformance":{"type":"string"}, diff --git a/apis/ec2/2016-11-15/docs-2.json b/apis/ec2/2016-11-15/docs-2.json index 6493d4c5730..73a170e7fbb 100644 --- a/apis/ec2/2016-11-15/docs-2.json +++ b/apis/ec2/2016-11-15/docs-2.json @@ -59,7 +59,7 @@ "CreateDefaultVpc": "Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and default subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.
If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is that possible?\" in the Default VPCs FAQ.
", "CreateDhcpOptions": "Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.
[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.
", - "CreateFleet": "Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide.
", + "CreateFleet": "Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide.
", "CreateFlowLogs": "Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
", "CreateFpgaImage": "Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).
The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.
An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the Amazon Web Services FPGA Hardware Development Kit.
", "CreateImage": "Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.
By default, Amazon EC2 shuts down and reboots the instance before creating the AMI to ensure that everything on the instance is stopped and in a consistent state during the creation process. If you're confident that your instance is in a consistent state appropriate for AMI creation, use the NoReboot parameter to prevent Amazon EC2 from shutting down and rebooting the instance.
If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.
For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
", @@ -125,7 +125,7 @@ "DeleteCustomerGateway": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
", "DeleteDhcpOptions": "Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
", "DeleteEgressOnlyInternetGateway": "Deletes an egress-only internet gateway.
", - "DeleteFleets": "Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Deleting an EC2 Fleet in the Amazon EC2 User Guide.
", + "DeleteFleets": "Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
", "DeleteFlowLogs": "Deletes one or more flow logs.
", "DeleteFpgaImage": "Deletes the specified Amazon FPGA Image (AFI).
", "DeleteInstanceEventWindow": "Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", @@ -185,7 +185,7 @@ "DeprovisionIpamPoolCidr": "Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.
", "DeprovisionPublicIpv4PoolCidr": "Deprovision a CIDR from a public IPv4 pool.
", "DeregisterImage": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.
If you deregister an AMI that matches a Recycle Bin retention rule, the AMI is retained in the Recycle Bin for the specified retention period. For more information, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
When you deregister an AMI, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
", - "DeregisterInstanceEventNotificationAttributes": "c
Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
", + "DeregisterInstanceEventNotificationAttributes": "Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
", "DeregisterTransitGatewayMulticastGroupMembers": "Deregisters the specified members (network interfaces) from the transit gateway multicast group.
", "DeregisterTransitGatewayMulticastGroupSources": "Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
", "DescribeAccountAttributes": "Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see On-Demand Instance Limits in the Amazon Elastic Compute Cloud User Guide.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
Describe details for Windows AMIs that are configured for faster launching.
", "DescribeFastSnapshotRestores": "Describes the state of fast snapshot restores for your snapshots.
", "DescribeFleetHistory": "Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
", - "DescribeFleetInstances": "Describes the running instances for the specified EC2 Fleet.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
", - "DescribeFleets": "Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
", + "DescribeFleetInstances": "Describes the running instances for the specified EC2 Fleet.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
", + "DescribeFleets": "Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
", "DescribeFlowLogs": "Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.
", "DescribeFpgaImageAttribute": "Describes the specified attribute of the specified Amazon FPGA Image (AFI).
", "DescribeFpgaImages": "Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other Amazon Web Services accounts for which you have load permissions.
", @@ -458,7 +458,7 @@ "ModifyVpnConnectionOptions": "Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
", "ModifyVpnTunnelCertificate": "Modifies the VPN tunnel endpoint certificate.
", "ModifyVpnTunnelOptions": "Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
", - "MonitorInstances": "Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see .
", + "MonitorInstances": "Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.
To disable detailed monitoring, see UnmonitorInstances.
", "MoveAddressToVpc": "Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.
", "MoveByoipCidrToIpam": "Move an BYOIP IPv4 CIDR to IPAM from a public IPv4 pool.
", "ProvisionByoipCidr": "Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
Purchases the Scheduled Instances with the specified schedule.
Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.
After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.
", "RebootInstances": "Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.
", "RegisterImage": "Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating your own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.
", - "RegisterInstanceEventNotificationAttributes": "Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use .
", + "RegisterInstanceEventNotificationAttributes": "Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
", "RegisterTransitGatewayMulticastGroupMembers": "Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
", "RegisterTransitGatewayMulticastGroupSources": "Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
", "RejectTransitGatewayMulticastDomainAssociations": "Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
", @@ -1488,7 +1488,7 @@ "AvailabilityZoneState": { "base": null, "refs": { - "AvailabilityZone$State": "The state of the Availability Zone, Local Zone, or Wavelength Zone.
" + "AvailabilityZone$State": "The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.
Returns true if the request succeeds; otherwise, it returns an error.
Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
", - "EbsBlockDevice$Encrypted": "Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by .
", + "EbsBlockDevice$Encrypted": "Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
", "EbsInstanceBlockDevice$DeleteOnTermination": "Indicates whether the volume is deleted on instance termination.
", "EbsInstanceBlockDeviceSpecification$DeleteOnTermination": "Indicates whether the volume is deleted on instance termination.
", "EnableEbsEncryptionByDefaultRequest$DryRun": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available | information | impaired | unavailable).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone, for example, local-zone.
The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
One or more filters.
state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
tenancy - The tenancy of the Fleet (default | dedicated).
allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
One or more filters.
carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC associated with the carrier gateway.
One or more filters.
group-id - The ID of a VPC security group that's associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
vpc-id - The ID of the VPC that the instance is linked to.
One or more filters. Filter names and values are case-sensitive.
description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the authorization rule applies.
group-id - The ID of the Active Directory group to which the authorization rule grants access.
One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol (tcp | udp).
One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint (associate | add-route).
target-subnet - The ID of the subnet through which traffic is routed.
One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association.
target-network-id - The ID of the subnet specified as the target network.
vpc-id - The ID of the VPC in which the target network is located.
The filters. The following are the possible values:
coip-pool.pool-id
coip-pool.local-gateway-route-table-id
One or more filters.
coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.
One or more filters.
bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway's Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
event-window-name - The event windows associated with the specified names.
instance-id - The event windows associated with the specified instance ID.
instance-tag - The event windows associated with the specified tag and value.
instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether it is a burstable performance instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-supported - Indicates whether data is encrypted at rest (required | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether it is a burstable performance instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", @@ -7933,12 +7933,12 @@ "DescribeKeyPairsRequest$Filters": "The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
One or more filters.
create-time - The time the launch template was created.
launch-template-name - The name of the launch template.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
state - The state of the association.
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
state - The state of the association.
vpc-id - The ID of the VPC.
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
state - The state of the local gateway route table.
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
One or more filters.
", - "DescribeLocalGatewaysRequest$Filters": "One or more filters.
", + "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest$Filters": "One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
state - The state of the association.
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the association.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association.
state - The state of the association.
vpc-id - The ID of the VPC.
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.
state - The state of the local gateway route table.
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
One or more filters.
local-address - The local address.
local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
vlan - The ID of the VLAN.
One or more filters.
local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.
One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
One or more filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
The filters. The following are possible values:
PathFound - A Boolean value that indicates whether a feasible path is found.
Status - The status of the analysis (running | succeeded | failed).
The filters. The following are possible values:
Destination - The ID of the resource.
DestinationPort - The destination port.
Name - The path name.
Protocol - The protocol.
Source - The ID of the resource.
One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more filters. The possible values are:
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of route (propagated | static).
The filters. The following are the possible values:
coip-address-usage.allocation-id
coip-address-usage.aws-account-id
coip-address-usage.aws-service
coip-address-usage.co-ip
One or more filters.
coip-address-usage.allocation-id - The allocation ID of the address.
coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
coip-address-usage.co-ip - The customer-owned IP address.
One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "GetIpamPoolCidrsRequest$Filters": "One or more filters for the request. For more information about filtering, see Filtering CLI output.
", "GetIpamResourceCidrsRequest$Filters": "One or more filters for the request. For more information about filtering, see Filtering CLI output.
", @@ -8007,7 +8007,7 @@ "GetTransitGatewayPrefixListReferencesRequest$Filters": "One or more filters. The possible values are:
attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked (true | false).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference (pending | available | modifying | deleting).
One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
One or more filters.
", + "SearchLocalGatewayRoutesRequest$Filters": "One or more filters.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route.
type - The route type.
One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
type - The type of route (propagated | static).
The IDs of the EC2 Fleets.
", - "DescribeFleetsRequest$FleetIds": "The ID of the EC2 Fleets.
" + "DescribeFleetsRequest$FleetIds": "The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
", + "LaunchTemplateInstanceMetadataOptions$InstanceMetadataTags": "
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
state - The state of the association.
The IDs of the local gateways.
" } }, "LocalGatewayMaxResults": { @@ -13194,7 +13194,7 @@ "NetworkInterfaceCreationType": { "base": null, "refs": { - "CreateNetworkInterfaceRequest$InterfaceType": "Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide. To create a trunk network interface, specify trunk.
The type of network interface. The default is interface.
The only supported values are efa and trunk.
The type of resource.
", - "LaunchTemplateTagSpecificationRequest$ResourceType": "The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags.
The type of resource to tag. Currently, the resource types that support tagging on creation are instance, volume, elastic-gpu, network-interface, and spot-instances-request. To tag a resource after it has been created, see CreateTags.
The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .
The resource type.
", "TagSpecification$ResourceType": "The type of resource to tag on creation.
" @@ -16509,9 +16509,9 @@ "CreateDefaultSubnetRequest$AvailabilityZone": "The Availability Zone in which to create the default subnet.
", "CreateEgressOnlyInternetGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "CreateEgressOnlyInternetGatewayResult$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "CreateFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.
", - "CreateFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes.
", - "CreateFleetRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", + "CreateFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", + "CreateFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", + "CreateFleetRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "CreateFleetRequest$Context": "Reserved.
", "CreateFlowLogsRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", "CreateFlowLogsRequest$DeliverLogsPermissionArn": "The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
", "DescribeFastSnapshotRestoreSuccessItem$OwnerAlias": "The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
", - "DescribeFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.
", - "DescribeFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error Codes.
", + "DescribeFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", + "DescribeFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", "DescribeFleetHistoryRequest$NextToken": "The token for the next set of results.
", "DescribeFleetHistoryResult$NextToken": "The token for the next set of results.
", "DescribeFleetInstancesRequest$NextToken": "The token for the next set of results.
", @@ -16953,7 +16953,7 @@ "Filter$Name": "The name of the filter. Filter names are case-sensitive.
", "FleetCapacityReservation$AvailabilityZoneId": "The ID of the Availability Zone in which the Capacity Reservation reserves capacity.
", "FleetCapacityReservation$AvailabilityZone": "The Availability Zone in which the Capacity Reservation reserves capacity.
", - "FleetData$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
", + "FleetData$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraints: Maximum 64 ASCII characters
", "FleetData$Context": "Reserved.
", "FleetLaunchTemplateOverrides$MaxPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance.
", "FleetLaunchTemplateOverrides$SubnetId": "The ID of the subnet in which to launch the instances.
", @@ -17184,7 +17184,7 @@ "InstanceNetworkInterface$PrivateIpAddress": "The IPv4 address of the network interface within the subnet.
", "InstanceNetworkInterface$SubnetId": "The ID of the subnet.
", "InstanceNetworkInterface$VpcId": "The ID of the VPC.
", - "InstanceNetworkInterface$InterfaceType": "Describes the type of network interface.
Valid values: interface | efa | trunk
The type of network interface.
Valid values: interface | efa | trunk
The carrier IP address associated with the network interface.
", "InstanceNetworkInterfaceAssociation$CustomerOwnedIp": "The customer-owned IP address associated with the network interface.
", "InstanceNetworkInterfaceAssociation$IpOwnerId": "The ID of the owner of the Elastic IP address.
", @@ -17194,7 +17194,7 @@ "InstanceNetworkInterfaceSpecification$Description": "The description of the network interface. Applies only if creating a network interface when launching an instance.
", "InstanceNetworkInterfaceSpecification$PrivateIpAddress": "The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", "InstanceNetworkInterfaceSpecification$SubnetId": "The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
", - "InstanceNetworkInterfaceSpecification$InterfaceType": "The type of network interface.
To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
Valid values: interface | efa
The type of network interface.
Valid values: interface | efa
The private IPv4 DNS name.
", "InstancePrivateIpAddress$PrivateIpAddress": "The private IPv4 address of the network interface.
", "InstanceStateChange$InstanceId": "The ID of the instance.
", @@ -17852,7 +17852,7 @@ "SuccessfulInstanceCreditSpecificationItem$InstanceId": "The ID of the instance.
", "SuccessfulQueuedPurchaseDeletion$ReservedInstancesId": "The ID of the Reserved Instance.
", "Tag$Key": "The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.
", + "Tag$Value": "The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
", "TagDescription$Key": "The tag key.
", "TagDescription$ResourceId": "The ID of the resource.
", "TagDescription$Value": "The tag value.
", diff --git a/apis/glue/2017-03-31/api-2.json b/apis/glue/2017-03-31/api-2.json index c7aff936f9c..bf5bb594884 100644 --- a/apis/glue/2017-03-31/api-2.json +++ b/apis/glue/2017-03-31/api-2.json @@ -8023,7 +8023,8 @@ "CreatedBy":{"shape":"NameString"}, "IsRegisteredWithLakeFormation":{"shape":"Boolean"}, "TargetTable":{"shape":"TableIdentifier"}, - "CatalogId":{"shape":"CatalogIdString"} + "CatalogId":{"shape":"CatalogIdString"}, + "VersionId":{"shape":"VersionString"} } }, "TableError":{ @@ -8728,7 +8729,8 @@ "DatabaseName":{"shape":"NameString"}, "TableInput":{"shape":"TableInput"}, "SkipArchive":{"shape":"BooleanNullable"}, - "TransactionId":{"shape":"TransactionIdString"} + "TransactionId":{"shape":"TransactionIdString"}, + "VersionId":{"shape":"VersionString"} } }, "UpdateTableResponse":{ diff --git a/apis/glue/2017-03-31/docs-2.json b/apis/glue/2017-03-31/docs-2.json index bcdddfbab57..047124c02bf 100644 --- a/apis/glue/2017-03-31/docs-2.json +++ b/apis/glue/2017-03-31/docs-2.json @@ -5982,8 +5982,10 @@ "BatchDeleteTableVersionList$member": null, "DeleteTableVersionRequest$VersionId": "The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.
The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.
The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.
The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.
The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
", "StartSession": "Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
Stop an Automation that is currently running.
", - "TerminateSession": "Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session isn't be resumed.
", + "TerminateSession": "Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
", "UnlabelParameterVersion": "Remove a label or labels from a parameter.
", - "UpdateAssociation": "Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system drops all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.
In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.
In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must be configured with permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.
Updates one or more values for an SSM document.
", "UpdateDocumentDefaultVersion": "Set the default version of a document.
", @@ -167,7 +167,7 @@ } }, "AccountSharingInfoList": { - "base": "A list of of Amazon Web Services accounts where the current document is shared and the version shared with each account.
", + "base": "A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.
", "refs": { "DescribeDocumentPermissionResponse$AccountSharingInfoList": "A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.
" } @@ -2249,7 +2249,7 @@ } }, "DocumentKeyValuesFilter": { - "base": "One or more filters. Use a filter to return a more specific list of documents.
For keys, you can specify one or more tags that have been applied to a document.
You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:
ApplicationConfiguration
ApplicationConfigurationSchema
Automation
ChangeCalendar
Command
DeploymentStrategy
Package
Policy
Session
Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.
Amazon
Private
Public
Self
ThirdParty
Linux
Windows
Name is another Amazon Web Services-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with Te, run the following command:
aws ssm list-documents --filters Key=Name,Values=Te
You can also use the TargetType Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.
To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
For example, if you created a key called region and are using the Amazon Web Services CLI to call the list-documents command:
aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self
One or more filters. Use a filter to return a more specific list of documents.
For keys, you can specify one or more tags that have been applied to a document.
You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:
ApplicationConfiguration
ApplicationConfigurationSchema
Automation
ChangeCalendar
Command
Package
Policy
Session
Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.
Amazon
Private
Public
Self
ThirdParty
Linux
Windows
Name is another Amazon Web Services-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with Te, run the following command:
aws ssm list-documents --filters Key=Name,Values=Te
You can also use the TargetType Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.
To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
For example, if you created a key called region and are using the Amazon Web Services CLI to call the list-documents command:
aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self
The type of document to create.
", + "CreateDocumentRequest$DocumentType": "The type of document to create.
The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.
The type of document.
", "DocumentIdentifier$DocumentType": "The document type.
", "GetDocumentResult$DocumentType": "The document type.
" @@ -4406,7 +4406,7 @@ "MaintenanceWindowIdentity$StartDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.
", "MaintenanceWindowIdentity$NextExecutionTime": "The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.
", "ScheduledWindowExecution$ExecutionTime": "The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.
", - "UpdateMaintenanceWindowRequest$StartDate": "The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"UTC\", or \"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.
", + "UpdateMaintenanceWindowRequest$StartDate": "The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.
The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.
", "UpdateMaintenanceWindowResult$EndDate": "The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.
" @@ -4597,14 +4597,14 @@ "CreateAssociationRequest$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.
The defined maximum number of task executions that could be run in parallel.
", "GetMaintenanceWindowTaskResult$MaxConcurrency": "The maximum number of targets allowed to run this task in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The maximum number of targets this task can be run for, in parallel.
", - "RegisterTaskWithMaintenanceWindowRequest$MaxConcurrency": "The maximum number of targets this task can be run for in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The maximum number of targets this task can be run for, in parallel.
Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The maximum number of targets this task can be run for, in parallel.
Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.
(Optional) The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.
The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.
The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
", "UpdateAssociationRequest$MaxConcurrency": "The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.
The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task, in parallel.
Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The updated MaxConcurrency value.
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.
", "GetMaintenanceWindowTaskResult$MaxErrors": "The maximum number of errors allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The maximum number of errors allowed before this task stops being scheduled.
", - "RegisterTaskWithMaintenanceWindowRequest$MaxErrors": "The maximum number of errors allowed before this task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The maximum number of errors allowed before this task stops being scheduled.
Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The maximum number of errors allowed before this task stops being scheduled.
Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.
The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.
The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.
Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.
", "TargetLocation$TargetLocationMaxErrors": "The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
", "UpdateAssociationRequest$MaxErrors": "The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. This value doesn't affect the running of your task and can be ignored.
The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.
Although this element is listed as \"Required: No\", a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases.
For maintenance window tasks without a target specified, you can't supply a value for this option. Instead, the system inserts a placeholder value of 1. This value doesn't affect the running of your task.
The updated MaxErrors value.
The Amazon Resource Name (ARN) of an OpsMetadata Object to delete.
", "GetOpsMetadataRequest$OpsMetadataArn": "The Amazon Resource Name (ARN) of an OpsMetadata Object to view.
", "OpsMetadata$OpsMetadataArn": "The Amazon Resource Name (ARN) of the OpsMetadata Object or blob.
", - "UpdateOpsMetadataRequest$OpsMetadataArn": "The Amazon Resoure Name (ARN) of the OpsMetadata Object to update.
", + "UpdateOpsMetadataRequest$OpsMetadataArn": "The Amazon Resource Name (ARN) of the OpsMetadata Object to update.
", "UpdateOpsMetadataResult$OpsMetadataArn": "The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.
" } }, @@ -5536,7 +5536,7 @@ "DeleteParameterRequest$Name": "The name of the parameter to delete.
", "GetParameterHistoryRequest$Name": "The name of the parameter for which you want to review history.
", "GetParameterRequest$Name": "The name of the parameter you want to query.
To query by parameter label, use \"Name\": \"name:label\". To query by parameter version, use \"Name\": \"name:version\".
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33
The parameter name on which you want to attach one or more labels.
", "Parameter$Name": "The name of the parameter.
", "ParameterHistory$Name": "The name of the parameter.
", @@ -5555,7 +5555,7 @@ "PSParameterValue": { "base": null, "refs": { - "Parameter$Value": "The parameter value.
", + "Parameter$Value": "The parameter value.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
The parameter value.
", "PutParameterRequest$Value": "The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.
Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.
The data type of the parameter, such as text or aws:ec2:image. The default is text.
The data type of the parameter, such as text or aws:ec2:image. The default is text.
The data type of the parameter, such as text or aws:ec2:image. The default is text.
The data type for a String parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.
The following data type values are supported.
text
aws:ec2:image
When you create a String parameter and specify aws:ec2:image, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your Amazon Web Services account. For more information, see Native parameter support for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User Guide.
The data type for a String parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.
The following data type values are supported.
text
aws:ec2:image
aws:ssm:integration
When you create a String parameter and specify aws:ec2:image, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as ami-12345abcdeEXAMPLE, and that the specified AMI is available in your Amazon Web Services account. For more information, see Native parameter support for Amazon Machine Image (AMI) IDs in the Amazon Web Services Systems Manager User Guide.
The type of parameter. Valid values include the following: String, StringList, and SecureString.
The type of parameter. Valid values include the following: String, StringList, and SecureString.
If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
The type of parameter used.
", "ParameterMetadata$Type": "The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.
The type of parameter that you want to add to the system.
SecureString isn't currently supported for CloudFormation templates.
Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.
Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.
The severity level of the patch. For example, CRITICAL or MODERATE.
The severity of the patchsuch as Critical, Important, and Moderate.
The severity of the patch such as Critical, Important, and Moderate.
Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
", "ParameterInlinePolicy$PolicyText": "The JSON text of the policy.
", - "ParameterInlinePolicy$PolicyType": "The type of policy. Parameter Store, a capablility of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
", + "ParameterInlinePolicy$PolicyType": "The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
", "ParameterInlinePolicy$PolicyStatus": "The status of the policy. Policies report the following statuses: Pending (the policy hasn't been enforced or applied yet), Finished (the policy was applied), Failed (the policy wasn't applied), or InProgress (the policy is being applied now).
", "ParameterLimitExceeded$message": null, "ParameterMaxVersionLimitExceeded$message": null, diff --git a/gems/aws-sdk-budgets/CHANGELOG.md b/gems/aws-sdk-budgets/CHANGELOG.md index fa7fec3f40d..108fc99b8bb 100644 --- a/gems/aws-sdk-budgets/CHANGELOG.md +++ b/gems/aws-sdk-budgets/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.47.0 (2022-02-16) +------------------ + +* Feature - Adds support for auto-adjusting budgets, a new budget method alongside fixed and planned. Auto-adjusting budgets introduces new metadata to configure a budget limit baseline using a historical lookback average or current period forecast. + 1.46.0 (2022-02-03) ------------------ diff --git a/gems/aws-sdk-budgets/VERSION b/gems/aws-sdk-budgets/VERSION index 0a3db35b241..21998d3c2d9 100644 --- a/gems/aws-sdk-budgets/VERSION +++ b/gems/aws-sdk-budgets/VERSION @@ -1 +1 @@ -1.46.0 +1.47.0 diff --git a/gems/aws-sdk-budgets/lib/aws-sdk-budgets.rb b/gems/aws-sdk-budgets/lib/aws-sdk-budgets.rb index 4cd56a0fc91..9556ae6871e 100644 --- a/gems/aws-sdk-budgets/lib/aws-sdk-budgets.rb +++ b/gems/aws-sdk-budgets/lib/aws-sdk-budgets.rb @@ -48,6 +48,6 @@ # @!group service module Aws::Budgets - GEM_VERSION = '1.46.0' + GEM_VERSION = '1.47.0' end diff --git a/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb b/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb index 761d2b0301e..52ea0a181c7 100644 --- a/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb +++ b/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb @@ -380,8 +380,8 @@ def initialize(*args) # A notification that you want to associate with a budget. A budget can # have up to five notifications, and each notification can have one SNS # subscriber and up to 10 email subscribers. If you include - # notifications and subscribers in your `CreateBudget` call, AWS creates - # the notifications and subscribers for you. + # notifications and subscribers in your `CreateBudget` call, Amazon Web + # Services creates the notifications and subscribers for you. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -434,6 +434,14 @@ def initialize(*args) # }, # budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE # last_updated_time: Time.now, + # auto_adjust_data: { + # auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST + # historical_options: { + # budget_adjustment_period: 1, # required + # look_back_available_periods: 1, + # }, + # last_auto_adjust_time: Time.now, + # }, # }, # notifications_with_subscribers: [ # { @@ -464,7 +472,7 @@ def create_budget(params = {}, options = {}) # Creates a budget action. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -559,8 +567,8 @@ def create_budget_action(params = {}, options = {}) # create a notification for. # # @option params [required, String] :budget_name - # The name of the budget that you want AWS to notify you about. Budget - # names must be unique within an account. + # The name of the budget that you want Amazon Web Services to notify you + # about. Budget names must be unique within an account. # # @option params [required, Types::Notification] :notification # The notification that you want to create. @@ -674,7 +682,7 @@ def delete_budget(params = {}, options = {}) # Deletes a budget action. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -877,6 +885,10 @@ def delete_subscriber(params = {}, options = {}) # resp.budget.calculated_spend.forecasted_spend.unit #=> String # resp.budget.budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE" # resp.budget.last_updated_time #=> Time + # resp.budget.auto_adjust_data.auto_adjust_type #=> String, one of "HISTORICAL", "FORECAST" + # resp.budget.auto_adjust_data.historical_options.budget_adjustment_period #=> Integer + # resp.budget.auto_adjust_data.historical_options.look_back_available_periods #=> Integer + # resp.budget.auto_adjust_data.last_auto_adjust_time #=> Time # # @overload describe_budget(params = {}) # @param [Hash] params ({}) @@ -888,7 +900,7 @@ def describe_budget(params = {}, options = {}) # Describes a budget action detail. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -953,7 +965,7 @@ def describe_budget_action(params = {}, options = {}) # Describes a budget action history detail. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -964,7 +976,7 @@ def describe_budget_action(params = {}, options = {}) # action. # # @option params [Types::TimePeriod] :time_period - # The period of time that is covered by a budget. The period has a start + # The period of time that's covered by a budget. The period has a start # date and an end date. The start date must come before the end date. # There are no restrictions on the end date. # @@ -1041,7 +1053,7 @@ def describe_budget_action_histories(params = {}, options = {}) # Describes all of the budget actions for an account. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [Integer] :max_results # An integer that represents how many entries a paginated response @@ -1106,7 +1118,7 @@ def describe_budget_actions_for_account(params = {}, options = {}) # Describes all of the budget actions for a budget. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -1177,7 +1189,7 @@ def describe_budget_actions_for_budget(params = {}, options = {}) # Budget history isn't available for `ANNUAL` budgets. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -1317,6 +1329,10 @@ def describe_budget_performance_history(params = {}, options = {}) # resp.budgets[0].calculated_spend.forecasted_spend.unit #=> String # resp.budgets[0].budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE" # resp.budgets[0].last_updated_time #=> Time + # resp.budgets[0].auto_adjust_data.auto_adjust_type #=> String, one of "HISTORICAL", "FORECAST" + # resp.budgets[0].auto_adjust_data.historical_options.budget_adjustment_period #=> Integer + # resp.budgets[0].auto_adjust_data.historical_options.look_back_available_periods #=> Integer + # resp.budgets[0].auto_adjust_data.last_auto_adjust_time #=> Time # resp.next_token #=> String # # @overload describe_budgets(params = {}) @@ -1436,7 +1452,7 @@ def describe_subscribers_for_notification(params = {}, options = {}) # Executes a budget action. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -1481,8 +1497,8 @@ def execute_budget_action(params = {}, options = {}) # Updates a budget. You can change every part of a budget except for the # `budgetName` and the `calculatedSpend`. When you modify a budget, the - # `calculatedSpend` drops to zero until AWS has new usage data to use - # for forecasting. + # `calculatedSpend` drops to zero until Amazon Web Services has new + # usage data to use for forecasting. # # Only one of `BudgetLimit` or `PlannedBudgetLimits` can be present in # the syntax at one time. Use the syntax that matches your case. The @@ -1551,6 +1567,14 @@ def execute_budget_action(params = {}, options = {}) # }, # budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE # last_updated_time: Time.now, + # auto_adjust_data: { + # auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST + # historical_options: { + # budget_adjustment_period: 1, # required + # look_back_available_periods: 1, + # }, + # last_auto_adjust_time: Time.now, + # }, # }, # }) # @@ -1564,7 +1588,7 @@ def update_budget(params = {}, options = {}) # Updates a budget action. # # @option params [required, String] :account_id - # The account ID of the user. It should be a 12-digit number. + # The account ID of the user. It's a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" @@ -1809,7 +1833,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-budgets' - context[:gem_version] = '1.46.0' + context[:gem_version] = '1.47.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client_api.rb b/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client_api.rb index 71211d97f4b..7a6ad6faffc 100644 --- a/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client_api.rb +++ b/gems/aws-sdk-budgets/lib/aws-sdk-budgets/client_api.rb @@ -25,7 +25,10 @@ module ClientApi ActionThreshold = Shapes::StructureShape.new(name: 'ActionThreshold') ActionType = Shapes::StringShape.new(name: 'ActionType') Actions = Shapes::ListShape.new(name: 'Actions') + AdjustmentPeriod = Shapes::IntegerShape.new(name: 'AdjustmentPeriod') ApprovalModel = Shapes::StringShape.new(name: 'ApprovalModel') + AutoAdjustData = Shapes::StructureShape.new(name: 'AutoAdjustData') + AutoAdjustType = Shapes::StringShape.new(name: 'AutoAdjustType') Budget = Shapes::StructureShape.new(name: 'Budget') BudgetName = Shapes::StringShape.new(name: 'BudgetName') BudgetPerformanceHistory = Shapes::StructureShape.new(name: 'BudgetPerformanceHistory') @@ -84,6 +87,7 @@ module ClientApi GenericTimestamp = Shapes::TimestampShape.new(name: 'GenericTimestamp') Group = Shapes::StringShape.new(name: 'Group') Groups = Shapes::ListShape.new(name: 'Groups') + HistoricalOptions = Shapes::StructureShape.new(name: 'HistoricalOptions') IamActionDefinition = Shapes::StructureShape.new(name: 'IamActionDefinition') InstanceId = Shapes::StringShape.new(name: 'InstanceId') InstanceIds = Shapes::ListShape.new(name: 'InstanceIds') @@ -167,6 +171,11 @@ module ClientApi Actions.member = Shapes::ShapeRef.new(shape: Action) + AutoAdjustData.add_member(:auto_adjust_type, Shapes::ShapeRef.new(shape: AutoAdjustType, required: true, location_name: "AutoAdjustType")) + AutoAdjustData.add_member(:historical_options, Shapes::ShapeRef.new(shape: HistoricalOptions, location_name: "HistoricalOptions")) + AutoAdjustData.add_member(:last_auto_adjust_time, Shapes::ShapeRef.new(shape: GenericTimestamp, location_name: "LastAutoAdjustTime")) + AutoAdjustData.struct_class = Types::AutoAdjustData + Budget.add_member(:budget_name, Shapes::ShapeRef.new(shape: BudgetName, required: true, location_name: "BudgetName")) Budget.add_member(:budget_limit, Shapes::ShapeRef.new(shape: Spend, location_name: "BudgetLimit")) Budget.add_member(:planned_budget_limits, Shapes::ShapeRef.new(shape: PlannedBudgetLimits, location_name: "PlannedBudgetLimits")) @@ -177,6 +186,7 @@ module ClientApi Budget.add_member(:calculated_spend, Shapes::ShapeRef.new(shape: CalculatedSpend, location_name: "CalculatedSpend")) Budget.add_member(:budget_type, Shapes::ShapeRef.new(shape: BudgetType, required: true, location_name: "BudgetType")) Budget.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: GenericTimestamp, location_name: "LastUpdatedTime")) + Budget.add_member(:auto_adjust_data, Shapes::ShapeRef.new(shape: AutoAdjustData, location_name: "AutoAdjustData")) Budget.struct_class = Types::Budget BudgetPerformanceHistory.add_member(:budget_name, Shapes::ShapeRef.new(shape: BudgetName, location_name: "BudgetName")) @@ -405,6 +415,10 @@ module ClientApi Groups.member = Shapes::ShapeRef.new(shape: Group) + HistoricalOptions.add_member(:budget_adjustment_period, Shapes::ShapeRef.new(shape: AdjustmentPeriod, required: true, location_name: "BudgetAdjustmentPeriod")) + HistoricalOptions.add_member(:look_back_available_periods, Shapes::ShapeRef.new(shape: AdjustmentPeriod, location_name: "LookBackAvailablePeriods")) + HistoricalOptions.struct_class = Types::HistoricalOptions + IamActionDefinition.add_member(:policy_arn, Shapes::ShapeRef.new(shape: PolicyArn, required: true, location_name: "PolicyArn")) IamActionDefinition.add_member(:roles, Shapes::ShapeRef.new(shape: Roles, location_name: "Roles")) IamActionDefinition.add_member(:groups, Shapes::ShapeRef.new(shape: Groups, location_name: "Groups")) diff --git a/gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb b/gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb index d35abfa704b..def64c43bd1 100644 --- a/gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb +++ b/gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb @@ -63,7 +63,7 @@ class AccessDeniedException < Struct.new( # @return [String] # # @!attribute [rw] status - # The status of action. + # The status of the action. # @return [String] # # @!attribute [rw] subscribers @@ -88,7 +88,7 @@ class Action < Struct.new( # The historical records for a budget action. # # @!attribute [rw] timestamp - # A generic time stamp. In Java, it is transformed to a `Date` object. + # A generic time stamp. In Java, it's transformed to a `Date` object. # @return [Time] # # @!attribute [rw] status @@ -97,11 +97,11 @@ class Action < Struct.new( # # @!attribute [rw] event_type # This distinguishes between whether the events are triggered by the - # user or generated by the system. + # user or are generated by the system. # @return [String] # # @!attribute [rw] action_history_details - # The description of details of the event. + # The description of the details for the event. # @return [Types::ActionHistoryDetails] # class ActionHistory < Struct.new( @@ -113,7 +113,7 @@ class ActionHistory < Struct.new( include Aws::Structure end - # The description of details of the event. + # The description of the details for the event. # # @!attribute [rw] message # A generic string. @@ -155,11 +155,48 @@ class ActionThreshold < Struct.new( include Aws::Structure end + # The parameters that determine the budget amount for an auto-adjusting + # budget. + # + # @note When making an API call, you may pass AutoAdjustData + # data as a hash: + # + # { + # auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST + # historical_options: { + # budget_adjustment_period: 1, # required + # look_back_available_periods: 1, + # }, + # last_auto_adjust_time: Time.now, + # } + # + # @!attribute [rw] auto_adjust_type + # The string that defines whether your budget auto-adjusts based on + # historical or forecasted data. + # @return [String] + # + # @!attribute [rw] historical_options + # The parameters that define or describe the historical data that your + # auto-adjusting budget is based on. + # @return [Types::HistoricalOptions] + # + # @!attribute [rw] last_auto_adjust_time + # The last time that your budget was auto-adjusted. + # @return [Time] + # + class AutoAdjustData < Struct.new( + :auto_adjust_type, + :historical_options, + :last_auto_adjust_time) + SENSITIVE = [] + include Aws::Structure + end + # Represents the output of the `CreateBudget` operation. The content # consists of the detailed metadata and data file information, and the # current status of the `budget` object. # - # This is the ARN pattern for a budget: + # This is the Amazon Resource Name (ARN) pattern for a budget: # # `arn:aws:budgets::AccountId:budget/budgetName` # @@ -211,6 +248,14 @@ class ActionThreshold < Struct.new( # }, # budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE # last_updated_time: Time.now, + # auto_adjust_data: { + # auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST + # historical_options: { + # budget_adjustment_period: 1, # required + # look_back_available_periods: 1, + # }, + # last_auto_adjust_time: Time.now, + # }, # } # # @!attribute [rw] budget_name @@ -225,8 +270,8 @@ class ActionThreshold < Struct.new( # # `BudgetLimit` is required for cost or usage budgets, but optional # for RI or Savings Plans utilization or coverage budgets. RI and - # Savings Plans utilization or coverage budgets default to `100`, - # which is the only valid value for RI or Savings Plans utilization or + # Savings Plans utilization or coverage budgets default to `100`. This + # is the only valid value for RI or Savings Plans utilization or # coverage budgets. You can't use `BudgetLimit` with # `PlannedBudgetLimits` for `CreateBudget` and `UpdateBudget` actions. # @return [Types::Spend] @@ -236,19 +281,20 @@ class ActionThreshold < Struct.new( # limits. # # `PlannedBudgetLimits` is available for cost or usage budget and - # supports monthly and quarterly `TimeUnit`. + # supports both monthly and quarterly `TimeUnit`. # # For monthly budgets, provide 12 months of `PlannedBudgetLimits` # values. This must start from the current month and include the next # 11 months. The `key` is the start of the month, `UTC` in epoch # seconds. # - # For quarterly budgets, provide 4 quarters of `PlannedBudgetLimits` - # value entries in standard calendar quarter increments. This must - # start from the current quarter and include the next 3 quarters. The - # `key` is the start of the quarter, `UTC` in epoch seconds. + # For quarterly budgets, provide four quarters of + # `PlannedBudgetLimits` value entries in standard calendar quarter + # increments. This must start from the current quarter and include the + # next three quarters. The `key` is the start of the quarter, `UTC` in + # epoch seconds. # - # If the planned budget expires before 12 months for monthly or 4 + # If the planned budget expires before 12 months for monthly or four # quarters for quarterly, provide the `PlannedBudgetLimits` values # only for the remaining periods. # @@ -261,21 +307,22 @@ class ActionThreshold < Struct.new( # experience as a fixed budget. # # `DescribeBudget` and `DescribeBudgets` response along with - # `PlannedBudgetLimits` will also contain `BudgetLimit` representing - # the current month or quarter limit present in `PlannedBudgetLimits`. - # This only applies to budgets created with `PlannedBudgetLimits`. - # Budgets created without `PlannedBudgetLimits` will only contain - # `BudgetLimit`, and no `PlannedBudgetLimits`. + # `PlannedBudgetLimits` also contain `BudgetLimit` representing the + # current month or quarter limit present in `PlannedBudgetLimits`. + # This only applies to budgets that are created with + # `PlannedBudgetLimits`. Budgets that are created without + # `PlannedBudgetLimits` only contain `BudgetLimit`. They don't + # contain `PlannedBudgetLimits`. # @return [Hash