Attempts to cancel a component deployment (for a component that is in the IN_PROGRESS deployment status).
For more information about components, see Proton components in the Proton User Guide.
Parameters:
-
component_name
(ResourceName)
–
The name of the component with the deployment to cancel.
Raises:
Source code in docs_src/capo_proton/_services/async_proton.py
| async def cancel_component_deployment(
self,
component_name: "capo_proton.types.resource_name.ResourceName",
*,
config_overrides: Optional[AsyncProtonClientConfig] = None,
) -> "capo_proton.types.cancel_component_deployment_output.CancelComponentDeploymentOutput":
"""<p>Attempts to cancel a component deployment (for a component that is in the <code>IN_PROGRESS</code> deployment status).</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>
Args:
component_name: <p>The name of the component with the deployment to cancel.</p>
Raises:
capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
capo_proton.errors.conflict_exception.ConflictException: <p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>
capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_proton.types.cancel_component_deployment_input.CancelComponentDeploymentInput]",
) -> AsyncOperationResponse[
"capo_proton.types.cancel_component_deployment_output.CancelComponentDeploymentOutput"
]:
import capo_proton._operations.aws_proton20200720.cancel_component_deployment
(
output,
http_response,
) = await capo_proton._operations.aws_proton20200720.cancel_component_deployment.async_cancel_component_deployment(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_proton.types.cancel_component_deployment_output.CancelComponentDeploymentOutput",
) -> dict[str, Any]:
import capo_proton.types.cancel_component_deployment_output
return (
capo_proton.types.cancel_component_deployment_output.redact_sensitive(
output
)
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("CancelComponentDeployment", redact_output=_redact_output),
)
input_: capo_proton.types.cancel_component_deployment_input.CancelComponentDeploymentInput = {
"component_name": component_name
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|