create_contact
¶
create_contact(
alias: ContactAlias,
type: ContactType,
plan: Plan,
*,
config_overrides: Optional[SSMContactsClientConfig] = None,
display_name: Optional[ContactName] = None,
tags: Optional[TagsList] = None,
idempotency_token: Optional[IdempotencyToken] = None,
) -> CreateContactResult
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
Parameters:
-
alias(ContactAlias) –The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
-
display_name(Optional[ContactName], default:None) –The full name of the contact or escalation plan.
-
type(ContactType) –The type of contact to create.
-
PERSONAL: A single, individual contact. -
ESCALATION: An escalation plan. -
ONCALL_SCHEDULE: An on-call schedule.
-
-
plan(Plan) –A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
-
tags(Optional[TagsList], default:None) –Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
-
idempotency_token(Optional[IdempotencyToken], default:None) –A token ensuring that the operation is called only once with the specified details.
Raises:
-
AccessDeniedException–You don't have sufficient access to perform this operation.
-
ConflictException–Updating or deleting a resource causes an inconsistent state.
-
DataEncryptionException–The operation failed to due an encryption key error.
-
InternalServerException–Unexpected error occurred while processing the request.
-
ServiceQuotaExceededException–Request would cause a service quota to be exceeded.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.