Skip to content

update_contact_channel

update_contact_channel(
    contact_channel_id: SsmContactsArn,
    *,
    config_overrides: Optional[SSMContactsClientConfig] = None,
    name: Optional[ChannelName] = None,
    delivery_address: Optional[ContactChannelAddress] = None,
) -> UpdateContactChannelResult

Updates a contact's contact channel.

Parameters:

  • contact_channel_id (SsmContactsArn) –

    The Amazon Resource Name (ARN) of the contact channel you want to update.

  • name (Optional[ChannelName], default: None ) –

    The name of the contact channel.

  • delivery_address (Optional[ContactChannelAddress], default: None ) –

    The details that Incident Manager uses when trying to engage the contact channel.

Raises:

Source code in docs_src/capo_ssm_contacts/_services/ssm_contacts.py
def update_contact_channel(
    self,
    contact_channel_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
    *,
    config_overrides: Optional[SSMContactsClientConfig] = None,
    name: Optional["capo_ssm_contacts.types.channel_name.ChannelName"] = None,
    delivery_address: Optional[
        "capo_ssm_contacts.types.contact_channel_address.ContactChannelAddress"
    ] = None,
) -> "capo_ssm_contacts.types.update_contact_channel_result.UpdateContactChannelResult":
    """<p>Updates a contact's contact channel.</p>

    Args:
        contact_channel_id: <p>The Amazon Resource Name (ARN) of the contact channel you want to update.</p>
        name: <p>The name of the contact channel.</p>
        delivery_address: <p>The details that Incident Manager uses when trying to engage 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.conflict_exception.ConflictException: <p>Updating or deleting a resource causes an inconsistent state.</p>
        capo_ssm_contacts.errors.data_encryption_exception.DataEncryptionException: <p>The operation failed to due an encryption key error.</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.update_contact_channel_request.UpdateContactChannelRequest]",
    ) -> OperationResponse[
        "capo_ssm_contacts.types.update_contact_channel_result.UpdateContactChannelResult"
    ]:
        import capo_ssm_contacts._operations.ssm_contacts.update_contact_channel

        output, http_response = (
            capo_ssm_contacts._operations.ssm_contacts.update_contact_channel.update_contact_channel(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateContactChannel")
    )
    input_: capo_ssm_contacts.types.update_contact_channel_request.UpdateContactChannelRequest = {
        "contact_channel_id": contact_channel_id
    }
    if name is not None:
        input_["name"] = name
    if delivery_address is not None:
        input_["delivery_address"] = delivery_address

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