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-configured-audience-model-association

Description

Provides the details necessary to create a configured audience model association.

See also: AWS API Documentation

Synopsis

  create-configured-audience-model-association
--membership-identifier <value>
--configured-audience-model-arn <value>
--configured-audience-model-association-name <value>
--manage-resource-policies | --no-manage-resource-policies
[--tags <value>]
[--description <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 configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.

--configured-audience-model-arn (string)

A unique identifier for the configured audience model that you want to associate.

--configured-audience-model-association-name (string)

The name of the configured audience model association.

--manage-resource-policies | --no-manage-resource-policies (boolean)

When TRUE , indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE , indicates that the configured audience model resource owner will manage permissions related to the given collaboration.

Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE , you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.

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

--description (string)

A description of the configured audience model association.

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

configuredAudienceModelAssociation -> (structure)

Information about the configured audience model association.

id -> (string)

A unique identifier of the configured audience model association.

arn -> (string)

The Amazon Resource Name (ARN) of the configured audience model association.

configuredAudienceModelArn -> (string)

The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.

membershipId -> (string)

A unique identifier for the membership that contains this configured audience model association.

membershipArn -> (string)

The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.

collaborationId -> (string)

A unique identifier of the collaboration that contains this configured audience model association.

collaborationArn -> (string)

The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.

name -> (string)

The name of the configured audience model association.

manageResourcePolicies -> (boolean)

When TRUE , indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE , indicates that the configured audience model resource owner will manage permissions related to the given collaboration.

description -> (string)

The description of the configured audience model association.

createTime -> (timestamp)

The time at which the configured audience model association was created.

updateTime -> (timestamp)

The most recent time at which the configured audience model association was updated.