deregister_service ¶

deregister_service(
    service_id: ServiceId, *, config_overrides: Optional[DevOpsAgentClientConfig] = None
) -> DeregisterServiceOutput

Deregister a service

Parameters:

service_id (ServiceId) –

The service id to deregister. A service can only be deregistered if it is not associated with any AgentSpace.

Raises:

AccessDeniedException –

Access to the requested resource is denied due to insufficient permissions.
ConflictException –

The request conflicts with the current state of the resource.
ContentSizeExceededException –

This exception is thrown when the content size exceeds the allowed limit.
InternalServerException –

This exception is thrown when an unexpected error occurs in the processing of a request.
InvalidParameterException –

One or more parameters provided in the request are invalid.
ResourceNotFoundException –

The requested resource could not be found.
ServiceQuotaExceededException –

The request would exceed the service quota limit.
ThrottlingException –

The request was throttled due to too many requests. Please slow down and try again.
ValidationException –

The input fails to satisfy the constraints specified by the service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_devops_agent/_services/dev_ops_agent.py

def deregister_service(
    self,
    service_id: "capo_devops_agent.types.service_id.ServiceId",
    *,
    config_overrides: Optional[DevOpsAgentClientConfig] = None,
) -> "capo_devops_agent.types.deregister_service_output.DeregisterServiceOutput":
    """<p>Deregister a service</p>

    Args:
        service_id: <p>The service id to deregister. A service can only be deregistered if it is not associated with any AgentSpace.</p>

    Raises:
        capo_devops_agent.errors.access_denied_exception.AccessDeniedException: <p>Access to the requested resource is denied due to insufficient permissions.</p>
        capo_devops_agent.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource.</p>
        capo_devops_agent.errors.content_size_exceeded_exception.ContentSizeExceededException: <p>This exception is thrown when the content size exceeds the allowed limit.</p>
        capo_devops_agent.errors.internal_server_exception.InternalServerException: <p>This exception is thrown when an unexpected error occurs in the processing of a request.</p>
        capo_devops_agent.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters provided in the request are invalid.</p>
        capo_devops_agent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_devops_agent.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed the service quota limit.</p>
        capo_devops_agent.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Please slow down and try again.</p>
        capo_devops_agent.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_devops_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_devops_agent.types.deregister_service_input.DeregisterServiceInput]",
    ) -> OperationResponse[
        "capo_devops_agent.types.deregister_service_output.DeregisterServiceOutput"
    ]:
        import capo_devops_agent._operations.dev_ops_agent.deregister_service

        output, http_response = (
            capo_devops_agent._operations.dev_ops_agent.deregister_service.deregister_service(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeregisterService")
    )
    input_: capo_devops_agent.types.deregister_service_input.DeregisterServiceInput = {
        "service_id": service_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output