To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
Parameters:
-
contact_channel_id
(SsmContactsArn)
–
The Amazon Resource Name (ARN) of the contact channel you're deactivating.
Raises:
Source code in docs_src/capo_ssm_contacts/_services/ssm_contacts.py
| def deactivate_contact_channel(
self,
contact_channel_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
*,
config_overrides: Optional[SSMContactsClientConfig] = None,
) -> "capo_ssm_contacts.types.deactivate_contact_channel_result.DeactivateContactChannelResult":
"""<p>To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.</p>
Args:
contact_channel_id: <p>The Amazon Resource Name (ARN) of the contact channel you're deactivating.</p>
Raises:
capo_ssm_contacts.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this operation.</p>
capo_ssm_contacts.errors.internal_server_exception.InternalServerException: <p>Unexpected error occurred while processing the request.</p>
capo_ssm_contacts.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource that doesn't exist.</p>
capo_ssm_contacts.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_ssm_contacts.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_ssm_contacts.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ssm_contacts.types.deactivate_contact_channel_request.DeactivateContactChannelRequest]",
) -> OperationResponse[
"capo_ssm_contacts.types.deactivate_contact_channel_result.DeactivateContactChannelResult"
]:
import capo_ssm_contacts._operations.ssm_contacts.deactivate_contact_channel
output, http_response = (
capo_ssm_contacts._operations.ssm_contacts.deactivate_contact_channel.deactivate_contact_channel(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeactivateContactChannel")
)
input_: capo_ssm_contacts.types.deactivate_contact_channel_request.DeactivateContactChannelRequest = {
"contact_channel_id": contact_channel_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|