start_audience_export_job `async` ¶

start_audience_export_job(
    name: NameString,
    audience_generation_job_arn: AudienceGenerationJobArn,
    audience_size: AudienceSize,
    *,
    config_overrides: Optional[AsyncCleanRoomsMLClientConfig] = None,
    description: Optional[ResourceDescription] = None,
) -> None

Export an audience of a specified size after you have generated an audience.

Parameters:

name (NameString) –

The name of the audience export job.
audience_generation_job_arn (AudienceGenerationJobArn) –

The Amazon Resource Name (ARN) of the audience generation job that you want to export.
description (Optional[ResourceDescription], default: None ) –

The description of the audience export job.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

You can't complete this action because another resource depends on this resource.
ResourceNotFoundException –

The resource you are requesting does not exist.
ServiceQuotaExceededException –

You have exceeded your service quota.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The request parameters for this request are incorrect.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cleanroomsml/_services/async_clean_rooms_ml.py

async def start_audience_export_job(
    self,
    name: "capo_cleanroomsml.types.name_string.NameString",
    audience_generation_job_arn: "capo_cleanroomsml.types.audience_generation_job_arn.AudienceGenerationJobArn",
    audience_size: "capo_cleanroomsml.types.audience_size.AudienceSize",
    *,
    config_overrides: Optional[AsyncCleanRoomsMLClientConfig] = None,
    description: Optional[
        "capo_cleanroomsml.types.resource_description.ResourceDescription"
    ] = None,
) -> None:
    """<p>Export an audience of a specified size after you have generated an audience.</p>

    Args:
        name: <p>The name of the audience export job.</p>
        audience_generation_job_arn: <p>The Amazon Resource Name (ARN) of the audience generation job that you want to export.</p>
        description: <p>The description of the audience export job.</p>

    Raises:
        capo_cleanroomsml.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_cleanroomsml.errors.conflict_exception.ConflictException: <p>You can't complete this action because another resource depends on this resource.</p>
        capo_cleanroomsml.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you are requesting does not exist.</p>
        capo_cleanroomsml.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have exceeded your service quota.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cleanroomsml.types.start_audience_export_job_request.StartAudienceExportJobRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_cleanroomsml._operations.aws_stark_control_service.start_audience_export_job

        (
            output,
            http_response,
        ) = await capo_cleanroomsml._operations.aws_stark_control_service.start_audience_export_job.async_start_audience_export_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartAudienceExportJob")
    )
    input_: capo_cleanroomsml.types.start_audience_export_job_request.StartAudienceExportJobRequest = {
        "name": name,
        "audience_generation_job_arn": audience_generation_job_arn,
        "audience_size": audience_size,
    }
    if description is not None:
        input_["description"] = description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

start_audience_export_job async ¶

start_audience_export_job `async` ¶