Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListPrivacyBudgets

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

Request Syntax


GET /memberships/membershipIdentifier/privacybudgets?maxResults=maxResults&nextToken=nextToken&privacyBudgetType=privacyBudgetType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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.

Valid Range: Minimum value of 1. Maximum value of 100.

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.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

nextToken

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

Length Constraints: Minimum length of 0. Maximum length of 10240.

privacyBudgetType

The privacy budget type.

Valid Values: DIFFERENTIAL_PRIVACY

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "privacyBudgetSummaries": [ 
      { 
         "budget": { ... },
         "collaborationArn": "string",
         "collaborationId": "string",
         "createTime": number,
         "id": "string",
         "membershipArn": "string",
         "membershipId": "string",
         "privacyBudgetTemplateArn": "string",
         "privacyBudgetTemplateId": "string",
         "type": "string",
         "updateTime": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10240.

privacyBudgetSummaries

An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.

Type: Array of PrivacyBudgetSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Caller does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400