AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cleanrooms ]

create-privacy-budget-template

Description

Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.

See also: AWS API Documentation

Synopsis

  create-privacy-budget-template
--membership-identifier <value>
--auto-refresh <value>
--privacy-budget-type <value>
--parameters <value>
[--tags <value>]
[--cli-input-json <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>]

Options

--membership-identifier (string)

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

--auto-refresh (string)

How often the privacy budget refreshes.

Warning

If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

Possible values:

  • CALENDAR_MONTH
  • NONE

--privacy-budget-type (string)

Specifies the type of the privacy budget template.

Possible values:

  • DIFFERENTIAL_PRIVACY

--parameters (tagged union structure)

Specifies your parameters for the privacy budget template.

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 and noise parameters.

epsilon -> (integer)

The epsilon value that you want to use.

usersNoisePerQuery -> (integer)

Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.

Shorthand Syntax:

differentialPrivacy={epsilon=integer,usersNoisePerQuery=integer}

JSON Syntax:

{
  "differentialPrivacy": {
    "epsilon": integer,
    "usersNoisePerQuery": integer
  }
}

--tags (map)

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

privacyBudgetTemplate -> (structure)

A summary of the elements in the privacy budget template.

id -> (string)

The unique identifier of the privacy budget template.

arn -> (string)

The ARN of the privacy budget template.

membershipId -> (string)

The identifier for a membership resource.

membershipArn -> (string)

The Amazon Resource Name (ARN) of the member who created the privacy budget template.

collaborationId -> (string)

The unique ID of the collaboration that contains this privacy budget template.

collaborationArn -> (string)

The ARN of the collaboration that contains this privacy budget template.

createTime -> (timestamp)

The time at which the privacy budget template was created.

updateTime -> (timestamp)

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

privacyBudgetType -> (string)

Specifies the type of the privacy budget template.

autoRefresh -> (string)

How often the privacy budget refreshes.

Warning

If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.

parameters -> (tagged union structure)

Specifies the epsilon and noise parameters for the privacy budget template.

Note

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

differentialPrivacy -> (structure)

The epsilon and noise parameters.

epsilon -> (integer)

The epsilon value that you specified.

usersNoisePerQuery -> (integer)

Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.