@aws-sdk/client-ssm-incidents 3.295.0 → 3.297.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 (41) hide show
  1. package/dist-types/SSMIncidents.d.ts +30 -0
  2. package/dist-types/SSMIncidentsClient.d.ts +24 -4
  3. package/dist-types/commands/CreateReplicationSetCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateResponsePlanCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateTimelineEventCommand.d.ts +16 -0
  6. package/dist-types/commands/DeleteIncidentRecordCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteReplicationSetCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteResponsePlanCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteTimelineEventCommand.d.ts +16 -0
  11. package/dist-types/commands/GetIncidentRecordCommand.d.ts +16 -0
  12. package/dist-types/commands/GetReplicationSetCommand.d.ts +16 -0
  13. package/dist-types/commands/GetResourcePoliciesCommand.d.ts +16 -0
  14. package/dist-types/commands/GetResponsePlanCommand.d.ts +16 -0
  15. package/dist-types/commands/GetTimelineEventCommand.d.ts +16 -0
  16. package/dist-types/commands/ListIncidentRecordsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListRelatedItemsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListReplicationSetsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListResponsePlansCommand.d.ts +16 -0
  20. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  21. package/dist-types/commands/ListTimelineEventsCommand.d.ts +16 -0
  22. package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -0
  23. package/dist-types/commands/StartIncidentCommand.d.ts +16 -0
  24. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateDeletionProtectionCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateIncidentRecordCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateRelatedItemsCommand.d.ts +16 -0
  29. package/dist-types/commands/UpdateReplicationSetCommand.d.ts +16 -0
  30. package/dist-types/commands/UpdateResponsePlanCommand.d.ts +16 -0
  31. package/dist-types/commands/UpdateTimelineEventCommand.d.ts +16 -0
  32. package/dist-types/models/SSMIncidentsServiceException.d.ts +2 -0
  33. package/dist-types/models/models_0.d.ts +281 -0
  34. package/dist-types/pagination/GetResourcePoliciesPaginator.d.ts +3 -0
  35. package/dist-types/pagination/Interfaces.d.ts +3 -0
  36. package/dist-types/pagination/ListIncidentRecordsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListRelatedItemsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListReplicationSetsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListResponsePlansPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListTimelineEventsPaginator.d.ts +3 -0
  41. package/package.json +30 -30
@@ -30,6 +30,7 @@ import { UpdateResponsePlanCommandInput, UpdateResponsePlanCommandOutput } from
30
30
  import { UpdateTimelineEventCommandInput, UpdateTimelineEventCommandOutput } from "./commands/UpdateTimelineEventCommand";
31
31
  import { SSMIncidentsClient } from "./SSMIncidentsClient";
32
32
  /**
33
+ * @public
33
34
  * <p>Systems Manager Incident Manager is an incident management console designed to help users
34
35
  * mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An
35
36
  * incident is any unplanned interruption or reduction in quality of services. </p>
@@ -41,6 +42,7 @@ import { SSMIncidentsClient } from "./SSMIncidentsClient";
41
42
  */
42
43
  export declare class SSMIncidents extends SSMIncidentsClient {
43
44
  /**
45
+ * @public
44
46
  * <p>A replication set replicates and encrypts your data to the provided Regions with the
45
47
  * provided KMS key. </p>
46
48
  */
@@ -48,6 +50,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
48
50
  createReplicationSet(args: CreateReplicationSetCommandInput, cb: (err: any, data?: CreateReplicationSetCommandOutput) => void): void;
49
51
  createReplicationSet(args: CreateReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationSetCommandOutput) => void): void;
