CleanRoomsService / Client / create_configured_audience_model_association

create_configured_audience_model_association#

CleanRoomsService.Client.create_configured_audience_model_association(**kwargs)#

Provides the details necessary to create a configured audience model association.

See also: AWS API Documentation

Request Syntax

response = client.create_configured_audience_model_association(
    membershipIdentifier='string',
    configuredAudienceModelArn='string',
    configuredAudienceModelAssociationName='string',
    manageResourcePolicies=True|False,
    tags={
        'string': 'string'
    },
    description='string'
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.

  • configuredAudienceModelArn (string) –

    [REQUIRED]

    A unique identifier for the configured audience model that you want to associate.

  • configuredAudienceModelAssociationName (string) –

    [REQUIRED]

    The name of the configured audience model association.

  • manageResourcePolicies (boolean) –

    [REQUIRED]

    When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.

    Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.

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

  • description (string) – A description of the configured audience model association.

Return type:

dict

Returns:

Response Syntax

{
    'configuredAudienceModelAssociation': {
        'id': 'string',
        'arn': 'string',
        'configuredAudienceModelArn': 'string',
        'membershipId': 'string',
        'membershipArn': 'string',
        'collaborationId': 'string',
        'collaborationArn': 'string',
        'name': 'string',
        'manageResourcePolicies': True|False,
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • configuredAudienceModelAssociation (dict) –

      Information about the configured audience model association.

      • id (string) –

        A unique identifier of the configured audience model association.

      • arn (string) –

        The Amazon Resource Name (ARN) of the configured audience model association.

      • configuredAudienceModelArn (string) –

        The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.

      • membershipId (string) –

        A unique identifier for the membership that contains this configured audience model association.

      • membershipArn (string) –

        The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.

      • collaborationId (string) –

        A unique identifier of the collaboration that contains this configured audience model association.

      • collaborationArn (string) –

        The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.

      • name (string) –

        The name of the configured audience model association.

      • manageResourcePolicies (boolean) –

        When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.

      • description (string) –

        The description of the configured audience model association.

      • createTime (datetime) –

        The time at which the configured audience model association was created.

      • updateTime (datetime) –

        The most recent time at which the configured audience model association was updated.

Exceptions