AWS.Tools.Budgets.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Budgets</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetCmdlet"> <summary> Describes a budget. <important><para> The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples">Examples</a> section. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget that you want a description of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetCmdlet.BudgetName"> <summary> <para> <para>The name of the budget that you want a description of.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetListCmdlet"> <summary> Lists the budgets that are associated with an account. <important><para> The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples">Examples</a> section. </para></important><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetListCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budgets that you want descriptions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetListCmdlet.MaxResult"> <summary> <para> <para>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetListCmdlet.NextToken"> <summary> <para> <para>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetPerformanceHistoryCmdlet"> <summary> Describes the history for <code>DAILY</code>, <code>MONTHLY</code>, and <code>QUARTERLY</code> budgets. Budget history isn't available for <code>ANNUAL</code> budgets. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetPerformanceHistoryCmdlet.AccountId"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetPerformanceHistoryCmdlet.BudgetName"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetPerformanceHistoryCmdlet.TimePeriod_End"> <summary> <para> <para>The end date for a budget. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</para><para>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetPerformanceHistoryCmdlet.TimePeriod_Start"> <summary> <para> <para>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 <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</para><para>You can change your start date with the <code>UpdateBudget</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetPerformanceHistoryCmdlet.MaxResult"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTBudgetPerformanceHistoryCmdlet.NextToken"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.GetBGTNotificationsForBudgetCmdlet"> <summary> Lists the notifications that are associated with a budget.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTNotificationsForBudgetCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget whose notifications you want descriptions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTNotificationsForBudgetCmdlet.BudgetName"> <summary> <para> <para>The name of the budget whose notifications you want descriptions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTNotificationsForBudgetCmdlet.MaxResult"> <summary> <para> <para>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTNotificationsForBudgetCmdlet.NextToken"> <summary> <para> <para>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet"> <summary> Lists the subscribers that are associated with a notification.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget whose subscribers you want descriptions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.BudgetName"> <summary> <para> <para>The name of the budget whose subscribers you want descriptions of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.Notification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.Notification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.Notification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.Notification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.Notification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.MaxResult"> <summary> <para> <para>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.GetBGTSubscribersForNotificationCmdlet.NextToken"> <summary> <para> <para>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet"> <summary> Creates a budget and, if included, notifications and subscribers. <important><para> Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples">Examples</a> section. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.BudgetLimit_Amount"> <summary> <para> <para>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.ActualSpend_Amount"> <summary> <para> <para>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.ForecastedSpend_Amount"> <summary> <para> <para>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.Budget_BudgetName"> <summary> <para> <para>The name of a budget. The name must be unique within an account. The <code>:</code> and <code>\</code> characters aren't allowed in <code>BudgetName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.Budget_BudgetType"> <summary> <para> <para>Whether this budget tracks costs, usage, RI utilization, or RI coverage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.Budget_CostFilter"> <summary> <para> <para>The cost filters, such as service or tag, that are applied to a budget.</para><para>AWS Budgets supports the following services as a filter for RI budgets:</para><ul><li><para>Amazon Elastic Compute Cloud - Compute</para></li><li><para>Amazon Redshift</para></li><li><para>Amazon Relational Database Service</para></li><li><para>Amazon ElastiCache</para></li><li><para>Amazon Elasticsearch Service</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.TimePeriod_End"> <summary> <para> <para>The end date for a budget. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</para><para>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeCredit"> <summary> <para> <para>Specifies whether a budget includes credits.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeDiscount"> <summary> <para> <para>Specifies whether a budget includes discounts.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeOtherSubscription"> <summary> <para> <para>Specifies whether a budget includes non-RI subscription costs.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeRecurring"> <summary> <para> <para>Specifies whether a budget includes recurring fees such as monthly RI fees.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeRefund"> <summary> <para> <para>Specifies whether a budget includes refunds.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeSubscription"> <summary> <para> <para>Specifies whether a budget includes subscriptions.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeSupport"> <summary> <para> <para>Specifies whether a budget includes support subscription fees.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeTax"> <summary> <para> <para>Specifies whether a budget includes taxes.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_IncludeUpfront"> <summary> <para> <para>Specifies whether a budget includes upfront RI costs.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.Budget_LastUpdatedTime"> <summary> <para> <para>The last time that you updated this budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.NotificationsWithSubscriber"> <summary> <para> <para>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 <code>CreateBudget</code> call, AWS creates the notifications and subscribers for you.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.Budget_PlannedBudgetLimit"> <summary> <para> <para>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</para><para><code>PlannedBudgetLimits</code> is available for cost or usage budget and supports monthly and quarterly <code>TimeUnit</code>. </para><para>For monthly budgets, provide 12 months of <code>PlannedBudgetLimits</code> values. This must start from the current month and include the next 11 months. The <code>key</code> is the start of the month, <code>UTC</code> in epoch seconds. </para><para>For quarterly budgets, provide 4 quarters of <code>PlannedBudgetLimits</code> value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The <code>key</code> is the start of the quarter, <code>UTC</code> in epoch seconds. </para><para>If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the <code>PlannedBudgetLimits</code> values only for the remaining periods.</para><para>If the budget begins at a date in the future, provide <code>PlannedBudgetLimits</code> values from the start date of the budget. </para><para>After all of the <code>BudgetLimit</code> values in <code>PlannedBudgetLimits</code> are used, the budget continues to use the last limit as the <code>BudgetLimit</code>. At that point, the planned budget provides the same experience as a fixed budget. </para><para><code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with <code>PlannedBudgetLimits</code> will also contain <code>BudgetLimit</code> representing the current month or quarter limit present in <code>PlannedBudgetLimits</code>. This only applies to budgets created with <code>PlannedBudgetLimits</code>. Budgets created without <code>PlannedBudgetLimits</code> will only contain <code>BudgetLimit</code>, and no <code>PlannedBudgetLimits</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.TimePeriod_Start"> <summary> <para> <para>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 <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</para><para>You can change your start date with the <code>UpdateBudget</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.Budget_TimeUnit"> <summary> <para> <para>The length of time until a budget resets the actual and forecasted spend. <code>DAILY</code> is available only for <code>RI_UTILIZATION</code> and <code>RI_COVERAGE</code> budgets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.BudgetLimit_Unit"> <summary> <para> <para>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.ActualSpend_Unit"> <summary> <para> <para>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.ForecastedSpend_Unit"> <summary> <para> <para>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_UseAmortized"> <summary> <para> <para>Specifies whether a budget uses the amortized rate.</para><para>The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.CostTypes_UseBlended"> <summary> <para> <para>Specifies whether a budget uses a blended rate.</para><para>The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.PassThru"> <summary> Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTBudgetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet"> <summary> Creates a notification. You must create the budget before you create the associated notification. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget that you want to create a notification for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.BudgetName"> <summary> <para> <para>The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.Notification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.Notification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.Notification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.Subscriber"> <summary> <para> <para>A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.Notification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.Notification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.PassThru"> <summary> Returns the value passed to the BudgetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTNotificationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet"> <summary> Creates a subscriber. You must create the associated budget and notification before you create the subscriber. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget that you want to create a subscriber for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Subscriber_Address"> <summary> <para> <para>The address that AWS sends budget notifications to, either an SNS topic or an email.</para><para>AWS validates the address for a <code>CreateSubscriber</code> request with the <code>.*</code> regex.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.BudgetName"> <summary> <para> <para>The name of the budget that you want to subscribe to. Budget names must be unique within an account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Notification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Notification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Notification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Subscriber_SubscriptionType"> <summary> <para> <para>The type of notification that AWS sends to a subscriber.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Notification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Notification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.PassThru"> <summary> Returns the value passed to the BudgetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.NewBGTSubscriberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTBudgetCmdlet"> <summary> Deletes a budget. You can delete your budget at any time. <important><para> Deleting a budget also deletes the notifications and subscribers that are associated with that budget. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTBudgetCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTBudgetCmdlet.BudgetName"> <summary> <para> <para>The name of the budget that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTBudgetCmdlet.PassThru"> <summary> Returns the value passed to the BudgetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTBudgetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet"> <summary> Deletes a notification. <important><para> Deleting a notification also deletes the subscribers that are associated with the notification. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget whose notification you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.BudgetName"> <summary> <para> <para>The name of the budget whose notification you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.Notification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.Notification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.Notification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.Notification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.Notification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.PassThru"> <summary> Returns the value passed to the BudgetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTNotificationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet"> <summary> Deletes a subscriber. <important><para> Deleting the last subscriber to a notification also deletes the notification. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget whose subscriber you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Subscriber_Address"> <summary> <para> <para>The address that AWS sends budget notifications to, either an SNS topic or an email.</para><para>AWS validates the address for a <code>CreateSubscriber</code> request with the <code>.*</code> regex.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.BudgetName"> <summary> <para> <para>The name of the budget whose subscriber you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Notification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Notification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Notification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Subscriber_SubscriptionType"> <summary> <para> <para>The type of notification that AWS sends to a subscriber.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Notification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Notification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.PassThru"> <summary> Returns the value passed to the BudgetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.RemoveBGTSubscriberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet"> <summary> Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting. <important><para> Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples">Examples</a> section. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.BudgetLimit_Amount"> <summary> <para> <para>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.ActualSpend_Amount"> <summary> <para> <para>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.ForecastedSpend_Amount"> <summary> <para> <para>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.NewBudget_BudgetName"> <summary> <para> <para>The name of a budget. The name must be unique within an account. The <code>:</code> and <code>\</code> characters aren't allowed in <code>BudgetName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.NewBudget_BudgetType"> <summary> <para> <para>Whether this budget tracks costs, usage, RI utilization, or RI coverage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.NewBudget_CostFilter"> <summary> <para> <para>The cost filters, such as service or tag, that are applied to a budget.</para><para>AWS Budgets supports the following services as a filter for RI budgets:</para><ul><li><para>Amazon Elastic Compute Cloud - Compute</para></li><li><para>Amazon Redshift</para></li><li><para>Amazon Relational Database Service</para></li><li><para>Amazon ElastiCache</para></li><li><para>Amazon Elasticsearch Service</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.TimePeriod_End"> <summary> <para> <para>The end date for a budget. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</para><para>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeCredit"> <summary> <para> <para>Specifies whether a budget includes credits.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeDiscount"> <summary> <para> <para>Specifies whether a budget includes discounts.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeOtherSubscription"> <summary> <para> <para>Specifies whether a budget includes non-RI subscription costs.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeRecurring"> <summary> <para> <para>Specifies whether a budget includes recurring fees such as monthly RI fees.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeRefund"> <summary> <para> <para>Specifies whether a budget includes refunds.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeSubscription"> <summary> <para> <para>Specifies whether a budget includes subscriptions.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeSupport"> <summary> <para> <para>Specifies whether a budget includes support subscription fees.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeTax"> <summary> <para> <para>Specifies whether a budget includes taxes.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_IncludeUpfront"> <summary> <para> <para>Specifies whether a budget includes upfront RI costs.</para><para>The default value is <code>true</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.NewBudget_LastUpdatedTime"> <summary> <para> <para>The last time that you updated this budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.NewBudget_PlannedBudgetLimit"> <summary> <para> <para>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</para><para><code>PlannedBudgetLimits</code> is available for cost or usage budget and supports monthly and quarterly <code>TimeUnit</code>. </para><para>For monthly budgets, provide 12 months of <code>PlannedBudgetLimits</code> values. This must start from the current month and include the next 11 months. The <code>key</code> is the start of the month, <code>UTC</code> in epoch seconds. </para><para>For quarterly budgets, provide 4 quarters of <code>PlannedBudgetLimits</code> value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The <code>key</code> is the start of the quarter, <code>UTC</code> in epoch seconds. </para><para>If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the <code>PlannedBudgetLimits</code> values only for the remaining periods.</para><para>If the budget begins at a date in the future, provide <code>PlannedBudgetLimits</code> values from the start date of the budget. </para><para>After all of the <code>BudgetLimit</code> values in <code>PlannedBudgetLimits</code> are used, the budget continues to use the last limit as the <code>BudgetLimit</code>. At that point, the planned budget provides the same experience as a fixed budget. </para><para><code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with <code>PlannedBudgetLimits</code> will also contain <code>BudgetLimit</code> representing the current month or quarter limit present in <code>PlannedBudgetLimits</code>. This only applies to budgets created with <code>PlannedBudgetLimits</code>. Budgets created without <code>PlannedBudgetLimits</code> will only contain <code>BudgetLimit</code>, and no <code>PlannedBudgetLimits</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.TimePeriod_Start"> <summary> <para> <para>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 <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</para><para>You can change your start date with the <code>UpdateBudget</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.NewBudget_TimeUnit"> <summary> <para> <para>The length of time until a budget resets the actual and forecasted spend. <code>DAILY</code> is available only for <code>RI_UTILIZATION</code> and <code>RI_COVERAGE</code> budgets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.BudgetLimit_Unit"> <summary> <para> <para>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.ActualSpend_Unit"> <summary> <para> <para>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.ForecastedSpend_Unit"> <summary> <para> <para>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_UseAmortized"> <summary> <para> <para>Specifies whether a budget uses the amortized rate.</para><para>The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.CostTypes_UseBlended"> <summary> <para> <para>Specifies whether a budget uses a blended rate.</para><para>The default value is <code>false</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.PassThru"> <summary> Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTBudgetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet"> <summary> Updates a notification. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget whose notification you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.BudgetName"> <summary> <para> <para>The name of the budget whose notification you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.NewNotification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.OldNotification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.NewNotification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.OldNotification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.NewNotification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.OldNotification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.NewNotification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.OldNotification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.NewNotification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.OldNotification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.PassThru"> <summary> Returns the value passed to the BudgetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTNotificationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet"> <summary> Updates a subscriber. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.AccountId"> <summary> <para> <para>The <code>accountId</code> that is associated with the budget whose subscriber you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.NewSubscriber_Address"> <summary> <para> <para>The address that AWS sends budget notifications to, either an SNS topic or an email.</para><para>AWS validates the address for a <code>CreateSubscriber</code> request with the <code>.*</code> regex.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.OldSubscriber_Address"> <summary> <para> <para>The address that AWS sends budget notifications to, either an SNS topic or an email.</para><para>AWS validates the address for a <code>CreateSubscriber</code> request with the <code>.*</code> regex.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.BudgetName"> <summary> <para> <para>The name of the budget whose subscriber you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.Notification_ComparisonOperator"> <summary> <para> <para>The comparison that is used for this notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.Notification_NotificationState"> <summary> <para> <para>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.Notification_NotificationType"> <summary> <para> <para>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.NewSubscriber_SubscriptionType"> <summary> <para> <para>The type of notification that AWS sends to a subscriber.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.OldSubscriber_SubscriptionType"> <summary> <para> <para>The type of notification that AWS sends to a subscriber.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.Notification_Threshold"> <summary> <para> <para>The threshold that is associated with a notification. Thresholds are always a percentage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.Notification_ThresholdType"> <summary> <para> <para>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> 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 <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.PassThru"> <summary> Returns the value passed to the BudgetName parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BGT.UpdateBGTSubscriberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |