ListPrivacyBudgetTemplates - AWS Clean Rooms

ListPrivacyBudgetTemplates

Returns detailed information about the privacy budget templates in a specified membership.

Request Syntax

GET /memberships/membershipIdentifier/privacybudgettemplates?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results 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 templates are 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 token value retrieved from a previous call to access the next page of results.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "privacyBudgetTemplateSummaries": [ { "arn": "string", "collaborationArn": "string", "collaborationId": "string", "createTime": number, "id": "string", "membershipArn": "string", "membershipId": "string", "privacyBudgetType": "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 token value retrieved from a previous call to access the next page of results.

Type: String

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

privacyBudgetTemplateSummaries

An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.

Type: Array of PrivacyBudgetTemplateSummary 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: