Skip to content

get_audience_model

get_audience_model(
    audience_model_arn: AudienceModelArn,
    *,
    config_overrides: Optional[CleanRoomsMLClientConfig] = None,
) -> GetAudienceModelResponse

Returns information about an audience model

Parameters:

  • audience_model_arn (AudienceModelArn) –

    The Amazon Resource Name (ARN) of the audience model that you are interested in.

Raises:

Source code in docs_src/capo_cleanroomsml/_services/clean_rooms_ml.py
def get_audience_model(
    self,
    audience_model_arn: "capo_cleanroomsml.types.audience_model_arn.AudienceModelArn",
    *,
    config_overrides: Optional[CleanRoomsMLClientConfig] = None,
) -> "capo_cleanroomsml.types.get_audience_model_response.GetAudienceModelResponse":
    """<p>Returns information about an audience model</p>

    Args:
        audience_model_arn: <p>The Amazon Resource Name (ARN) of the audience model that you are interested in.</p>

    Raises:
        capo_cleanroomsml.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_cleanroomsml.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you are requesting does not exist.</p>
        capo_cleanroomsml.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_cleanroomsml.errors.validation_exception.ValidationException: <p>The request parameters for this request are incorrect.</p>
        capo_cleanroomsml.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cleanroomsml.types.get_audience_model_request.GetAudienceModelRequest]",
    ) -> OperationResponse[
        "capo_cleanroomsml.types.get_audience_model_response.GetAudienceModelResponse"
    ]:
        import capo_cleanroomsml._operations.aws_stark_control_service.get_audience_model

        output, http_response = (
            capo_cleanroomsml._operations.aws_stark_control_service.get_audience_model.get_audience_model(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAudienceModel")
    )
    input_: capo_cleanroomsml.types.get_audience_model_request.GetAudienceModelRequest = {
        "audience_model_arn": audience_model_arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output