@aws-sdk/client-ssm-incidents 3.300.0 → 3.303.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-cjs/models/models_0.js +53 -63
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +53 -63
- package/dist-types/SSMIncidents.d.ts +20 -22
- package/dist-types/commands/CreateReplicationSetCommand.d.ts +5 -5
- package/dist-types/commands/CreateResponsePlanCommand.d.ts +22 -22
- package/dist-types/commands/CreateTimelineEventCommand.d.ts +6 -6
- package/dist-types/commands/DeleteIncidentRecordCommand.d.ts +1 -1
- package/dist-types/commands/DeleteReplicationSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResponsePlanCommand.d.ts +3 -3
- package/dist-types/commands/DeleteTimelineEventCommand.d.ts +1 -1
- package/dist-types/commands/GetIncidentRecordCommand.d.ts +1 -1
- package/dist-types/commands/GetReplicationSetCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcePoliciesCommand.d.ts +1 -1
- package/dist-types/commands/GetResponsePlanCommand.d.ts +1 -1
- package/dist-types/commands/GetTimelineEventCommand.d.ts +1 -1
- package/dist-types/commands/ListIncidentRecordsCommand.d.ts +8 -8
- package/dist-types/commands/ListRelatedItemsCommand.d.ts +1 -1
- package/dist-types/commands/ListReplicationSetsCommand.d.ts +1 -1
- package/dist-types/commands/ListResponsePlansCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTimelineEventsCommand.d.ts +7 -7
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +3 -4
- package/dist-types/commands/StartIncidentCommand.d.ts +8 -8
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDeletionProtectionCommand.d.ts +2 -2
- package/dist-types/commands/UpdateIncidentRecordCommand.d.ts +8 -8
- package/dist-types/commands/UpdateRelatedItemsCommand.d.ts +7 -7
- package/dist-types/commands/UpdateReplicationSetCommand.d.ts +5 -5
- package/dist-types/commands/UpdateResponsePlanCommand.d.ts +18 -18
- package/dist-types/commands/UpdateTimelineEventCommand.d.ts +4 -5
- package/dist-types/models/models_0.d.ts +313 -289
- package/dist-types/ts3.4/models/models_0.d.ts +67 -53
- package/package.json +35 -35
|
@@ -20,23 +20,23 @@ 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 = {
|
|
32
|
+
* const input = { // CreateTimelineEventInput
|
|
33
33
|
* clientToken: "STRING_VALUE",
|
|
34
34
|
* incidentRecordArn: "STRING_VALUE", // required
|
|
35
35
|
* eventTime: new Date("TIMESTAMP"), // required
|
|
36
36
|
* eventType: "STRING_VALUE", // required
|
|
37
37
|
* eventData: "STRING_VALUE", // required
|
|
38
|
-
* eventReferences: [
|
|
39
|
-
* { // Union: only one key present
|
|
38
|
+
* eventReferences: [ // EventReferenceList
|
|
39
|
+
* { // EventReference Union: only one key present
|
|
40
40
|
* resource: "STRING_VALUE",
|
|
41
41
|
* relatedItemId: "STRING_VALUE",
|
|
42
42
|
* },
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // DeleteIncidentRecordInput
|
|
30
30
|
* arn: "STRING_VALUE", // required
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DeleteIncidentRecordCommand(input);
|
|
@@ -20,14 +20,14 @@ 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 = {
|
|
30
|
+
* const input = { // DeleteReplicationSetInput
|
|
31
31
|
* arn: "STRING_VALUE", // required
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteReplicationSetCommand(input);
|
|
@@ -20,14 +20,14 @@ 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 = {
|
|
30
|
+
* const input = { // DeleteResourcePolicyInput
|
|
31
31
|
* resourceArn: "STRING_VALUE", // required
|
|
32
32
|
* policyId: "STRING_VALUE", // required
|
|
33
33
|
* };
|
|
@@ -19,15 +19,15 @@ 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 = {
|
|
30
|
+
* const input = { // DeleteResponsePlanInput
|
|
31
31
|
* arn: "STRING_VALUE", // required
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DeleteResponsePlanCommand(input);
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // DeleteTimelineEventInput
|
|
30
30
|
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
31
|
* eventId: "STRING_VALUE", // required
|
|
32
32
|
* };
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // GetIncidentRecordInput
|
|
30
30
|
* arn: "STRING_VALUE", // required
|
|
31
31
|
* };
|
|
32
32
|
* const command = new GetIncidentRecordCommand(input);
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // GetReplicationSetInput
|
|
30
30
|
* arn: "STRING_VALUE", // required
|
|
31
31
|
* };
|
|
32
32
|
* const command = new GetReplicationSetCommand(input);
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // GetResourcePoliciesInput
|
|
30
30
|
* resourceArn: "STRING_VALUE", // required
|
|
31
31
|
* maxResults: Number("int"),
|
|
32
32
|
* nextToken: "STRING_VALUE",
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // GetResponsePlanInput
|
|
30
30
|
* arn: "STRING_VALUE", // required
|
|
31
31
|
* };
|
|
32
32
|
* const command = new GetResponsePlanCommand(input);
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // GetTimelineEventInput
|
|
30
30
|
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
31
|
* eventId: "STRING_VALUE", // required
|
|
32
32
|
* };
|
|
@@ -20,25 +20,25 @@ 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 = {
|
|
31
|
-
* filters: [
|
|
32
|
-
* {
|
|
30
|
+
* const input = { // ListIncidentRecordsInput
|
|
31
|
+
* filters: [ // FilterList
|
|
32
|
+
* { // Filter
|
|
33
33
|
* key: "STRING_VALUE", // required
|
|
34
|
-
* condition: { // Union: only one key present
|
|
34
|
+
* condition: { // Condition Union: only one key present
|
|
35
35
|
* before: new Date("TIMESTAMP"),
|
|
36
36
|
* after: new Date("TIMESTAMP"),
|
|
37
|
-
* equals: { // Union: only one key present
|
|
38
|
-
* stringValues: [
|
|
37
|
+
* equals: { // AttributeValueList Union: only one key present
|
|
38
|
+
* stringValues: [ // StringList
|
|
39
39
|
* "STRING_VALUE",
|
|
40
40
|
* ],
|
|
41
|
-
* integerValues: [
|
|
41
|
+
* integerValues: [ // IntegerList
|
|
42
42
|
* Number("int"),
|
|
43
43
|
* ],
|
|
44
44
|
* },
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // ListRelatedItemsInput
|
|
30
30
|
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
31
|
* maxResults: Number("int"),
|
|
32
32
|
* nextToken: "STRING_VALUE",
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // ListReplicationSetsInput
|
|
30
30
|
* maxResults: Number("int"),
|
|
31
31
|
* nextToken: "STRING_VALUE",
|
|
32
32
|
* };
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // ListResponsePlansInput
|
|
30
30
|
* maxResults: Number("int"),
|
|
31
31
|
* nextToken: "STRING_VALUE",
|
|
32
32
|
* };
|
|
@@ -26,7 +26,7 @@ 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 = {
|
|
29
|
+
* const input = { // ListTagsForResourceRequest
|
|
30
30
|
* resourceArn: "STRING_VALUE", // required
|
|
31
31
|
* };
|
|
32
32
|
* const command = new ListTagsForResourceCommand(input);
|
|
@@ -26,19 +26,19 @@ 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 = {
|
|
29
|
+
* const input = { // ListTimelineEventsInput
|
|
30
30
|
* incidentRecordArn: "STRING_VALUE", // required
|
|
31
|
-
* filters: [
|
|
32
|
-
* {
|
|
31
|
+
* filters: [ // FilterList
|
|
32
|
+
* { // Filter
|
|
33
33
|
* key: "STRING_VALUE", // required
|
|
34
|
-
* condition: { // Union: only one key present
|
|
34
|
+
* condition: { // Condition Union: only one key present
|
|
35
35
|
* before: new Date("TIMESTAMP"),
|
|
36
36
|
* after: new Date("TIMESTAMP"),
|
|
37
|
-
* equals: { // Union: only one key present
|
|
38
|
-
* stringValues: [
|
|
37
|
+
* equals: { // AttributeValueList Union: only one key present
|
|
38
|
+
* stringValues: [ // StringList
|
|
39
39
|
* "STRING_VALUE",
|
|
40
40
|
* ],
|
|
41
|
-
* integerValues: [
|
|
41
|
+
* integerValues: [ // IntegerList
|
|
42
42
|
* Number("int"),
|
|
43
43
|
* ],
|
|
44
44
|
* },
|
|
@@ -20,16 +20,15 @@ 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);
|
|
32
|
-
* const input = {
|
|
31
|
+
* const input = { // PutResourcePolicyInput
|
|
33
32
|
* resourceArn: "STRING_VALUE", // required
|
|
34
33
|
* policy: "STRING_VALUE", // required
|
|
35
34
|
* };
|
|
@@ -20,32 +20,32 @@ export interface StartIncidentCommandOutput extends StartIncidentOutput, __Metad
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Used to start an incident from CloudWatch alarms, EventBridge events, or
|
|
23
|
-
*
|
|
23
|
+
* manually. </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, StartIncidentCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
28
|
* // const { SSMIncidentsClient, StartIncidentCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
29
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
-
* const input = {
|
|
30
|
+
* const input = { // StartIncidentInput
|
|
31
31
|
* clientToken: "STRING_VALUE",
|
|
32
32
|
* responsePlanArn: "STRING_VALUE", // required
|
|
33
33
|
* title: "STRING_VALUE",
|
|
34
34
|
* impact: Number("int"),
|
|
35
|
-
* triggerDetails: {
|
|
35
|
+
* triggerDetails: { // TriggerDetails
|
|
36
36
|
* source: "STRING_VALUE", // required
|
|
37
37
|
* triggerArn: "STRING_VALUE",
|
|
38
38
|
* timestamp: new Date("TIMESTAMP"), // required
|
|
39
39
|
* rawData: "STRING_VALUE",
|
|
40
40
|
* },
|
|
41
|
-
* relatedItems: [
|
|
42
|
-
* {
|
|
43
|
-
* identifier: {
|
|
44
|
-
* value: { // Union: only one key present
|
|
41
|
+
* relatedItems: [ // RelatedItemList
|
|
42
|
+
* { // RelatedItem
|
|
43
|
+
* identifier: { // ItemIdentifier
|
|
44
|
+
* value: { // ItemValue Union: only one key present
|
|
45
45
|
* arn: "STRING_VALUE",
|
|
46
46
|
* url: "STRING_VALUE",
|
|
47
47
|
* metricDefinition: "STRING_VALUE",
|
|
48
|
-
* pagerDutyIncidentDetail: {
|
|
48
|
+
* pagerDutyIncidentDetail: { // PagerDutyIncidentDetail
|
|
49
49
|
* id: "STRING_VALUE", // required
|
|
50
50
|
* autoResolve: true || false,
|
|
51
51
|
* secretId: "STRING_VALUE",
|
|
@@ -26,9 +26,9 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
26
26
|
* import { SSMIncidentsClient, TagResourceCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, TagResourceCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // TagResourceRequest
|
|
30
30
|
* resourceArn: "STRING_VALUE", // required
|
|
31
|
-
* tags: { // required
|
|
31
|
+
* tags: { // TagMap // required
|
|
32
32
|
* "<keys>": "STRING_VALUE",
|
|
33
33
|
* },
|
|
34
34
|
* };
|
|
@@ -26,9 +26,9 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
26
26
|
* import { SSMIncidentsClient, UntagResourceCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, UntagResourceCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UntagResourceRequest
|
|
30
30
|
* resourceArn: "STRING_VALUE", // required
|
|
31
|
-
* tagKeys: [ // required
|
|
31
|
+
* tagKeys: [ // TagKeyList // required
|
|
32
32
|
* "STRING_VALUE",
|
|
33
33
|
* ],
|
|
34
34
|
* };
|
|
@@ -20,14 +20,14 @@ export interface UpdateDeletionProtectionCommandOutput extends UpdateDeletionPro
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Update deletion protection to either allow or deny deletion of the final Region in a
|
|
23
|
-
*
|
|
23
|
+
* replication set.</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, UpdateDeletionProtectionCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
28
|
* // const { SSMIncidentsClient, UpdateDeletionProtectionCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
29
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
-
* const input = {
|
|
30
|
+
* const input = { // UpdateDeletionProtectionInput
|
|
31
31
|
* arn: "STRING_VALUE", // required
|
|
32
32
|
* deletionProtected: true || false, // required
|
|
33
33
|
* clientToken: "STRING_VALUE",
|
|
@@ -19,30 +19,30 @@ export interface UpdateIncidentRecordCommandOutput extends UpdateIncidentRecordO
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Update the details of an incident record. You can use this operation to update an
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>Update the details of an incident record. You can use this operation to update an incident
|
|
23
|
+
* record from the defined chat channel. For more information about using actions in chat
|
|
24
|
+
* channels, see <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/chat.html#chat-interact">Interacting through chat</a>.</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, UpdateIncidentRecordCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
29
29
|
* // const { SSMIncidentsClient, UpdateIncidentRecordCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
30
30
|
* const client = new SSMIncidentsClient(config);
|
|
31
|
-
* const input = {
|
|
31
|
+
* const input = { // UpdateIncidentRecordInput
|
|
32
32
|
* clientToken: "STRING_VALUE",
|
|
33
33
|
* arn: "STRING_VALUE", // required
|
|
34
34
|
* title: "STRING_VALUE",
|
|
35
35
|
* summary: "STRING_VALUE",
|
|
36
36
|
* impact: Number("int"),
|
|
37
37
|
* status: "STRING_VALUE",
|
|
38
|
-
* chatChannel: { // Union: only one key present
|
|
38
|
+
* chatChannel: { // ChatChannel Union: only one key present
|
|
39
39
|
* empty: {},
|
|
40
|
-
* chatbotSns: [
|
|
40
|
+
* chatbotSns: [ // ChatbotSnsConfigurationSet
|
|
41
41
|
* "STRING_VALUE",
|
|
42
42
|
* ],
|
|
43
43
|
* },
|
|
44
|
-
* notificationTargets: [
|
|
45
|
-
* { // Union: only one key present
|
|
44
|
+
* notificationTargets: [ // NotificationTargetSet
|
|
45
|
+
* { // NotificationTargetItem Union: only one key present
|
|
46
46
|
* snsTopicArn: "STRING_VALUE",
|
|
47
47
|
* },
|
|
48
48
|
* ],
|
|
@@ -26,17 +26,17 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
|
|
|
26
26
|
* import { SSMIncidentsClient, UpdateRelatedItemsCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, UpdateRelatedItemsCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateRelatedItemsInput
|
|
30
30
|
* clientToken: "STRING_VALUE",
|
|
31
31
|
* incidentRecordArn: "STRING_VALUE", // required
|
|
32
|
-
* relatedItemsUpdate: { // Union: only one key present
|
|
33
|
-
* itemToAdd: {
|
|
34
|
-
* identifier: {
|
|
35
|
-
* value: { // Union: only one key present
|
|
32
|
+
* relatedItemsUpdate: { // RelatedItemsUpdate Union: only one key present
|
|
33
|
+
* itemToAdd: { // RelatedItem
|
|
34
|
+
* identifier: { // ItemIdentifier
|
|
35
|
+
* value: { // ItemValue Union: only one key present
|
|
36
36
|
* arn: "STRING_VALUE",
|
|
37
37
|
* url: "STRING_VALUE",
|
|
38
38
|
* metricDefinition: "STRING_VALUE",
|
|
39
|
-
* pagerDutyIncidentDetail: {
|
|
39
|
+
* pagerDutyIncidentDetail: { // PagerDutyIncidentDetail
|
|
40
40
|
* id: "STRING_VALUE", // required
|
|
41
41
|
* autoResolve: true || false,
|
|
42
42
|
* secretId: "STRING_VALUE",
|
|
@@ -48,7 +48,7 @@ export interface UpdateRelatedItemsCommandOutput extends UpdateRelatedItemsOutpu
|
|
|
48
48
|
* generatedId: "STRING_VALUE",
|
|
49
49
|
* },
|
|
50
50
|
* itemToRemove: {
|
|
51
|
-
* value: {
|
|
51
|
+
* value: {// Union: only one key present
|
|
52
52
|
* arn: "STRING_VALUE",
|
|
53
53
|
* url: "STRING_VALUE",
|
|
54
54
|
* metricDefinition: "STRING_VALUE",
|
|
@@ -26,15 +26,15 @@ export interface UpdateReplicationSetCommandOutput extends UpdateReplicationSetO
|
|
|
26
26
|
* import { SSMIncidentsClient, UpdateReplicationSetCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, UpdateReplicationSetCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateReplicationSetInput
|
|
30
30
|
* arn: "STRING_VALUE", // required
|
|
31
|
-
* actions: [ // required
|
|
32
|
-
* { // Union: only one key present
|
|
33
|
-
* addRegionAction: {
|
|
31
|
+
* actions: [ // UpdateActionList // required
|
|
32
|
+
* { // UpdateReplicationSetAction Union: only one key present
|
|
33
|
+
* addRegionAction: { // AddRegionAction
|
|
34
34
|
* regionName: "STRING_VALUE", // required
|
|
35
35
|
* sseKmsKeyId: "STRING_VALUE",
|
|
36
36
|
* },
|
|
37
|
-
* deleteRegionAction: {
|
|
37
|
+
* deleteRegionAction: { // DeleteRegionAction
|
|
38
38
|
* regionName: "STRING_VALUE", // required
|
|
39
39
|
* },
|
|
40
40
|
* },
|
|
@@ -26,7 +26,7 @@ export interface UpdateResponsePlanCommandOutput extends UpdateResponsePlanOutpu
|
|
|
26
26
|
* import { SSMIncidentsClient, UpdateResponsePlanCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
27
27
|
* // const { SSMIncidentsClient, UpdateResponsePlanCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
28
28
|
* const client = new SSMIncidentsClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateResponsePlanInput
|
|
30
30
|
* clientToken: "STRING_VALUE",
|
|
31
31
|
* arn: "STRING_VALUE", // required
|
|
32
32
|
* displayName: "STRING_VALUE",
|
|
@@ -34,49 +34,49 @@ export interface UpdateResponsePlanCommandOutput extends UpdateResponsePlanOutpu
|
|
|
34
34
|
* incidentTemplateImpact: Number("int"),
|
|
35
35
|
* incidentTemplateSummary: "STRING_VALUE",
|
|
36
36
|
* incidentTemplateDedupeString: "STRING_VALUE",
|
|
37
|
-
* incidentTemplateNotificationTargets: [
|
|
38
|
-
* { // Union: only one key present
|
|
37
|
+
* incidentTemplateNotificationTargets: [ // NotificationTargetSet
|
|
38
|
+
* { // NotificationTargetItem Union: only one key present
|
|
39
39
|
* snsTopicArn: "STRING_VALUE",
|
|
40
40
|
* },
|
|
41
41
|
* ],
|
|
42
|
-
* chatChannel: { // Union: only one key present
|
|
42
|
+
* chatChannel: { // ChatChannel Union: only one key present
|
|
43
43
|
* empty: {},
|
|
44
|
-
* chatbotSns: [
|
|
44
|
+
* chatbotSns: [ // ChatbotSnsConfigurationSet
|
|
45
45
|
* "STRING_VALUE",
|
|
46
46
|
* ],
|
|
47
47
|
* },
|
|
48
|
-
* engagements: [
|
|
48
|
+
* engagements: [ // EngagementSet
|
|
49
49
|
* "STRING_VALUE",
|
|
50
50
|
* ],
|
|
51
|
-
* actions: [
|
|
52
|
-
* { // Union: only one key present
|
|
53
|
-
* ssmAutomation: {
|
|
51
|
+
* actions: [ // ActionsList
|
|
52
|
+
* { // Action Union: only one key present
|
|
53
|
+
* ssmAutomation: { // SsmAutomation
|
|
54
54
|
* roleArn: "STRING_VALUE", // required
|
|
55
55
|
* documentName: "STRING_VALUE", // required
|
|
56
56
|
* documentVersion: "STRING_VALUE",
|
|
57
57
|
* targetAccount: "STRING_VALUE",
|
|
58
|
-
* parameters: {
|
|
59
|
-
* "<keys>": [
|
|
58
|
+
* parameters: { // SsmParameters
|
|
59
|
+
* "<keys>": [ // SsmParameterValues
|
|
60
60
|
* "STRING_VALUE",
|
|
61
61
|
* ],
|
|
62
62
|
* },
|
|
63
|
-
* dynamicParameters: {
|
|
64
|
-
* "<keys>": { // Union: only one key present
|
|
63
|
+
* dynamicParameters: { // DynamicSsmParameters
|
|
64
|
+
* "<keys>": { // DynamicSsmParameterValue Union: only one key present
|
|
65
65
|
* variable: "STRING_VALUE",
|
|
66
66
|
* },
|
|
67
67
|
* },
|
|
68
68
|
* },
|
|
69
69
|
* },
|
|
70
70
|
* ],
|
|
71
|
-
* incidentTemplateTags: {
|
|
71
|
+
* incidentTemplateTags: { // TagMapUpdate
|
|
72
72
|
* "<keys>": "STRING_VALUE",
|
|
73
73
|
* },
|
|
74
|
-
* integrations: [
|
|
75
|
-
* { // Union: only one key present
|
|
76
|
-
* pagerDutyConfiguration: {
|
|
74
|
+
* integrations: [ // Integrations
|
|
75
|
+
* { // Integration Union: only one key present
|
|
76
|
+
* pagerDutyConfiguration: { // PagerDutyConfiguration
|
|
77
77
|
* name: "STRING_VALUE", // required
|
|
78
78
|
* secretId: "STRING_VALUE", // required
|
|
79
|
-
* pagerDutyIncidentConfiguration: {
|
|
79
|
+
* pagerDutyIncidentConfiguration: { // PagerDutyIncidentConfiguration
|
|
80
80
|
* serviceId: "STRING_VALUE", // required
|
|
81
81
|
* },
|
|
82
82
|
* },
|
|
@@ -19,23 +19,22 @@ export interface UpdateTimelineEventCommandOutput extends UpdateTimelineEventOut
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Updates a timeline event. You can update events of type <code>Custom
|
|
23
|
-
* Event</code>.</p>
|
|
22
|
+
* <p>Updates a timeline event. You can update events of type <code>Custom Event</code>.</p>
|
|
24
23
|
* @example
|
|
25
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
25
|
* ```javascript
|
|
27
26
|
* import { SSMIncidentsClient, UpdateTimelineEventCommand } from "@aws-sdk/client-ssm-incidents"; // ES Modules import
|
|
28
27
|
* // const { SSMIncidentsClient, UpdateTimelineEventCommand } = require("@aws-sdk/client-ssm-incidents"); // CommonJS import
|
|
29
28
|
* const client = new SSMIncidentsClient(config);
|
|
30
|
-
* const input = {
|
|
29
|
+
* const input = { // UpdateTimelineEventInput
|
|
31
30
|
* clientToken: "STRING_VALUE",
|
|
32
31
|
* incidentRecordArn: "STRING_VALUE", // required
|
|
33
32
|
* eventId: "STRING_VALUE", // required
|
|
34
33
|
* eventTime: new Date("TIMESTAMP"),
|
|
35
34
|
* eventType: "STRING_VALUE",
|
|
36
35
|
* eventData: "STRING_VALUE",
|
|
37
|
-
* eventReferences: [
|
|
38
|
-
* { // Union: only one key present
|
|
36
|
+
* eventReferences: [ // EventReferenceList
|
|
37
|
+
* { // EventReference Union: only one key present
|
|
39
38
|
* resource: "STRING_VALUE",
|
|
40
39
|
* relatedItemId: "STRING_VALUE",
|
|
41
40
|
* },
|