aws-sdk 2.1344.0 → 2.1346.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -29,11 +29,11 @@ declare class SSMIncidents extends Service {
29
29
  */
30
30
  createResponsePlan(callback?: (err: AWSError, data: SSMIncidents.Types.CreateResponsePlanOutput) => void): Request<SSMIncidents.Types.CreateResponsePlanOutput, AWSError>;
31
31
  /**
32
- * Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.
32
+ * Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.
33
33
  */
34
34
  createTimelineEvent(params: SSMIncidents.Types.CreateTimelineEventInput, callback?: (err: AWSError, data: SSMIncidents.Types.CreateTimelineEventOutput) => void): Request<SSMIncidents.Types.CreateTimelineEventOutput, AWSError>;
35
35
  /**
36
- * Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.
36
+ * Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.
37
37
  */
38
38
  createTimelineEvent(callback?: (err: AWSError, data: SSMIncidents.Types.CreateTimelineEventOutput) => void): Request<SSMIncidents.Types.CreateTimelineEventOutput, AWSError>;
39
39
  /**
@@ -390,7 +390,7 @@ declare namespace SSMIncidents {
390
390
  }
391
391
  export interface CreateTimelineEventInput {
392
392
  /**
393
- * A token ensuring that the action is called only once with the specified details.
393
+ * A token that ensures that a client calls the action only once with the specified details.
394
394
  */
395
395
  clientToken?: ClientToken;
396
396
  /**
@@ -398,7 +398,7 @@ declare namespace SSMIncidents {
398
398
  */
399
399
  eventData: EventData;
400
400
  /**
401
- * Adds one or more references to the TimelineEvent. A reference can be an Amazon Web Services resource involved in the incident or in some way associated with it. When you specify a reference, you enter the Amazon Resource Name (ARN) of the resource. You can also specify a related item. As an example, you could specify the ARN of an Amazon DynamoDB (DynamoDB) table. The table for this example is the resource. You could also specify a Amazon CloudWatch metric for that table. The metric is the related item.
401
+ * Adds one or more references to the TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.
402
402
  */
403
403
  eventReferences?: EventReferenceList;
404
404
  /**
@@ -406,11 +406,11 @@ declare namespace SSMIncidents {
406
406
  */
407
407
  eventTime: Timestamp;
408
408
  /**
409
- * The type of the event. You can create timeline events of type Custom Event.
409
+ * The type of event. You can create timeline events of type Custom Event.
410
410
  */
411
411
  eventType: TimelineEventType;
412
412
  /**
413
- * The Amazon Resource Name (ARN) of the incident record to which the event will be added.
413
+ * The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.
414
414
  */
415
415
  incidentRecordArn: Arn;
416
416
  }
@@ -469,7 +469,7 @@ declare namespace SSMIncidents {
469
469
  }
