Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
Parameters:
Raises:
Source code in docs_src/capo_ivs_realtime/_services/async_ivs_real_time.py
| async def stop_composition(
self,
arn: "capo_ivs_realtime.types.composition_arn.CompositionArn",
*,
config_overrides: Optional[AsyncIVSRealTimeClientConfig] = None,
) -> "capo_ivs_realtime.types.stop_composition_response.StopCompositionResponse":
"""<p>Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.</p>
Args:
arn: <p>ARN of the Composition.</p>
Raises:
capo_ivs_realtime.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
capo_ivs_realtime.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
capo_ivs_realtime.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
capo_ivs_realtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
capo_ivs_realtime.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
capo_ivs_realtime.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_ivs_realtime.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_ivs_realtime.types.stop_composition_request.StopCompositionRequest]",
) -> AsyncOperationResponse[
"capo_ivs_realtime.types.stop_composition_response.StopCompositionResponse"
]:
import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.stop_composition
(
output,
http_response,
) = await capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.stop_composition.async_stop_composition(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("StopComposition")
)
input_: capo_ivs_realtime.types.stop_composition_request.StopCompositionRequest = {
"arn": arn
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|