@aws-sdk/client-ssm-incidents 3.325.0 → 3.327.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.
Files changed (30) hide show
  1. package/dist-types/commands/CreateReplicationSetCommand.d.ts +6 -0
  2. package/dist-types/commands/CreateResponsePlanCommand.d.ts +6 -0
  3. package/dist-types/commands/CreateTimelineEventCommand.d.ts +7 -0
  4. package/dist-types/commands/DeleteIncidentRecordCommand.d.ts +4 -0
  5. package/dist-types/commands/DeleteReplicationSetCommand.d.ts +4 -0
  6. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
  7. package/dist-types/commands/DeleteResponsePlanCommand.d.ts +4 -0
  8. package/dist-types/commands/DeleteTimelineEventCommand.d.ts +4 -0
  9. package/dist-types/commands/GetIncidentRecordCommand.d.ts +39 -0
  10. package/dist-types/commands/GetReplicationSetCommand.d.ts +22 -0
  11. package/dist-types/commands/GetResourcePoliciesCommand.d.ts +13 -0
  12. package/dist-types/commands/GetResponsePlanCommand.d.ts +62 -0
  13. package/dist-types/commands/GetTimelineEventCommand.d.ts +19 -0
  14. package/dist-types/commands/ListIncidentRecordsCommand.d.ts +22 -0
  15. package/dist-types/commands/ListRelatedItemsCommand.d.ts +25 -0
  16. package/dist-types/commands/ListReplicationSetsCommand.d.ts +9 -0
  17. package/dist-types/commands/ListResponsePlansCommand.d.ts +13 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  19. package/dist-types/commands/ListTimelineEventsCommand.d.ts +21 -0
  20. package/dist-types/commands/PutResourcePolicyCommand.d.ts +6 -0
  21. package/dist-types/commands/StartIncidentCommand.d.ts +6 -0
  22. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  23. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  24. package/dist-types/commands/UpdateDeletionProtectionCommand.d.ts +4 -0
  25. package/dist-types/commands/UpdateIncidentRecordCommand.d.ts +4 -0
  26. package/dist-types/commands/UpdateRelatedItemsCommand.d.ts +4 -0
  27. package/dist-types/commands/UpdateReplicationSetCommand.d.ts +4 -0
  28. package/dist-types/commands/UpdateResponsePlanCommand.d.ts +4 -0
  29. package/dist-types/commands/UpdateTimelineEventCommand.d.ts +4 -0
  30. package/package.json +7 -7
@@ -40,6 +40,10 @@ export interface CreateReplicationSetCommandOutput extends CreateReplicationSetO
40
40
  * };
41
41
  * const command = new CreateReplicationSetCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // CreateReplicationSetOutput
44
+ * // arn: "STRING_VALUE", // required
45
+ * // };
46
+ *
43
47
  * ```
44
48
  *
45
49
  * @param CreateReplicationSetCommandInput - {@link CreateReplicationSetCommandInput}
@@ -68,6 +72,8 @@ export interface CreateReplicationSetCommandOutput extends CreateReplicationSetO
68
72
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
69
73
  * service.</p>
70
74
  *
75
+ * @throws {@link SSMIncidentsServiceException}
76
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
71
77
  *
72
78
  */
73
79
  export declare class CreateReplicationSetCommand extends $Command<CreateReplicationSetCommandInput, CreateReplicationSetCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -92,6 +92,10 @@ export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutpu
92
92
  * };
93
93
  * const command = new CreateResponsePlanCommand(input);
94
94
  * const response = await client.send(command);
95
+ * // { // CreateResponsePlanOutput
96
+ * // arn: "STRING_VALUE", // required
97
+ * // };
98
+ *
95
99
  * ```
96
100
  *
97
101
  * @param CreateResponsePlanCommandInput - {@link CreateResponsePlanCommandInput}
@@ -120,6 +124,8 @@ export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutpu
120
124
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
121
125
  * service.</p>
122
126
  *
127
+ * @throws {@link SSMIncidentsServiceException}
128
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
123
129
  *
124
130
  */