50
52
  /**
53
+ * @public
51
54
  * <p>Creates a response plan that automates the initial response to incidents. A response
52
55
  * plan engages contacts, starts chat channel collaboration, and initiates runbooks at the
53
56
  * beginning of an incident.</p>
@@ -56,6 +59,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
56
59
  createResponsePlan(args: CreateResponsePlanCommandInput, cb: (err: any, data?: CreateResponsePlanCommandOutput) => void): void;
57
60
  createResponsePlan(args: CreateResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResponsePlanCommandOutput) => void): void;
58
61
  /**
62
+ * @public
59
63
  * <p>Creates a custom timeline event on the incident details page of an incident record.
60
64
  * Timeline events are automatically created by Incident Manager, marking key moment during an
61
65
  * incident. You can create custom timeline events to mark important events that are
@@ -65,12 +69,14 @@ export declare class SSMIncidents extends SSMIncidentsClient {
65
69
  createTimelineEvent(args: CreateTimelineEventCommandInput, cb: (err: any, data?: CreateTimelineEventCommandOutput) => void): void;
66
70
  createTimelineEvent(args: CreateTimelineEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTimelineEventCommandOutput) => void): void;
67
71
  /**
72
+ * @public
68
73
  * <p>Delete an incident record from Incident Manager. </p>
69
74
  */
70
75
  deleteIncidentRecord(args: DeleteIncidentRecordCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIncidentRecordCommandOutput>;
71
76
  deleteIncidentRecord(args: DeleteIncidentRecordCommandInput, cb: (err: any, data?: DeleteIncidentRecordCommandOutput) => void): void;
72
77
  deleteIncidentRecord(args: DeleteIncidentRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIncidentRecordCommandOutput) => void): void;
73
78
  /**
79
+ * @public
74
80
  * <p>Deletes all Regions in your replication set. Deleting the replication set deletes all
75
81
  * Incident Manager data.</p>
76
82
  */
@@ -78,6 +84,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
78
84
  deleteReplicationSet(args: DeleteReplicationSetCommandInput, cb: (err: any, data?: DeleteReplicationSetCommandOutput) => void): void;
79
85
  deleteReplicationSet(args: DeleteReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteReplicationSetCommandOutput) => void): void;
80
86
  /**
87
+ * @public
81
88
  * <p>Deletes the resource policy that Resource Access Manager uses to share your Incident Manager
82
89
  * resource.</p>
83
90
  */
@@ -85,6 +92,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
85
92
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
86
93
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
87
94
  /**
95
+ * @public
88
96
  * <p>Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this
89
97
  * response plan.</p>
90
98
  */
@@ -92,42 +100,49 @@ export declare class SSMIncidents extends SSMIncidentsClient {
92
100
  deleteResponsePlan(args: DeleteResponsePlanCommandInput, cb: (err: any, data?: DeleteResponsePlanCommandOutput) => void): void;
93
101
  deleteResponsePlan(args: DeleteResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResponsePlanCommandOutput) => void): void;
94
102
  /**
103
+ * @public
95
104
  * <p>Deletes a timeline event from an incident.</p>
96
105
  */
97
106
  deleteTimelineEvent(args: DeleteTimelineEventCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTimelineEventCommandOutput>;
98
107
  deleteTimelineEvent(args: DeleteTimelineEventCommandInput, cb: (err: any, data?: DeleteTimelineEventCommandOutput) => void): void;
99
108
  deleteTimelineEvent(args: DeleteTimelineEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTimelineEventCommandOutput) => void): void;
100
109
  /**
110
+ * @public
101
111
  * <p>Returns the details for the specified incident record.</p>
102
112
  */
103
113
  getIncidentRecord(args: GetIncidentRecordCommandInput, options?: __HttpHandlerOptions): Promise<GetIncidentRecordCommandOutput>;
104
114
  getIncidentRecord(args: GetIncidentRecordCommandInput, cb: (err: any, data?: GetIncidentRecordCommandOutput) => void): void;
105
115
  getIncidentRecord(args: GetIncidentRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIncidentRecordCommandOutput) => void): void;
106
116
  /**
117
+ * @public
107
118
  * <p>Retrieve your Incident Manager replication set.</p>
108
119
  */
109
120
  getReplicationSet(args: GetReplicationSetCommandInput, options?: __HttpHandlerOptions): Promise<GetReplicationSetCommandOutput>;
110
121
  getReplicationSet(args: GetReplicationSetCommandInput, cb: (err: any, data?: GetReplicationSetCommandOutput) => void): void;
111
122
  getReplicationSet(args: GetReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetReplicationSetCommandOutput) => void): void;
112
123
  /**
124
+ * @public
113
125
  * <p>Retrieves the resource policies attached to the specified response plan.</p>
114
126
  */
