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-id-mapping-table

Description

Creates an ID mapping table.

See also: AWS API Documentation

Synopsis

  create-id-mapping-table
--membership-identifier <value>
--name <value>
[--description <value>]
--input-reference-config <value>
[--tags <value>]
[--kms-key-arn <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)

The unique identifier of the membership that contains the ID mapping table.

--name (string)

A name for the ID mapping table.

--description (string)

A description of the ID mapping table.

--input-reference-config (structure)

The input reference configuration needed to create the ID mapping table.

inputReferenceArn -> (string)

The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.

manageResourcePolicies -> (boolean)

When TRUE , Clean Rooms manages permissions for the ID mapping table resource.

When FALSE , the resource owner manages permissions for the ID mapping table resource.

Shorthand Syntax:

inputReferenceArn=string,manageResourcePolicies=boolean

JSON Syntax:

{
  "inputReferenceArn": "string",
  "manageResourcePolicies": true|false
}

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

--kms-key-arn (string)

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.

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

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

idMappingTable -> (structure)

The ID mapping table that was created.

id -> (string)

The unique identifier of the ID mapping table.

arn -> (string)

The Amazon Resource Name (ARN) of the ID mapping table.

inputReferenceConfig -> (structure)

The input reference configuration for the ID mapping table.

inputReferenceArn -> (string)

The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.

manageResourcePolicies -> (boolean)

When TRUE , Clean Rooms manages permissions for the ID mapping table resource.

When FALSE , the resource owner manages permissions for the ID mapping table resource.

membershipId -> (string)

The unique identifier of the membership resource for the ID mapping table.

membershipArn -> (string)

The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.

collaborationId -> (string)

The unique identifier of the collaboration that contains this ID mapping table.

collaborationArn -> (string)

The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.

description -> (string)

The description of the ID mapping table.

name -> (string)

The name of the ID mapping table.

createTime -> (timestamp)

The time at which the ID mapping table was created.

updateTime -> (timestamp)

The most recent time at which the ID mapping table was updated.

inputReferenceProperties -> (structure)

The input reference properties for the ID mapping table.

idMappingTableInputSource -> (list)

The input source of the ID mapping table.

(structure)

The input source of the ID mapping table.

idNamespaceAssociationId -> (string)

The unique identifier of the ID namespace association.

type -> (string)

The type of the input source of the ID mapping table.

kmsKeyArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.