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 ]

get-id-namespace-association

Description

Retrieves an ID namespace association.

See also: AWS API Documentation

get-id-namespace-association uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  get-id-namespace-association
--id-namespace-association-identifier <value>
--membership-identifier <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

--id-namespace-association-identifier (string)

The unique identifier of the ID namespace association that you want to retrieve.

--membership-identifier (string)

The unique identifier of the membership that contains the ID namespace association that you want to retrieve.

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

idNamespaceAssociation -> (structure)

The ID namespace association that you requested.

id -> (string)

The unique identifier for this ID namespace association.

arn -> (string)

The Amazon Resource Name (ARN) of the ID namespace association.

membershipId -> (string)

The unique identifier of the membership resource for this ID namespace association.

membershipArn -> (string)

The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.

collaborationId -> (string)

The unique identifier of the collaboration that contains this ID namespace association.

collaborationArn -> (string)

The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.

name -> (string)

The name of this ID namespace association.

description -> (string)

The description of the ID namespace association.

createTime -> (timestamp)

The time at which the ID namespace association was created.

updateTime -> (timestamp)

The most recent time at which the ID namespace association was updated.

inputReferenceConfig -> (structure)

The input reference configuration for the ID namespace association.

inputReferenceArn -> (string)

The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.

manageResourcePolicies -> (boolean)

When TRUE , Clean Rooms manages permissions for the ID namespace association resource.

When FALSE , the resource owner manages permissions for the ID namespace association resource.

inputReferenceProperties -> (structure)

The input reference properties for the ID namespace association.

idNamespaceType -> (string)

The ID namespace type for this ID namespace association.

idMappingWorkflowsSupported -> (list)

Defines how ID mapping workflows are supported for this ID namespace association.

(document)

idMappingConfig -> (structure)

The configuration settings for the ID mapping table.

allowUseAsDimensionColumn -> (boolean)

An indicator as to whether you can use your column as a dimension column in the ID mapping table (TRUE ) or not (FALSE ).

Default is FALSE .