115
127
  getResourcePolicies(args: GetResourcePoliciesCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcePoliciesCommandOutput>;
116
128
  getResourcePolicies(args: GetResourcePoliciesCommandInput, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void): void;
117
129
  getResourcePolicies(args: GetResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcePoliciesCommandOutput) => void): void;
118
130
  /**
131
+ * @public
119
132
  * <p>Retrieves the details of the specified response plan.</p>
120
133
  */
121
134
  getResponsePlan(args: GetResponsePlanCommandInput, options?: __HttpHandlerOptions): Promise<GetResponsePlanCommandOutput>;
122
135
  getResponsePlan(args: GetResponsePlanCommandInput, cb: (err: any, data?: GetResponsePlanCommandOutput) => void): void;
123
136
  getResponsePlan(args: GetResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResponsePlanCommandOutput) => void): void;
124
137
  /**
138
+ * @public
125
139
  * <p>Retrieves a timeline event based on its ID and incident record.</p>
126
140
  */
127
141
  getTimelineEvent(args: GetTimelineEventCommandInput, options?: __HttpHandlerOptions): Promise<GetTimelineEventCommandOutput>;
128
142
  getTimelineEvent(args: GetTimelineEventCommandInput, cb: (err: any, data?: GetTimelineEventCommandOutput) => void): void;
129
143
  getTimelineEvent(args: GetTimelineEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTimelineEventCommandOutput) => void): void;
130
144
  /**
145
+ * @public
131
146
  * <p>Lists all incident records in your account. Use this command to retrieve the Amazon
132
147
  * Resource Name (ARN) of the incident record you want to update. </p>
133
148
  */
@@ -135,36 +150,42 @@ export declare class SSMIncidents extends SSMIncidentsClient {
135
150
  listIncidentRecords(args: ListIncidentRecordsCommandInput, cb: (err: any, data?: ListIncidentRecordsCommandOutput) => void): void;
136
151
  listIncidentRecords(args: ListIncidentRecordsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIncidentRecordsCommandOutput) => void): void;
137
152
  /**
153
+ * @public
138
154
  * <p>List all related items for an incident record.</p>
139
155
  */
140
156
  listRelatedItems(args: ListRelatedItemsCommandInput, options?: __HttpHandlerOptions): Promise<ListRelatedItemsCommandOutput>;
141
157
  listRelatedItems(args: ListRelatedItemsCommandInput, cb: (err: any, data?: ListRelatedItemsCommandOutput) => void): void;
142
158
  listRelatedItems(args: ListRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRelatedItemsCommandOutput) => void): void;
143
159
  /**
160
+ * @public
144
161
  * <p>Lists details about the replication set configured in your account. </p>
145
162
  */
146
163
  listReplicationSets(args: ListReplicationSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListReplicationSetsCommandOutput>;
147
164
  listReplicationSets(args: ListReplicationSetsCommandInput, cb: (err: any, data?: ListReplicationSetsCommandOutput) => void): void;
148
165
  listReplicationSets(args: ListReplicationSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListReplicationSetsCommandOutput) => void): void;
149
166
  /**
167
+ * @public
150
168
  * <p>Lists all response plans in your account.</p>
151
169
  */
152
170
  listResponsePlans(args: ListResponsePlansCommandInput, options?: __HttpHandlerOptions): Promise<ListResponsePlansCommandOutput>;
153
171
  listResponsePlans(args: ListResponsePlansCommandInput, cb: (err: any, data?: ListResponsePlansCommandOutput) => void): void;
154
172
  listResponsePlans(args: ListResponsePlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResponsePlansCommandOutput) => void): void;
155
173
  /**
174
+ * @public
156
175
  * <p>Lists the tags that are attached to the specified response plan.</p>
157
176
  */
158
177
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
159
178
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
160
179
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
161
180
  /**
181
+ * @public
162
182
  * <p>Lists timeline events for the specified incident record.</p>
163
183
  */
164
184
  listTimelineEvents(args: ListTimelineEventsCommandInput, options?: __HttpHandlerOptions): Promise<ListTimelineEventsCommandOutput>;