470
470
  export interface DeleteTimelineEventInput {
471
471
  /**
472
- * The ID of the event you are updating. You can find this by using ListTimelineEvents.
472
+ * The ID of the event to update. You can use ListTimelineEvents to find an event's ID.
473
473
  */
474
474
  eventId: UUID;
475
475
  /**
@@ -824,7 +824,7 @@ declare namespace SSMIncidents {
824
824
  }
825
825
  export interface ListIncidentRecordsInput {
826
826
  /**
827
- * Filters the list of incident records through which you are searching. You can filter on the following keys: creationTime impact status createdBy Note the following when deciding how to use Filters: If you don't specify a Filter, the response includes all incident records. If you specify more than one filter in a single request, the response returns incident records that match all filters. If you specify a filter with more than one value, the response returns incident records that match any of the values provided.
827
+ * Filters the list of incident records you want to search through. You can filter on the following keys: creationTime impact status createdBy Note the following when when you use Filters: If you don't specify a Filter, the response includes all incident records. If you specify more than one filter in a single request, the response returns incident records that match all filters. If you specify a filter with more than one value, the response returns incident records that match any of the values provided.
828
828
  */
829
829
  filters?: FilterList;
830
830
  /**
@@ -924,7 +924,7 @@ declare namespace SSMIncidents {
924
924
  }
925
925
  export interface ListTimelineEventsInput {
926
926
  /**
927
- * Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys: eventTime eventType Note the following when deciding how to use Filters: If you don't specify a Filter, the response includes all timeline events. If you specify more than one filter in a single request, the response returns timeline events that match all filters. If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
927
+ * Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys: eventTime eventType Note the following when deciding how to use Filters: If you don't specify a Filter, the response includes all timeline events. If you specify more than one filter in a single request, the response returns timeline events that match all filters. If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
928
928
  */
929
929
  filters?: FilterList;
930
930
  /**
@@ -940,7 +940,7 @@ declare namespace SSMIncidents {
940
940
  */
941
941
  nextToken?: NextToken;
942
942
  /**
943
- * Sort by the specified key value pair.
943
+ * Sort timeline events by the specified key value pair.
944
944
  */
945
945
  sortBy?: TimelineEventSort;
946
946
  /**
@@ -1197,7 +1197,7 @@ declare namespace SSMIncidents {
1197
1197
  */
1198
1198
  impact?: Impact;
1199
1199
  /**
1200
- * Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an Amazon S3 bucket.
1200
+ * Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.
1201
1201
  */
1202
1202
  relatedItems?: RelatedItemList;
1203
1203
  /**
@@ -1329,19 +1329,19 @@ declare namespace SSMIncidents {
1329
1329
  */
1330
1330
  chatChannel?: ChatChannel;
1331
1331
  /**
1332
- * A token that ensures that the operation is called only once with the specified details.
1332
+ * A token that ensures that a client calls the operation only once with the specified details.
1333
1333
  */
1334
1334
  clientToken?: ClientToken;
1335
1335
  /**
1336
- * Defines the impact of the incident to customers and applications. Providing an impact overwrites the impact provided by the response plan. Possible impacts: 1 - Critical impact, full application failure that impacts many to all customers. 2 - High impact, partial application failure with impact to many customers. 3 - Medium impact, the application is providing reduced service to customers. 4 - Low impact, customer aren't impacted by the problem yet. 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
1336
+ * Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan. Possible impacts: 1 - Critical impact, full application failure that impacts many to all customers. 2 - High impact, partial application failure with impact to many customers. 3 - Medium impact, the application is providing reduced service to customers. 4 - Low impact, customer aren't impacted by the problem yet. 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
1337
1337
  */
1338
1338
  impact?: Impact;
1339
1339
  /**
1340
- * The Amazon SNS targets that are notified when updates are made to an incident. Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.
1340
+ * The Amazon SNS targets that Incident Manager notifies when a client updates an incident. Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.
1341
1341
  */
1342
1342
  notificationTargets?: NotificationTargetSet;
1343
1343
  /**
1344
- * The status of the incident. An incident can be Open or Resolved.
1344
+ * The status of the incident. Possible statuses are Open or Resolved.
1345
1345
  */
1346
1346
  status?: IncidentRecordStatus;
1347
1347
  /**
@@ -1357,15 +1357,15 @@ declare namespace SSMIncidents {
1357
1357
  }
1358
1358
  export interface UpdateRelatedItemsInput {
1359
1359
  /**
1360
- * A token ensuring that the operation is called only once with the specified details.
1360
+ * A token that ensures that a client calls the operation only once with the specified details.
1361
1361
  */
1362
1362
  clientToken?: ClientToken;
1363
1363
  /**
1364
- * The Amazon Resource Name (ARN) of the incident record containing the related items you are updating.
1364
+ * The Amazon Resource Name (ARN) of the incident record that contains the related items that you update.
1365
1365
  */
1366
1366
  incidentRecordArn: Arn;
1367
1367
  /**
1368
- * Details about the item you are adding or deleting.
1368
+ * Details about the item that you are add to, or delete from, an incident.
1369
1369
  */
1370
1370
  relatedItemsUpdate: RelatedItemsUpdate;
1371
1371
  }
@@ -1456,7 +1456,7 @@ declare namespace SSMIncidents {
1456
1456
  }
1457
1457
  export interface UpdateTimelineEventInput {
1458
1458
  /**
1459
- * A token ensuring that the operation is called only once with the specified details.
1459
+ * A token that ensures that a client calls the operation only once with the specified details.
1460
1460
  */
1461
1461
  clientToken?: ClientToken;
1462
1462
  /**
@@ -1464,11 +1464,11 @@ declare namespace SSMIncidents {
1464
1464
  */
1465
1465
  eventData?: EventData;
1466
1466
  /**
1467
- * The ID of the event you are updating. You can find this by using ListTimelineEvents.
1467
+ * The ID of the event to update. You can use ListTimelineEvents to find an event's ID.
1468
1468
  */
1469
1469
  eventId: UUID;
1470
1470
  /**
1471
- * Updates all existing references in a TimelineEvent. A reference can be an Amazon Web Services resource involved in the incident or in some way associated with it. When you specify a reference, you enter the Amazon Resource Name (ARN) of the resource. You can also specify a related item. As an example, you could specify the ARN of an Amazon DynamoDB (DynamoDB) table. The table for this example is the resource. You could also specify a Amazon CloudWatch metric for that table. The metric is the related item. This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes them and enters only new references.
1471
+ * Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item. This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.
1472
1472
  */
1473
1473
  eventReferences?: EventReferenceList;
1474
1474
  /**
@@ -1476,7 +1476,7 @@ declare namespace SSMIncidents {
1476
1476
  */
1477
1477
  eventTime?: Timestamp;
1478
1478
  /**
1479
- * The type of the event. You can update events of type Custom Event.
1479
+ * The type of event. You can update events of type Custom Event.
1480
1480
  */
1481
1481
  eventType?: TimelineEventType;
1482
1482
  /**
@@ -83,7 +83,7 @@ return /******/ (function(modules) { // webpackBootstrap
83
83
  /**
84
84
  * @constant
85
85
  */
86
- VERSION: '2.1344.0',
86
+ VERSION: '2.1346.0',
87
87
 
88
88
  /**
89
89
  * @api private