Deletes the specified channel and its associated stream keys.
If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)
Parameters:
-
arn
(ChannelArn)
–
ARN of the channel to be deleted.
Raises:
Source code in docs_src/capo_ivs/_services/async_ivs.py
| async def delete_channel(
self,
arn: "capo_ivs.types.channel_arn.ChannelArn",
*,
config_overrides: Optional[AsyncivsClientConfig] = None,
) -> None:
"""<p>Deletes the specified channel and its associated stream keys.</p> <p>If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call <a>StopStream</a>, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.) </p>
Args:
arn: <p>ARN of the channel to be deleted.</p>
Raises:
capo_ivs.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
capo_ivs.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
capo_ivs.errors.pending_verification.PendingVerification: <p>Your account is pending verification.</p>
capo_ivs.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
capo_ivs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_ivs.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_ivs.types.delete_channel_request.DeleteChannelRequest]",
) -> AsyncOperationResponse[None]:
import capo_ivs._operations.amazon_interactive_video_service.delete_channel
(
output,
http_response,
) = await capo_ivs._operations.amazon_interactive_video_service.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_ivs.types.delete_channel_request.DeleteChannelRequest = {
"arn": arn
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|