165
185
  listTimelineEvents(args: ListTimelineEventsCommandInput, cb: (err: any, data?: ListTimelineEventsCommandOutput) => void): void;
166
186
  listTimelineEvents(args: ListTimelineEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTimelineEventsCommandOutput) => void): void;
167
187
  /**
188
+ * @public
168
189
  * <p>Adds a resource policy to the specified response plan. The resource policy is used to
169
190
  * share the response plan using Resource Access Manager (RAM). For more
170
191
  * information about cross-account sharing, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-cross-account-cross-region.html">Cross-Region and cross-account incident
@@ -174,6 +195,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
174
195
  putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
175
196
  putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
176
197
  /**
198
+ * @public
177
199
  * <p>Used to start an incident from CloudWatch alarms, EventBridge events, or
178
200
  * manually. </p>
179
201
  */
@@ -181,18 +203,21 @@ export declare class SSMIncidents extends SSMIncidentsClient {
181
203
  startIncident(args: StartIncidentCommandInput, cb: (err: any, data?: StartIncidentCommandOutput) => void): void;
182
204
  startIncident(args: StartIncidentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartIncidentCommandOutput) => void): void;
183
205
  /**
206
+ * @public
184
207
  * <p>Adds a tag to a response plan.</p>
185
208
  */
186
209
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
187
210
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
188
211
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
189
212
  /**
213
+ * @public
190
214
  * <p>Removes a tag from a resource.</p>
191
215
  */
192
216
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
193
217
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
194
218
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
195
219
  /**
220
+ * @public
196
221
  * <p>Update deletion protection to either allow or deny deletion of the final Region in a
197
222
  * replication set.</p>
198
223
  */
@@ -200,6 +225,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
200
225
  updateDeletionProtection(args: UpdateDeletionProtectionCommandInput, cb: (err: any, data?: UpdateDeletionProtectionCommandOutput) => void): void;
201
226
  updateDeletionProtection(args: UpdateDeletionProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeletionProtectionCommandOutput) => void): void;
202
227
  /**
228
+ * @public
203
229
  * <p>Update the details of an incident record. You can use this operation to update an
204
230
  * incident record from the defined chat channel. For more information about using actions
205
231
  * in chat channels, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact">Interacting through chat</a>.</p>
@@ -208,24 +234,28 @@ export declare class SSMIncidents extends SSMIncidentsClient {
208
234
  updateIncidentRecord(args: UpdateIncidentRecordCommandInput, cb: (err: any, data?: UpdateIncidentRecordCommandOutput) => void): void;
209
235
  updateIncidentRecord(args: UpdateIncidentRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIncidentRecordCommandOutput) => void): void;
210
236
  /**
237
+ * @public
211
238
  * <p>Add or remove related items from the related items tab of an incident record.</p>
212
239
  */
213
240
  updateRelatedItems(args: UpdateRelatedItemsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRelatedItemsCommandOutput>;
214
241
  updateRelatedItems(args: UpdateRelatedItemsCommandInput, cb: (err: any, data?: UpdateRelatedItemsCommandOutput) => void): void;
215
242
  updateRelatedItems(args: UpdateRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRelatedItemsCommandOutput) => void): void;
216
243
  /**
244
+ * @public
217
245
  * <p>Add or delete Regions from your replication set.</p>
218
246
  */
219
247
  updateReplicationSet(args: UpdateReplicationSetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateReplicationSetCommandOutput>;
220
248
  updateReplicationSet(args: UpdateReplicationSetCommandInput, cb: (err: any, data?: UpdateReplicationSetCommandOutput) => void): void;
221
249
  updateReplicationSet(args: UpdateReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateReplicationSetCommandOutput) => void): void;
222
250
  /**
251
+ * @public
223
252
  * <p>Updates the specified response plan.</p>
224
253
  */
225
254
  updateResponsePlan(args: UpdateResponsePlanCommandInput, options?: __HttpHandlerOptions): Promise<UpdateResponsePlanCommandOutput>;
226
255
  updateResponsePlan(args: UpdateResponsePlanCommandInput, cb: (err: any, data?: UpdateResponsePlanCommandOutput) => void): void;
