delete_channel `async` ¶

delete_channel(
    channel_group_name: ResourceName,
    channel_name: ResourceName,
    *,
    config_overrides: Optional[AsyncMediaPackageV2ClientConfig] = None,
) -> DeleteChannelResponse

Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.

Parameters:

channel_group_name (ResourceName) –

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
channel_name (ResourceName) –

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

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.
ConflictException –

Updating or deleting this resource can cause an inconsistent state.
InternalServerException –

Indicates that an error from the service occurred while trying to process a request.
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:

Deleting a Channel

>>> await client.delete_channel(channel_group_name='exampleChannelGroup', channel_name='exampleChannel')

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

async def delete_channel(
    self,
    channel_group_name: "capo_mediapackagev2.types.resource_name.ResourceName",
    channel_name: "capo_mediapackagev2.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AsyncMediaPackageV2ClientConfig] = None,
) -> "capo_mediapackagev2.types.delete_channel_response.DeleteChannelResponse":
    """<p>Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.</p>

    Args:
        channel_group_name: <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
        channel_name: <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</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.conflict_exception.ConflictException: <p>Updating or deleting this resource can cause an inconsistent state.</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.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:
        Deleting a Channel

        >>> await client.delete_channel(channel_group_name='exampleChannelGroup', channel_name='exampleChannel')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mediapackagev2.types.delete_channel_request.DeleteChannelRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediapackagev2.types.delete_channel_response.DeleteChannelResponse"
    ]:
        import capo_mediapackagev2._operations.mediapackagev2.delete_channel

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteChannel")
    )
    input_: capo_mediapackagev2.types.delete_channel_request.DeleteChannelRequest = {
        "channel_group_name": channel_group_name,
        "channel_name": channel_name,
    }

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

delete_channel async ¶

delete_channel `async` ¶