125
131
  export declare class CreateResponsePlanCommand extends $Command<CreateResponsePlanCommandInput, CreateResponsePlanCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -44,6 +44,11 @@ export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOut
44
44
  * };
45
45
  * const command = new CreateTimelineEventCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // CreateTimelineEventOutput
48
+ * // incidentRecordArn: "STRING_VALUE", // required
49
+ * // eventId: "STRING_VALUE", // required
50
+ * // };
51
+ *
47
52
  * ```
48
53
  *
49
54
  * @param CreateTimelineEventCommandInput - {@link CreateTimelineEventCommandInput}
@@ -72,6 +77,8 @@ export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOut
72
77
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
73
78
  * service.</p>
74
79
  *
80
+ * @throws {@link SSMIncidentsServiceException}
81
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
75
82
  *
76
83
  */
77
84
  export declare class CreateTimelineEventCommand extends $Command<CreateTimelineEventCommandInput, CreateTimelineEventCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordO
31
31
  * };
32
32
  * const command = new DeleteIncidentRecordCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteIncidentRecordCommandInput - {@link DeleteIncidentRecordCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordO
53
55
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
54
56
  * service.</p>
55
57
  *
58
+ * @throws {@link SSMIncidentsServiceException}
59
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeleteIncidentRecordCommand extends $Command<DeleteIncidentRecordCommandInput, DeleteIncidentRecordCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteReplicationSetCommandOutput extends DeleteReplicationSetO
32
32
  * };
33
33
  * const command = new DeleteReplicationSetCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteReplicationSetCommandInput - {@link DeleteReplicationSetCommandInput}
@@ -57,6 +59,8 @@ export interface DeleteReplicationSetCommandOutput extends DeleteReplicationSetO
57
59
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
60
  * service.</p>
59
61
  *
62
+ * @throws {@link SSMIncidentsServiceException}
63
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
60
64
  *
61
65
  */
62
66
  export declare class DeleteReplicationSetCommand extends $Command<DeleteReplicationSetCommandInput, DeleteReplicationSetCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO
33
33
  * };
34
34
  * const command = new DeleteResourcePolicyCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
@@ -58,6 +60,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO
58
60
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
61
  * service.</p>
60
62
  *
63
+ * @throws {@link SSMIncidentsServiceException}
64
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
61
65
  *
62
66
  */
63
67
  export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteResponsePlanCommandOutput extends DeleteResponsePlanOutpu
32
32
  * };
33
33
  * const command = new DeleteResponsePlanCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteResponsePlanCommandInput - {@link DeleteResponsePlanCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteResponsePlanCommandOutput extends DeleteResponsePlanOutpu
54
56
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
55
57
  * service.</p>
56
58
  *
59
+ * @throws {@link SSMIncidentsServiceException}
60
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteResponsePlanCommand extends $Command<DeleteResponsePlanCommandInput, DeleteResponsePlanCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteTimelineEventCommandOutput extends DeleteTimelineEventOut
32
32
  * };
33
33
  * const command = new DeleteTimelineEventCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteTimelineEventCommandInput - {@link DeleteTimelineEventCommandInput}
@@ -54,6 +56,8 @@ export interface DeleteTimelineEventCommandOutput extends DeleteTimelineEventOut
54
56
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
55
57
  * service.</p>
56
58
  *
59
+ * @throws {@link SSMIncidentsServiceException}
60
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
57
61
  *
58
62
  */
59
63
  export declare class DeleteTimelineEventCommand extends $Command<DeleteTimelineEventCommandInput, DeleteTimelineEventCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -31,6 +31,43 @@ export interface GetIncidentRecordCommandOutput extends GetIncidentRecordOutput,
31
31
  * };
32
32
  * const command = new GetIncidentRecordCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetIncidentRecordOutput
35
+ * // incidentRecord: { // IncidentRecord
36
+ * // arn: "STRING_VALUE", // required
37
+ * // title: "STRING_VALUE", // required
38
+ * // summary: "STRING_VALUE",
39
+ * // status: "STRING_VALUE", // required
40
+ * // impact: Number("int"), // required
41
+ * // creationTime: new Date("TIMESTAMP"), // required
42
+ * // resolvedTime: new Date("TIMESTAMP"),
43
+ * // lastModifiedTime: new Date("TIMESTAMP"), // required
44
+ * // lastModifiedBy: "STRING_VALUE", // required
45
+ * // automationExecutions: [ // AutomationExecutionSet
46
+ * // { // AutomationExecution Union: only one key present
47
+ * // ssmExecutionArn: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // incidentRecordSource: { // IncidentRecordSource
51
+ * // createdBy: "STRING_VALUE", // required
52
+ * // invokedBy: "STRING_VALUE",
53
+ * // resourceArn: "STRING_VALUE",
54
+ * // source: "STRING_VALUE", // required
55
+ * // },
56
+ * // dedupeString: "STRING_VALUE", // required
57
+ * // chatChannel: { // ChatChannel Union: only one key present
58
+ * // empty: {},
59
+ * // chatbotSns: [ // ChatbotSnsConfigurationSet
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // },
63
+ * // notificationTargets: [ // NotificationTargetSet
64
+ * // { // NotificationTargetItem Union: only one key present
65
+ * // snsTopicArn: "STRING_VALUE",
66
+ * // },
67
+ * // ],
68
+ * // },
69
+ * // };
70
+ *
34
71
  * ```
35
72
  *
36
73
  * @param GetIncidentRecordCommandInput - {@link GetIncidentRecordCommandInput}
@@ -56,6 +93,8 @@ export interface GetIncidentRecordCommandOutput extends GetIncidentRecordOutput,
56
93
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
94
  * service.</p>
58
95
  *
96
+ * @throws {@link SSMIncidentsServiceException}
97
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
59
98
  *
60
99
  */
61
100
  export declare class GetIncidentRecordCommand extends $Command<GetIncidentRecordCommandInput, GetIncidentRecordCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -31,6 +31,26 @@ export interface GetReplicationSetCommandOutput extends GetReplicationSetOutput,
31
31
  * };
32
32
  * const command = new GetReplicationSetCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetReplicationSetOutput
35
+ * // replicationSet: { // ReplicationSet
36
+ * // arn: "STRING_VALUE",
37
+ * // regionMap: { // RegionInfoMap // required
38
+ * // "<keys>": { // RegionInfo
39
+ * // sseKmsKeyId: "STRING_VALUE",
40
+ * // status: "STRING_VALUE", // required
41
+ * // statusMessage: "STRING_VALUE",
42
+ * // statusUpdateDateTime: new Date("TIMESTAMP"), // required
43
+ * // },
44
+ * // },
45
+ * // status: "STRING_VALUE", // required
46
+ * // deletionProtected: true || false, // required
47
+ * // createdTime: new Date("TIMESTAMP"), // required
48
+ * // createdBy: "STRING_VALUE", // required
49
+ * // lastModifiedTime: new Date("TIMESTAMP"), // required
50
+ * // lastModifiedBy: "STRING_VALUE", // required
51
+ * // },
52
+ * // };
53
+ *
34
54
  * ```
35
55
  *
36
56
  * @param GetReplicationSetCommandInput - {@link GetReplicationSetCommandInput}
@@ -56,6 +76,8 @@ export interface GetReplicationSetCommandOutput extends GetReplicationSetOutput,
56
76
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
77
  * service.</p>
58
78
  *
79
+ * @throws {@link SSMIncidentsServiceException}
80
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
59
81
  *
60
82
  */
61
83
  export declare class GetReplicationSetCommand extends $Command<GetReplicationSetCommandInput, GetReplicationSetCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -33,6 +33,17 @@ export interface GetResourcePoliciesCommandOutput extends GetResourcePoliciesOut
33
33
  * };
34
34
  * const command = new GetResourcePoliciesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // GetResourcePoliciesOutput
37
+ * // resourcePolicies: [ // ResourcePolicyList // required
38
+ * // { // ResourcePolicy
39
+ * // policyDocument: "STRING_VALUE", // required
40
+ * // policyId: "STRING_VALUE", // required
41
+ * // ramResourceShareRegion: "STRING_VALUE", // required
42
+ * // },
43
+ * // ],
44
+ * // nextToken: "STRING_VALUE",
45
+ * // };
46
+ *
36
47
  * ```
37
48
  *
38
49
  * @param GetResourcePoliciesCommandInput - {@link GetResourcePoliciesCommandInput}
@@ -58,6 +69,8 @@ export interface GetResourcePoliciesCommandOutput extends GetResourcePoliciesOut
58
69
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
59
70
  * service.</p>
60
71
  *
72
+ * @throws {@link SSMIncidentsServiceException}
73
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
61
74
  *
62
75
  */
63
76
  export declare class GetResourcePoliciesCommand extends $Command<GetResourcePoliciesCommandInput, GetResourcePoliciesCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -31,6 +31,66 @@ export interface GetResponsePlanCommandOutput extends GetResponsePlanOutput, __M
31
31
  * };
32
32
  * const command = new GetResponsePlanCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetResponsePlanOutput
35
+ * // arn: "STRING_VALUE", // required
36
+ * // name: "STRING_VALUE", // required
37
+ * // displayName: "STRING_VALUE",
38
+ * // incidentTemplate: { // IncidentTemplate
39
+ * // title: "STRING_VALUE", // required
40
+ * // impact: Number("int"), // required
41
+ * // summary: "STRING_VALUE",
42
+ * // dedupeString: "STRING_VALUE",
43
+ * // notificationTargets: [ // NotificationTargetSet
44
+ * // { // NotificationTargetItem Union: only one key present
45
+ * // snsTopicArn: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // incidentTags: { // TagMap
49
+ * // "<keys>": "STRING_VALUE",
50
+ * // },
51
+ * // },
52
+ * // chatChannel: { // ChatChannel Union: only one key present
53
+ * // empty: {},
54
+ * // chatbotSns: [ // ChatbotSnsConfigurationSet
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // },
58
+ * // engagements: [ // EngagementSet
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // actions: [ // ActionsList
62
+ * // { // Action Union: only one key present
63
+ * // ssmAutomation: { // SsmAutomation
64
+ * // roleArn: "STRING_VALUE", // required
65
+ * // documentName: "STRING_VALUE", // required
66
+ * // documentVersion: "STRING_VALUE",
67
+ * // targetAccount: "STRING_VALUE",
68
+ * // parameters: { // SsmParameters
69
+ * // "<keys>": [ // SsmParameterValues
70
+ * // "STRING_VALUE",
71
+ * // ],
72
+ * // },
73
+ * // dynamicParameters: { // DynamicSsmParameters
74
+ * // "<keys>": { // DynamicSsmParameterValue Union: only one key present
75
+ * // variable: "STRING_VALUE",
76
+ * // },
77
+ * // },
78
+ * // },
79
+ * // },
80
+ * // ],
81
+ * // integrations: [ // Integrations
82
+ * // { // Integration Union: only one key present
83
+ * // pagerDutyConfiguration: { // PagerDutyConfiguration
84
+ * // name: "STRING_VALUE", // required
85
+ * // secretId: "STRING_VALUE", // required
86
+ * // pagerDutyIncidentConfiguration: { // PagerDutyIncidentConfiguration
87
+ * // serviceId: "STRING_VALUE", // required
88
+ * // },
89
+ * // },
90
+ * // },
91
+ * // ],
92
+ * // };
93
+ *
34
94
  * ```
35
95
  *
36
96
  * @param GetResponsePlanCommandInput - {@link GetResponsePlanCommandInput}
@@ -56,6 +116,8 @@ export interface GetResponsePlanCommandOutput extends GetResponsePlanOutput, __M
56
116
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
117
  * service.</p>
58
118
  *
119
+ * @throws {@link SSMIncidentsServiceException}
120
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
59
121
  *
60
122
  */
61
123
  export declare class GetResponsePlanCommand extends $Command<GetResponsePlanCommandInput, GetResponsePlanCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -32,6 +32,23 @@ export interface GetTimelineEventCommandOutput extends GetTimelineEventOutput, _
32
32
  * };
33
33
  * const command = new GetTimelineEventCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // GetTimelineEventOutput
36
+ * // event: { // TimelineEvent
37
+ * // incidentRecordArn: "STRING_VALUE", // required
38
+ * // eventId: "STRING_VALUE", // required
39
+ * // eventTime: new Date("TIMESTAMP"), // required
40
+ * // eventUpdatedTime: new Date("TIMESTAMP"), // required
41
+ * // eventType: "STRING_VALUE", // required
42
+ * // eventData: "STRING_VALUE", // required
43
+ * // eventReferences: [ // EventReferenceList
44
+ * // { // EventReference Union: only one key present
45
+ * // resource: "STRING_VALUE",
46
+ * // relatedItemId: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // },
50
+ * // };
51
+ *
35
52
  * ```
36
53
  *
37
54
  * @param GetTimelineEventCommandInput - {@link GetTimelineEventCommandInput}
@@ -57,6 +74,8 @@ export interface GetTimelineEventCommandOutput extends GetTimelineEventOutput, _
57
74
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
58
75
  * service.</p>
59
76
  *
77
+ * @throws {@link SSMIncidentsServiceException}
78
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
60
79
  *
61
80
  */
62
81
  export declare class GetTimelineEventCommand extends $Command<GetTimelineEventCommandInput, GetTimelineEventCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -50,6 +50,26 @@ export interface ListIncidentRecordsCommandOutput extends ListIncidentRecordsOut
50
50
  * };
51
51
  * const command = new ListIncidentRecordsCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // ListIncidentRecordsOutput
54
+ * // incidentRecordSummaries: [ // IncidentRecordSummaryList // required
55
+ * // { // IncidentRecordSummary
56
+ * // arn: "STRING_VALUE", // required
57
+ * // title: "STRING_VALUE", // required
58
+ * // status: "STRING_VALUE", // required
59
+ * // impact: Number("int"), // required
60
+ * // creationTime: new Date("TIMESTAMP"), // required
61
+ * // resolvedTime: new Date("TIMESTAMP"),
62
+ * // incidentRecordSource: { // IncidentRecordSource
63
+ * // createdBy: "STRING_VALUE", // required
64
+ * // invokedBy: "STRING_VALUE",
65
+ * // resourceArn: "STRING_VALUE",
66
+ * // source: "STRING_VALUE", // required
67
+ * // },
68
+ * // },
69
+ * // ],
70
+ * // nextToken: "STRING_VALUE",
71
+ * // };
72
+ *
53
73
  * ```
54
74
  *
55
75
  * @param ListIncidentRecordsCommandInput - {@link ListIncidentRecordsCommandInput}
@@ -72,6 +92,8 @@ export interface ListIncidentRecordsCommandOutput extends ListIncidentRecordsOut
72
92
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
73
93
  * service.</p>
74
94
  *
95
+ * @throws {@link SSMIncidentsServiceException}
96
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
75
97
  *
76
98
  */
77
99
  export declare class ListIncidentRecordsCommand extends $Command<ListIncidentRecordsCommandInput, ListIncidentRecordsCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -33,6 +33,29 @@ export interface ListRelatedItemsCommandOutput extends ListRelatedItemsOutput, _
33
33
  * };
34
34
  * const command = new ListRelatedItemsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ListRelatedItemsOutput
37
+ * // relatedItems: [ // RelatedItemList // required
38
+ * // { // RelatedItem
39
+ * // identifier: { // ItemIdentifier
40
+ * // value: { // ItemValue Union: only one key present
41
+ * // arn: "STRING_VALUE",
42
+ * // url: "STRING_VALUE",
43
+ * // metricDefinition: "STRING_VALUE",
44
+ * // pagerDutyIncidentDetail: { // PagerDutyIncidentDetail
45
+ * // id: "STRING_VALUE", // required
46
+ * // autoResolve: true || false,
47
+ * // secretId: "STRING_VALUE",
48
+ * // },
49
+ * // },
50
+ * // type: "STRING_VALUE", // required
51
+ * // },
52
+ * // title: "STRING_VALUE",
53
+ * // generatedId: "STRING_VALUE",
54
+ * // },
55
+ * // ],
56
+ * // nextToken: "STRING_VALUE",
57
+ * // };
58
+ *
36
59
  * ```
37
60
  *
38
61
  * @param ListRelatedItemsCommandInput - {@link ListRelatedItemsCommandInput}
@@ -55,6 +78,8 @@ export interface ListRelatedItemsCommandOutput extends ListRelatedItemsOutput, _
55
78
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
56
79
  * service.</p>
57
80
  *
81
+ * @throws {@link SSMIncidentsServiceException}
82
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
58
83
  *
59
84
  */
60
85
  export declare class ListRelatedItemsCommand extends $Command<ListRelatedItemsCommandInput, ListRelatedItemsCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -32,6 +32,13 @@ export interface ListReplicationSetsCommandOutput extends ListReplicationSetsOut
32
32
  * };
33
33
  * const command = new ListReplicationSetsCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListReplicationSetsOutput
36
+ * // replicationSetArns: [ // ReplicationSetArnList // required
37
+ * // "STRING_VALUE",
38
+ * // ],
39
+ * // nextToken: "STRING_VALUE",
40
+ * // };
41
+ *
35
42
  * ```
36
43
  *
37
44
  * @param ListReplicationSetsCommandInput - {@link ListReplicationSetsCommandInput}
@@ -54,6 +61,8 @@ export interface ListReplicationSetsCommandOutput extends ListReplicationSetsOut
54
61
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
55
62
  * service.</p>
56
63
  *
64
+ * @throws {@link SSMIncidentsServiceException}
65
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
57
66
  *
58
67
  */
59
68
  export declare class ListReplicationSetsCommand extends $Command<ListReplicationSetsCommandInput, ListReplicationSetsCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface ListResponsePlansCommandOutput extends ListResponsePlansOutput,
32
32
  * };
33
33
  * const command = new ListResponsePlansCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListResponsePlansOutput
36
+ * // responsePlanSummaries: [ // ResponsePlanSummaryList // required
37
+ * // { // ResponsePlanSummary
38
+ * // arn: "STRING_VALUE", // required
39
+ * // name: "STRING_VALUE", // required
40
+ * // displayName: "STRING_VALUE",
41
+ * // },
42
+ * // ],
43
+ * // nextToken: "STRING_VALUE",
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param ListResponsePlansCommandInput - {@link ListResponsePlansCommandInput}
@@ -54,6 +65,8 @@ export interface ListResponsePlansCommandOutput extends ListResponsePlansOutput,
54
65
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
55
66
  * service.</p>
56
67
  *
68
+ * @throws {@link SSMIncidentsServiceException}
69
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
57
70
  *
58
71
  */
59
72
  export declare class ListResponsePlansCommand extends $Command<ListResponsePlansCommandInput, ListResponsePlansCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
31
31
  * };
32
32
  * const command = new ListTagsForResourceCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // ListTagsForResourceResponse
35
+ * // tags: { // TagMap // required
36
+ * // "<keys>": "STRING_VALUE",
37
+ * // },
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -56,6 +62,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
56
62
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
57
63
  * service.</p>
58
64
  *
65
+ * @throws {@link SSMIncidentsServiceException}
66
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
59
67
  *
60
68
  */
61
69
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -52,6 +52,25 @@ export interface ListTimelineEventsCommandOutput extends ListTimelineEventsOutpu
52
52
  * };
53
53
  * const command = new ListTimelineEventsCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // ListTimelineEventsOutput
56
+ * // eventSummaries: [ // EventSummaryList // required
57
+ * // { // EventSummary
58
+ * // incidentRecordArn: "STRING_VALUE", // required
59
+ * // eventId: "STRING_VALUE", // required
60
+ * // eventTime: new Date("TIMESTAMP"), // required
61
+ * // eventUpdatedTime: new Date("TIMESTAMP"), // required
62
+ * // eventType: "STRING_VALUE", // required
63
+ * // eventReferences: [ // EventReferenceList
64
+ * // { // EventReference Union: only one key present
65
+ * // resource: "STRING_VALUE",
66
+ * // relatedItemId: "STRING_VALUE",
67
+ * // },
68
+ * // ],
69
+ * // },
70
+ * // ],
71
+ * // nextToken: "STRING_VALUE",
72
+ * // };
73
+ *
55
74
  * ```
56
75
  *
57
76
  * @param ListTimelineEventsCommandInput - {@link ListTimelineEventsCommandInput}
@@ -74,6 +93,8 @@ export interface ListTimelineEventsCommandOutput extends ListTimelineEventsOutpu
74
93
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
75
94
  * service.</p>
76
95
  *
96
+ * @throws {@link SSMIncidentsServiceException}
97
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
77
98
  *
78
99
  */
79
100
  export declare class ListTimelineEventsCommand extends $Command<ListTimelineEventsCommandInput, ListTimelineEventsCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -34,6 +34,10 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput,
34
34
  * };
35
35
  * const command = new PutResourcePolicyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // PutResourcePolicyOutput
38
+ * // policyId: "STRING_VALUE", // required
39
+ * // };
40
+ *
37
41
  * ```
38
42
  *
39
43
  * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
@@ -59,6 +63,8 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput,
59
63
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
60
64
  * service.</p>
61
65
  *
66
+ * @throws {@link SSMIncidentsServiceException}
67
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
62
68
  *
63
69
  */
64
70
  export declare class PutResourcePolicyCommand extends $Command<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -60,6 +60,10 @@ export interface StartIncidentCommandOutput extends StartIncidentOutput, __Metad
60
60
  * };
61
61
  * const command = new StartIncidentCommand(input);
62
62
  * const response = await client.send(command);
63
+ * // { // StartIncidentOutput
64
+ * // incidentRecordArn: "STRING_VALUE", // required
65
+ * // };
66
+ *
63
67
  * ```
64
68
  *
65
69
  * @param StartIncidentCommandInput - {@link StartIncidentCommandInput}
@@ -88,6 +92,8 @@ export interface StartIncidentCommandOutput extends StartIncidentOutput, __Metad
88
92
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
89
93
  * service.</p>
90
94
  *
95
+ * @throws {@link SSMIncidentsServiceException}
96
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
91
97
  *
92
98
  */
93
99
  export declare class StartIncidentCommand extends $Command<StartIncidentCommandInput, StartIncidentCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
34
34
  * };
35
35
  * const command = new TagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -65,6 +67,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
65
67
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
66
68
  * service.</p>
67
69
  *
70
+ * @throws {@link SSMIncidentsServiceException}
71
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
68
72
  *
69
73
  */
70
74
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -62,6 +64,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
62
64
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
63
65
  * service.</p>
64
66
  *
67
+ * @throws {@link SSMIncidentsServiceException}
68
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
65
69
  *
66
70
  */
67
71
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UpdateDeletionProtectionCommandOutput extends UpdateDeletionPro
34
34
  * };
35
35
  * const command = new UpdateDeletionProtectionCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UpdateDeletionProtectionCommandInput - {@link UpdateDeletionProtectionCommandInput}
@@ -59,6 +61,8 @@ export interface UpdateDeletionProtectionCommandOutput extends UpdateDeletionPro
59
61
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
60
62
  * service.</p>
61
63
  *
64
+ * @throws {@link SSMIncidentsServiceException}
65
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
62
66
  *
63
67
  */
64
68
  export declare class UpdateDeletionProtectionCommand extends $Command<UpdateDeletionProtectionCommandInput, UpdateDeletionProtectionCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -49,6 +49,8 @@ export interface UpdateIncidentRecordCommandOutput extends UpdateIncidentRecordO
49
49
  * };
50
50
  * const command = new UpdateIncidentRecordCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // {};
53
+ *
52
54
  * ```
53
55
  *
54
56
  * @param UpdateIncidentRecordCommandInput - {@link UpdateIncidentRecordCommandInput}
@@ -77,6 +79,8 @@ export interface UpdateIncidentRecordCommandOutput extends UpdateIncidentRecordO
77
79
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
78
80
  * service.</p>
79
81
  *
82
+ * @throws {@link SSMIncidentsServiceException}
83
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
80
84
  *
81
85
  */
82
86
  export declare class UpdateIncidentRecordCommand extends $Command<UpdateIncidentRecordCommandInput, UpdateIncidentRecordCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -64,6 +64,8 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
64
64
  * };
65
65
  * const command = new UpdateRelatedItemsCommand(input);
66
66
  * const response = await client.send(command);
67
+ * // {};
68
+ *
67
69
  * ```
68
70
  *
69
71
  * @param UpdateRelatedItemsCommandInput - {@link UpdateRelatedItemsCommandInput}
@@ -92,6 +94,8 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
92
94
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
93
95
  * service.</p>
94
96
  *
97
+ * @throws {@link SSMIncidentsServiceException}
98
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
95
99
  *
96
100
  */
97
101
  export declare class UpdateRelatedItemsCommand extends $Command<UpdateRelatedItemsCommandInput, UpdateRelatedItemsCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -43,6 +43,8 @@ export interface UpdateReplicationSetCommandOutput extends UpdateReplicationSetO
43
43
  * };
44
44
  * const command = new UpdateReplicationSetCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // {};
47
+ *
46
48
  * ```
47
49
  *
48
50
  * @param UpdateReplicationSetCommandInput - {@link UpdateReplicationSetCommandInput}
@@ -71,6 +73,8 @@ export interface UpdateReplicationSetCommandOutput extends UpdateReplicationSetO
71
73
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
72
74
  * service.</p>
73
75
  *
76
+ * @throws {@link SSMIncidentsServiceException}
77
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
74
78
  *
75
79
  */
76
80
  export declare class UpdateReplicationSetCommand extends $Command<UpdateReplicationSetCommandInput, UpdateReplicationSetCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -85,6 +85,8 @@ export interface UpdateResponsePlanCommandOutput extends UpdateResponsePlanOutpu
85
85
  * };
86
86
  * const command = new UpdateResponsePlanCommand(input);
87
87
  * const response = await client.send(command);
88
+ * // {};
89
+ *
88
90
  * ```
89
91
  *
90
92
  * @param UpdateResponsePlanCommandInput - {@link UpdateResponsePlanCommandInput}
@@ -113,6 +115,8 @@ export interface UpdateResponsePlanCommandOutput extends UpdateResponsePlanOutpu
113
115
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
114
116
  * service.</p>
115
117
  *
118
+ * @throws {@link SSMIncidentsServiceException}
119
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
116
120
  *
117
121
  */
118
122
  export declare class UpdateResponsePlanCommand extends $Command<UpdateResponsePlanCommandInput, UpdateResponsePlanCommandOutput, SSMIncidentsClientResolvedConfig> {
@@ -42,6 +42,8 @@ export interface UpdateTimelineEventCommandOutput extends UpdateTimelineEventOut
42
42
  * };
43
43
  * const command = new UpdateTimelineEventCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // {};
46
+ *
45
47
  * ```
46
48
  *
47
49
  * @param UpdateTimelineEventCommandInput - {@link UpdateTimelineEventCommandInput}
@@ -70,6 +72,8 @@ export interface UpdateTimelineEventCommandOutput extends UpdateTimelineEventOut
70
72
  * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
71
73
  * service.</p>
72
74
  *
75
+ * @throws {@link SSMIncidentsServiceException}
76
+ * <p>Base exception class for all service exceptions from SSMIncidents service.</p>
73
77
  *
74
78
  */
75
79
  export declare class UpdateTimelineEventCommand extends $Command<UpdateTimelineEventCommandInput, UpdateTimelineEventCommandOutput, SSMIncidentsClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ssm-incidents",
3
3
  "description": "AWS SDK for JavaScript Ssm Incidents Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",