Updates the contact or escalation plan specified.
Parameters:
-
contact_id
(SsmContactsArn)
–
The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
-
display_name
(Optional[ContactName], default:
None
)
–
The full name of the contact or escalation plan.
-
plan
(Optional[Plan], default:
None
)
–
A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.
Raises:
Source code in docs_src/capo_ssm_contacts/_services/ssm_contacts.py
| def update_contact(
self,
contact_id: "capo_ssm_contacts.types.ssm_contacts_arn.SsmContactsArn",
*,
config_overrides: Optional[SSMContactsClientConfig] = None,
display_name: Optional[
"capo_ssm_contacts.types.contact_name.ContactName"
] = None,
plan: Optional["capo_ssm_contacts.types.plan.Plan"] = None,
) -> "capo_ssm_contacts.types.update_contact_result.UpdateContactResult":
"""<p>Updates the contact or escalation plan specified.</p>
Args:
contact_id: <p>The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.</p>
display_name: <p>The full name of the contact or escalation plan.</p>
plan: <p>A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.</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.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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</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_request.UpdateContactRequest]",
) -> OperationResponse[
"capo_ssm_contacts.types.update_contact_result.UpdateContactResult"
]:
import capo_ssm_contacts._operations.ssm_contacts.update_contact
output, http_response = (
capo_ssm_contacts._operations.ssm_contacts.update_contact.update_contact(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("UpdateContact")
)
input_: capo_ssm_contacts.types.update_contact_request.UpdateContactRequest = {
"contact_id": contact_id
}
if display_name is not None:
input_["display_name"] = display_name
if plan is not None:
input_["plan"] = plan
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|