github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/ssm-contacts/2021-05-03/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<p>Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services. </p> <p>Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation. </p>",
     4    "operations": {
     5      "AcceptPage": "<p>Used to acknowledge an engagement to a contact channel during an incident.</p>",
     6      "ActivateContactChannel": "<p>Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.</p>",
     7      "CreateContact": "<p>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. </p>",
     8      "CreateContactChannel": "<p>A contact channel is the method that Incident Manager uses to engage your contact.</p>",
     9      "DeactivateContactChannel": "<p>To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.</p>",
    10      "DeleteContact": "<p>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.</p>",
    11      "DeleteContactChannel": "<p>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.</p>",
    12      "DescribeEngagement": "<p>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.</p>",
    13      "DescribePage": "<p>Lists details of the engagement to a contact channel.</p>",
    14      "GetContact": "<p>Retrieves information about the specified contact or escalation plan.</p>",
    15      "GetContactChannel": "<p>List details about a specific contact channel.</p>",
    16      "GetContactPolicy": "<p>Retrieves the resource policies attached to the specified contact or escalation plan.</p>",
    17      "ListContactChannels": "<p>Lists all contact channels for the specified contact.</p>",
    18      "ListContacts": "<p>Lists all contacts and escalation plans in Incident Manager.</p>",
    19      "ListEngagements": "<p>Lists all engagements that have happened in an incident.</p>",
    20      "ListPageReceipts": "<p>Lists all of the engagements to contact channels that have been acknowledged. </p>",
    21      "ListPagesByContact": "<p>Lists the engagements to a contact's contact channels.</p>",
    22      "ListPagesByEngagement": "<p>Lists the engagements to contact channels that occurred by engaging a contact.</p>",
    23      "ListTagsForResource": "<p>Lists the tags of an escalation plan or contact.</p>",
    24      "PutContactPolicy": "<p>Adds a resource to the specified contact or escalation plan.</p>",
    25      "SendActivationCode": "<p>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 <code>ActivateChannel</code> operation. Incident Manager can't engage a contact channel until it has been activated.</p>",
    26      "StartEngagement": "<p>Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.</p>",
    27      "StopEngagement": "<p>Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.</p>",
    28      "TagResource": "<p>Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set. </p>",
    29      "UntagResource": "<p>Removes tags from the specified resource. </p>",
    30      "UpdateContact": "<p>Updates the contact or escalation plan specified. </p>",
    31      "UpdateContactChannel": "<p>Updates a contact's contact channel.</p>"
    32    },
    33    "shapes": {
    34      "AcceptCode": {
    35        "base": null,
    36        "refs": {
    37          "AcceptPageRequest$AcceptCode": "<p>The accept code is a 6-digit code used to acknowledge the page.</p>"
    38        }
    39      },
    40      "AcceptCodeValidation": {
    41        "base": null,
    42        "refs": {
    43          "AcceptPageRequest$AcceptCodeValidation": "<p>An optional field that Incident Manager uses to <code>ENFORCE</code> <code>AcceptCode</code> validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.</p> <p>Incident Manager can also <code>IGNORE</code> <code>AcceptCode</code> validation. Ignoring <code>AcceptCode</code> validation causes Incident Manager to accept any value entered for the <code>AcceptCode</code>.</p>"
    44        }
    45      },
    46      "AcceptPageRequest": {
    47        "base": null,
    48        "refs": {
    49        }
    50      },
    51      "AcceptPageResult": {
    52        "base": null,
    53        "refs": {
    54        }
    55      },
    56      "AcceptType": {
    57        "base": null,
    58        "refs": {
    59          "AcceptPageRequest$AcceptType": "<p>The type indicates if the page was <code>DELIVERED</code> or <code>READ</code>.</p>"
    60        }
    61      },
    62      "AccessDeniedException": {
    63        "base": "<p>You don't have sufficient access to perform this operation.</p>",
    64        "refs": {
    65        }
    66      },
    67      "ActivateContactChannelRequest": {
    68        "base": null,
    69        "refs": {
    70        }
    71      },
    72      "ActivateContactChannelResult": {
    73        "base": null,
    74        "refs": {
    75        }
    76      },
    77      "ActivationCode": {
    78        "base": null,
    79        "refs": {
    80          "ActivateContactChannelRequest$ActivationCode": "<p>The code sent to the contact channel when it was created in the contact. </p>"
    81        }
    82      },
    83      "ActivationStatus": {
    84        "base": null,
    85        "refs": {
    86          "ContactChannel$ActivationStatus": "<p>A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it. </p>",
    87          "GetContactChannelResult$ActivationStatus": "<p>A Boolean value indicating if the contact channel has been activated or not.</p>"
    88        }
    89      },
    90      "AmazonResourceName": {
    91        "base": null,
    92        "refs": {
    93          "ListTagsForResourceRequest$ResourceARN": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>",
    94          "TagResourceRequest$ResourceARN": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>",
    95          "UntagResourceRequest$ResourceARN": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>"
    96        }
    97      },
    98      "ChannelName": {
    99        "base": null,
   100        "refs": {
   101          "ContactChannel$Name": "<p>The name of the contact channel.</p>",
   102          "CreateContactChannelRequest$Name": "<p>The name of the contact channel.</p>",
   103          "GetContactChannelResult$Name": "<p>The name of the contact channel</p>",
   104          "UpdateContactChannelRequest$Name": "<p>The name of the contact channel.</p>"
   105        }
   106      },
   107      "ChannelTargetInfo": {
   108        "base": "<p>Information about the contact channel that Incident Manager uses to engage the contact.</p>",
   109        "refs": {
   110          "Target$ChannelTargetInfo": "<p>Information about the contact channel Incident Manager is engaging.</p>"
   111        }
   112      },
   113      "ChannelType": {
   114        "base": null,
   115        "refs": {
   116          "ContactChannel$Type": "<p>The type of the contact channel. Incident Manager supports three contact methods:</p> <ul> <li> <p>SMS</p> </li> <li> <p>VOICE</p> </li> <li> <p>EMAIL</p> </li> </ul>",
   117          "CreateContactChannelRequest$Type": "<p>Incident Manager supports three types of contact channels:</p> <ul> <li> <p> <code>SMS</code> </p> </li> <li> <p> <code>VOICE</code> </p> </li> <li> <p> <code>EMAIL</code> </p> </li> </ul>",
   118          "GetContactChannelResult$Type": "<p>The type of contact channel. The type is <code>SMS</code>, <code>VOICE</code>, or <code>EMAIL</code>.</p>"
   119        }
   120      },
   121      "ConflictException": {
   122        "base": "<p>Updating or deleting a resource causes an inconsistent state.</p>",
   123        "refs": {
   124        }
   125      },
   126      "Contact": {
   127        "base": "<p>A personal contact or escalation plan that Incident Manager engages during an incident.</p>",
   128        "refs": {
   129          "ContactsList$member": null
   130        }
   131      },
   132      "ContactAlias": {
   133        "base": null,
   134        "refs": {
   135          "Contact$Alias": "<p>The unique and identifiable alias of the contact or escalation plan.</p>",
   136          "CreateContactRequest$Alias": "<p>The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable. </p>",
   137          "GetContactResult$Alias": "<p>The alias of the contact or escalation plan. The alias is unique and identifiable.</p>",
   138          "ListContactsRequest$AliasPrefix": "<p>Used to list only contacts who's aliases start with the specified prefix.</p>"
   139        }
   140      },
   141      "ContactChannel": {
   142        "base": "<p>The method that Incident Manager uses to engage a contact.</p>",
   143        "refs": {
   144          "ContactChannelList$member": null
   145        }
   146      },
   147      "ContactChannelAddress": {
   148        "base": "<p>The details that Incident Manager uses when trying to engage the contact channel. </p>",
   149        "refs": {
   150          "ContactChannel$DeliveryAddress": "<p>The details that Incident Manager uses when trying to engage the contact channel.</p>",
   151          "CreateContactChannelRequest$DeliveryAddress": "<p>The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:</p> <ul> <li> <p>SMS - '+' followed by the country code and phone number</p> </li> <li> <p>VOICE - '+' followed by the country code and phone number</p> </li> <li> <p>EMAIL - any standard email format</p> </li> </ul>",
   152          "GetContactChannelResult$DeliveryAddress": "<p>The details that Incident Manager uses when trying to engage the contact channel. </p>",
   153          "UpdateContactChannelRequest$DeliveryAddress": "<p>The details that Incident Manager uses when trying to engage the contact channel. </p>"
   154        }
   155      },
   156      "ContactChannelList": {
   157        "base": null,
   158        "refs": {
   159          "ListContactChannelsResult$ContactChannels": "<p>A list of contact channels related to the specified contact.</p>"
   160        }
   161      },
   162      "ContactName": {
   163        "base": null,
   164        "refs": {
   165          "Contact$DisplayName": "<p>The full name of the contact or escalation plan.</p>",
   166          "CreateContactRequest$DisplayName": "<p>The full name of the contact or escalation plan. </p>",
   167          "GetContactResult$DisplayName": "<p>The full name of the contact or escalation plan.</p>",
   168          "UpdateContactRequest$DisplayName": "<p>The full name of the contact or escalation plan.</p>"
   169        }
   170      },
   171      "ContactTargetInfo": {
   172        "base": "<p>The contact that Incident Manager is engaging during an incident.</p>",
   173        "refs": {
   174          "Target$ContactTargetInfo": "<p>Information about the contact that Incident Manager is engaging.</p>"
   175        }
   176      },
   177      "ContactType": {
   178        "base": null,
   179        "refs": {
   180          "Contact$Type": "<p>Refers to the type of contact. A single contact is type <code>PERSONAL</code> and an escalation plan is type <code>ESCALATION</code>.</p>",
   181          "CreateContactRequest$Type": "<p>To create an escalation plan use <code>ESCALATION</code>. To create a contact use <code>PERSONAL</code>.</p>",
   182          "GetContactResult$Type": "<p>The type of contact, either <code>PERSONAL</code> or <code>ESCALATION</code>. </p>",
   183          "ListContactsRequest$Type": "<p>The type of contact. A contact is type <code>PERSONAL</code> and an escalation plan is type <code>ESCALATION</code>.</p>"
   184        }
   185      },
   186      "ContactsList": {
   187        "base": null,
   188        "refs": {
   189          "ListContactsResult$Contacts": "<p>A list of the contacts and escalation plans in your Incident Manager account.</p>"
   190        }
   191      },
   192      "Content": {
   193        "base": null,
   194        "refs": {
   195          "DescribeEngagementResult$Content": "<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>",
   196          "DescribePageResult$Content": "<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>",
   197          "StartEngagementRequest$Content": "<p>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>"
   198        }
   199      },
   200      "CreateContactChannelRequest": {
   201        "base": null,
   202        "refs": {
   203        }
   204      },
   205      "CreateContactChannelResult": {
   206        "base": null,
   207        "refs": {
   208        }
   209      },
   210      "CreateContactRequest": {
   211        "base": null,
   212        "refs": {
   213        }
   214      },
   215      "CreateContactResult": {
   216        "base": null,
   217        "refs": {
   218        }
   219      },
   220      "DataEncryptionException": {
   221        "base": "<p>The operation failed to due an encryption key error.</p>",
   222        "refs": {
   223        }
   224      },
   225      "DateTime": {
   226        "base": null,
   227        "refs": {
   228          "DescribeEngagementResult$StartTime": "<p>The time that the engagement started.</p>",
   229          "DescribeEngagementResult$StopTime": "<p>The time that the engagement ended.</p>",
   230          "DescribePageResult$SentTime": "<p>The time the engagement was sent to the contact channel.</p>",
   231          "DescribePageResult$ReadTime": "<p>The time that the contact channel acknowledged the engagement.</p>",
   232          "DescribePageResult$DeliveryTime": "<p>The time that the contact channel received the engagement.</p>",
   233          "Engagement$StartTime": "<p>The time that the engagement began.</p>",
   234          "Engagement$StopTime": "<p>The time that the engagement ended.</p>",
   235          "Page$SentTime": "<p>The time that Incident Manager engaged the contact channel.</p>",
   236          "Page$DeliveryTime": "<p>The time the message was delivered to the contact channel.</p>",
   237          "Page$ReadTime": "<p>The time that the contact channel acknowledged engagement.</p>",
   238          "Receipt$ReceiptTime": "<p>The time receipt was <code>SENT</code>, <code>DELIVERED</code>, or <code>READ</code>.</p>",
   239          "TimeRange$StartTime": "<p>The start of the time range.</p>",
   240          "TimeRange$EndTime": "<p>The end of the time range.</p>"
   241        }
   242      },
   243      "DeactivateContactChannelRequest": {
   244        "base": null,
   245        "refs": {
   246        }
   247      },
   248      "DeactivateContactChannelResult": {
   249        "base": null,
   250        "refs": {
   251        }
   252      },
   253      "DeferActivation": {
   254        "base": null,
   255        "refs": {
   256          "CreateContactChannelRequest$DeferActivation": "<p>If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.</p>"
   257        }
   258      },
   259      "DeleteContactChannelRequest": {
   260        "base": null,
   261        "refs": {
   262        }
   263      },
   264      "DeleteContactChannelResult": {
   265        "base": null,
   266        "refs": {
   267        }
   268      },
   269      "DeleteContactRequest": {
   270        "base": null,
   271        "refs": {
   272        }
   273      },
   274      "DeleteContactResult": {
   275        "base": null,
   276        "refs": {
   277        }
   278      },
   279      "DescribeEngagementRequest": {
   280        "base": null,
   281        "refs": {
   282        }
   283      },
   284      "DescribeEngagementResult": {
   285        "base": null,
   286        "refs": {
   287        }
   288      },
   289      "DescribePageRequest": {
   290        "base": null,
   291        "refs": {
   292        }
   293      },
   294      "DescribePageResult": {
   295        "base": null,
   296        "refs": {
   297        }
   298      },
   299      "Engagement": {
   300        "base": "<p>Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.</p>",
   301        "refs": {
   302          "EngagementsList$member": null
   303        }
   304      },
   305      "EngagementsList": {
   306        "base": null,
   307        "refs": {
   308          "ListEngagementsResult$Engagements": "<p>A list of each engagement that occurred during the specified time range of an incident.</p>"
   309        }
   310      },
   311      "GetContactChannelRequest": {
   312        "base": null,
   313        "refs": {
   314        }
   315      },
   316      "GetContactChannelResult": {
   317        "base": null,
   318        "refs": {
   319        }
   320      },
   321      "GetContactPolicyRequest": {
   322        "base": null,
   323        "refs": {
   324        }
   325      },
   326      "GetContactPolicyResult": {
   327        "base": null,
   328        "refs": {
   329        }
   330      },
   331      "GetContactRequest": {
   332        "base": null,
   333        "refs": {
   334        }
   335      },
   336      "GetContactResult": {
   337        "base": null,
   338        "refs": {
   339        }
   340      },
   341      "IdempotencyToken": {
   342        "base": null,
   343        "refs": {
   344          "CreateContactChannelRequest$IdempotencyToken": "<p>A token ensuring that the operation is called only once with the specified details.</p>",
   345          "CreateContactRequest$IdempotencyToken": "<p>A token ensuring that the operation is called only once with the specified details.</p>",
   346          "StartEngagementRequest$IdempotencyToken": "<p>A token ensuring that the operation is called only once with the specified details.</p>"
   347        }
   348      },
   349      "IncidentId": {
   350        "base": null,
   351        "refs": {
   352          "DescribeEngagementResult$IncidentId": "<p>The ARN of the incident in which the engagement occurred.</p>",
   353          "DescribePageResult$IncidentId": "<p>The ARN of the incident that engaged the contact channel.</p>",
   354          "Engagement$IncidentId": "<p>The ARN of the incident that's engaging the contact.</p>",
   355          "ListEngagementsRequest$IncidentId": "<p>The Amazon Resource Name (ARN) of the incident you're listing engagements for.</p>",
   356          "Page$IncidentId": "<p>The ARN of the incident that's engaging the contact channel.</p>",
   357          "StartEngagementRequest$IncidentId": "<p>The ARN of the incident that the engagement is part of.</p>"
   358        }
   359      },
   360      "InternalServerException": {
   361        "base": "<p>Unexpected error occurred while processing the request.</p>",
   362        "refs": {
   363        }
   364      },
   365      "IsEssential": {
   366        "base": null,
   367        "refs": {
   368          "ContactTargetInfo$IsEssential": "<p>A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.</p>"
   369        }
   370      },
   371      "ListContactChannelsRequest": {
   372        "base": null,
   373        "refs": {
   374        }
   375      },
   376      "ListContactChannelsResult": {
   377        "base": null,
   378        "refs": {
   379        }
   380      },
   381      "ListContactsRequest": {
   382        "base": null,
   383        "refs": {
   384        }
   385      },
   386      "ListContactsResult": {
   387        "base": null,
   388        "refs": {
   389        }
   390      },
   391      "ListEngagementsRequest": {
   392        "base": null,
   393        "refs": {
   394        }
   395      },
   396      "ListEngagementsResult": {
   397        "base": null,
   398        "refs": {
   399        }
   400      },
   401      "ListPageReceiptsRequest": {
   402        "base": null,
   403        "refs": {
   404        }
   405      },
   406      "ListPageReceiptsResult": {
   407        "base": null,
   408        "refs": {
   409        }
   410      },
   411      "ListPagesByContactRequest": {
   412        "base": null,
   413        "refs": {
   414        }
   415      },
   416      "ListPagesByContactResult": {
   417        "base": null,
   418        "refs": {
   419        }
   420      },
   421      "ListPagesByEngagementRequest": {
   422        "base": null,
   423        "refs": {
   424        }
   425      },
   426      "ListPagesByEngagementResult": {
   427        "base": null,
   428        "refs": {
   429        }
   430      },
   431      "ListTagsForResourceRequest": {
   432        "base": null,
   433        "refs": {
   434        }
   435      },
   436      "ListTagsForResourceResult": {
   437        "base": null,
   438        "refs": {
   439        }
   440      },
   441      "MaxResults": {
   442        "base": null,
   443        "refs": {
   444          "ListContactChannelsRequest$MaxResults": "<p>The maximum number of contact channels per page.</p>",
   445          "ListContactsRequest$MaxResults": "<p>The maximum number of contacts and escalation plans per page of results.</p>",
   446          "ListEngagementsRequest$MaxResults": "<p>The maximum number of engagements per page of results.</p>",
   447          "ListPageReceiptsRequest$MaxResults": "<p>The maximum number of acknowledgements per page of results.</p>",
   448          "ListPagesByContactRequest$MaxResults": "<p>The maximum number of engagements to contact channels to list per page of results. </p>",
   449          "ListPagesByEngagementRequest$MaxResults": "<p>The maximum number of engagements to contact channels to list per page of results.</p>"
   450        }
   451      },
   452      "Page": {
   453        "base": "<p>Incident Manager engaging a contact's contact channel.</p>",
   454        "refs": {
   455          "PagesList$member": null
   456        }
   457      },
   458      "PagesList": {
   459        "base": null,
   460        "refs": {
   461          "ListPagesByContactResult$Pages": "<p>The list of engagements to a contact's contact channel.</p>",
   462          "ListPagesByEngagementResult$Pages": "<p>The list of engagements to contact channels.</p>"
   463        }
   464      },
   465      "PaginationToken": {
   466        "base": null,
   467        "refs": {
   468          "ListContactChannelsRequest$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   469          "ListContactChannelsResult$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   470          "ListContactsRequest$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   471          "ListContactsResult$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   472          "ListEngagementsRequest$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   473          "ListEngagementsResult$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   474          "ListPageReceiptsRequest$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   475          "ListPageReceiptsResult$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   476          "ListPagesByContactRequest$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   477          "ListPagesByContactResult$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   478          "ListPagesByEngagementRequest$NextToken": "<p>The pagination token to continue to the next page of results.</p>",
   479          "ListPagesByEngagementResult$NextToken": "<p>The pagination token to continue to the next page of results.</p>"
   480        }
   481      },
   482      "Plan": {
   483        "base": "<p>The stages that an escalation plan or engagement plan engages contacts and contact methods in.</p>",
   484        "refs": {
   485          "CreateContactRequest$Plan": "<p>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. </p>",
   486          "GetContactResult$Plan": "<p>Details about the specific timing or stages and targets of the escalation plan or engagement plan.</p>",
   487          "UpdateContactRequest$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>"
   488        }
   489      },
   490      "Policy": {
   491        "base": null,
   492        "refs": {
   493          "GetContactPolicyResult$Policy": "<p>Details about the resource policy attached to the contact or escalation plan.</p>",
   494          "PutContactPolicyRequest$Policy": "<p>Details of the resource policy.</p>"
   495        }
   496      },
   497      "PublicContent": {
   498        "base": null,
   499        "refs": {
   500          "DescribeEngagementResult$PublicContent": "<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>",
   501          "DescribePageResult$PublicContent": "<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>",
   502          "StartEngagementRequest$PublicContent": "<p>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>"
   503        }
   504      },
   505      "PublicSubject": {
   506        "base": null,
   507        "refs": {
   508          "DescribeEngagementResult$PublicSubject": "<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>",
   509          "DescribePageResult$PublicSubject": "<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>",
   510          "StartEngagementRequest$PublicSubject": "<p>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</p>"
   511        }
   512      },
   513      "PutContactPolicyRequest": {
   514        "base": null,
   515        "refs": {
   516        }
   517      },
   518      "PutContactPolicyResult": {
   519        "base": null,
   520        "refs": {
   521        }
   522      },
   523      "Receipt": {
   524        "base": "<p>Records events during an engagement.</p>",
   525        "refs": {
   526          "ReceiptsList$member": null
   527        }
   528      },
   529      "ReceiptInfo": {
   530        "base": null,
   531        "refs": {
   532          "AcceptPageRequest$Note": "<p>Information provided by the user when the user acknowledges the page.</p>",
   533          "Receipt$ReceiptInfo": "<p>Information provided during the page acknowledgement.</p>"
   534        }
   535      },
   536      "ReceiptType": {
   537        "base": null,
   538        "refs": {
   539          "Receipt$ReceiptType": "<p>The type follows the engagement cycle, <code>SENT</code>, <code>DELIVERED</code>, and <code>READ</code>.</p>"
   540        }
   541      },
   542      "ReceiptsList": {
   543        "base": null,
   544        "refs": {
   545          "ListPageReceiptsResult$Receipts": "<p>A list of each acknowledgement.</p>"
   546        }
   547      },
   548      "ResourceNotFoundException": {
   549        "base": "<p>Request references a resource that doesn't exist.</p>",
   550        "refs": {
   551        }
   552      },
   553      "RetryAfterSeconds": {
   554        "base": null,
   555        "refs": {
   556          "InternalServerException$RetryAfterSeconds": "Advice to clients on when the call can be safely retried",
   557          "ThrottlingException$RetryAfterSeconds": "Advice to clients on when the call can be safely retried"
   558        }
   559      },
   560      "RetryIntervalInMinutes": {
   561        "base": null,
   562        "refs": {
   563          "ChannelTargetInfo$RetryIntervalInMinutes": "<p>The number of minutes to wait to retry sending engagement in the case the engagement initially fails.</p>"
   564        }
   565      },
   566      "SendActivationCodeRequest": {
   567        "base": null,
   568        "refs": {
   569        }
   570      },
   571      "SendActivationCodeResult": {
   572        "base": null,
   573        "refs": {
   574        }
   575      },
   576      "Sender": {
   577        "base": null,
   578        "refs": {
   579          "DescribeEngagementResult$Sender": "<p>The user that started the engagement.</p>",
   580          "DescribePageResult$Sender": "<p>The user that started the engagement.</p>",
   581          "Engagement$Sender": "<p>The user that started the engagement.</p>",
   582          "Page$Sender": "<p>The user that started the engagement.</p>",
   583          "StartEngagementRequest$Sender": "<p>The user that started the engagement.</p>"
   584        }
   585      },
   586      "ServiceQuotaExceededException": {
   587        "base": "<p>Request would cause a service quota to be exceeded.</p>",
   588        "refs": {
   589        }
   590      },
   591      "SimpleAddress": {
   592        "base": null,
   593        "refs": {
   594          "ContactChannelAddress$SimpleAddress": "<p>The format is dependent on the type of the contact channel. The following are the expected formats:</p> <ul> <li> <p>SMS - '+' followed by the country code and phone number</p> </li> <li> <p>VOICE - '+' followed by the country code and phone number</p> </li> <li> <p>EMAIL - any standard email format</p> </li> </ul>"
   595        }
   596      },
   597      "SsmContactsArn": {
   598        "base": null,
   599        "refs": {
   600          "AcceptPageRequest$PageId": "<p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>",
   601          "AcceptPageRequest$ContactChannelId": "<p>The ARN of the contact channel.</p>",
   602          "ActivateContactChannelRequest$ContactChannelId": "<p>The Amazon Resource Name (ARN) of the contact channel.</p>",
   603          "ChannelTargetInfo$ContactChannelId": "<p>The Amazon Resource Name (ARN) of the contact channel.</p>",
   604          "Contact$ContactArn": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>",
   605          "ContactChannel$ContactChannelArn": "<p>The Amazon Resource Name (ARN) of the contact channel.</p>",
   606          "ContactChannel$ContactArn": "<p>The ARN of the contact that contains the contact channel.</p>",
   607          "ContactTargetInfo$ContactId": "<p>The Amazon Resource Name (ARN) of the contact.</p>",
   608          "CreateContactChannelRequest$ContactId": "<p>The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.</p>",
   609          "CreateContactChannelResult$ContactChannelArn": "<p>The Amazon Resource Name (ARN) of the contact channel.</p>",
   610          "CreateContactResult$ContactArn": "<p>The Amazon Resource Name (ARN) of the created contact or escalation plan.</p>",
   611          "DeactivateContactChannelRequest$ContactChannelId": "<p>The Amazon Resource Name (ARN) of the contact channel you're deactivating.</p>",
   612          "DeleteContactChannelRequest$ContactChannelId": "<p>The Amazon Resource Name (ARN) of the contact channel.</p>",
   613          "DeleteContactRequest$ContactId": "<p>The Amazon Resource Name (ARN) of the contact that you're deleting.</p>",
   614          "DescribeEngagementRequest$EngagementId": "<p>The Amazon Resource Name (ARN) of the engagement you want the details of.</p>",
   615          "DescribeEngagementResult$ContactArn": "<p>The ARN of the escalation plan or contacts involved in the engagement.</p>",
   616          "DescribeEngagementResult$EngagementArn": "<p>The ARN of the engagement.</p>",
   617          "DescribePageRequest$PageId": "<p>The ID of the engagement to a contact channel.</p>",
   618          "DescribePageResult$PageArn": "<p>The Amazon Resource Name (ARN) of the engagement to a contact channel.</p>",
   619          "DescribePageResult$EngagementArn": "<p>The ARN of the engagement that engaged the contact channel.</p>",
   620          "DescribePageResult$ContactArn": "<p>The ARN of the contact that was engaged.</p>",
   621          "Engagement$EngagementArn": "<p>The Amazon Resource Name (ARN) of the engagement.</p>",
   622          "Engagement$ContactArn": "<p>The ARN of the escalation plan or contact that Incident Manager is engaging.</p>",
   623          "GetContactChannelRequest$ContactChannelId": "<p>The Amazon Resource Name (ARN) of the contact channel you want information about.</p>",
   624          "GetContactChannelResult$ContactArn": "<p>The ARN of the contact that the channel belongs to.</p>",
   625          "GetContactChannelResult$ContactChannelArn": "<p>The ARN of the contact channel.</p>",
   626          "GetContactPolicyRequest$ContactArn": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>",
   627          "GetContactPolicyResult$ContactArn": "<p>The ARN of the contact or escalation plan.</p>",
   628          "GetContactRequest$ContactId": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>",
   629          "GetContactResult$ContactArn": "<p>The ARN of the contact or escalation plan.</p>",
   630          "ListContactChannelsRequest$ContactId": "<p>The Amazon Resource Name (ARN) of the contact. </p>",
   631          "ListPageReceiptsRequest$PageId": "<p>The Amazon Resource Name (ARN) of the engagement to a specific contact channel.</p>",
   632          "ListPagesByContactRequest$ContactId": "<p>The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.</p>",
   633          "ListPagesByEngagementRequest$EngagementId": "<p>The Amazon Resource Name (ARN) of the engagement.</p>",
   634          "Page$PageArn": "<p>The Amazon Resource Name (ARN) of the page to the contact channel.</p>",
   635          "Page$EngagementArn": "<p>The ARN of the engagement that this page is part of.</p>",
   636          "Page$ContactArn": "<p>The ARN of the contact that Incident Manager is engaging.</p>",
   637          "PutContactPolicyRequest$ContactArn": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan.</p>",
   638          "Receipt$ContactChannelArn": "<p>The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.</p>",
   639          "SendActivationCodeRequest$ContactChannelId": "<p>The Amazon Resource Name (ARN) of the contact channel.</p>",
   640          "StartEngagementRequest$ContactId": "<p>The Amazon Resource Name (ARN) of the contact being engaged.</p>",
   641          "StartEngagementResult$EngagementArn": "<p>The ARN of the engagement.</p>",
   642          "StopEngagementRequest$EngagementId": "<p>The Amazon Resource Name (ARN) of the engagement.</p>",
   643          "UpdateContactChannelRequest$ContactChannelId": "<p>The Amazon Resource Name (ARN) of the contact channel you want to update.</p>",
   644          "UpdateContactRequest$ContactId": "<p>The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.</p>"
   645        }
   646      },
   647      "Stage": {
   648        "base": "<p>A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.</p>",
   649        "refs": {
   650          "StagesList$member": null
   651        }
   652      },
   653      "StageDurationInMins": {
   654        "base": null,
   655        "refs": {
   656          "Stage$DurationInMinutes": "<p>The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.</p>"
   657        }
   658      },
   659      "StagesList": {
   660        "base": null,
   661        "refs": {
   662          "Plan$Stages": "<p>A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.</p>"
   663        }
   664      },
   665      "StartEngagementRequest": {
   666        "base": null,
   667        "refs": {
   668        }
   669      },
   670      "StartEngagementResult": {
   671        "base": null,
   672        "refs": {
   673        }
   674      },
   675      "StopEngagementRequest": {
   676        "base": null,
   677        "refs": {
   678        }
   679      },
   680      "StopEngagementResult": {
   681        "base": null,
   682        "refs": {
   683        }
   684      },
   685      "StopReason": {
   686        "base": null,
   687        "refs": {
   688          "StopEngagementRequest$Reason": "<p>The reason that you're stopping the engagement. </p>"
   689        }
   690      },
   691      "String": {
   692        "base": null,
   693        "refs": {
   694          "AccessDeniedException$Message": null,
   695          "ConflictException$Message": null,
   696          "ConflictException$ResourceId": "Identifier of the resource in use",
   697          "ConflictException$ResourceType": "ype of the resource in use",
   698          "DataEncryptionException$Message": null,
   699          "InternalServerException$Message": null,
   700          "ResourceNotFoundException$Message": null,
   701          "ResourceNotFoundException$ResourceId": "Hypothetical resource identifier that was not found",
   702          "ResourceNotFoundException$ResourceType": "Hypothetical resource type that was not found",
   703          "ServiceQuotaExceededException$Message": null,
   704          "ServiceQuotaExceededException$ResourceId": "Identifier of the resource affected",
   705          "ServiceQuotaExceededException$ResourceType": "Type of the resource affected",
   706          "ServiceQuotaExceededException$QuotaCode": "Service Quotas requirement to identify originating service",
   707          "ServiceQuotaExceededException$ServiceCode": "Service Quotas requirement to identify originating quota",
   708          "ThrottlingException$Message": null,
   709          "ThrottlingException$QuotaCode": "Service Quotas requirement to identify originating service",
   710          "ThrottlingException$ServiceCode": "Service Quotas requirement to identify originating quota",
   711          "ValidationException$Message": null,
   712          "ValidationExceptionField$Name": "<p>The name of the field that caused the exception.</p>",
   713          "ValidationExceptionField$Message": "<p>Information about what caused the field to cause an exception.</p>"
   714        }
   715      },
   716      "Subject": {
   717        "base": null,
   718        "refs": {
   719          "DescribeEngagementResult$Subject": "<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>",
   720          "DescribePageResult$Subject": "<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> and <code>EMAIL</code>.</p>",
   721          "StartEngagementRequest$Subject": "<p>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</p>"
   722        }
   723      },
   724      "Tag": {
   725        "base": "<p>A container of a key-value name pair.</p>",
   726        "refs": {
   727          "TagsList$member": null
   728        }
   729      },
   730      "TagKey": {
   731        "base": null,
   732        "refs": {
   733          "Tag$Key": "<p>Name of the object key.</p>",
   734          "TagKeyList$member": null
   735        }
   736      },
   737      "TagKeyList": {
   738        "base": null,
   739        "refs": {
   740          "UntagResourceRequest$TagKeys": "<p>The key of the tag that you want to remove.</p>"
   741        }
   742      },
   743      "TagResourceRequest": {
   744        "base": null,
   745        "refs": {
   746        }
   747      },
   748      "TagResourceResult": {
   749        "base": null,
   750        "refs": {
   751        }
   752      },
   753      "TagValue": {
   754        "base": null,
   755        "refs": {
   756          "Tag$Value": "<p>Value of the tag.</p>"
   757        }
   758      },
   759      "TagsList": {
   760        "base": null,
   761        "refs": {
   762          "CreateContactRequest$Tags": "<p>Adds a tag to the target. You can only tag resources created in the first Region of your replication set. </p>",
   763          "ListTagsForResourceResult$Tags": "<p>The tags related to the contact or escalation plan.</p>",
   764          "TagResourceRequest$Tags": "<p>A list of tags that you are adding to the contact or escalation plan.</p>"
   765        }
   766      },
   767      "Target": {
   768        "base": "<p>The contact or contact channel that's being engaged.</p>",
   769        "refs": {
   770          "TargetsList$member": null
   771        }
   772      },
   773      "TargetsList": {
   774        "base": null,
   775        "refs": {
   776          "Stage$Targets": "<p>The contacts or contact methods that the escalation plan or engagement plan is engaging.</p>"
   777        }
   778      },
   779      "ThrottlingException": {
   780        "base": "<p>The request was denied due to request throttling.</p>",
   781        "refs": {
   782        }
   783      },
   784      "TimeRange": {
   785        "base": "<p>A range of between two set times</p>",
   786        "refs": {
   787          "ListEngagementsRequest$TimeRangeValue": "<p>The time range to lists engagements for an incident.</p>"
   788        }
   789      },
   790      "UntagResourceRequest": {
   791        "base": null,
   792        "refs": {
   793        }
   794      },
   795      "UntagResourceResult": {
   796        "base": null,
   797        "refs": {
   798        }
   799      },
   800      "UpdateContactChannelRequest": {
   801        "base": null,
   802        "refs": {
   803        }
   804      },
   805      "UpdateContactChannelResult": {
   806        "base": null,
   807        "refs": {
   808        }
   809      },
   810      "UpdateContactRequest": {
   811        "base": null,
   812        "refs": {
   813        }
   814      },
   815      "UpdateContactResult": {
   816        "base": null,
   817        "refs": {
   818        }
   819      },
   820      "ValidationException": {
   821        "base": "<p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>",
   822        "refs": {
   823        }
   824      },
   825      "ValidationExceptionField": {
   826        "base": "<p>Provides information about which field caused the exception.</p>",
   827        "refs": {
   828          "ValidationExceptionFieldList$member": null
   829        }
   830      },
   831      "ValidationExceptionFieldList": {
   832        "base": null,
   833        "refs": {
   834          "ValidationException$Fields": "The fields that caused the error"
   835        }
   836      },
   837      "ValidationExceptionReason": {
   838        "base": null,
   839        "refs": {
   840          "ValidationException$Reason": "Reason the request failed validation"
   841        }
   842      }
   843    }
   844  }