Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.
Parameters:
-
bulk_deployment_id
(__string)
–
The ID of the bulk deployment.
Raises:
Source code in docs_src/capo_greengrass/_services/async_greengrass.py
| async def stop_bulk_deployment(
self,
bulk_deployment_id: "capo_greengrass.types.__string.__string",
*,
config_overrides: Optional[AsyncGreengrassClientConfig] = None,
) -> (
"capo_greengrass.types.stop_bulk_deployment_response.StopBulkDeploymentResponse"
):
"""Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.
Args:
bulk_deployment_id: The ID of the bulk deployment.
Raises:
capo_greengrass.errors.bad_request_exception.BadRequestException: General error information.
capo_greengrass.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_greengrass.types.stop_bulk_deployment_request.StopBulkDeploymentRequest]",
) -> AsyncOperationResponse[
"capo_greengrass.types.stop_bulk_deployment_response.StopBulkDeploymentResponse"
]:
import capo_greengrass._operations.greengrass.stop_bulk_deployment
(
output,
http_response,
) = await capo_greengrass._operations.greengrass.stop_bulk_deployment.async_stop_bulk_deployment(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("StopBulkDeployment")
)
input_: capo_greengrass.types.stop_bulk_deployment_request.StopBulkDeploymentRequest = {
"bulk_deployment_id": bulk_deployment_id
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|