Smaws_Client_SSMContacts (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_hand_off_time : 
  minute_of_hour:Types.minute_of_hour ->
  hour_of_day:Types.hour_of_day ->
  unit ->
  Types.hand_off_time

val make_weekly_setting : 
  hand_off_time:Types.hand_off_time ->
  day_of_week:Types.day_of_week ->
  unit ->
  Types.weekly_setting

val make_validation_exception_field : 
  message:Types.string_ ->
  name:Types.string_ ->
  unit ->
  Types.validation_exception_field

val make_monthly_setting : 
  hand_off_time:Types.hand_off_time ->
  day_of_month:Types.day_of_month ->
  unit ->
  Types.monthly_setting

val make_coverage_time : 
  ?end_:Types.hand_off_time ->
  ?start:Types.hand_off_time ->
  unit ->
  Types.coverage_time

val make_recurrence_settings : 
  ?shift_coverages:Types.shift_coverages_map ->
  ?daily_settings:Types.daily_settings ->
  ?weekly_settings:Types.weekly_settings ->
  ?monthly_settings:Types.monthly_settings ->
  recurrence_multiplier:Types.recurrence_multiplier ->
  number_of_on_calls:Types.number_of_on_calls ->
  unit ->
  Types.recurrence_settings

val make_update_rotation_request : 
  ?time_zone_id:Types.time_zone_id ->
  ?start_time:Types.date_time ->
  ?contact_ids:Types.rotation_contacts_arn_list ->
  recurrence:Types.recurrence_settings ->
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.update_rotation_request

val make_dependent_entity : 
  dependent_resource_ids:Types.ssm_contacts_arn_list ->
  relation_type:Types.string_ ->
  unit ->
  Types.dependent_entity

val make_channel_target_info : 
  ?retry_interval_in_minutes:Types.retry_interval_in_minutes ->
  contact_channel_id:Types.ssm_contacts_arn ->
  unit ->
  Types.channel_target_info

val make_contact_target_info : 
  ?contact_id:Types.ssm_contacts_arn ->
  is_essential:Types.is_essential ->
  unit ->
  Types.contact_target_info

val make_target : 
  ?contact_target_info:Types.contact_target_info ->
  ?channel_target_info:Types.channel_target_info ->
  unit ->
  Types.target

val make_stage : 
  targets:Types.targets_list ->
  duration_in_minutes:Types.stage_duration_in_mins ->
  unit ->
  Types.stage

val make_plan : 
  ?rotation_ids:Types.ssm_contacts_arn_list ->
  ?stages:Types.stages_list ->
  unit ->
  Types.plan

val make_update_contact_request : 
  ?plan:Types.plan ->
  ?display_name:Types.contact_name ->
  contact_id:Types.ssm_contacts_arn ->
  unit ->
  Types.update_contact_request

val make_contact_channel_address : 
  ?simple_address:Types.simple_address ->
  unit ->
  Types.contact_channel_address

val make_update_contact_channel_request : 
  ?delivery_address:Types.contact_channel_address ->
  ?name:Types.channel_name ->
  contact_channel_id:Types.ssm_contacts_arn ->
  unit ->
  Types.update_contact_channel_request

val make_untag_resource_request : 
  tag_keys:Types.tag_key_list ->
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.untag_resource_request

val make_time_range : 
  ?end_time:Types.date_time ->
  ?start_time:Types.date_time ->
  unit ->
  Types.time_range

val make_tag : 
  ?value:Types.tag_value ->
  ?key:Types.tag_key ->
  unit ->
  Types.tag

val make_tag_resource_request : 
  tags:Types.tags_list ->
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.tag_resource_request

val make_stop_engagement_request : 
  ?reason:Types.stop_reason ->
  engagement_id:Types.ssm_contacts_arn ->
  unit ->
  Types.stop_engagement_request

val make_start_engagement_request : 
  ?idempotency_token:Types.idempotency_token ->
  ?incident_id:Types.incident_id ->
  ?public_content:Types.public_content ->
  ?public_subject:Types.public_subject ->
  content:Types.content ->
  subject:Types.subject ->
  sender:Types.sender ->
  contact_id:Types.ssm_contacts_arn ->
  unit ->
  Types.start_engagement_request

val make_shift_details : 
  overridden_contact_ids:Types.ssm_contacts_arn_list ->
  unit ->
  Types.shift_details

val make_send_activation_code_request : 
  contact_channel_id:Types.ssm_contacts_arn ->
  unit ->
  Types.send_activation_code_request

val make_put_contact_policy_request : 
  policy:Types.policy ->
  contact_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.put_contact_policy_request

val make_list_tags_for_resource_request : 
  resource_ar_n:Types.amazon_resource_name ->
  unit ->
  Types.list_tags_for_resource_request

val make_rotation_shift : 
  ?shift_details:Types.shift_details ->
  ?type_:Types.shift_type ->
  ?contact_ids:Types.ssm_contacts_arn_list ->
  end_time:Types.date_time ->
  start_time:Types.date_time ->
  unit ->
  Types.rotation_shift

val make_list_rotation_shifts_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  ?start_time:Types.date_time ->
  end_time:Types.date_time ->
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.list_rotation_shifts_request

val make_rotation : 
  ?recurrence:Types.recurrence_settings ->
  ?time_zone_id:Types.time_zone_id ->
  ?start_time:Types.date_time ->
  ?contact_ids:Types.ssm_contacts_arn_list ->
  name:Types.rotation_name ->
  rotation_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.rotation

val make_list_rotations_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  ?rotation_name_prefix:Types.rotation_name ->
  unit ->
  Types.list_rotations_request

val make_rotation_override : 
  create_time:Types.date_time ->
  end_time:Types.date_time ->
  start_time:Types.date_time ->
  new_contact_ids:Types.ssm_contacts_arn_list ->
  rotation_override_id:Types.uuid ->
  unit ->
  Types.rotation_override

val make_list_rotation_overrides_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  end_time:Types.date_time ->
  start_time:Types.date_time ->
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.list_rotation_overrides_request

val make_preview_override : 
  ?end_time:Types.date_time ->
  ?start_time:Types.date_time ->
  ?new_members:Types.rotation_override_preview_member_list ->
  unit ->
  Types.preview_override

val make_list_preview_rotation_shifts_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  ?overrides:Types.override_list ->
  ?start_time:Types.date_time ->
  ?rotation_start_time:Types.date_time ->
  recurrence:Types.recurrence_settings ->
  time_zone_id:Types.time_zone_id ->
  members:Types.rotation_preview_member_list ->
  end_time:Types.date_time ->
  unit ->
  Types.list_preview_rotation_shifts_request

val make_page : 
  ?read_time:Types.date_time ->
  ?delivery_time:Types.date_time ->
  ?sent_time:Types.date_time ->
  ?incident_id:Types.incident_id ->
  sender:Types.sender ->
  contact_arn:Types.ssm_contacts_arn ->
  engagement_arn:Types.ssm_contacts_arn ->
  page_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.page

val make_list_pages_by_engagement_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  engagement_id:Types.ssm_contacts_arn ->
  unit ->
  Types.list_pages_by_engagement_request

val make_list_pages_by_contact_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  contact_id:Types.ssm_contacts_arn ->
  unit ->
  Types.list_pages_by_contact_request

val make_resolution_contact : 
  ?stage_index:Types.stage_index ->
  type_:Types.contact_type ->
  contact_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.resolution_contact

val make_list_page_resolutions_request : 
  ?next_token:Types.pagination_token ->
  page_id:Types.ssm_contacts_arn ->
  unit ->
  Types.list_page_resolutions_request

val make_receipt : 
  ?receipt_info:Types.receipt_info ->
  ?contact_channel_arn:Types.ssm_contacts_arn ->
  receipt_time:Types.date_time ->
  receipt_type:Types.receipt_type ->
  unit ->
  Types.receipt

val make_list_page_receipts_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  page_id:Types.ssm_contacts_arn ->
  unit ->
  Types.list_page_receipts_request

val make_engagement : 
  ?stop_time:Types.date_time ->
  ?start_time:Types.date_time ->
  ?incident_id:Types.incident_id ->
  sender:Types.sender ->
  contact_arn:Types.ssm_contacts_arn ->
  engagement_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.engagement

val make_list_engagements_request : 
  ?time_range_value:Types.time_range ->
  ?incident_id:Types.incident_id ->
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  unit ->
  Types.list_engagements_request

val make_contact : 
  ?display_name:Types.contact_name ->
  type_:Types.contact_type ->
  alias:Types.contact_alias ->
  contact_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.contact

val make_list_contacts_request : 
  ?type_:Types.contact_type ->
  ?alias_prefix:Types.contact_alias ->
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  unit ->
  Types.list_contacts_request

val make_contact_channel : 
  ?type_:Types.channel_type ->
  activation_status:Types.activation_status ->
  delivery_address:Types.contact_channel_address ->
  name:Types.channel_name ->
  contact_arn:Types.ssm_contacts_arn ->
  contact_channel_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.contact_channel

val make_list_contact_channels_request : 
  ?max_results:Types.max_results ->
  ?next_token:Types.pagination_token ->
  contact_id:Types.ssm_contacts_arn ->
  unit ->
  Types.list_contact_channels_request

val make_get_rotation_override_request : 
  rotation_override_id:Types.uuid ->
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.get_rotation_override_request

val make_get_rotation_request : 
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.get_rotation_request

val make_get_contact_policy_request : 
  contact_arn:Types.ssm_contacts_arn ->
  unit ->
  Types.get_contact_policy_request

val make_get_contact_channel_request : 
  contact_channel_id:Types.ssm_contacts_arn ->
  unit ->
  Types.get_contact_channel_request

val make_get_contact_request : 
  contact_id:Types.ssm_contacts_arn ->
  unit ->
  Types.get_contact_request

val make_describe_page_request : 
  page_id:Types.ssm_contacts_arn ->
  unit ->
  Types.describe_page_request

val make_describe_engagement_request : 
  engagement_id:Types.ssm_contacts_arn ->
  unit ->
  Types.describe_engagement_request

val make_delete_rotation_override_request : 
  rotation_override_id:Types.uuid ->
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.delete_rotation_override_request

val make_delete_rotation_request : 
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.delete_rotation_request

val make_delete_contact_channel_request : 
  contact_channel_id:Types.ssm_contacts_arn ->
  unit ->
  Types.delete_contact_channel_request

val make_delete_contact_request : 
  contact_id:Types.ssm_contacts_arn ->
  unit ->
  Types.delete_contact_request

val make_deactivate_contact_channel_request : 
  contact_channel_id:Types.ssm_contacts_arn ->
  unit ->
  Types.deactivate_contact_channel_request

val make_create_rotation_override_request : 
  ?idempotency_token:Types.idempotency_token ->
  end_time:Types.date_time ->
  start_time:Types.date_time ->
  new_contact_ids:Types.rotation_override_contacts_arn_list ->
  rotation_id:Types.ssm_contacts_arn ->
  unit ->
  Types.create_rotation_override_request

val make_create_rotation_request : 
  ?idempotency_token:Types.idempotency_token ->
  ?tags:Types.tags_list ->
  ?start_time:Types.date_time ->
  recurrence:Types.recurrence_settings ->
  time_zone_id:Types.time_zone_id ->
  contact_ids:Types.rotation_contacts_arn_list ->
  name:Types.rotation_name ->
  unit ->
  Types.create_rotation_request

val make_create_contact_channel_request : 
  ?idempotency_token:Types.idempotency_token ->
  ?defer_activation:Types.defer_activation ->
  delivery_address:Types.contact_channel_address ->
  type_:Types.channel_type ->
  name:Types.channel_name ->
  contact_id:Types.ssm_contacts_arn ->
  unit ->
  Types.create_contact_channel_request

val make_create_contact_request : 
  ?idempotency_token:Types.idempotency_token ->
  ?tags:Types.tags_list ->
  ?display_name:Types.contact_name ->
  plan:Types.plan ->
  type_:Types.contact_type ->
  alias:Types.contact_alias ->
  unit ->
  Types.create_contact_request

val make_activate_contact_channel_request : 
  activation_code:Types.activation_code ->
  contact_channel_id:Types.ssm_contacts_arn ->
  unit ->
  Types.activate_contact_channel_request

val make_accept_page_request : 
  ?accept_code_validation:Types.accept_code_validation ->
  ?note:Types.receipt_info ->
  ?contact_channel_id:Types.ssm_contacts_arn ->
  accept_code:Types.accept_code ->
  accept_type:Types.accept_type ->
  page_id:Types.ssm_contacts_arn ->
  unit ->
  Types.accept_page_request

Operations

module AcceptPage : sig ... end

Used to acknowledge an engagement to a contact channel during an incident.

module ActivateContactChannel : sig ... end

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

module CreateContact : sig ... end

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.

module CreateContactChannel : sig ... end

A contact channel is the method that Incident Manager uses to engage your contact.

module CreateRotation : sig ... end

Creates a rotation in an on-call schedule.

module CreateRotationOverride : sig ... end

Creates an override for a rotation in an on-call schedule.

module DeactivateContactChannel : sig ... end

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

module DeleteContact : sig ... end

To remove a contact from Incident Manager, you can delete the contact. However, deleting a contact does not remove it from escalation plans and related response plans. Deleting an escalation plan also does not remove it from all related response plans. To modify an escalation plan, we recommend using the UpdateContact action to specify a different existing contact.

module DeleteContactChannel : sig ... end

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.

module DeleteRotation : sig ... end

Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.

module DeleteRotationOverride : sig ... end

Deletes an existing override for an on-call rotation.

module DescribeEngagement : sig ... end

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

module DescribePage : sig ... end

Lists details of the engagement to a contact channel.

module GetContact : sig ... end

Retrieves information about the specified contact or escalation plan.

module GetContactChannel : sig ... end

List details about a specific contact channel.

module GetContactPolicy : sig ... end

Retrieves the resource policies attached to the specified contact or escalation plan.

module GetRotation : sig ... end

Retrieves information about an on-call rotation.

module GetRotationOverride : sig ... end

Retrieves information about an override to an on-call rotation.

module ListContactChannels : sig ... end

Lists all contact channels for the specified contact.

module ListContacts : sig ... end

Lists all contacts and escalation plans in Incident Manager.

module ListEngagements : sig ... end

Lists all engagements that have happened in an incident.

module ListPageReceipts : sig ... end

Lists all of the engagements to contact channels that have been acknowledged.

module ListPageResolutions : sig ... end

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.

module ListPagesByContact : sig ... end

Lists the engagements to a contact's contact channels.

module ListPagesByEngagement : sig ... end

Lists the engagements to contact channels that occurred by engaging a contact.

module ListPreviewRotationShifts : sig ... end

Returns a list of shifts based on rotation configuration parameters.

module ListRotationOverrides : sig ... end

Retrieves a list of overrides currently specified for an on-call rotation.

module ListRotations : sig ... end

Retrieves a list of on-call rotations.

module ListRotationShifts : sig ... end

Returns a list of shifts generated by an existing rotation in the system.

module ListTagsForResource : sig ... end

Lists the tags of a contact, escalation plan, rotation, or on-call schedule.

module PutContactPolicy : sig ... end

Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.

module SendActivationCode : sig ... end

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.

module StartEngagement : sig ... end

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

module StopEngagement : sig ... end

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

module TagResource : sig ... end

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

module UntagResource : sig ... end

Removes tags from the specified resource.

module UpdateContact : sig ... end

Updates the contact or escalation plan specified.

module UpdateContactChannel : sig ... end

Updates a contact's contact channel.

module UpdateRotation : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end