227
256
  updateResponsePlan(args: UpdateResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResponsePlanCommandOutput) => void): void;
228
257
  /**
258
+ * @public
229
259
  * <p>Updates a timeline event. You can update events of type <code>Custom
230
260
  * Event</code>.</p>
231
261
  */
@@ -37,15 +37,24 @@ import { UpdateReplicationSetCommandInput, UpdateReplicationSetCommandOutput } f
37
37
  import { UpdateResponsePlanCommandInput, UpdateResponsePlanCommandOutput } from "./commands/UpdateResponsePlanCommand";
38
38
  import { UpdateTimelineEventCommandInput, UpdateTimelineEventCommandOutput } from "./commands/UpdateTimelineEventCommand";
39
39
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
40
+ /**
41
+ * @public
42
+ */
40
43
  export type ServiceInputTypes = CreateReplicationSetCommandInput | CreateResponsePlanCommandInput | CreateTimelineEventCommandInput | DeleteIncidentRecordCommandInput | DeleteReplicationSetCommandInput | DeleteResourcePolicyCommandInput | DeleteResponsePlanCommandInput | DeleteTimelineEventCommandInput | GetIncidentRecordCommandInput | GetReplicationSetCommandInput | GetResourcePoliciesCommandInput | GetResponsePlanCommandInput | GetTimelineEventCommandInput | ListIncidentRecordsCommandInput | ListRelatedItemsCommandInput | ListReplicationSetsCommandInput | ListResponsePlansCommandInput | ListTagsForResourceCommandInput | ListTimelineEventsCommandInput | PutResourcePolicyCommandInput | StartIncidentCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDeletionProtectionCommandInput | UpdateIncidentRecordCommandInput | UpdateRelatedItemsCommandInput | UpdateReplicationSetCommandInput | UpdateResponsePlanCommandInput | UpdateTimelineEventCommandInput;
44
+ /**
45
+ * @public
46
+ */
41
47
  export type ServiceOutputTypes = CreateReplicationSetCommandOutput | CreateResponsePlanCommandOutput | CreateTimelineEventCommandOutput | DeleteIncidentRecordCommandOutput | DeleteReplicationSetCommandOutput | DeleteResourcePolicyCommandOutput | DeleteResponsePlanCommandOutput | DeleteTimelineEventCommandOutput | GetIncidentRecordCommandOutput | GetReplicationSetCommandOutput | GetResourcePoliciesCommandOutput | GetResponsePlanCommandOutput | GetTimelineEventCommandOutput | ListIncidentRecordsCommandOutput | ListRelatedItemsCommandOutput | ListReplicationSetsCommandOutput | ListResponsePlansCommandOutput | ListTagsForResourceCommandOutput | ListTimelineEventsCommandOutput | PutResourcePolicyCommandOutput | StartIncidentCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDeletionProtectionCommandOutput | UpdateIncidentRecordCommandOutput | UpdateRelatedItemsCommandOutput | UpdateReplicationSetCommandOutput | UpdateResponsePlanCommandOutput | UpdateTimelineEventCommandOutput;
48
+ /**
49
+ * @public
50
+ */
42
51
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
43
52
  /**
44
53
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
45
54
  */
46
55
  requestHandler?: __HttpHandler;
47
56
  /**
48
- * A constructor for a class implementing the {@link __Checksum} interface
57
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
49
58
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
50
59
  * @internal
51
60
  */
@@ -135,23 +144,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
135
144
  */
136
145
  logger?: __Logger;
137
146
  /**
138
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
147
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
139
148
  */
140
149
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
141
150
  }
151
+ /**
152
+ * @public
153
+ */
142
154
  type SSMIncidentsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
143
155
  /**
144
- * The configuration interface of SSMIncidentsClient class constructor that set the region, credentials and other options.
156
+ * @public
157
+ *
158
+ * The configuration interface of SSMIncidentsClient class constructor that set the region, credentials and other options.
145
159
  */
146
160
  export interface SSMIncidentsClientConfig extends SSMIncidentsClientConfigType {
147
161
  }
162
+ /**
163
+ * @public
164
+ */
148
165
  type SSMIncidentsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
149
166
  /**
150
- * The resolved configuration interface of SSMIncidentsClient class. This is resolved and normalized from the {@link SSMIncidentsClientConfig | constructor configuration interface}.
167
+ * @public
168
+ *
169
+ * The resolved configuration interface of SSMIncidentsClient class. This is resolved and normalized from the {@link SSMIncidentsClientConfig | constructor configuration interface}.
151
170
  */
152
171
  export interface SSMIncidentsClientResolvedConfig extends SSMIncidentsClientResolvedConfigType {
153
172
  }
154
173
  /**
174
+ * @public
155
175
  * <p>Systems Manager Incident Manager is an incident management console designed to help users
156
176
  * mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An
157
177
  * incident is any unplanned interruption or reduction in quality of services. </p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateReplicationSetInput, CreateReplicationSetOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateReplicationSetCommand}.
8
10
  */
9
11
  export interface CreateReplicationSetCommandInput extends CreateReplicationSetInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateReplicationSetCommand}.
13
17
  */
14
18
  export interface CreateReplicationSetCommandOutput extends CreateReplicationSetOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A replication set replicates and encrypts your data to the provided Regions with the
18
23
  * provided KMS key. </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateReplicationSetCommandOutput extends CreateReplicationSetO
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateReplicationSetCommandInput - {@link CreateReplicationSetCommandInput}
35
+ * @returns {@link CreateReplicationSetCommandOutput}
29
36
  * @see {@link CreateReplicationSetCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateReplicationSetCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateReplicationSetCommandOutput extends CreateReplicationSetO
55
62
  export declare class CreateReplicationSetCommand extends $Command<CreateReplicationSetCommandInput, CreateReplicationSetCommandOutput, SSMIncidentsClientResolvedConfig> {
56
63
  readonly input: CreateReplicationSetCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateReplicationSetCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateReplicationSetCommandInput, CreateReplicationSetCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateResponsePlanInput, CreateResponsePlanOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateResponsePlanCommand}.
8
10
  */
9
11
  export interface CreateResponsePlanCommandInput extends CreateResponsePlanInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateResponsePlanCommand}.
13
17
  */
14
18
  export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a response plan that automates the initial response to incidents. A response
18
23
  * plan engages contacts, starts chat channel collaboration, and initiates runbooks at the
19
24
  * beginning of an incident.</p>
@@ -27,6 +32,8 @@ export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutpu
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateResponsePlanCommandInput - {@link CreateResponsePlanCommandInput}
36
+ * @returns {@link CreateResponsePlanCommandOutput}
30
37
  * @see {@link CreateResponsePlanCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateResponsePlanCommandOutput} for command's `response` shape.
32
39
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -56,11 +63,20 @@ export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutpu
56
63
  export declare class CreateResponsePlanCommand extends $Command<CreateResponsePlanCommandInput, CreateResponsePlanCommandOutput, SSMIncidentsClientResolvedConfig> {
57
64
  readonly input: CreateResponsePlanCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: CreateResponsePlanCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateResponsePlanCommandInput, CreateResponsePlanCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateTimelineEventInput, CreateTimelineEventOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateTimelineEventCommand}.
8
10
  */
9
11
  export interface CreateTimelineEventCommandInput extends CreateTimelineEventInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateTimelineEventCommand}.
13
17
  */
14
18
  export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a custom timeline event on the incident details page of an incident record.
18
23
  * Timeline events are automatically created by Incident Manager, marking key moment during an
19
24
  * incident. You can create custom timeline events to mark important events that are
@@ -28,6 +33,8 @@ export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOut
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param CreateTimelineEventCommandInput - {@link CreateTimelineEventCommandInput}
37
+ * @returns {@link CreateTimelineEventCommandOutput}
31
38
  * @see {@link CreateTimelineEventCommandInput} for command's `input` shape.
32
39
  * @see {@link CreateTimelineEventCommandOutput} for command's `response` shape.
33
40
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOut
57
64
  export declare class CreateTimelineEventCommand extends $Command<CreateTimelineEventCommandInput, CreateTimelineEventCommandOutput, SSMIncidentsClientResolvedConfig> {
58
65
  readonly input: CreateTimelineEventCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: CreateTimelineEventCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateTimelineEventCommandInput, CreateTimelineEventCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteIncidentRecordInput, DeleteIncidentRecordOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteIncidentRecordCommand}.
