Deletes a connector from an Amazon EVS environment.
Before deleting a connector, you must remove all entitlements that are associated with the same vCenter.
Parameters:
-
client_token
(Optional[ClientToken], default:
None
)
–
This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
-
environment_id
(EnvironmentId)
–
A unique ID for the environment that the connector belongs to.
-
connector_id
(ConnectorId)
–
A unique ID for the connector to be deleted.
Raises:
-
ResourceNotFoundException
–
A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a state of DELETED.
-
ThrottlingException
–
The operation could not be performed because the service is throttling requests. This exception is thrown when the service endpoint receives too many concurrent requests.
-
ValidationException
–
The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_evs/_services/evs.py
| def delete_environment_connector(
self,
environment_id: "capo_evs.types.environment_id.EnvironmentId",
connector_id: "capo_evs.types.connector_id.ConnectorId",
*,
config_overrides: Optional[evsClientConfig] = None,
client_token: Optional["capo_evs.types.client_token.ClientToken"] = None,
) -> "capo_evs.types.delete_environment_connector_response.DeleteEnvironmentConnectorResponse":
"""<p>Deletes a connector from an Amazon EVS environment.</p> <note> <p>Before deleting a connector, you must remove all entitlements that are associated with the same vCenter.</p> </note>
Args:
client_token: <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
environment_id: <p>A unique ID for the environment that the connector belongs to.</p>
connector_id: <p>A unique ID for the connector to be deleted.</p>
Raises:
capo_evs.errors.resource_not_found_exception.ResourceNotFoundException: <p>A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a <code>state</code> of <code>DELETED</code>.</p>
capo_evs.errors.throttling_exception.ThrottlingException: <p>The operation could not be performed because the service is throttling requests. This exception is thrown when the service endpoint receives too many concurrent requests.</p>
capo_evs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.</p>
capo_evs.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_evs.types.delete_environment_connector_request.DeleteEnvironmentConnectorRequest]",
) -> OperationResponse[
"capo_evs.types.delete_environment_connector_response.DeleteEnvironmentConnectorResponse"
]:
import capo_evs._operations.amazon_elastic_v_mware_service.delete_environment_connector
output, http_response = (
capo_evs._operations.amazon_elastic_v_mware_service.delete_environment_connector.delete_environment_connector(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteEnvironmentConnector")
)
input_: capo_evs.types.delete_environment_connector_request.DeleteEnvironmentConnectorRequest = {
"environment_id": environment_id,
"connector_id": connector_id,
}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|