{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-ssm-contacts","description":"AWS Systems Manager Incident Manager Contacts","version":"2021-05-03","base_url":"","endpoints":39,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS Systems Manager Incident Manager Contacts\n@version 2021-05-03\n@auth AWS SigV4\n@endpoints 39\n@hint download_for_search\n@toc root(39)\n\n@endpoint POST /\n@desc Used to acknowledge an engagement to a contact channel during an incident.\n@required {PageId: str, AcceptType: str, AcceptCode: str}\n@optional {ContactChannelId: str, Note: str, AcceptCodeValidation: str}\n\n@endpoint POST /\n@desc Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.\n@required {ContactChannelId: str, ActivationCode: str}\n\n@endpoint POST /\n@desc 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.\n@required {Alias: str, Type: str, Plan: Plan}\n@optional {DisplayName: str, Tags: [Tag], IdempotencyToken: str}\n@returns(200) {ContactArn: str}\n\n@endpoint POST /\n@desc A contact channel is the method that Incident Manager uses to engage your contact.\n@required {ContactId: str, Name: str, Type: str, DeliveryAddress: ContactChannelAddress}\n@optional {DeferActivation: bool, IdempotencyToken: str}\n@returns(200) {ContactChannelArn: str}\n\n@endpoint POST /\n@desc Creates a rotation in an on-call schedule.\n@required {Name: str, ContactIds: [str], TimeZoneId: str, Recurrence: RecurrenceSettings}\n@optional {StartTime: str(timestamp), Tags: [Tag], IdempotencyToken: str}\n@returns(200) {RotationArn: str}\n\n@endpoint POST /\n@desc Creates an override for a rotation in an on-call schedule.\n@required {RotationId: str, NewContactIds: [str], StartTime: str(timestamp), EndTime: str(timestamp)}\n@optional {IdempotencyToken: str}\n@returns(200) {RotationOverrideId: str}\n\n@endpoint POST /\n@desc To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.\n@required {ContactChannelId: str}\n\n@endpoint POST /\n@desc To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.\n@required {ContactId: str}\n\n@endpoint POST /\n@desc To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.\n@required {ContactChannelId: str}\n\n@endpoint POST /\n@desc 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.\n@required {RotationId: str}\n\n@endpoint POST /\n@desc Deletes an existing override for an on-call rotation.\n@required {RotationId: str, RotationOverrideId: str}\n\n@endpoint POST /\n@desc 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.\n@required {EngagementId: str}\n@returns(200) {ContactArn: str, EngagementArn: str, Sender: str, Subject: str, Content: str, PublicSubject: str?, PublicContent: str?, IncidentId: str?, StartTime: str(timestamp)?, StopTime: str(timestamp)?}\n\n@endpoint POST /\n@desc Lists details of the engagement to a contact channel.\n@required {PageId: str}\n@returns(200) {PageArn: str, EngagementArn: str, ContactArn: str, Sender: str, Subject: str, Content: str, PublicSubject: str?, PublicContent: str?, IncidentId: str?, SentTime: str(timestamp)?, ReadTime: str(timestamp)?, DeliveryTime: str(timestamp)?}\n\n@endpoint POST /\n@desc Retrieves information about the specified contact or escalation plan.\n@required {ContactId: str}\n@returns(200) {ContactArn: str, Alias: str, DisplayName: str?, Type: str, Plan: Plan{Stages: [Stage]?, RotationIds: [str]?}}\n\n@endpoint POST /\n@desc List details about a specific contact channel.\n@required {ContactChannelId: str}\n@returns(200) {ContactArn: str, ContactChannelArn: str, Name: str, Type: str, DeliveryAddress: ContactChannelAddress{SimpleAddress: str?}, ActivationStatus: str?}\n\n@endpoint POST /\n@desc Retrieves the resource policies attached to the specified contact or escalation plan.\n@required {ContactArn: str}\n@returns(200) {ContactArn: str?, Policy: str?}\n\n@endpoint POST /\n@desc Retrieves information about an on-call rotation.\n@required {RotationId: str}\n@returns(200) {RotationArn: str, Name: str, ContactIds: [str], StartTime: str(timestamp), TimeZoneId: str, Recurrence: RecurrenceSettings{MonthlySettings: [MonthlySetting]?, WeeklySettings: [WeeklySetting]?, DailySettings: [HandOffTime]?, NumberOfOnCalls: int, ShiftCoverages: map<str,[CoverageTime]>?, RecurrenceMultiplier: int}}\n\n@endpoint POST /\n@desc Retrieves information about an override to an on-call rotation.\n@required {RotationId: str, RotationOverrideId: str}\n@returns(200) {RotationOverrideId: str?, RotationArn: str?, NewContactIds: [str]?, StartTime: str(timestamp)?, EndTime: str(timestamp)?, CreateTime: str(timestamp)?}\n\n@endpoint POST /\n@desc Lists all contact channels for the specified contact.\n@required {ContactId: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, ContactChannels: [ContactChannel]}\n\n@endpoint POST /\n@desc Lists all contacts and escalation plans in Incident Manager.\n@optional {NextToken: str, MaxResults: int, AliasPrefix: str, Type: str}\n@returns(200) {NextToken: str?, Contacts: [Contact]?}\n\n@endpoint POST /\n@desc Lists all engagements that have happened in an incident.\n@optional {NextToken: str, MaxResults: int, IncidentId: str, TimeRangeValue: TimeRange}\n@returns(200) {NextToken: str?, Engagements: [Engagement]}\n\n@endpoint POST /\n@desc Lists all of the engagements to contact channels that have been acknowledged.\n@required {PageId: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, Receipts: [Receipt]?}\n\n@endpoint POST /\n@desc 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.\n@required {PageId: str}\n@optional {NextToken: str}\n@returns(200) {NextToken: str?, PageResolutions: [ResolutionContact]}\n\n@endpoint POST /\n@desc Lists the engagements to a contact's contact channels.\n@required {ContactId: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, Pages: [Page]}\n\n@endpoint POST /\n@desc Lists the engagements to contact channels that occurred by engaging a contact.\n@required {EngagementId: str}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, Pages: [Page]}\n\n@endpoint POST /\n@desc 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.\n@required {EndTime: str(timestamp), Members: [str], TimeZoneId: str, Recurrence: RecurrenceSettings}\n@optional {RotationStartTime: str(timestamp), StartTime: str(timestamp), Overrides: [PreviewOverride], NextToken: str, MaxResults: int}\n@returns(200) {RotationShifts: [RotationShift]?, NextToken: str?}\n\n@endpoint POST /\n@desc Retrieves a list of overrides currently specified for an on-call rotation.\n@required {RotationId: str, StartTime: str(timestamp), EndTime: str(timestamp)}\n@optional {NextToken: str, MaxResults: int}\n@returns(200) {RotationOverrides: [RotationOverride]?, NextToken: str?}\n\n@endpoint POST /\n@desc Returns a list of shifts generated by an existing rotation in the system.\n@required {RotationId: str, EndTime: str(timestamp)}\n@optional {StartTime: str(timestamp), NextToken: str, MaxResults: int}\n@returns(200) {RotationShifts: [RotationShift]?, NextToken: str?}\n\n@endpoint POST /\n@desc Retrieves a list of on-call rotations.\n@optional {RotationNamePrefix: str, NextToken: str, MaxResults: int}\n@returns(200) {NextToken: str?, Rotations: [Rotation]}\n\n@endpoint POST /\n@desc Lists the tags of an escalation plan or contact.\n@required {ResourceARN: str}\n@returns(200) {Tags: [Tag]?}\n\n@endpoint POST /\n@desc 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.\n@required {ContactArn: str, Policy: str}\n\n@endpoint POST /\n@desc 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.\n@required {ContactChannelId: str}\n\n@endpoint POST /\n@desc Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.\n@required {ContactId: str, Sender: str, Subject: str, Content: str}\n@optional {PublicSubject: str, PublicContent: str, IncidentId: str, IdempotencyToken: str}\n@returns(200) {EngagementArn: str}\n\n@endpoint POST /\n@desc Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.\n@required {EngagementId: str}\n@optional {Reason: str}\n\n@endpoint POST /\n@desc Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.\n@required {ResourceARN: str, Tags: [Tag]}\n\n@endpoint POST /\n@desc Removes tags from the specified resource.\n@required {ResourceARN: str, TagKeys: [str]}\n\n@endpoint POST /\n@desc Updates the contact or escalation plan specified.\n@required {ContactId: str}\n@optional {DisplayName: str, Plan: Plan}\n\n@endpoint POST /\n@desc Updates a contact's contact channel.\n@required {ContactChannelId: str}\n@optional {Name: str, DeliveryAddress: ContactChannelAddress}\n\n@endpoint POST /\n@desc Updates the information specified for an on-call rotation.\n@required {RotationId: str, Recurrence: RecurrenceSettings}\n@optional {ContactIds: [str], StartTime: str(timestamp), TimeZoneId: str}\n\n@end\n"}