describeBudgetPerformanceHistory method

Future<DescribeBudgetPerformanceHistoryResponse> describeBudgetPerformanceHistory({ required String accountId, required String budgetName, int? maxResults, String? nextToken, TimePeriod? timePeriod, })

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

May throw InternalErrorException. May throw InvalidParameterException. May throw NotFoundException. May throw InvalidNextTokenException. May throw ExpiredNextTokenException. May throw AccessDeniedException.

Parameter timePeriod : Retrieves how often the budget went into an ALARM state for the specified time period.

Implementation

Future<DescribeBudgetPerformanceHistoryResponse>
    describeBudgetPerformanceHistory({
  required String accountId,
  required String budgetName,
  int? maxResults,
  String? nextToken,
  TimePeriod? timePeriod,
}) async {
  ArgumentError.checkNotNull(accountId, 'accountId');
  _s.validateStringLength(
    'accountId',
    accountId,
    12,
    12,
    isRequired: true,
  );
  ArgumentError.checkNotNull(budgetName, 'budgetName');
  _s.validateStringLength(
    'budgetName',
    budgetName,
    1,
    100,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    0,
    2147483647,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSBudgetServiceGateway.DescribeBudgetPerformanceHistory'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AccountId': accountId,
      'BudgetName': budgetName,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (timePeriod != null) 'TimePeriod': timePeriod,
    },
  );

  return DescribeBudgetPerformanceHistoryResponse.fromJson(jsonResponse.body);
}