To stop receiving engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel does not remove it from the contact's engagement plan, but the stage that includes the channel will be ignored. If you delete the only contact channel for a contact, you'll no longer be able to engage that contact during an incident.
Parameters:
-
contact_channel_id
(SsmContactsArn)
–
The Amazon Resource Name (ARN) of the contact channel.
Raises:
Source code in docs_src/capo_ssm_contacts/_services/async_ssm_contacts.py
| async def delete_contact_channel(
self,
contact_channel_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
*,
config_overrides: Optional[AsyncSSMContactsClientConfig] = None,
) -> "capo_ssm_contacts.types.delete_contact_channel_result.DeleteContactChannelResult":
"""<p>To stop receiving engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel does not remove it from the contact's engagement plan, but the stage that includes the channel will be ignored. If you delete the only contact channel for a contact, you'll no longer be able to engage that contact during an incident.</p>
Args:
contact_channel_id: <p>The Amazon Resource Name (ARN) of the contact channel.</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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_ssm_contacts.types.delete_contact_channel_request.DeleteContactChannelRequest]",
) -> AsyncOperationResponse[
"capo_ssm_contacts.types.delete_contact_channel_result.DeleteContactChannelResult"
]:
import capo_ssm_contacts._operations.ssm_contacts.delete_contact_channel
(
output,
http_response,
) = await capo_ssm_contacts._operations.ssm_contacts.delete_contact_channel.async_delete_contact_channel(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteContactChannel")
)
input_: capo_ssm_contacts.types.delete_contact_channel_request.DeleteContactChannelRequest = {
"contact_channel_id": contact_channel_id
}
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|