get_harvest_job `async` ¶

get_harvest_job(
    channel_group_name: ResourceName,
    channel_name: ResourceName,
    origin_endpoint_name: ResourceName,
    harvest_job_name: ResourceName,
    *,
    config_overrides: Optional[AsyncMediaPackageV2ClientConfig] = None,
) -> GetHarvestJobResponse

Retrieves the details of a specific harvest job.

Parameters:

channel_group_name (ResourceName) –

The name of the channel group containing the channel associated with the harvest job.
channel_name (ResourceName) –

The name of the channel associated with the harvest job.
origin_endpoint_name (ResourceName) –

The name of the origin endpoint associated with the harvest job.
harvest_job_name (ResourceName) –

The name of the harvest job to retrieve.

Raises:

AccessDeniedException –

Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.
InternalServerException –

Indicates that an error from the service occurred while trying to process a request.
ResourceNotFoundException –

The specified resource doesn't exist.
ThrottlingException –

The request throughput limit was exceeded.
ValidationException –

The input failed to meet the constraints specified by the AWS service.
UnknownServiceError –

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

Examples:

Getting a Harvest Job

>>> await client.get_harvest_job(channel_group_name='exampleChannelGroup', channel_name='exampleChannelName', origin_endpoint_name='exampleOriginEndpointName', harvest_job_name='HarvestJobName')

Source code in docs_src/capo_mediapackagev2/_services/async_media_package_v2.py

async def get_harvest_job(
    self,
    channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName",
    channel_name: "capo_mediapackagev2.types.resource_name.ResourceName",
    origin_endpoint_name: "capo_mediapackagev2.types.resource_name.ResourceName",
    harvest_job_name: "capo_mediapackagev2.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AsyncMediaPackageV2ClientConfig] = None,
) -> "capo_mediapackagev2.types.get_harvest_job_response.GetHarvestJobResponse":
    """<p>Retrieves the details of a specific harvest job.</p>

    Args:
        channel_group_name: <p>The name of the channel group containing the channel associated with the harvest job.</p>
        channel_name: <p>The name of the channel associated with the harvest job.</p>
        origin_endpoint_name: <p>The name of the origin endpoint associated with the harvest job.</p>
        harvest_job_name: <p>The name of the harvest job to retrieve.</p>

    Raises:
        capo_mediapackagev2.errors.access_denied_exception.AccessDeniedException: <p>Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.</p>
        capo_mediapackagev2.errors.internal_server_exception.InternalServerException: <p>Indicates that an error from the service occurred while trying to process a request.</p>
        capo_mediapackagev2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource doesn't exist.</p>
        capo_mediapackagev2.errors.throttling_exception.ThrottlingException: <p>The request throughput limit was exceeded.</p>
        capo_mediapackagev2.errors.validation_exception.ValidationException: <p>The input failed to meet the constraints specified by the AWS service.</p>
        capo_mediapackagev2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Getting a Harvest Job

        >>> await client.get_harvest_job(channel_group_name='exampleChannelGroup', channel_name='exampleChannelName', origin_endpoint_name='exampleOriginEndpointName', harvest_job_name='HarvestJobName')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mediapackagev2.types.get_harvest_job_request.GetHarvestJobRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediapackagev2.types.get_harvest_job_response.GetHarvestJobResponse"
    ]:
        import capo_mediapackagev2._operations.mediapackagev2.get_harvest_job

        (
            output,
            http_response,
        ) = await capo_mediapackagev2._operations.mediapackagev2.get_harvest_job.async_get_harvest_job(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetHarvestJob")
    )
    input_: capo_mediapackagev2.types.get_harvest_job_request.GetHarvestJobRequest = {
        "channel_group_name": channel_group_name,
        "channel_name": channel_name,
        "origin_endpoint_name": origin_endpoint_name,
        "harvest_job_name": harvest_job_name,
    }

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

get_harvest_job async ¶

get_harvest_job `async` ¶