8
10
  */
9
11
  export interface DeleteIncidentRecordCommandInput extends DeleteIncidentRecordInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteIncidentRecordCommand}.
13
17
  */
14
18
  export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Delete an incident record from Incident Manager. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordO
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteIncidentRecordCommandInput - {@link DeleteIncidentRecordCommandInput}
34
+ * @returns {@link DeleteIncidentRecordCommandOutput}
28
35
  * @see {@link DeleteIncidentRecordCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteIncidentRecordCommandOutput} for command's `response` shape.
30
37
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordO
48
55
  export declare class DeleteIncidentRecordCommand extends $Command<DeleteIncidentRecordCommandInput, DeleteIncidentRecordCommandOutput, SSMIncidentsClientResolvedConfig> {
49
56
  readonly input: DeleteIncidentRecordCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteIncidentRecordCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteIncidentRecordCommandInput, DeleteIncidentRecordCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteReplicationSetInput, DeleteReplicationSetOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteReplicationSetCommand}.
8
10
  */
9
11
  export interface DeleteReplicationSetCommandInput extends DeleteReplicationSetInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteReplicationSetCommand}.
13
17
  */
14
18
  export interface DeleteReplicationSetCommandOutput extends DeleteReplicationSetOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes all Regions in your replication set. Deleting the replication set deletes all
18
23
  * Incident Manager data.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteReplicationSetCommandOutput extends DeleteReplicationSetO
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteReplicationSetCommandInput - {@link DeleteReplicationSetCommandInput}
35
+ * @returns {@link DeleteReplicationSetCommandOutput}
29
36
  * @see {@link DeleteReplicationSetCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteReplicationSetCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteReplicationSetCommandOutput extends DeleteReplicationSetO
52
59
  export declare class DeleteReplicationSetCommand extends $Command<DeleteReplicationSetCommandInput, DeleteReplicationSetCommandOutput, SSMIncidentsClientResolvedConfig> {
53
60
  readonly input: DeleteReplicationSetCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteReplicationSetCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteReplicationSetCommandInput, DeleteReplicationSetCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteResourcePolicyInput, DeleteResourcePolicyOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteResourcePolicyCommand}.
8
10
  */
9
11
  export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteResourcePolicyCommand}.
13
17
  */
14
18
  export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the resource policy that Resource Access Manager uses to share your Incident Manager
18
23
  * resource.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
35
+ * @returns {@link DeleteResourcePolicyCommandOutput}
29
36
  * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO
52
59
  export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, SSMIncidentsClientResolvedConfig> {
53
60
  readonly input: DeleteResourcePolicyCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteResourcePolicyCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteResponsePlanInput, DeleteResponsePlanOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SSMIncidentsClientResolvedConfig } from "../SSMIncidentsClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteResponsePlanCommand}.
8
10
  */
9
11
  export interface DeleteResponsePlanCommandInput extends DeleteResponsePlanInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteResponsePlanCommand}.
13
17
  */
14
18
  export interface DeleteResponsePlanCommandOutput extends DeleteResponsePlanOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this
18
23
  * response plan.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteResponsePlanCommandOutput extends DeleteResponsePlanOutpu
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteResponsePlanCommandInput - {@link DeleteResponsePlanCommandInput}
35
+ * @returns {@link DeleteResponsePlanCommandOutput}
29
36
  * @see {@link DeleteResponsePlanCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteResponsePlanCommandOutput} for command's `response` shape.
31
38
  * @see {@link SSMIncidentsClientResolvedConfig | config} for SSMIncidentsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteResponsePlanCommandOutput extends DeleteResponsePlanOutpu
49
56
  export declare class DeleteResponsePlanCommand extends $Command<DeleteResponsePlanCommandInput, DeleteResponsePlanCommandOutput, SSMIncidentsClientResolvedConfig> {
50
57
  readonly input: DeleteResponsePlanCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteResponsePlanCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SSMIncidentsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteResponsePlanCommandInput, DeleteResponsePlanCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }