Skip to content

list_privacy_budgets

list_privacy_budgets(
    membership_identifier: MembershipIdentifier,
    privacy_budget_type: PrivacyBudgetType,
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
    access_budget_resource_arn: Optional[BudgetedResourceArn] = None,
) -> ListPrivacyBudgetsOutput

Returns detailed information about the privacy budgets in a specified membership.

Parameters:

  • membership_identifier (MembershipIdentifier) –

    A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.

  • privacy_budget_type (PrivacyBudgetType) –

    The privacy budget type.

  • next_token (Optional[PaginationToken], default: None ) –

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

  • max_results (Optional[MaxResults], default: None ) –

    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.

  • access_budget_resource_arn (Optional[BudgetedResourceArn], default: None ) –

    The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.

Raises:

Source code in docs_src/capo_cleanrooms/_services/clean_rooms.py
def list_privacy_budgets(
    self,
    membership_identifier: "capo_cleanrooms.types.membership_identifier.MembershipIdentifier",
    privacy_budget_type: "capo_cleanrooms.types.privacy_budget_type.PrivacyBudgetType",
    *,
    config_overrides: Optional[CleanRoomsClientConfig] = None,
    next_token: Optional[
        "capo_cleanrooms.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_cleanrooms.types.max_results.MaxResults"] = None,
    access_budget_resource_arn: Optional[
        "capo_cleanrooms.types.budgeted_resource_arn.BudgetedResourceArn"
    ] = None,
) -> "capo_cleanrooms.types.list_privacy_budgets_output.ListPrivacyBudgetsOutput":
    """<p>Returns detailed information about the privacy budgets in a specified membership.</p>

    Args:
        membership_identifier: <p>A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.</p>
        privacy_budget_type: <p>The privacy budget type.</p>
        next_token: <p>The pagination token that's used to fetch the next set of results.</p>
        max_results: <p>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.</p>
        access_budget_resource_arn: <p>The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.</p>

    Raises:
        capo_cleanrooms.errors.access_denied_exception.AccessDeniedException: <p>Caller does not have sufficient access to perform this action.</p>
        capo_cleanrooms.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_cleanrooms.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_cleanrooms.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_cleanrooms.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints.</p>
        capo_cleanrooms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cleanrooms.types.list_privacy_budgets_input.ListPrivacyBudgetsInput]",
    ) -> OperationResponse[
        "capo_cleanrooms.types.list_privacy_budgets_output.ListPrivacyBudgetsOutput"
    ]:
        import capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.list_privacy_budgets

        output, http_response = (
            capo_cleanrooms._operations.aws_bastion_control_plane_service_lambda.list_privacy_budgets.list_privacy_budgets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPrivacyBudgets")
    )
    input_: capo_cleanrooms.types.list_privacy_budgets_input.ListPrivacyBudgetsInput = {
        "membership_identifier": membership_identifier,
        "privacy_budget_type": privacy_budget_type,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if access_budget_resource_arn is not None:
        input_["access_budget_resource_arn"] = access_budget_resource_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output