list-collaboration-privacy-budgets¶

Description¶

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.

Synopsis¶

  list-collaboration-privacy-budgets
--collaboration-identifier <value>
--privacy-budget-type <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--collaboration-identifier (string)

A unique identifier for one of your collaborations.

--privacy-budget-type (string)

Specifies the type of the privacy budget.

Possible values:

DIFFERENTIAL_PRIVACY

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

collaborationPrivacyBudgetSummaries -> (list)

Summaries of the collaboration privacy budgets.

(structure)

A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.

id -> (string)

The unique identifier of the collaboration privacy budget.

privacyBudgetTemplateId -> (string)

The unique identifier of the collaboration privacy budget template.

privacyBudgetTemplateArn -> (string)

The ARN of the collaboration privacy budget template.

collaborationId -> (string)

The unique identifier of the collaboration that includes this privacy budget.

collaborationArn -> (string)

The ARN of the collaboration that includes this privacy budget.

creatorAccountId -> (string)

The unique identifier of the account that created this privacy budget.

type -> (string)

The type of privacy budget template.

createTime -> (timestamp)

The time at which the privacy budget was created.

updateTime -> (timestamp)

The most recent time at which the privacy budget was updated.

budget -> (tagged union structure)

The includes epsilon provided and utility in terms of aggregations.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: differentialPrivacy.

differentialPrivacy -> (structure)

An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.

aggregations -> (list)

This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.

(structure)

Information about the total number of aggregations, as well as the remaining aggregations.

type -> (string)

The different types of aggregation functions that you can perform.

maxCount -> (integer)

The maximum number of aggregation functions that you can perform with the given privacy budget.

remainingCount -> (integer)

The remaining number of aggregation functions that can be run with the available privacy budget.

epsilon -> (integer)

The epsilon value that you configured.

nextToken -> (string)

The token value retrieved from a previous call to access the next page of results.

Table of Contents

Feedback

User Guide