CleanRoomsService / Client / get_configured_table_association

get_configured_table_association

CleanRoomsService.Client.get_configured_table_association(**kwargs)

Retrieves a configured table association.

See also: AWS API Documentation

Request Syntax

response = client.get_configured_table_association(
    configuredTableAssociationIdentifier='string',
    membershipIdentifier='string'
)

Parameters:

• configuredTableAssociationIdentifier (string) –

  [REQUIRED]

  The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.

• membershipIdentifier (string) –

  [REQUIRED]

  A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.

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),
        'childResources': [
            {
                'resourceId': 'string',
                'resourceType': 'INTERMEDIATE_TABLE',
                'resourceName': 'string',
                'ownerAccountId': 'string',
                'resourceStatus': 'CREATED'|'POPULATE_STARTED'|'POPULATE_SUCCESS'|'POPULATE_FAILED'|'DISALLOWED_BY_DATA_PROVIDER'|'BASE_TABLE_REMOVED'|'RETENTION_PERIOD_EXPIRED'
            },
        ]
    }
}

Response Structure

• (dict) –

  • configuredTableAssociation (dict) –

    The entire configured table association object.

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

    • childResources (list) –

      The child resources that depend on this configured table association.

      • (dict) –

        Contains information about a child resource of a given resource in a collaboration.

        • resourceId (string) –

          The unique identifier of the child resource.

        • resourceType (string) –

          The type of the child resource.

        • resourceName (string) –

          The name of the child resource.

        • ownerAccountId (string) –

          The Amazon Web Services account ID of the member who owns the child resource.

        • resourceStatus (string) –

          The current status of the child resource.

Exceptions

• CleanRoomsService.Client.exceptions.ResourceNotFoundException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException