CleanRoomsService / Client / update_id_namespace_association

update_id_namespace_association

CleanRoomsService.Client.update_id_namespace_association(**kwargs)

Provides the details that are necessary to update an ID namespace association.

See also: AWS API Documentation

Request Syntax

response = client.update_id_namespace_association(
    idNamespaceAssociationIdentifier='string',
    membershipIdentifier='string',
    name='string',
    description='string',
    idMappingConfig={
        'allowUseAsDimensionColumn': True|False
    }
)

Parameters:

• idNamespaceAssociationIdentifier (string) –

  [REQUIRED]

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

• membershipIdentifier (string) –

  [REQUIRED]

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

• name (string) – A new name for the ID namespace association.

• description (string) – A new description for the ID namespace association.

• idMappingConfig (dict) –

  The configuration settings for the ID mapping table.

  • allowUseAsDimensionColumn (boolean) – [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'idNamespaceAssociation': {
        'id': 'string',
        'arn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'name': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'inputReferenceConfig': {
            'inputReferenceArn': 'string',
            'manageResourcePolicies': True|False
        },
        'inputReferenceProperties': {
            'idNamespaceType': 'SOURCE'|'TARGET',
            'idMappingWorkflowsSupported': [
                {...}|[...]|123|123.4|'string'|True|None,
            ]
        },
        'idMappingConfig': {
            'allowUseAsDimensionColumn': True|False
        }
    }
}

Response Structure

• (dict) –

  • idNamespaceAssociation (dict) –

    The updated ID namespace association.

    • 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 (datetime) –

      The time at which the ID namespace association was created.

    • updateTime (datetime) –

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

    • inputReferenceConfig (dict) –

      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 (dict) –

      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 (dict) –

      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.

Exceptions

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException