listCollaborationPrivacyBudgets method

Future<ListCollaborationPrivacyBudgetsOutput> listCollaborationPrivacyBudgets({ required String collaborationIdentifier, required PrivacyBudgetType privacyBudgetType, String? accessBudgetResourceArn, int? maxResults, String? nextToken, })

Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter collaborationIdentifier : A unique identifier for one of your collaborations.

Parameter privacyBudgetType : Specifies the type of the privacy budget.

Parameter accessBudgetResourceArn : The Amazon Resource Name (ARN) of the Configured Table Association (ConfiguredTableAssociation) used to filter privacy budgets.

Parameter maxResults : The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Parameter nextToken : The pagination token that's used to fetch the next set of results.

Implementation

Future<ListCollaborationPrivacyBudgetsOutput>
    listCollaborationPrivacyBudgets({
  required String collaborationIdentifier,
  required PrivacyBudgetType privacyBudgetType,
  String? accessBudgetResourceArn,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    'privacyBudgetType': [privacyBudgetType.value],
    if (accessBudgetResourceArn != null)
      'accessBudgetResourceArn': [accessBudgetResourceArn],
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/collaborations/${Uri.encodeComponent(collaborationIdentifier)}/privacybudgets',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListCollaborationPrivacyBudgetsOutput.fromJson(response);
}