@aws-sdk/client-security-ir 3.703.0 → 3.709.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-types/commands/BatchGetMemberAccountDetailsCommand.d.ts +25 -0
- package/dist-types/commands/CancelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/CloseCaseCommand.d.ts +17 -0
- package/dist-types/commands/CreateCaseCommand.d.ts +46 -0
- package/dist-types/commands/CreateCaseCommentCommand.d.ts +17 -0
- package/dist-types/commands/CreateMembershipCommand.d.ts +34 -0
- package/dist-types/commands/GetCaseAttachmentDownloadUrlCommand.d.ts +17 -0
- package/dist-types/commands/GetCaseAttachmentUploadUrlCommand.d.ts +18 -0
- package/dist-types/commands/GetCaseCommand.d.ts +57 -0
- package/dist-types/commands/GetMembershipCommand.d.ts +43 -0
- package/dist-types/commands/ListCaseEditsCommand.d.ts +24 -0
- package/dist-types/commands/ListCasesCommand.d.ts +29 -0
- package/dist-types/commands/ListCommentsCommand.d.ts +22 -0
- package/dist-types/commands/ListMembershipsCommand.d.ts +24 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +19 -0
- package/dist-types/commands/TagResourceCommand.d.ts +15 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
- package/dist-types/commands/UpdateCaseCommand.d.ts +64 -0
- package/dist-types/commands/UpdateCaseCommentCommand.d.ts +19 -0
- package/dist-types/commands/UpdateCaseStatusCommand.d.ts +17 -0
- package/dist-types/commands/UpdateMembershipCommand.d.ts +30 -0
- package/dist-types/commands/UpdateResolverTypeCommand.d.ts +19 -0
- package/package.json +35 -35
|
@@ -98,6 +98,31 @@ declare const BatchGetMemberAccountDetailsCommand_base: {
|
|
|
98
98
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
99
99
|
*
|
|
100
100
|
* @public
|
|
101
|
+
* @example Invoke BatchGetMemberAccountDetails
|
|
102
|
+
* ```javascript
|
|
103
|
+
* //
|
|
104
|
+
* const input = {
|
|
105
|
+
* "accountIds": [
|
|
106
|
+
* "123412341234"
|
|
107
|
+
* ],
|
|
108
|
+
* "membershipId": "m-abcd1234efgh"
|
|
109
|
+
* };
|
|
110
|
+
* const command = new BatchGetMemberAccountDetailsCommand(input);
|
|
111
|
+
* const response = await client.send(command);
|
|
112
|
+
* /* response ==
|
|
113
|
+
* {
|
|
114
|
+
* "items": [
|
|
115
|
+
* {
|
|
116
|
+
* "accountId": "123412341234",
|
|
117
|
+
* "relationshipStatus": "Associated",
|
|
118
|
+
* "relationshipType": "Organization"
|
|
119
|
+
* }
|
|
120
|
+
* ]
|
|
121
|
+
* }
|
|
122
|
+
* *\/
|
|
123
|
+
* // example id: example-1
|
|
124
|
+
* ```
|
|
125
|
+
*
|
|
101
126
|
*/
|
|
102
127
|
export declare class BatchGetMemberAccountDetailsCommand extends BatchGetMemberAccountDetailsCommand_base {
|
|
103
128
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -82,6 +82,22 @@ declare const CancelMembershipCommand_base: {
|
|
|
82
82
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
83
83
|
*
|
|
84
84
|
* @public
|
|
85
|
+
* @example Invoke CancelMembership
|
|
86
|
+
* ```javascript
|
|
87
|
+
* //
|
|
88
|
+
* const input = {
|
|
89
|
+
* "membershipId": "m-abcd1234efgh"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new CancelMembershipCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response ==
|
|
94
|
+
* {
|
|
95
|
+
* "membershipId": "m-abcd1234efgh"
|
|
96
|
+
* }
|
|
97
|
+
* *\/
|
|
98
|
+
* // example id: example-1
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
85
101
|
*/
|
|
86
102
|
export declare class CancelMembershipCommand extends CancelMembershipCommand_base {
|
|
87
103
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,6 +83,23 @@ declare const CloseCaseCommand_base: {
|
|
|
83
83
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
84
84
|
*
|
|
85
85
|
* @public
|
|
86
|
+
* @example Invoke CloseCase
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* "caseId": "8403556009"
|
|
91
|
+
* };
|
|
92
|
+
* const command = new CloseCaseCommand(input);
|
|
93
|
+
* const response = await client.send(command);
|
|
94
|
+
* /* response ==
|
|
95
|
+
* {
|
|
96
|
+
* "caseStatus": "Closed",
|
|
97
|
+
* "closedDate": "2024-02-27T17:01:33.000Z"
|
|
98
|
+
* }
|
|
99
|
+
* *\/
|
|
100
|
+
* // example id: example-1
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
86
103
|
*/
|
|
87
104
|
export declare class CloseCaseCommand extends CloseCaseCommand_base {
|
|
88
105
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -114,6 +114,52 @@ declare const CreateCaseCommand_base: {
|
|
|
114
114
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
115
115
|
*
|
|
116
116
|
* @public
|
|
117
|
+
* @example Invoke CreateCase
|
|
118
|
+
* ```javascript
|
|
119
|
+
* //
|
|
120
|
+
* const input = {
|
|
121
|
+
* "description": "Case description",
|
|
122
|
+
* "engagementType": "Investigation",
|
|
123
|
+
* "impactedAccounts": [
|
|
124
|
+
* "000000000000",
|
|
125
|
+
* "111111111111"
|
|
126
|
+
* ],
|
|
127
|
+
* "impactedAwsRegions": [
|
|
128
|
+
* {
|
|
129
|
+
* "region": "ap-southeast-1"
|
|
130
|
+
* }
|
|
131
|
+
* ],
|
|
132
|
+
* "impactedServices": [
|
|
133
|
+
* "Amazon EC2",
|
|
134
|
+
* "Amazon EKS"
|
|
135
|
+
* ],
|
|
136
|
+
* "reportedIncidentStartDate": "2023-03-27T15:32:01.789Z",
|
|
137
|
+
* "resolverType": "Self",
|
|
138
|
+
* "threatActorIpAddresses": [
|
|
139
|
+
* {
|
|
140
|
+
* "ipAddress": "192.168.192.168",
|
|
141
|
+
* "userAgent": "Browser"
|
|
142
|
+
* }
|
|
143
|
+
* ],
|
|
144
|
+
* "title": "My sample case",
|
|
145
|
+
* "watchers": [
|
|
146
|
+
* {
|
|
147
|
+
* "name": "Alice",
|
|
148
|
+
* "email": "alice@example.com",
|
|
149
|
+
* "jobTitle": "CEO"
|
|
150
|
+
* },
|
|
151
|
+
* {
|
|
152
|
+
* "name": "Bob",
|
|
153
|
+
* "email": "bob@example.com",
|
|
154
|
+
* "jobTitle": "CFO"
|
|
155
|
+
* }
|
|
156
|
+
* ]
|
|
157
|
+
* };
|
|
158
|
+
* const command = new CreateCaseCommand(input);
|
|
159
|
+
* await client.send(command);
|
|
160
|
+
* // example id: example-1
|
|
161
|
+
* ```
|
|
162
|
+
*
|
|
117
163
|
*/
|
|
118
164
|
export declare class CreateCaseCommand extends CreateCaseCommand_base {
|
|
119
165
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -84,6 +84,23 @@ declare const CreateCaseCommentCommand_base: {
|
|
|
84
84
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
85
85
|
*
|
|
86
86
|
* @public
|
|
87
|
+
* @example Invoke CreateCaseComment
|
|
88
|
+
* ```javascript
|
|
89
|
+
* //
|
|
90
|
+
* const input = {
|
|
91
|
+
* "body": "Case comment body.",
|
|
92
|
+
* "caseId": "8403556009"
|
|
93
|
+
* };
|
|
94
|
+
* const command = new CreateCaseCommentCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* /* response ==
|
|
97
|
+
* {
|
|
98
|
+
* "commentId": "000000"
|
|
99
|
+
* }
|
|
100
|
+
* *\/
|
|
101
|
+
* // example id: example-1
|
|
102
|
+
* ```
|
|
103
|
+
*
|
|
87
104
|
*/
|
|
88
105
|
export declare class CreateCaseCommentCommand extends CreateCaseCommentCommand_base {
|
|
89
106
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -99,6 +99,40 @@ declare const CreateMembershipCommand_base: {
|
|
|
99
99
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
100
100
|
*
|
|
101
101
|
* @public
|
|
102
|
+
* @example Invoke CreateMembership
|
|
103
|
+
* ```javascript
|
|
104
|
+
* //
|
|
105
|
+
* const input = {
|
|
106
|
+
* "incidentResponseTeam": [
|
|
107
|
+
* {
|
|
108
|
+
* "name": "Bob Jones",
|
|
109
|
+
* "email": "bob.jones@gmail.com",
|
|
110
|
+
* "jobTitle": "Security Responder"
|
|
111
|
+
* },
|
|
112
|
+
* {
|
|
113
|
+
* "name": "Alice",
|
|
114
|
+
* "email": "alice@example.com",
|
|
115
|
+
* "jobTitle": "CEO"
|
|
116
|
+
* }
|
|
117
|
+
* ],
|
|
118
|
+
* "membershipName": "Example Membership Name.",
|
|
119
|
+
* "optInFeatures": [
|
|
120
|
+
* {
|
|
121
|
+
* "featureName": "Triage",
|
|
122
|
+
* "isEnabled": true
|
|
123
|
+
* }
|
|
124
|
+
* ]
|
|
125
|
+
* };
|
|
126
|
+
* const command = new CreateMembershipCommand(input);
|
|
127
|
+
* const response = await client.send(command);
|
|
128
|
+
* /* response ==
|
|
129
|
+
* {
|
|
130
|
+
* "membershipId": "m-abcd1234efgh"
|
|
131
|
+
* }
|
|
132
|
+
* *\/
|
|
133
|
+
* // example id: example-1
|
|
134
|
+
* ```
|
|
135
|
+
*
|
|
102
136
|
*/
|
|
103
137
|
export declare class CreateMembershipCommand extends CreateMembershipCommand_base {
|
|
104
138
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,6 +83,23 @@ declare const GetCaseAttachmentDownloadUrlCommand_base: {
|
|
|
83
83
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
84
84
|
*
|
|
85
85
|
* @public
|
|
86
|
+
* @example Invoke GetCaseAttachmentDownloadUrl
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* "attachmentId": "3C5A6B89-1DEF-4C2D-A5B6-123456789ABC",
|
|
91
|
+
* "caseId": "8403556009"
|
|
92
|
+
* };
|
|
93
|
+
* const command = new GetCaseAttachmentDownloadUrlCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response ==
|
|
96
|
+
* {
|
|
97
|
+
* "attachmentPresignedUrl": "https://presignedurl.com"
|
|
98
|
+
* }
|
|
99
|
+
* *\/
|
|
100
|
+
* // example id: example-1
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
86
103
|
*/
|
|
87
104
|
export declare class GetCaseAttachmentDownloadUrlCommand extends GetCaseAttachmentDownloadUrlCommand_base {
|
|
88
105
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,6 +85,24 @@ declare const GetCaseAttachmentUploadUrlCommand_base: {
|
|
|
85
85
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
86
86
|
*
|
|
87
87
|
* @public
|
|
88
|
+
* @example Invoke GetCaseAttachmentUploadUrl
|
|
89
|
+
* ```javascript
|
|
90
|
+
* //
|
|
91
|
+
* const input = {
|
|
92
|
+
* "caseId": "8403556009",
|
|
93
|
+
* "contentLength": 1500,
|
|
94
|
+
* "fileName": "TestFileName"
|
|
95
|
+
* };
|
|
96
|
+
* const command = new GetCaseAttachmentUploadUrlCommand(input);
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response ==
|
|
99
|
+
* {
|
|
100
|
+
* "attachmentPresignedUrl": "https://presignedurl.com"
|
|
101
|
+
* }
|
|
102
|
+
* *\/
|
|
103
|
+
* // example id: example-1
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
88
106
|
*/
|
|
89
107
|
export declare class GetCaseAttachmentUploadUrlCommand extends GetCaseAttachmentUploadUrlCommand_base {
|
|
90
108
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -127,6 +127,63 @@ declare const GetCaseCommand_base: {
|
|
|
127
127
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
128
128
|
*
|
|
129
129
|
* @public
|
|
130
|
+
* @example Invoke GetCase
|
|
131
|
+
* ```javascript
|
|
132
|
+
* //
|
|
133
|
+
* const input = {
|
|
134
|
+
* "caseId": "8403556009"
|
|
135
|
+
* };
|
|
136
|
+
* const command = new GetCaseCommand(input);
|
|
137
|
+
* const response = await client.send(command);
|
|
138
|
+
* /* response ==
|
|
139
|
+
* {
|
|
140
|
+
* "actualIncidentStartDate": "2023-03-27T15:32:01.789Z",
|
|
141
|
+
* "caseArn": "arn:aws:security-ir:us-west-1:123456789012:case/1234567890",
|
|
142
|
+
* "caseStatus": "Submitted",
|
|
143
|
+
* "createdDate": "2023-01-27T15:32:01.789Z",
|
|
144
|
+
* "description": "Case description",
|
|
145
|
+
* "engagementType": "Investigation",
|
|
146
|
+
* "impactedAccounts": [
|
|
147
|
+
* "000000000000",
|
|
148
|
+
* "111111111111"
|
|
149
|
+
* ],
|
|
150
|
+
* "impactedAwsRegions": [
|
|
151
|
+
* {
|
|
152
|
+
* "region": "ap-southeast-1"
|
|
153
|
+
* }
|
|
154
|
+
* ],
|
|
155
|
+
* "impactedServices": [
|
|
156
|
+
* "Amazon EC2",
|
|
157
|
+
* "Amazon EKS"
|
|
158
|
+
* ],
|
|
159
|
+
* "lastUpdatedDate": "2023-02-27T15:32:01.789Z",
|
|
160
|
+
* "pendingAction": "Customer",
|
|
161
|
+
* "reportedIncidentStartDate": "2023-03-27T15:32:01.789Z",
|
|
162
|
+
* "resolverType": "Self",
|
|
163
|
+
* "threatActorIpAddresses": [
|
|
164
|
+
* {
|
|
165
|
+
* "ipAddress": "192.168.192.168",
|
|
166
|
+
* "userAgent": "Browser"
|
|
167
|
+
* }
|
|
168
|
+
* ],
|
|
169
|
+
* "title": "My sample case",
|
|
170
|
+
* "watchers": [
|
|
171
|
+
* {
|
|
172
|
+
* "name": "Alice",
|
|
173
|
+
* "email": "alice@example.com",
|
|
174
|
+
* "jobTitle": "CEO"
|
|
175
|
+
* },
|
|
176
|
+
* {
|
|
177
|
+
* "name": "Bob",
|
|
178
|
+
* "email": "bob@example.com",
|
|
179
|
+
* "jobTitle": "CFO"
|
|
180
|
+
* }
|
|
181
|
+
* ]
|
|
182
|
+
* }
|
|
183
|
+
* *\/
|
|
184
|
+
* // example id: example-1
|
|
185
|
+
* ```
|
|
186
|
+
*
|
|
130
187
|
*/
|
|
131
188
|
export declare class GetCaseCommand extends GetCaseCommand_base {
|
|
132
189
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -104,6 +104,49 @@ declare const GetMembershipCommand_base: {
|
|
|
104
104
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
105
105
|
*
|
|
106
106
|
* @public
|
|
107
|
+
* @example Invoke GetMembership
|
|
108
|
+
* ```javascript
|
|
109
|
+
* //
|
|
110
|
+
* const input = {
|
|
111
|
+
* "membershipId": "m-abcd1234efgh"
|
|
112
|
+
* };
|
|
113
|
+
* const command = new GetMembershipCommand(input);
|
|
114
|
+
* const response = await client.send(command);
|
|
115
|
+
* /* response ==
|
|
116
|
+
* {
|
|
117
|
+
* "accountId": "123412341234",
|
|
118
|
+
* "customerType": "Standalone",
|
|
119
|
+
* "incidentResponseTeam": [
|
|
120
|
+
* {
|
|
121
|
+
* "name": "Bob Jones",
|
|
122
|
+
* "email": "bob.jones@gmail.com",
|
|
123
|
+
* "jobTitle": "Security Responder"
|
|
124
|
+
* },
|
|
125
|
+
* {
|
|
126
|
+
* "name": "Alice",
|
|
127
|
+
* "email": "alice@example.com",
|
|
128
|
+
* "jobTitle": "CEO"
|
|
129
|
+
* }
|
|
130
|
+
* ],
|
|
131
|
+
* "membershipActivationTimestamp": "2023-03-27T15:32:01.789Z",
|
|
132
|
+
* "membershipArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh",
|
|
133
|
+
* "membershipDeactivationTimestamp": "2023-04-27T15:32:01.789Z",
|
|
134
|
+
* "membershipId": "m-abcd1234efgh",
|
|
135
|
+
* "membershipName": "Example Membership",
|
|
136
|
+
* "membershipStatus": "Active",
|
|
137
|
+
* "numberOfAccountsCovered": 50,
|
|
138
|
+
* "optInFeatures": [
|
|
139
|
+
* {
|
|
140
|
+
* "featureName": "Triage",
|
|
141
|
+
* "isEnabled": true
|
|
142
|
+
* }
|
|
143
|
+
* ],
|
|
144
|
+
* "region": "af-south-1"
|
|
145
|
+
* }
|
|
146
|
+
* *\/
|
|
147
|
+
* // example id: example-1
|
|
148
|
+
* ```
|
|
149
|
+
*
|
|
107
150
|
*/
|
|
108
151
|
export declare class GetMembershipCommand extends GetMembershipCommand_base {
|
|
109
152
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -93,6 +93,30 @@ declare const ListCaseEditsCommand_base: {
|
|
|
93
93
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
94
94
|
*
|
|
95
95
|
* @public
|
|
96
|
+
* @example Invoke ListCaseEdits
|
|
97
|
+
* ```javascript
|
|
98
|
+
* //
|
|
99
|
+
* const input = {
|
|
100
|
+
* "caseId": "8403556009"
|
|
101
|
+
* };
|
|
102
|
+
* const command = new ListCaseEditsCommand(input);
|
|
103
|
+
* const response = await client.send(command);
|
|
104
|
+
* /* response ==
|
|
105
|
+
* {
|
|
106
|
+
* "items": [
|
|
107
|
+
* {
|
|
108
|
+
* "action": "Add comment",
|
|
109
|
+
* "eventTimestamp": "2023-03-27T15:32:01.789Z",
|
|
110
|
+
* "message": "Added comment to ask question to responder.",
|
|
111
|
+
* "principal": "00000000000"
|
|
112
|
+
* }
|
|
113
|
+
* ],
|
|
114
|
+
* "total": 1
|
|
115
|
+
* }
|
|
116
|
+
* *\/
|
|
117
|
+
* // example id: example-1
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
96
120
|
*/
|
|
97
121
|
export declare class ListCaseEditsCommand extends ListCaseEditsCommand_base {
|
|
98
122
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -98,6 +98,35 @@ declare const ListCasesCommand_base: {
|
|
|
98
98
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
99
99
|
*
|
|
100
100
|
* @public
|
|
101
|
+
* @example Invoke ListCases
|
|
102
|
+
* ```javascript
|
|
103
|
+
* //
|
|
104
|
+
* const input = {
|
|
105
|
+
* "maxResults": 10
|
|
106
|
+
* };
|
|
107
|
+
* const command = new ListCasesCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response ==
|
|
110
|
+
* {
|
|
111
|
+
* "items": [
|
|
112
|
+
* {
|
|
113
|
+
* "caseArn": "arn:aws:security-ir:us-west-1:123456789012:case/1234567890",
|
|
114
|
+
* "caseId": "8403556009",
|
|
115
|
+
* "caseStatus": "Acknowledged",
|
|
116
|
+
* "createdDate": "2023-01-27T15:32:01.789Z",
|
|
117
|
+
* "engagementType": "Security Incident",
|
|
118
|
+
* "lastUpdatedDate": "2023-03-27T15:32:01.789Z",
|
|
119
|
+
* "pendingAction": "None",
|
|
120
|
+
* "resolverType": "Self",
|
|
121
|
+
* "title": "Example case title"
|
|
122
|
+
* }
|
|
123
|
+
* ],
|
|
124
|
+
* "total": 1
|
|
125
|
+
* }
|
|
126
|
+
* *\/
|
|
127
|
+
* // example id: example-1
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
101
130
|
*/
|
|
102
131
|
export declare class ListCasesCommand extends ListCasesCommand_base {
|
|
103
132
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -95,6 +95,28 @@ declare const ListCommentsCommand_base: {
|
|
|
95
95
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
96
96
|
*
|
|
97
97
|
* @public
|
|
98
|
+
* @example Invoke ListComments
|
|
99
|
+
* ```javascript
|
|
100
|
+
* //
|
|
101
|
+
* const input = {
|
|
102
|
+
* "caseId": "8403556009"
|
|
103
|
+
* };
|
|
104
|
+
* const command = new ListCommentsCommand(input);
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* /* response ==
|
|
107
|
+
* {
|
|
108
|
+
* "items": [
|
|
109
|
+
* {
|
|
110
|
+
* "body": "Case comment body.",
|
|
111
|
+
* "commentId": "000000"
|
|
112
|
+
* }
|
|
113
|
+
* ],
|
|
114
|
+
* "total": 1
|
|
115
|
+
* }
|
|
116
|
+
* *\/
|
|
117
|
+
* // example id: example-1
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
98
120
|
*/
|
|
99
121
|
export declare class ListCommentsCommand extends ListCommentsCommand_base {
|
|
100
122
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -92,6 +92,30 @@ declare const ListMembershipsCommand_base: {
|
|
|
92
92
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
93
93
|
*
|
|
94
94
|
* @public
|
|
95
|
+
* @example Invoke ListMemberships
|
|
96
|
+
* ```javascript
|
|
97
|
+
* //
|
|
98
|
+
* const input = {
|
|
99
|
+
* "maxResults": 10
|
|
100
|
+
* };
|
|
101
|
+
* const command = new ListMembershipsCommand(input);
|
|
102
|
+
* const response = await client.send(command);
|
|
103
|
+
* /* response ==
|
|
104
|
+
* {
|
|
105
|
+
* "items": [
|
|
106
|
+
* {
|
|
107
|
+
* "accountId": "123123123123",
|
|
108
|
+
* "membershipArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh",
|
|
109
|
+
* "membershipId": "m-abcd1234efgh",
|
|
110
|
+
* "membershipStatus": "Cancelled",
|
|
111
|
+
* "region": "af-south-1"
|
|
112
|
+
* }
|
|
113
|
+
* ]
|
|
114
|
+
* }
|
|
115
|
+
* *\/
|
|
116
|
+
* // example id: example-1
|
|
117
|
+
* ```
|
|
118
|
+
*
|
|
95
119
|
*/
|
|
96
120
|
export declare class ListMembershipsCommand extends ListMembershipsCommand_base {
|
|
97
121
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -84,6 +84,25 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
84
84
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
85
85
|
*
|
|
86
86
|
* @public
|
|
87
|
+
* @example Invoke ListTagsForResource
|
|
88
|
+
* ```javascript
|
|
89
|
+
* //
|
|
90
|
+
* const input = {
|
|
91
|
+
* "resourceArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh"
|
|
92
|
+
* };
|
|
93
|
+
* const command = new ListTagsForResourceCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response ==
|
|
96
|
+
* {
|
|
97
|
+
* "tags": {
|
|
98
|
+
* "key": "example-tag-key",
|
|
99
|
+
* "value": "example-tag-value"
|
|
100
|
+
* }
|
|
101
|
+
* }
|
|
102
|
+
* *\/
|
|
103
|
+
* // example id: example-1
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
87
106
|
*/
|
|
88
107
|
export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
|
|
89
108
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,6 +83,21 @@ declare const TagResourceCommand_base: {
|
|
|
83
83
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
84
84
|
*
|
|
85
85
|
* @public
|
|
86
|
+
* @example Invoke TagResource
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* "resourceArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh",
|
|
91
|
+
* "tags": {
|
|
92
|
+
* "key": "example-tag-key",
|
|
93
|
+
* "value": "example-tag-value"
|
|
94
|
+
* }
|
|
95
|
+
* };
|
|
96
|
+
* const command = new TagResourceCommand(input);
|
|
97
|
+
* await client.send(command);
|
|
98
|
+
* // example id: example-1
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
86
101
|
*/
|
|
87
102
|
export declare class TagResourceCommand extends TagResourceCommand_base {
|
|
88
103
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,6 +83,20 @@ declare const UntagResourceCommand_base: {
|
|
|
83
83
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
84
84
|
*
|
|
85
85
|
* @public
|
|
86
|
+
* @example Invoke UntagResource
|
|
87
|
+
* ```javascript
|
|
88
|
+
* //
|
|
89
|
+
* const input = {
|
|
90
|
+
* "resourceArn": "arn:aws:security-ir:us-west-1:123456789012:membership/m-abcd1234efgh",
|
|
91
|
+
* "tagKeys": [
|
|
92
|
+
* "example-tag-key"
|
|
93
|
+
* ]
|
|
94
|
+
* };
|
|
95
|
+
* const command = new UntagResourceCommand(input);
|
|
96
|
+
* await client.send(command);
|
|
97
|
+
* // example id: example-1
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
86
100
|
*/
|
|
87
101
|
export declare class UntagResourceCommand extends UntagResourceCommand_base {
|
|
88
102
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -133,6 +133,70 @@ declare const UpdateCaseCommand_base: {
|
|
|
133
133
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
134
134
|
*
|
|
135
135
|
* @public
|
|
136
|
+
* @example Invoke UpdateCase
|
|
137
|
+
* ```javascript
|
|
138
|
+
* //
|
|
139
|
+
* const input = {
|
|
140
|
+
* "actualIncidentStartDate": "2023-03-25T15:32:01.789Z",
|
|
141
|
+
* "caseId": "8403556009",
|
|
142
|
+
* "description": "Case description",
|
|
143
|
+
* "engagementType": "Investigation",
|
|
144
|
+
* "impactedAccountsToAdd": [
|
|
145
|
+
* "000000000000"
|
|
146
|
+
* ],
|
|
147
|
+
* "impactedAccountsToDelete": [
|
|
148
|
+
* "111111111111"
|
|
149
|
+
* ],
|
|
150
|
+
* "impactedAwsRegionsToAdd": [
|
|
151
|
+
* {
|
|
152
|
+
* "region": "ap-southeast-1"
|
|
153
|
+
* }
|
|
154
|
+
* ],
|
|
155
|
+
* "impactedAwsRegionsToDelete": [
|
|
156
|
+
* {
|
|
157
|
+
* "region": "us-east-1"
|
|
158
|
+
* }
|
|
159
|
+
* ],
|
|
160
|
+
* "impactedServicesToAdd": [
|
|
161
|
+
* "Amazon EC2"
|
|
162
|
+
* ],
|
|
163
|
+
* "impactedServicesToDelete": [
|
|
164
|
+
* "Amazon EKS"
|
|
165
|
+
* ],
|
|
166
|
+
* "reportedIncidentStartDate": "2023-03-27T15:32:01.789Z",
|
|
167
|
+
* "threatActorIpAddressesToAdd": [
|
|
168
|
+
* {
|
|
169
|
+
* "ipAddress": "190.160.190.160",
|
|
170
|
+
* "userAgent": "Browser"
|
|
171
|
+
* }
|
|
172
|
+
* ],
|
|
173
|
+
* "threatActorIpAddressesToDelete": [
|
|
174
|
+
* {
|
|
175
|
+
* "ipAddress": "192.168.192.168",
|
|
176
|
+
* "userAgent": "Browser"
|
|
177
|
+
* }
|
|
178
|
+
* ],
|
|
179
|
+
* "title": "My sample case",
|
|
180
|
+
* "watchersToAdd": [
|
|
181
|
+
* {
|
|
182
|
+
* "name": "Same",
|
|
183
|
+
* "email": "Sam@example.com",
|
|
184
|
+
* "jobTitle": "CEO"
|
|
185
|
+
* }
|
|
186
|
+
* ],
|
|
187
|
+
* "watchersToDelete": [
|
|
188
|
+
* {
|
|
189
|
+
* "name": "Bob",
|
|
190
|
+
* "email": "bob@example.com",
|
|
191
|
+
* "jobTitle": "CFO"
|
|
192
|
+
* }
|
|
193
|
+
* ]
|
|
194
|
+
* };
|
|
195
|
+
* const command = new UpdateCaseCommand(input);
|
|
196
|
+
* await client.send(command);
|
|
197
|
+
* // example id: example-1
|
|
198
|
+
* ```
|
|
199
|
+
*
|
|
136
200
|
*/
|
|
137
201
|
export declare class UpdateCaseCommand extends UpdateCaseCommand_base {
|
|
138
202
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,6 +85,25 @@ declare const UpdateCaseCommentCommand_base: {
|
|
|
85
85
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
86
86
|
*
|
|
87
87
|
* @public
|
|
88
|
+
* @example Invoke UpdateCaseComment
|
|
89
|
+
* ```javascript
|
|
90
|
+
* //
|
|
91
|
+
* const input = {
|
|
92
|
+
* "body": "Updated case comment.",
|
|
93
|
+
* "caseId": "8403556009",
|
|
94
|
+
* "commentId": "000000"
|
|
95
|
+
* };
|
|
96
|
+
* const command = new UpdateCaseCommentCommand(input);
|
|
97
|
+
* const response = await client.send(command);
|
|
98
|
+
* /* response ==
|
|
99
|
+
* {
|
|
100
|
+
* "body": "Updated case comment.",
|
|
101
|
+
* "commentId": "000000"
|
|
102
|
+
* }
|
|
103
|
+
* *\/
|
|
104
|
+
* // example id: example-1
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
88
107
|
*/
|
|
89
108
|
export declare class UpdateCaseCommentCommand extends UpdateCaseCommentCommand_base {
|
|
90
109
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,6 +85,23 @@ declare const UpdateCaseStatusCommand_base: {
|
|
|
85
85
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
86
86
|
*
|
|
87
87
|
* @public
|
|
88
|
+
* @example Invoke UpdateCaseStatus
|
|
89
|
+
* ```javascript
|
|
90
|
+
* //
|
|
91
|
+
* const input = {
|
|
92
|
+
* "caseId": "8403556009",
|
|
93
|
+
* "caseStatus": "Post-incident Activities"
|
|
94
|
+
* };
|
|
95
|
+
* const command = new UpdateCaseStatusCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response ==
|
|
98
|
+
* {
|
|
99
|
+
* "caseStatus": "Post-incident Activities"
|
|
100
|
+
* }
|
|
101
|
+
* *\/
|
|
102
|
+
* // example id: example-1
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
88
105
|
*/
|
|
89
106
|
export declare class UpdateCaseStatusCommand extends UpdateCaseStatusCommand_base {
|
|
90
107
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -94,6 +94,36 @@ declare const UpdateMembershipCommand_base: {
|
|
|
94
94
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
95
95
|
*
|
|
96
96
|
* @public
|
|
97
|
+
* @example Invoke UpdateMembership
|
|
98
|
+
* ```javascript
|
|
99
|
+
* //
|
|
100
|
+
* const input = {
|
|
101
|
+
* "incidentResponseTeam": [
|
|
102
|
+
* {
|
|
103
|
+
* "name": "Bob Jones",
|
|
104
|
+
* "email": "bob.jones@gmail.com",
|
|
105
|
+
* "jobTitle": "Security Responder"
|
|
106
|
+
* },
|
|
107
|
+
* {
|
|
108
|
+
* "name": "Alice",
|
|
109
|
+
* "email": "alice@example.com",
|
|
110
|
+
* "jobTitle": "CEO"
|
|
111
|
+
* }
|
|
112
|
+
* ],
|
|
113
|
+
* "membershipId": "m-abcd1234efgh",
|
|
114
|
+
* "membershipName": "New membership name",
|
|
115
|
+
* "optInFeatures": [
|
|
116
|
+
* {
|
|
117
|
+
* "featureName": "Triage",
|
|
118
|
+
* "isEnabled": true
|
|
119
|
+
* }
|
|
120
|
+
* ]
|
|
121
|
+
* };
|
|
122
|
+
* const command = new UpdateMembershipCommand(input);
|
|
123
|
+
* await client.send(command);
|
|
124
|
+
* // example id: example-1
|
|
125
|
+
* ```
|
|
126
|
+
*
|
|
97
127
|
*/
|
|
98
128
|
export declare class UpdateMembershipCommand extends UpdateMembershipCommand_base {
|
|
99
129
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -89,6 +89,25 @@ declare const UpdateResolverTypeCommand_base: {
|
|
|
89
89
|
* <p>Base exception class for all service exceptions from SecurityIR service.</p>
|
|
90
90
|
*
|
|
91
91
|
* @public
|
|
92
|
+
* @example Invoke UpdateResolverType
|
|
93
|
+
* ```javascript
|
|
94
|
+
* //
|
|
95
|
+
* const input = {
|
|
96
|
+
* "caseId": "8403556009",
|
|
97
|
+
* "resolverType": "AWS"
|
|
98
|
+
* };
|
|
99
|
+
* const command = new UpdateResolverTypeCommand(input);
|
|
100
|
+
* const response = await client.send(command);
|
|
101
|
+
* /* response ==
|
|
102
|
+
* {
|
|
103
|
+
* "caseId": "8403556009",
|
|
104
|
+
* "caseStatus": "Detection and Analysis",
|
|
105
|
+
* "resolverType": "AWS"
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* // example id: example-1
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
92
111
|
*/
|
|
93
112
|
export declare class UpdateResolverTypeCommand extends UpdateResolverTypeCommand_base {
|
|
94
113
|
/** @internal type navigation helper, not in runtime. */
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-security-ir",
|
|
3
3
|
"description": "AWS SDK for JavaScript Security Ir Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.709.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,43 +20,43 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/core": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
28
|
-
"@aws-sdk/middleware-logger": "3.
|
|
29
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
32
|
-
"@aws-sdk/types": "3.
|
|
33
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
36
|
-
"@smithy/config-resolver": "^3.0.
|
|
37
|
-
"@smithy/core": "^2.5.
|
|
38
|
-
"@smithy/fetch-http-handler": "^4.1.
|
|
39
|
-
"@smithy/hash-node": "^3.0.
|
|
40
|
-
"@smithy/invalid-dependency": "^3.0.
|
|
41
|
-
"@smithy/middleware-content-length": "^3.0.
|
|
42
|
-
"@smithy/middleware-endpoint": "^3.2.
|
|
43
|
-
"@smithy/middleware-retry": "^3.0.
|
|
44
|
-
"@smithy/middleware-serde": "^3.0.
|
|
45
|
-
"@smithy/middleware-stack": "^3.0.
|
|
46
|
-
"@smithy/node-config-provider": "^3.1.
|
|
47
|
-
"@smithy/node-http-handler": "^3.3.
|
|
48
|
-
"@smithy/protocol-http": "^4.1.
|
|
49
|
-
"@smithy/smithy-client": "^3.
|
|
50
|
-
"@smithy/types": "^3.7.
|
|
51
|
-
"@smithy/url-parser": "^3.0.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.709.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.709.0",
|
|
25
|
+
"@aws-sdk/core": "3.709.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.709.0",
|
|
27
|
+
"@aws-sdk/middleware-host-header": "3.709.0",
|
|
28
|
+
"@aws-sdk/middleware-logger": "3.709.0",
|
|
29
|
+
"@aws-sdk/middleware-recursion-detection": "3.709.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.709.0",
|
|
31
|
+
"@aws-sdk/region-config-resolver": "3.709.0",
|
|
32
|
+
"@aws-sdk/types": "3.709.0",
|
|
33
|
+
"@aws-sdk/util-endpoints": "3.709.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-browser": "3.709.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.709.0",
|
|
36
|
+
"@smithy/config-resolver": "^3.0.13",
|
|
37
|
+
"@smithy/core": "^2.5.5",
|
|
38
|
+
"@smithy/fetch-http-handler": "^4.1.2",
|
|
39
|
+
"@smithy/hash-node": "^3.0.11",
|
|
40
|
+
"@smithy/invalid-dependency": "^3.0.11",
|
|
41
|
+
"@smithy/middleware-content-length": "^3.0.13",
|
|
42
|
+
"@smithy/middleware-endpoint": "^3.2.5",
|
|
43
|
+
"@smithy/middleware-retry": "^3.0.30",
|
|
44
|
+
"@smithy/middleware-serde": "^3.0.11",
|
|
45
|
+
"@smithy/middleware-stack": "^3.0.11",
|
|
46
|
+
"@smithy/node-config-provider": "^3.1.12",
|
|
47
|
+
"@smithy/node-http-handler": "^3.3.2",
|
|
48
|
+
"@smithy/protocol-http": "^4.1.8",
|
|
49
|
+
"@smithy/smithy-client": "^3.5.0",
|
|
50
|
+
"@smithy/types": "^3.7.2",
|
|
51
|
+
"@smithy/url-parser": "^3.0.11",
|
|
52
52
|
"@smithy/util-base64": "^3.0.0",
|
|
53
53
|
"@smithy/util-body-length-browser": "^3.0.0",
|
|
54
54
|
"@smithy/util-body-length-node": "^3.0.0",
|
|
55
|
-
"@smithy/util-defaults-mode-browser": "^3.0.
|
|
56
|
-
"@smithy/util-defaults-mode-node": "^3.0.
|
|
57
|
-
"@smithy/util-endpoints": "^2.1.
|
|
58
|
-
"@smithy/util-middleware": "^3.0.
|
|
59
|
-
"@smithy/util-retry": "^3.0.
|
|
55
|
+
"@smithy/util-defaults-mode-browser": "^3.0.30",
|
|
56
|
+
"@smithy/util-defaults-mode-node": "^3.0.30",
|
|
57
|
+
"@smithy/util-endpoints": "^2.1.7",
|
|
58
|
+
"@smithy/util-middleware": "^3.0.11",
|
|
59
|
+
"@smithy/util-retry": "^3.0.11",
|
|
60
60
|
"@smithy/util-utf8": "^3.0.0",
|
|
61
61
|
"@types/uuid": "^9.0.1",
|
|
62
62
|
"tslib": "^2.6.2",
|