Skip to content

get_audience_generation_job

get_audience_generation_job(
    audience_generation_job_arn: AudienceGenerationJobArn,
    *,
    config_overrides: Optional[CleanRoomsMLClientConfig] = None,
) -> GetAudienceGenerationJobResponse

Returns information about an audience generation job.

Parameters:

  • audience_generation_job_arn (AudienceGenerationJobArn) –

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

Raises:

Source code in docs_src/capo_cleanroomsml/_services/clean_rooms_ml.py
def get_audience_generation_job(
    self,
    audience_generation_job_arn: "capo_cleanroomsml.types.audience_generation_job_arn.AudienceGenerationJobArn",
    *,
    config_overrides: Optional[CleanRoomsMLClientConfig] = None,
) -> "capo_cleanroomsml.types.get_audience_generation_job_response.GetAudienceGenerationJobResponse":
    """<p>Returns information about an audience generation job.</p>

    Args:
        audience_generation_job_arn: <p>The Amazon Resource Name (ARN) of the audience generation job 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_generation_job_request.GetAudienceGenerationJobRequest]",
    ) -> OperationResponse[
        "capo_cleanroomsml.types.get_audience_generation_job_response.GetAudienceGenerationJobResponse"
    ]:
        import capo_cleanroomsml._operations.aws_stark_control_service.get_audience_generation_job

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

    def _redact_output(
        output: "capo_cleanroomsml.types.get_audience_generation_job_response.GetAudienceGenerationJobResponse",
    ) -> dict[str, Any]:
        import capo_cleanroomsml.types.get_audience_generation_job_response

        return capo_cleanroomsml.types.get_audience_generation_job_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetAudienceGenerationJob", redact_output=_redact_output),
    )
    input_: capo_cleanroomsml.types.get_audience_generation_job_request.GetAudienceGenerationJobRequest = {
        "audience_generation_job_arn": audience_generation_job_arn
    }

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