@aws-sdk/client-ssm-incidents 3.299.0 → 3.301.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.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/SSMIncidents.d.ts +20 -22
- package/dist-types/commands/CreateReplicationSetCommand.d.ts +12 -1
- package/dist-types/commands/CreateResponsePlanCommand.d.ts +65 -3
- package/dist-types/commands/CreateTimelineEventCommand.d.ts +16 -3
- package/dist-types/commands/DeleteIncidentRecordCommand.d.ts +3 -0
- package/dist-types/commands/DeleteReplicationSetCommand.d.ts +4 -1
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +5 -1
- package/dist-types/commands/DeleteResponsePlanCommand.d.ts +5 -2
- package/dist-types/commands/DeleteTimelineEventCommand.d.ts +4 -0
- package/dist-types/commands/GetIncidentRecordCommand.d.ts +3 -0
- package/dist-types/commands/GetReplicationSetCommand.d.ts +3 -0
- package/dist-types/commands/GetResourcePoliciesCommand.d.ts +5 -0
- package/dist-types/commands/GetResponsePlanCommand.d.ts +3 -0
- package/dist-types/commands/GetTimelineEventCommand.d.ts +4 -0
- package/dist-types/commands/ListIncidentRecordsCommand.d.ts +22 -1
- package/dist-types/commands/ListRelatedItemsCommand.d.ts +5 -0
- package/dist-types/commands/ListReplicationSetsCommand.d.ts +4 -0
- package/dist-types/commands/ListResponsePlansCommand.d.ts +4 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
- package/dist-types/commands/ListTimelineEventsCommand.d.ts +24 -0
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +6 -3
- package/dist-types/commands/StartIncidentCommand.d.ts +32 -1
- package/dist-types/commands/TagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateDeletionProtectionCommand.d.ts +6 -1
- package/dist-types/commands/UpdateIncidentRecordCommand.d.ts +22 -3
- package/dist-types/commands/UpdateRelatedItemsCommand.d.ts +36 -0
- package/dist-types/commands/UpdateReplicationSetCommand.d.ts +15 -0
- package/dist-types/commands/UpdateResponsePlanCommand.d.ts +57 -0
- package/dist-types/commands/UpdateTimelineEventCommand.d.ts +15 -2
- package/dist-types/models/models_0.d.ts +210 -236
- package/package.json +8 -8
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ssm-incidents-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ssm-incidents-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ssm-incidents.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://ssm-incidents.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ssm-incidents-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ssm-incidents-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://ssm-incidents.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://ssm-incidents.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -44,16 +44,16 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
44
44
|
/**
|
|
45
45
|
* @public
|
|
46
46
|
* <p>A replication set replicates and encrypts your data to the provided Regions with the
|
|
47
|
-
*
|
|
47
|
+
* provided KMS key. </p>
|
|
48
48
|
*/
|
|
49
49
|
createReplicationSet(args: CreateReplicationSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateReplicationSetCommandOutput>;
|
|
50
50
|
createReplicationSet(args: CreateReplicationSetCommandInput, cb: (err: any, data?: CreateReplicationSetCommandOutput) => void): void;
|
|
51
51
|
createReplicationSet(args: CreateReplicationSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateReplicationSetCommandOutput) => void): void;
|
|
52
52
|
/**
|
|
53
53
|
* @public
|
|
54
|
-
* <p>Creates a response plan that automates the initial response to incidents. A response
|
|
55
|
-
*
|
|
56
|
-
*
|
|
54
|
+
* <p>Creates a response plan that automates the initial response to incidents. A response plan
|
|
55
|
+
* engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning
|
|
56
|
+
* of an incident.</p>
|
|
57
57
|
*/
|
|
58
58
|
createResponsePlan(args: CreateResponsePlanCommandInput, options?: __HttpHandlerOptions): Promise<CreateResponsePlanCommandOutput>;
|
|
59
59
|
createResponsePlan(args: CreateResponsePlanCommandInput, cb: (err: any, data?: CreateResponsePlanCommandOutput) => void): void;
|
|
@@ -61,9 +61,9 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
61
61
|
/**
|
|
62
62
|
* @public
|
|
63
63
|
* <p>Creates a custom timeline event on the incident details page of an incident record.
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
64
|
+
* Incident Manager automatically creates timeline events that mark key moments during an incident.
|
|
65
|
+
* You can create custom timeline events to mark important events that Incident Manager can detect
|
|
66
|
+
* automatically.</p>
|
|
67
67
|
*/
|
|
68
68
|
createTimelineEvent(args: CreateTimelineEventCommandInput, options?: __HttpHandlerOptions): Promise<CreateTimelineEventCommandOutput>;
|
|
69
69
|
createTimelineEvent(args: CreateTimelineEventCommandInput, cb: (err: any, data?: CreateTimelineEventCommandOutput) => void): void;
|
|
@@ -78,7 +78,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
78
78
|
/**
|
|
79
79
|
* @public
|
|
80
80
|
* <p>Deletes all Regions in your replication set. Deleting the replication set deletes all
|
|
81
|
-
*
|
|
81
|
+
* Incident Manager data.</p>
|
|
82
82
|
*/
|
|
83
83
|
deleteReplicationSet(args: DeleteReplicationSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteReplicationSetCommandOutput>;
|
|
84
84
|
deleteReplicationSet(args: DeleteReplicationSetCommandInput, cb: (err: any, data?: DeleteReplicationSetCommandOutput) => void): void;
|
|
@@ -86,15 +86,15 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
86
86
|
/**
|
|
87
87
|
* @public
|
|
88
88
|
* <p>Deletes the resource policy that Resource Access Manager uses to share your Incident Manager
|
|
89
|
-
*
|
|
89
|
+
* resource.</p>
|
|
90
90
|
*/
|
|
91
91
|
deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
|
|
92
92
|
deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
|
|
93
93
|
deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
|
|
94
94
|
/**
|
|
95
95
|
* @public
|
|
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
|
|
97
|
-
*
|
|
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 response
|
|
97
|
+
* plan.</p>
|
|
98
98
|
*/
|
|
99
99
|
deleteResponsePlan(args: DeleteResponsePlanCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResponsePlanCommandOutput>;
|
|
100
100
|
deleteResponsePlan(args: DeleteResponsePlanCommandInput, cb: (err: any, data?: DeleteResponsePlanCommandOutput) => void): void;
|
|
@@ -144,7 +144,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
144
144
|
/**
|
|
145
145
|
* @public
|
|
146
146
|
* <p>Lists all incident records in your account. Use this command to retrieve the Amazon
|
|
147
|
-
*
|
|
147
|
+
* Resource Name (ARN) of the incident record you want to update. </p>
|
|
148
148
|
*/
|
|
149
149
|
listIncidentRecords(args: ListIncidentRecordsCommandInput, options?: __HttpHandlerOptions): Promise<ListIncidentRecordsCommandOutput>;
|
|
150
150
|
listIncidentRecords(args: ListIncidentRecordsCommandInput, cb: (err: any, data?: ListIncidentRecordsCommandOutput) => void): void;
|
|
@@ -187,9 +187,8 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
187
187
|
/**
|
|
188
188
|
* @public
|
|
189
189
|
* <p>Adds a resource policy to the specified response plan. The resource policy is used to
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
* management</a>.</p>
|
|
190
|
+
* share the response plan using Resource Access Manager (RAM). For more
|
|
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 management</a>.</p>
|
|
193
192
|
*/
|
|
194
193
|
putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
|
|
195
194
|
putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
|
|
@@ -197,7 +196,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
197
196
|
/**
|
|
198
197
|
* @public
|
|
199
198
|
* <p>Used to start an incident from CloudWatch alarms, EventBridge events, or
|
|
200
|
-
*
|
|
199
|
+
* manually. </p>
|
|
201
200
|
*/
|
|
202
201
|
startIncident(args: StartIncidentCommandInput, options?: __HttpHandlerOptions): Promise<StartIncidentCommandOutput>;
|
|
203
202
|
startIncident(args: StartIncidentCommandInput, cb: (err: any, data?: StartIncidentCommandOutput) => void): void;
|
|
@@ -219,16 +218,16 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
219
218
|
/**
|
|
220
219
|
* @public
|
|
221
220
|
* <p>Update deletion protection to either allow or deny deletion of the final Region in a
|
|
222
|
-
*
|
|
221
|
+
* replication set.</p>
|
|
223
222
|
*/
|
|
224
223
|
updateDeletionProtection(args: UpdateDeletionProtectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDeletionProtectionCommandOutput>;
|
|
225
224
|
updateDeletionProtection(args: UpdateDeletionProtectionCommandInput, cb: (err: any, data?: UpdateDeletionProtectionCommandOutput) => void): void;
|
|
226
225
|
updateDeletionProtection(args: UpdateDeletionProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDeletionProtectionCommandOutput) => void): void;
|
|
227
226
|
/**
|
|
228
227
|
* @public
|
|
229
|
-
* <p>Update the details of an incident record. You can use this operation to update an
|
|
230
|
-
*
|
|
231
|
-
*
|
|
228
|
+
* <p>Update the details of an incident record. You can use this operation to update an incident
|
|
229
|
+
* record from the defined chat channel. For more information about using actions in chat
|
|
230
|
+
* channels, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact">Interacting through chat</a>.</p>
|
|
232
231
|
*/
|
|
233
232
|
updateIncidentRecord(args: UpdateIncidentRecordCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIncidentRecordCommandOutput>;
|
|
234
233
|
updateIncidentRecord(args: UpdateIncidentRecordCommandInput, cb: (err: any, data?: UpdateIncidentRecordCommandOutput) => void): void;
|
|
@@ -256,8 +255,7 @@ export declare class SSMIncidents extends SSMIncidentsClient {
|
|
|
256
255
|
updateResponsePlan(args: UpdateResponsePlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateResponsePlanCommandOutput) => void): void;
|
|
257
256
|
/**
|
|
258
257
|
* @public
|
|
259
|
-
* <p>Updates a timeline event. You can update events of type <code>Custom
|
|
260
|
-
* Event</code>.</p>
|
|
258
|
+
* <p>Updates a timeline event. You can update events of type <code>Custom Event</code>.</p>
|
|
261
259
|
*/
|
|
262
260
|
updateTimelineEvent(args: UpdateTimelineEventCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTimelineEventCommandOutput>;
|
|
263
261
|
updateTimelineEvent(args: UpdateTimelineEventCommandInput, cb: (err: any, data?: UpdateTimelineEventCommandOutput) => void): void;
|
|
@@ -20,13 +20,24 @@ export interface CreateReplicationSetCommandOutput extends CreateReplicationSetO
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>A replication set replicates and encrypts your data to the provided Regions with the
|
|
23
|
-
*
|
|
23
|
+
* provided KMS key. </p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
27
27
|
* import { SSMIncidentsClient, CreateReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
28
|
* // const { SSMIncidentsClient, CreateReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
29
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
+
* const input = { // CreateReplicationSetInput
|
|
31
|
+
* regions: { // RegionMapInput // required
|
|
32
|
+
* "<keys>": { // RegionMapInputValue
|
|
33
|
+
* sseKmsKeyId: "STRING_VALUE",
|
|
34
|
+
* },
|
|
35
|
+
* },
|
|
36
|
+
* clientToken: "STRING_VALUE",
|
|
37
|
+
* tags: { // TagMap
|
|
38
|
+
* "<keys>": "STRING_VALUE",
|
|
39
|
+
* },
|
|
40
|
+
* };
|
|
30
41
|
* const command = new CreateReplicationSetCommand(input);
|
|
31
42
|
* const response = await client.send(command);
|
|
32
43
|
* ```
|
|
@@ -19,15 +19,77 @@ export interface CreateResponsePlanCommandOutput extends CreateResponsePlanOutpu
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Creates a response plan that automates the initial response to incidents. A response
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Creates a response plan that automates the initial response to incidents. A response plan
|
|
23
|
+
* engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning
|
|
24
|
+
* of an incident.</p>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
28
28
|
* import { SSMIncidentsClient, CreateResponsePlanCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
29
29
|
* // const { SSMIncidentsClient, CreateResponsePlanCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
30
30
|
* const client = new SSMIncidentsClient(config);
|
|
31
|
+
* const input = { // CreateResponsePlanInput
|
|
32
|
+
* clientToken: "STRING_VALUE",
|
|
33
|
+
* name: "STRING_VALUE", // required
|
|
34
|
+
* displayName: "STRING_VALUE",
|
|
35
|
+
* incidentTemplate: { // IncidentTemplate
|
|
36
|
+
* title: "STRING_VALUE", // required
|
|
37
|
+
* impact: Number("int"), // required
|
|
38
|
+
* summary: "STRING_VALUE",
|
|
39
|
+
* dedupeString: "STRING_VALUE",
|
|
40
|
+
* notificationTargets: [ // NotificationTargetSet
|
|
41
|
+
* { // NotificationTargetItem Union: only one key present
|
|
42
|
+
* snsTopicArn: "STRING_VALUE",
|
|
43
|
+
* },
|
|
44
|
+
* ],
|
|
45
|
+
* incidentTags: { // TagMap
|
|
46
|
+
* "<keys>": "STRING_VALUE",
|
|
47
|
+
* },
|
|
48
|
+
* },
|
|
49
|
+
* chatChannel: { // ChatChannel Union: only one key present
|
|
50
|
+
* empty: {},
|
|
51
|
+
* chatbotSns: [ // ChatbotSnsConfigurationSet
|
|
52
|
+
* "STRING_VALUE",
|
|
53
|
+
* ],
|
|
54
|
+
* },
|
|
55
|
+
* engagements: [ // EngagementSet
|
|
56
|
+
* "STRING_VALUE",
|
|
57
|
+
* ],
|
|
58
|
+
* actions: [ // ActionsList
|
|
59
|
+
* { // Action Union: only one key present
|
|
60
|
+
* ssmAutomation: { // SsmAutomation
|
|
61
|
+
* roleArn: "STRING_VALUE", // required
|
|
62
|
+
* documentName: "STRING_VALUE", // required
|
|
63
|
+
* documentVersion: "STRING_VALUE",
|
|
64
|
+
* targetAccount: "STRING_VALUE",
|
|
65
|
+
* parameters: { // SsmParameters
|
|
66
|
+
* "<keys>": [ // SsmParameterValues
|
|
67
|
+
* "STRING_VALUE",
|
|
68
|
+
* ],
|
|
69
|
+
* },
|
|
70
|
+
* dynamicParameters: { // DynamicSsmParameters
|
|
71
|
+
* "<keys>": { // DynamicSsmParameterValue Union: only one key present
|
|
72
|
+
* variable: "STRING_VALUE",
|
|
73
|
+
* },
|
|
74
|
+
* },
|
|
75
|
+
* },
|
|
76
|
+
* },
|
|
77
|
+
* ],
|
|
78
|
+
* tags: {
|
|
79
|
+
* "<keys>": "STRING_VALUE",
|
|
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
|
+
* };
|
|
31
93
|
* const command = new CreateResponsePlanCommand(input);
|
|
32
94
|
* const response = await client.send(command);
|
|
33
95
|
* ```
|
|
@@ -20,15 +20,28 @@ export interface CreateTimelineEventCommandOutput extends CreateTimelineEventOut
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Creates a custom timeline event on the incident details page of an incident record.
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
23
|
+
* Incident Manager automatically creates timeline events that mark key moments during an incident.
|
|
24
|
+
* You can create custom timeline events to mark important events that Incident Manager can detect
|
|
25
|
+
* automatically.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
29
29
|
* import { SSMIncidentsClient, CreateTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
30
30
|
* // const { SSMIncidentsClient, CreateTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
31
31
|
* const client = new SSMIncidentsClient(config);
|
|
32
|
+
* const input = { // CreateTimelineEventInput
|
|
33
|
+
* clientToken: "STRING_VALUE",
|
|
34
|
+
* incidentRecordArn: "STRING_VALUE", // required
|
|
35
|
+
* eventTime: new Date("TIMESTAMP"), // required
|
|
36
|
+
* eventType: "STRING_VALUE", // required
|
|
37
|
+
* eventData: "STRING_VALUE", // required
|
|
38
|
+
* eventReferences: [ // EventReferenceList
|
|
39
|
+
* { // EventReference Union: only one key present
|
|
40
|
+
* resource: "STRING_VALUE",
|
|
41
|
+
* relatedItemId: "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* ],
|
|
44
|
+
* };
|
|
32
45
|
* const command = new CreateTimelineEventCommand(input);
|
|
33
46
|
* const response = await client.send(command);
|
|
34
47
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface DeleteIncidentRecordCommandOutput extends DeleteIncidentRecordO
|
|
|
26
26
|
* import { SSMIncidentsClient, DeleteIncidentRecordCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, DeleteIncidentRecordCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // DeleteIncidentRecordInput
|
|
30
|
+
* arn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new DeleteIncidentRecordCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -20,13 +20,16 @@ export interface DeleteReplicationSetCommandOutput extends DeleteReplicationSetO
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes all Regions in your replication set. Deleting the replication set deletes all
|
|
23
|
-
*
|
|
23
|
+
* Incident Manager data.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
27
27
|
* import { SSMIncidentsClient, DeleteReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
28
|
* // const { SSMIncidentsClient, DeleteReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
29
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
+
* const input = { // DeleteReplicationSetInput
|
|
31
|
+
* arn: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
30
33
|
* const command = new DeleteReplicationSetCommand(input);
|
|
31
34
|
* const response = await client.send(command);
|
|
32
35
|
* ```
|
|
@@ -20,13 +20,17 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyO
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the resource policy that Resource Access Manager uses to share your Incident Manager
|
|
23
|
-
*
|
|
23
|
+
* resource.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
27
27
|
* import { SSMIncidentsClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
28
|
* // const { SSMIncidentsClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
29
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
+
* const input = { // DeleteResourcePolicyInput
|
|
31
|
+
* resourceArn: "STRING_VALUE", // required
|
|
32
|
+
* policyId: "STRING_VALUE", // required
|
|
33
|
+
* };
|
|
30
34
|
* const command = new DeleteResourcePolicyCommand(input);
|
|
31
35
|
* const response = await client.send(command);
|
|
32
36
|
* ```
|
|
@@ -19,14 +19,17 @@ export interface DeleteResponsePlanCommandOutput extends DeleteResponsePlanOutpu
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
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
|
|
23
|
-
*
|
|
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 response
|
|
23
|
+
* plan.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
27
27
|
* import { SSMIncidentsClient, DeleteResponsePlanCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
28
|
* // const { SSMIncidentsClient, DeleteResponsePlanCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
29
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
+
* const input = { // DeleteResponsePlanInput
|
|
31
|
+
* arn: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
30
33
|
* const command = new DeleteResponsePlanCommand(input);
|
|
31
34
|
* const response = await client.send(command);
|
|
32
35
|
* ```
|
|
@@ -26,6 +26,10 @@ export interface DeleteTimelineEventCommandOutput extends DeleteTimelineEventOut
|
|
|
26
26
|
* import { SSMIncidentsClient, DeleteTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, DeleteTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // DeleteTimelineEventInput
|
|
30
|
+
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
|
+
* eventId: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
29
33
|
* const command = new DeleteTimelineEventCommand(input);
|
|
30
34
|
* const response = await client.send(command);
|
|
31
35
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface GetIncidentRecordCommandOutput extends GetIncidentRecordOutput,
|
|
|
26
26
|
* import { SSMIncidentsClient, GetIncidentRecordCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, GetIncidentRecordCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // GetIncidentRecordInput
|
|
30
|
+
* arn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new GetIncidentRecordCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface GetReplicationSetCommandOutput extends GetReplicationSetOutput,
|
|
|
26
26
|
* import { SSMIncidentsClient, GetReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, GetReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // GetReplicationSetInput
|
|
30
|
+
* arn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new GetReplicationSetCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -26,6 +26,11 @@ export interface GetResourcePoliciesCommandOutput extends GetResourcePoliciesOut
|
|
|
26
26
|
* import { SSMIncidentsClient, GetResourcePoliciesCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, GetResourcePoliciesCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // GetResourcePoliciesInput
|
|
30
|
+
* resourceArn: "STRING_VALUE", // required
|
|
31
|
+
* maxResults: Number("int"),
|
|
32
|
+
* nextToken: "STRING_VALUE",
|
|
33
|
+
* };
|
|
29
34
|
* const command = new GetResourcePoliciesCommand(input);
|
|
30
35
|
* const response = await client.send(command);
|
|
31
36
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface GetResponsePlanCommandOutput extends GetResponsePlanOutput, __M
|
|
|
26
26
|
* import { SSMIncidentsClient, GetResponsePlanCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, GetResponsePlanCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // GetResponsePlanInput
|
|
30
|
+
* arn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new GetResponsePlanCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -26,6 +26,10 @@ export interface GetTimelineEventCommandOutput extends GetTimelineEventOutput, _
|
|
|
26
26
|
* import { SSMIncidentsClient, GetTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, GetTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // GetTimelineEventInput
|
|
30
|
+
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
|
+
* eventId: "STRING_VALUE", // required
|
|
32
|
+
* };
|
|
29
33
|
* const command = new GetTimelineEventCommand(input);
|
|
30
34
|
* const response = await client.send(command);
|
|
31
35
|
* ```
|
|
@@ -20,13 +20,34 @@ export interface ListIncidentRecordsCommandOutput extends ListIncidentRecordsOut
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Lists all incident records in your account. Use this command to retrieve the Amazon
|
|
23
|
-
*
|
|
23
|
+
* Resource Name (ARN) of the incident record you want to update. </p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
27
27
|
* import { SSMIncidentsClient, ListIncidentRecordsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
28
|
* // const { SSMIncidentsClient, ListIncidentRecordsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
29
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
+
* const input = { // ListIncidentRecordsInput
|
|
31
|
+
* filters: [ // FilterList
|
|
32
|
+
* { // Filter
|
|
33
|
+
* key: "STRING_VALUE", // required
|
|
34
|
+
* condition: { // Condition Union: only one key present
|
|
35
|
+
* before: new Date("TIMESTAMP"),
|
|
36
|
+
* after: new Date("TIMESTAMP"),
|
|
37
|
+
* equals: { // AttributeValueList Union: only one key present
|
|
38
|
+
* stringValues: [ // StringList
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* integerValues: [ // IntegerList
|
|
42
|
+
* Number("int"),
|
|
43
|
+
* ],
|
|
44
|
+
* },
|
|
45
|
+
* },
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* maxResults: Number("int"),
|
|
49
|
+
* nextToken: "STRING_VALUE",
|
|
50
|
+
* };
|
|
30
51
|
* const command = new ListIncidentRecordsCommand(input);
|
|
31
52
|
* const response = await client.send(command);
|
|
32
53
|
* ```
|
|
@@ -26,6 +26,11 @@ export interface ListRelatedItemsCommandOutput extends ListRelatedItemsOutput, _
|
|
|
26
26
|
* import { SSMIncidentsClient, ListRelatedItemsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, ListRelatedItemsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // ListRelatedItemsInput
|
|
30
|
+
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
|
+
* maxResults: Number("int"),
|
|
32
|
+
* nextToken: "STRING_VALUE",
|
|
33
|
+
* };
|
|
29
34
|
* const command = new ListRelatedItemsCommand(input);
|
|
30
35
|
* const response = await client.send(command);
|
|
31
36
|
* ```
|
|
@@ -26,6 +26,10 @@ export interface ListReplicationSetsCommandOutput extends ListReplicationSetsOut
|
|
|
26
26
|
* import { SSMIncidentsClient, ListReplicationSetsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, ListReplicationSetsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // ListReplicationSetsInput
|
|
30
|
+
* maxResults: Number("int"),
|
|
31
|
+
* nextToken: "STRING_VALUE",
|
|
32
|
+
* };
|
|
29
33
|
* const command = new ListReplicationSetsCommand(input);
|
|
30
34
|
* const response = await client.send(command);
|
|
31
35
|
* ```
|
|
@@ -26,6 +26,10 @@ export interface ListResponsePlansCommandOutput extends ListResponsePlansOutput,
|
|
|
26
26
|
* import { SSMIncidentsClient, ListResponsePlansCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, ListResponsePlansCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // ListResponsePlansInput
|
|
30
|
+
* maxResults: Number("int"),
|
|
31
|
+
* nextToken: "STRING_VALUE",
|
|
32
|
+
* };
|
|
29
33
|
* const command = new ListResponsePlansCommand(input);
|
|
30
34
|
* const response = await client.send(command);
|
|
31
35
|
* ```
|
|
@@ -26,6 +26,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
26
26
|
* import { SSMIncidentsClient, ListTagsForResourceCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // ListTagsForResourceRequest
|
|
30
|
+
* resourceArn: "STRING_VALUE", // required
|
|
31
|
+
* };
|
|
29
32
|
* const command = new ListTagsForResourceCommand(input);
|
|
30
33
|
* const response = await client.send(command);
|
|
31
34
|
* ```
|
|
@@ -26,6 +26,30 @@ export interface ListTimelineEventsCommandOutput extends ListTimelineEventsOutpu
|
|
|
26
26
|
* import { SSMIncidentsClient, ListTimelineEventsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, ListTimelineEventsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
+
* const input = { // ListTimelineEventsInput
|
|
30
|
+
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
|
+
* filters: [ // FilterList
|
|
32
|
+
* { // Filter
|
|
33
|
+
* key: "STRING_VALUE", // required
|
|
34
|
+
* condition: { // Condition Union: only one key present
|
|
35
|
+
* before: new Date("TIMESTAMP"),
|
|
36
|
+
* after: new Date("TIMESTAMP"),
|
|
37
|
+
* equals: { // AttributeValueList Union: only one key present
|
|
38
|
+
* stringValues: [ // StringList
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* integerValues: [ // IntegerList
|
|
42
|
+
* Number("int"),
|
|
43
|
+
* ],
|
|
44
|
+
* },
|
|
45
|
+
* },
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* sortBy: "STRING_VALUE",
|
|
49
|
+
* sortOrder: "STRING_VALUE",
|
|
50
|
+
* maxResults: Number("int"),
|
|
51
|
+
* nextToken: "STRING_VALUE",
|
|
52
|
+
* };
|
|
29
53
|
* const command = new ListTimelineEventsCommand(input);
|
|
30
54
|
* const response = await client.send(command);
|
|
31
55
|
* ```
|
|
@@ -20,15 +20,18 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyOutput,
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Adds a resource policy to the specified response plan. The resource policy is used to
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* management</a>.</p>
|
|
23
|
+
* share the response plan using Resource Access Manager (RAM). For more
|
|
24
|
+
* 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 management</a>.</p>
|
|
26
25
|
* @example
|
|
27
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
27
|
* ```javascript
|
|
29
28
|
* import { SSMIncidentsClient, PutResourcePolicyCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
30
29
|
* // const { SSMIncidentsClient, PutResourcePolicyCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
31
30
|
* const client = new SSMIncidentsClient(config);
|
|
31
|
+
* const input = { // PutResourcePolicyInput
|
|
32
|
+
* resourceArn: "STRING_VALUE", // required
|
|
33
|
+
* policy: "STRING_VALUE", // required
|
|
34
|
+
* };
|
|
32
35
|
* const command = new PutResourcePolicyCommand(input);
|
|
33
36
|
* const response = await client.send(command);
|
|
34
37
|
* ```
|