Module Awso_ssm_contacts.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval targetPrefix : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule HourOfDay : sig ... end
Sourcemodule MinuteOfHour : sig ... end
Sourcemodule RetryIntervalInMinutes : sig ... end
Sourcemodule SsmContactsArn : sig ... end
Sourcemodule IsEssential : sig ... end
Sourcemodule HandOffTime : sig ... end

Details about when an on-call rotation shift begins or ends.

Sourcemodule ChannelTargetInfo : sig ... end

Information about the contact channel that Incident Manager uses to engage the contact.

Sourcemodule ContactTargetInfo : sig ... end

The contact that Incident Manager is engaging during an incident.

Sourcemodule DayOfMonth : sig ... end
Sourcemodule CoverageTime : sig ... end

Information about when an on-call shift begins and ends.

Sourcemodule DayOfWeek : sig ... end
Sourcemodule Target : sig ... end

The contact or contact channel that's being engaged.

Sourcemodule MonthlySetting : sig ... end

Information about on-call rotations that recur monthly.

Sourcemodule CoverageTimes : sig ... end
Sourcemodule WeeklySetting : sig ... end

Information about rotations that recur weekly.

Sourcemodule SsmContactsArnList : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule StageDurationInMins : sig ... end
Sourcemodule TargetsList : sig ... end
Sourcemodule DailySettings : sig ... end
Sourcemodule MonthlySettings : sig ... end
Sourcemodule NumberOfOnCalls : sig ... end
Sourcemodule RecurrenceMultiplier : sig ... end
Sourcemodule ShiftCoveragesMap : sig ... end
Sourcemodule WeeklySettings : sig ... end
Sourcemodule Member : sig ... end
Sourcemodule SimpleAddress : sig ... end
Sourcemodule DependentEntity : sig ... end

Information about a resource that another resource is related to or depends on. For example, if a contact is a member of a rotation, the rotation is a dependent entity of the contact.

Sourcemodule ValidationExceptionField : sig ... end

Provides information about which field caused the exception.

Sourcemodule Stage : sig ... end

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule DateTime : sig ... end
Sourcemodule RecurrenceSettings : sig ... end

Information about when an on-call rotation is in effect and how long the rotation period lasts.

Sourcemodule RotationName : sig ... end
Sourcemodule TimeZoneId : sig ... end
Sourcemodule ShiftDetails : sig ... end

Information about overrides to an on-call rotation shift.

Sourcemodule ShiftType : sig ... end
Sourcemodule Uuid : sig ... end
Sourcemodule IncidentId : sig ... end
Sourcemodule Sender : sig ... end
Sourcemodule ContactType : sig ... end
Sourcemodule StageIndex : sig ... end
Sourcemodule ReceiptInfo : sig ... end
Sourcemodule ReceiptType : sig ... end
Sourcemodule ContactAlias : sig ... end
Sourcemodule ContactName : sig ... end
Sourcemodule ActivationStatus : sig ... end
Sourcemodule ChannelName : sig ... end
Sourcemodule ChannelType : sig ... end
Sourcemodule ContactChannelAddress : sig ... end

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

Sourcemodule DependentEntityList : sig ... end
Sourcemodule RetryAfterSeconds : sig ... end
Sourcemodule ValidationExceptionReason : sig ... end
Sourcemodule StagesList : sig ... end
Sourcemodule Tag : sig ... end

A container of a key-value name pair.

Sourcemodule Rotation : sig ... end

Information about a rotation in an on-call schedule.

Sourcemodule RotationShift : sig ... end

Information about a shift that belongs to an on-call rotation.

Sourcemodule RotationOverride : sig ... end

Information about an override specified for an on-call rotation.

Sourcemodule PreviewOverride : sig ... end

Information about contacts and times that an on-call override replaces.

Sourcemodule Page : sig ... end

Incident Manager engaging a contact's contact channel.

Sourcemodule ResolutionContact : sig ... end

Information about the engagement resolution steps. The resolution starts from the first contact, which can be an escalation plan, then resolves to an on-call rotation, and finally to a personal contact. The ResolutionContact structure describes the information for each node or step in that process. It contains information about different contact types, such as the escalation, rotation, and personal contacts.

Sourcemodule Receipt : sig ... end

Records events during an engagement.

Sourcemodule Engagement : sig ... end

Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.

Sourcemodule Contact : sig ... end

A personal contact or escalation plan that Incident Manager engages during an incident.

Sourcemodule ContactChannel : sig ... end

The method that Incident Manager uses to engage a contact.

Sourcemodule AccessDeniedException : sig ... end

You don't have sufficient access to perform this operation.

Sourcemodule ConflictException : sig ... end

Updating or deleting a resource causes an inconsistent state.

Sourcemodule InternalServerException : sig ... end

Unexpected error occurred while processing the request.

Sourcemodule ResourceNotFoundException : sig ... end

Request references a resource that doesn't exist.

Sourcemodule ThrottlingException : sig ... end

The request was denied due to request throttling.

Sourcemodule ValidationException : sig ... end

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Sourcemodule RotationContactsArnList : sig ... end
Sourcemodule DataEncryptionException : sig ... end

The operation failed to due an encryption key error.

Request would cause a service quota to be exceeded.

Sourcemodule Plan : sig ... end

Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan.

Sourcemodule AmazonResourceName : sig ... end
Sourcemodule TagKeyList : sig ... end
Sourcemodule TagsList : sig ... end
Sourcemodule StopReason : sig ... end
Sourcemodule Content : sig ... end
Sourcemodule IdempotencyToken : sig ... end
Sourcemodule PublicContent : sig ... end
Sourcemodule PublicSubject : sig ... end
Sourcemodule Subject : sig ... end
Sourcemodule Policy : sig ... end
Sourcemodule PaginationToken : sig ... end
Sourcemodule Rotations : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule RotationShifts : sig ... end
Sourcemodule RotationOverrides : sig ... end
Sourcemodule OverrideList : sig ... end
Sourcemodule RotationPreviewMemberList : sig ... end
Sourcemodule PagesList : sig ... end
Sourcemodule ResolutionList : sig ... end
Sourcemodule ReceiptsList : sig ... end
Sourcemodule EngagementsList : sig ... end
Sourcemodule TimeRange : sig ... end

A range of between two set times

Sourcemodule ContactsList : sig ... end
Sourcemodule ContactChannelList : sig ... end
Sourcemodule DeferActivation : sig ... end
Sourcemodule ActivationCode : sig ... end
Sourcemodule AcceptCode : sig ... end
Sourcemodule AcceptCodeValidation : sig ... end
Sourcemodule AcceptType : sig ... end
Sourcemodule UpdateRotationResult : sig ... end

Updates the information specified for an on-call rotation.

Sourcemodule UpdateRotationRequest : sig ... end

Updates the information specified for an on-call rotation.

Sourcemodule UpdateContactResult : sig ... end

Updates the contact or escalation plan specified.

Sourcemodule UpdateContactRequest : sig ... end

Updates the contact or escalation plan specified.

Updates a contact's contact channel.

Updates a contact's contact channel.

Sourcemodule UntagResourceResult : sig ... end

Removes tags from the specified resource.

Sourcemodule UntagResourceRequest : sig ... end

Removes tags from the specified resource.

Sourcemodule TagResourceResult : sig ... end

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

Sourcemodule TagResourceRequest : sig ... end

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

Sourcemodule StopEngagementResult : sig ... end

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

Sourcemodule StopEngagementRequest : sig ... end

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

Sourcemodule StartEngagementResult : sig ... end

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

Sourcemodule StartEngagementRequest : sig ... end

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

Sourcemodule SendActivationCodeResult : 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.

Sourcemodule SendActivationCodeRequest : 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.

Sourcemodule PutContactPolicyResult : 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.

Sourcemodule PutContactPolicyRequest : 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.

Sourcemodule ListTagsForResourceResult : sig ... end

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

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

Sourcemodule ListRotationsResult : sig ... end

Retrieves a list of on-call rotations.

Sourcemodule ListRotationsRequest : sig ... end

Retrieves a list of on-call rotations.

Sourcemodule ListRotationShiftsResult : sig ... end

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

Sourcemodule ListRotationShiftsRequest : sig ... end

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

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

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

Returns a list of shifts based on rotation configuration parameters. The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

Returns a list of shifts based on rotation configuration parameters. The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.

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

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

Sourcemodule ListPagesByContactResult : sig ... end

Lists the engagements to a contact's contact channels.

Sourcemodule ListPagesByContactRequest : sig ... end

Lists the engagements to a contact's contact channels.

Sourcemodule ListPageResolutionsResult : 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.

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.

Sourcemodule ListPageReceiptsResult : sig ... end

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

Sourcemodule ListPageReceiptsRequest : sig ... end

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

Sourcemodule ListEngagementsResult : sig ... end

Lists all engagements that have happened in an incident.

Sourcemodule ListEngagementsRequest : sig ... end

Lists all engagements that have happened in an incident.

Sourcemodule ListContactsResult : sig ... end

Lists all contacts and escalation plans in Incident Manager.

Sourcemodule ListContactsRequest : sig ... end

Lists all contacts and escalation plans in Incident Manager.

Sourcemodule ListContactChannelsResult : sig ... end

Lists all contact channels for the specified contact.

Lists all contact channels for the specified contact.

Sourcemodule GetRotationResult : sig ... end

Retrieves information about an on-call rotation.

Sourcemodule GetRotationRequest : sig ... end

Retrieves information about an on-call rotation.

Sourcemodule GetRotationOverrideResult : sig ... end

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

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

Sourcemodule GetContactResult : sig ... end

Retrieves information about the specified contact or escalation plan.

Sourcemodule GetContactRequest : sig ... end

Retrieves information about the specified contact or escalation plan.

Sourcemodule GetContactPolicyResult : sig ... end

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

Sourcemodule GetContactPolicyRequest : sig ... end

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

Sourcemodule GetContactChannelResult : sig ... end

List details about a specific contact channel.

Sourcemodule GetContactChannelRequest : sig ... end

List details about a specific contact channel.

Sourcemodule DescribePageResult : sig ... end

Lists details of the engagement to a contact channel.

Sourcemodule DescribePageRequest : sig ... end

Lists details of the engagement to a contact channel.

Sourcemodule DescribeEngagementResult : 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.

Sourcemodule DescribeEngagementRequest : 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.

Sourcemodule DeleteRotationResult : 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.

Sourcemodule DeleteRotationRequest : 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.

Deletes an existing override for an on-call rotation.

Deletes an existing override for an on-call rotation.

Sourcemodule DeleteContactResult : 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.

Sourcemodule DeleteContactRequest : 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.

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.

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.

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

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

Sourcemodule CreateRotationResult : sig ... end

Creates a rotation in an on-call schedule.

Sourcemodule CreateRotationRequest : sig ... end

Creates a rotation in an on-call schedule.

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

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

Sourcemodule CreateContactResult : 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.

Sourcemodule CreateContactRequest : 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.

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

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

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

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

Sourcemodule AcceptPageResult : sig ... end

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

Sourcemodule AcceptPageRequest : sig ... end

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