CleanRoomsService / Client / create_configured_table_association

create_configured_table_association#

CleanRoomsService.Client.create_configured_table_association(**kwargs)#

Creates a configured table association. A configured table association links a configured table with a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.create_configured_table_association(
    name='string',
    description='string',
    membershipIdentifier='string',
    configuredTableIdentifier='string',
    roleArn='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    The name of the configured table association. This name is used to query the underlying configured table.

  • description (string) – A description for the configured table association.

  • membershipIdentifier (string) –

    [REQUIRED]

    A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.

  • configuredTableIdentifier (string) –

    [REQUIRED]

    A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.

  • roleArn (string) –

    [REQUIRED]

    The service will assume this role to access catalog metadata and query the table.

  • tags (dict) –

    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.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'configuredTableAssociation': {
        'arn': 'string',
        'id': 'string',
        'configuredTableId': 'string',
        'configuredTableArn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'roleArn': 'string',
        'name': 'string',
        'description': 'string',
        'analysisRuleTypes': [
            'AGGREGATION'|'LIST'|'CUSTOM',
        ],
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • configuredTableAssociation (dict) –

      The configured table association.

      • arn (string) –

        The unique ARN for the configured table association.

      • id (string) –

        The unique ID for the configured table association.

      • configuredTableId (string) –

        The unique ID for the configured table that the association refers to.

      • configuredTableArn (string) –

        The unique ARN for the configured table that the association refers to.

      • membershipId (string) –

        The unique ID for the membership this configured table association belongs to.

      • membershipArn (string) –

        The unique ARN for the membership this configured table association belongs to.

      • roleArn (string) –

        The service will assume this role to access catalog metadata and query the table.

      • name (string) –

        The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

      • description (string) –

        A description of the configured table association.

      • analysisRuleTypes (list) –

        The analysis rule types for the configured table association.

        • (string) –

      • createTime (datetime) –

        The time the configured table association was created.

      • updateTime (datetime) –

        The time the configured table association was last updated.

Exceptions