:doc:`CleanRoomsML <../../cleanroomsml>` / Client / update_configured_audience_model

********************************
update_configured_audience_model
********************************



.. py:method:: CleanRoomsML.Client.update_configured_audience_model(**kwargs)

  

  Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UpdateConfiguredAudienceModel>`_  


  **Request Syntax**
  ::

    response = client.update_configured_audience_model(
        configuredAudienceModelArn='string',
        outputConfig={
            'destination': {
                's3Destination': {
                    's3Uri': 'string'
                }
            },
            'roleArn': 'string'
        },
        audienceModelArn='string',
        sharedAudienceMetrics=[
            'ALL'|'NONE',
        ],
        minMatchingSeedSize=123,
        audienceSizeConfig={
            'audienceSizeType': 'ABSOLUTE'|'PERCENTAGE',
            'audienceSizeBins': [
                123,
            ]
        },
        description='string'
    )
    
  :type configuredAudienceModelArn: string
  :param configuredAudienceModelArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the configured audience model that you want to update.

    

  
  :type outputConfig: dict
  :param outputConfig: 

    The new output configuration.

    

  
    - **destination** *(dict) --* **[REQUIRED]** 

      Defines the Amazon S3 bucket where the configured audience is stored.

      

    
      - **s3Destination** *(dict) --* **[REQUIRED]** 

        The Amazon S3 bucket and path for the configured audience.

        

      
        - **s3Uri** *(string) --* **[REQUIRED]** 

          The Amazon S3 location URI.

          

        
      
    
    - **roleArn** *(string) --* **[REQUIRED]** 

      The ARN of the IAM role that can write the Amazon S3 bucket.

      

    
  
  :type audienceModelArn: string
  :param audienceModelArn: 

    The Amazon Resource Name (ARN) of the new audience model that you want to use.

    

  
  :type sharedAudienceMetrics: list
  :param sharedAudienceMetrics: 

    The new value for whether to share audience metrics.

    

  
    - *(string) --* 

    

  :type minMatchingSeedSize: integer
  :param minMatchingSeedSize: 

    The minimum number of users from the seed audience that must match with users in the training data of the audience model.

    

  
  :type audienceSizeConfig: dict
  :param audienceSizeConfig: 

    The new audience size configuration.

    

  
    - **audienceSizeType** *(string) --* **[REQUIRED]** 

      Whether the audience output sizes are defined as an absolute number or a percentage.

      

    
    - **audienceSizeBins** *(list) --* **[REQUIRED]** 

      An array of the different audience output sizes.

      

    
      - *(integer) --* 

      
  
  
  :type description: string
  :param description: 

    The new description of the configured audience model.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'configuredAudienceModelArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **configuredAudienceModelArn** *(string) --* 

        The Amazon Resource Name (ARN) of the configured audience model that was updated.

        
  
  **Exceptions**
  
  *   :py:class:`CleanRoomsML.Client.exceptions.ConflictException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.ValidationException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CleanRoomsML.Client.exceptions.ResourceNotFoundException`

  