reset_channel_state async ¶

async def reset_channel_state(
    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.reset_channel_state_response.ResetChannelStateResponse":
    """<p>Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content. </p> <p> Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder. </p>

    Args:
        channel_group_name: <p>The name of the channel group that contains the channel that you are resetting.</p>
        channel_name: <p>The name of the channel that you are resetting.</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.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:
        Reset a Channel

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

    async def _handler(
        req: "AsyncOperationRequest[capo_mediapackagev2.types.reset_channel_state_request.ResetChannelStateRequest]",
    ) -> AsyncOperationResponse[
        "capo_mediapackagev2.types.reset_channel_state_response.ResetChannelStateResponse"
    ]:
        import capo_mediapackagev2._operations.mediapackagev2.reset_channel_state

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ResetChannelState")
    )
    input_: capo_mediapackagev2.types.reset_channel_state_request.ResetChannelStateRequest = {
        "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