@aws-sdk/client-securityagent 3.1041.0 → 3.1042.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/index.js +1 -0
  3. package/dist-cjs/schemas/schemas_0.js +9 -8
  4. package/dist-es/models/enums.js +1 -0
  5. package/dist-es/schemas/schemas_0.js +9 -8
  6. package/dist-types/SecurityAgent.d.ts +1 -1
  7. package/dist-types/SecurityAgentClient.d.ts +1 -1
  8. package/dist-types/commands/AddArtifactCommand.d.ts +6 -8
  9. package/dist-types/commands/BatchDeletePentestsCommand.d.ts +1 -1
  10. package/dist-types/commands/BatchGetAgentSpacesCommand.d.ts +1 -1
  11. package/dist-types/commands/BatchGetArtifactMetadataCommand.d.ts +6 -8
  12. package/dist-types/commands/BatchGetFindingsCommand.d.ts +1 -1
  13. package/dist-types/commands/BatchGetPentestJobTasksCommand.d.ts +1 -1
  14. package/dist-types/commands/BatchGetPentestJobsCommand.d.ts +1 -1
  15. package/dist-types/commands/BatchGetPentestsCommand.d.ts +1 -1
  16. package/dist-types/commands/BatchGetTargetDomainsCommand.d.ts +3 -2
  17. package/dist-types/commands/CreateAgentSpaceCommand.d.ts +1 -1
  18. package/dist-types/commands/CreateApplicationCommand.d.ts +1 -1
  19. package/dist-types/commands/CreateIntegrationCommand.d.ts +7 -9
  20. package/dist-types/commands/CreateMembershipCommand.d.ts +1 -1
  21. package/dist-types/commands/CreatePentestCommand.d.ts +1 -1
  22. package/dist-types/commands/CreateTargetDomainCommand.d.ts +4 -3
  23. package/dist-types/commands/DeleteAgentSpaceCommand.d.ts +1 -1
  24. package/dist-types/commands/DeleteApplicationCommand.d.ts +1 -1
  25. package/dist-types/commands/DeleteArtifactCommand.d.ts +6 -8
  26. package/dist-types/commands/DeleteIntegrationCommand.d.ts +7 -9
  27. package/dist-types/commands/DeleteMembershipCommand.d.ts +1 -1
  28. package/dist-types/commands/DeleteTargetDomainCommand.d.ts +1 -1
  29. package/dist-types/commands/GetApplicationCommand.d.ts +1 -1
  30. package/dist-types/commands/GetArtifactCommand.d.ts +6 -8
  31. package/dist-types/commands/GetIntegrationCommand.d.ts +6 -8
  32. package/dist-types/commands/InitiateProviderRegistrationCommand.d.ts +7 -9
  33. package/dist-types/commands/ListAgentSpacesCommand.d.ts +1 -1
  34. package/dist-types/commands/ListApplicationsCommand.d.ts +1 -1
  35. package/dist-types/commands/ListArtifactsCommand.d.ts +6 -8
  36. package/dist-types/commands/ListDiscoveredEndpointsCommand.d.ts +1 -1
  37. package/dist-types/commands/ListFindingsCommand.d.ts +1 -1
  38. package/dist-types/commands/ListIntegratedResourcesCommand.d.ts +6 -8
  39. package/dist-types/commands/ListIntegrationsCommand.d.ts +8 -5
  40. package/dist-types/commands/ListMembershipsCommand.d.ts +1 -1
  41. package/dist-types/commands/ListPentestJobTasksCommand.d.ts +1 -1
  42. package/dist-types/commands/ListPentestJobsForPentestCommand.d.ts +1 -1
  43. package/dist-types/commands/ListPentestsCommand.d.ts +1 -1
  44. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  45. package/dist-types/commands/ListTargetDomainsCommand.d.ts +1 -1
  46. package/dist-types/commands/StartCodeRemediationCommand.d.ts +1 -1
  47. package/dist-types/commands/StartPentestJobCommand.d.ts +1 -1
  48. package/dist-types/commands/StopPentestJobCommand.d.ts +1 -1
  49. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  50. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  51. package/dist-types/commands/UpdateAgentSpaceCommand.d.ts +1 -1
  52. package/dist-types/commands/UpdateApplicationCommand.d.ts +1 -1
  53. package/dist-types/commands/UpdateFindingCommand.d.ts +1 -1
  54. package/dist-types/commands/UpdateIntegratedResourcesCommand.d.ts +7 -9
  55. package/dist-types/commands/UpdatePentestCommand.d.ts +1 -1
  56. package/dist-types/commands/UpdateTargetDomainCommand.d.ts +4 -3
  57. package/dist-types/commands/VerifyTargetDomainCommand.d.ts +2 -1
  58. package/dist-types/index.d.ts +1 -1
  59. package/dist-types/models/enums.d.ts +81 -77
  60. package/dist-types/models/errors.d.ts +9 -12
  61. package/dist-types/models/models_0.d.ts +679 -659
  62. package/dist-types/ts3.4/models/enums.d.ts +1 -0
  63. package/dist-types/ts3.4/models/models_0.d.ts +4 -0
  64. package/package.json +1 -1
@@ -1,42 +1,42 @@
1
1
  import type { AccessType, ArtifactType, AuthenticationProviderType, CodeRemediationStrategy, CodeRemediationTaskStatus, ConfidenceLevel, ContextType, DNSRecordType, DomainVerificationMethod, ErrorCode, FindingStatus, JobStatus, LogType, MembershipType, MembershipTypeFilter, NetworkTrafficRuleEffect, NetworkTrafficRuleType, Provider, ProviderType, ResourceType, RiskLevel, RiskType, StepName, StepStatus, TargetDomainStatus, TaskExecutionStatus, UserRole } from "./enums";
2
2
  /**
3
- * Authentication information used to access protected resources
3
+ * <p>The authentication configuration for an actor, specifying the provider type and credentials.</p>
4
4
  * @public
5
5
  */
6
6
  export interface Authentication {
7
7
  /**
8
- * Provider type for the authentication credentials
8
+ * <p>The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.</p>
9
9
  * @public
10
10
  */
11
11
  providerType?: AuthenticationProviderType | undefined;
12
12
  /**
13
- * Authentication credential value or reference
13
+ * <p>The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.</p>
14
14
  * @public
15
15
  */
16
16
  value?: string | undefined;
17
17
  }
18
18
  /**
19
- * Represents an entity that interacts with the system during security testing
19
+ * <p>Represents an actor used during penetration testing. An actor defines a user or entity that interacts with the target application, including authentication credentials and target URIs.</p>
20
20
  * @public
21
21
  */
22
22
  export interface Actor {
23
23
  /**
24
- * Unique identifier for the actor (case-insensitive)
24
+ * <p>The unique identifier for the actor.</p>
25
25
  * @public
26
26
  */
27
27
  identifier?: string | undefined;
28
28
  /**
29
- * List of URIs accessible with the actor's credentials
29
+ * <p>The list of URIs that the actor targets during testing.</p>
30
30
  * @public
31
31
  */
32
32
  uris?: string[] | undefined;
33
33
  /**
34
- * Authentication information used by the actor to access resources
34
+ * <p>The authentication configuration for the actor.</p>
35
35
  * @public
36
36
  */
37
37
  authentication?: Authentication | undefined;
38
38
  /**
39
- * Additional description or details about the actor
39
+ * <p>A description of the actor.</p>
40
40
  * @public
41
41
  */
42
42
  description?: string | undefined;
@@ -46,22 +46,22 @@ export interface Actor {
46
46
  */
47
47
  export interface AddArtifactInput {
48
48
  /**
49
- * Unique identifier of the agent space
49
+ * <p>The unique identifier of the agent space to add the artifact to.</p>
50
50
  * @public
51
51
  */
52
52
  agentSpaceId: string | undefined;
53
53
  /**
54
- * Binary content of the artifact
54
+ * <p>The binary content of the artifact to upload.</p>
55
55
  * @public
56
56
  */
57
57
  artifactContent: Uint8Array | undefined;
58
58
  /**
59
- * Type of the artifact file
59
+ * <p>The file type of the artifact. Valid values include TXT, PNG, JPEG, MD, PDF, DOCX, DOC, JSON, and YAML.</p>
60
60
  * @public
61
61
  */
62
62
  artifactType: ArtifactType | undefined;
63
63
  /**
64
- * Name of the artifact file
64
+ * <p>The file name of the artifact.</p>
65
65
  * @public
66
66
  */
67
67
  fileName: string | undefined;
@@ -71,428 +71,428 @@ export interface AddArtifactInput {
71
71
  */
72
72
  export interface AddArtifactOutput {
73
73
  /**
74
- * Unique identifier of the created artifact
74
+ * <p>The unique identifier assigned to the uploaded artifact.</p>
75
75
  * @public
76
76
  */
77
77
  artifactId: string | undefined;
78
78
  }
79
79
  /**
80
- * Describes one specific validation failure for an input member.
80
+ * <p>Describes one specific validation failure for an input member.</p>
81
81
  * @public
82
82
  */
83
83
  export interface ValidationExceptionField {
84
84
  /**
85
- * A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.
85
+ * <p>A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraint.</p>
86
86
  * @public
87
87
  */
88
88
  path: string | undefined;
89
89
  /**
90
- * A detailed description of the validation failure.
90
+ * <p>A detailed description of the validation failure.</p>
91
91
  * @public
92
92
  */
93
93
  message: string | undefined;
94
94
  }
95
95
  /**
96
- * Customer VPC configuration that the Security Agent accesses
96
+ * <p>The VPC configuration for a pentest, specifying the VPC, security groups, and subnets to use during testing.</p>
97
97
  * @public
98
98
  */
99
99
  export interface VpcConfig {
100
100
  /**
101
- * ARN or ID of the customer VPC
101
+ * <p>The Amazon Resource Name (ARN) of the VPC.</p>
102
102
  * @public
103
103
  */
104
104
  vpcArn?: string | undefined;
105
105
  /**
106
- * List of security group ARNs or IDs in the customer VPC
106
+ * <p>The Amazon Resource Names (ARNs) of the security groups for the VPC configuration.</p>
107
107
  * @public
108
108
  */
109
109
  securityGroupArns?: string[] | undefined;
110
110
  /**
111
- * List of subnet ARNs or IDs in the customer VPC
111
+ * <p>The Amazon Resource Names (ARNs) of the subnets for the VPC configuration.</p>
112
112
  * @public
113
113
  */
114
114
  subnetArns?: string[] | undefined;
115
115
  }
116
116
  /**
117
- * AWS resource configurations associated with the agent space
117
+ * <p>The AWS resources associated with an agent space, including VPCs, log groups, S3 buckets, secrets, Lambda functions, and IAM roles.</p>
118
118
  * @public
119
119
  */
120
120
  export interface AWSResources {
121
121
  /**
122
- * VPC configurations that the Security Agent accesses in the customer environment
122
+ * <p>The VPC configurations associated with the agent space.</p>
123
123
  * @public
124
124
  */
125
125
  vpcs?: VpcConfig[] | undefined;
126
126
  /**
127
- * CloudWatch log group ARNs or names used to store Security Agent logs
127
+ * <p>The Amazon Resource Names (ARNs) of the CloudWatch log groups associated with the agent space.</p>
128
128
  * @public
129
129
  */
130
130
  logGroups?: string[] | undefined;
131
131
  /**
132
- * S3 bucket ARNs or names used to store Security Agent artifacts
132
+ * <p>The Amazon Resource Names (ARNs) of the S3 buckets associated with the agent space.</p>
133
133
  * @public
134
134
  */
135
135
  s3Buckets?: string[] | undefined;
136
136
  /**
137
- * SecretsManager secret ARNs or names used to store tester credentials for pentests
137
+ * <p>The Amazon Resource Names (ARNs) of the Secrets Manager secrets associated with the agent space.</p>
138
138
  * @public
139
139
  */
140
140
  secretArns?: string[] | undefined;
141
141
  /**
142
- * Lambda function ARNs or names used to retrieve tester credentials for pentests
142
+ * <p>The Amazon Resource Names (ARNs) of the Lambda functions associated with the agent space.</p>
143
143
  * @public
144
144
  */
145
145
  lambdaFunctionArns?: string[] | undefined;
146
146
  /**
147
- * IAM role ARNs that the Security Agent can assume to access customer resources
147
+ * <p>The IAM roles associated with the agent space.</p>
148
148
  * @public
149
149
  */
150
150
  iamRoles?: string[] | undefined;
151
151
  }
152
152
  /**
153
- * Details of code review settings
153
+ * <p>The code review settings for an agent space, controlling which types of scanning are enabled.</p>
154
154
  * @public
155
155
  */
156
156
  export interface CodeReviewSettings {
157
157
  /**
158
- * Whether Controls are utilized for code review analysis
158
+ * <p>Indicates whether controls scanning is enabled for code reviews.</p>
159
159
  * @public
160
160
  */
161
161
  controlsScanning: boolean | undefined;
162
162
  /**
163
- * Whether general purpose analysis is performed for code review
163
+ * <p>Indicates whether general-purpose scanning is enabled for code reviews.</p>
164
164
  * @public
165
165
  */
166
166
  generalPurposeScanning: boolean | undefined;
167
167
  }
168
168
  /**
169
- * Agent space structure
169
+ * <p>Represents an agent space, which is a dedicated workspace for securing a specific application. An agent space contains the configuration, resources, and settings needed for security testing.</p>
170
170
  * @public
171
171
  */
172
172
  export interface AgentSpace {
173
173
  /**
174
- * Unique identifier of the agent space
174
+ * <p>The unique identifier of the agent space.</p>
175
175
  * @public
176
176
  */
177
177
  agentSpaceId: string | undefined;
178
178
  /**
179
- * Name of the agent space
179
+ * <p>The name of the agent space.</p>
180
180
  * @public
181
181
  */
182
182
  name: string | undefined;
183
183
  /**
184
- * Description of the agent space
184
+ * <p>A description of the agent space.</p>
185
185
  * @public
186
186
  */
187
187
  description?: string | undefined;
188
188
  /**
189
- * AWS resource configurations
189
+ * <p>The AWS resources associated with the agent space.</p>
190
190
  * @public
191
191
  */
192
192
  awsResources?: AWSResources | undefined;
193
193
  /**
194
- * List of target domain IDs registered with the agent space
194
+ * <p>The list of target domain identifiers associated with the agent space.</p>
195
195
  * @public
196
196
  */
197
197
  targetDomainIds?: string[] | undefined;
198
198
  /**
199
- * Configuration for code review analysis, including controls scanning and general purpose scanning settings
199
+ * <p>The code review settings for the agent space.</p>
200
200
  * @public
201
201
  */
202
202
  codeReviewSettings?: CodeReviewSettings | undefined;
203
203
  /**
204
- * Identifier of the KMS key used to encrypt data. Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.
204
+ * <p>The identifier of the AWS KMS key used to encrypt data in the agent space.</p>
205
205
  * @public
206
206
  */
207
207
  kmsKeyId?: string | undefined;
208
208
  /**
209
- * Timestamp when the agent space was created
209
+ * <p>The date and time the agent space was created, in UTC format.</p>
210
210
  * @public
211
211
  */
212
212
  createdAt?: Date | undefined;
213
213
  /**
214
- * Timestamp when the agent space was last updated
214
+ * <p>The date and time the agent space was last updated, in UTC format.</p>
215
215
  * @public
216
216
  */
217
217
  updatedAt?: Date | undefined;
218
218
  }
219
219
  /**
220
- * Input for batch retrieving agent spaces
220
+ * <p>Input for batch retrieving agent spaces.</p>
221
221
  * @public
222
222
  */
223
223
  export interface BatchGetAgentSpacesInput {
224
224
  /**
225
- * List of agent space IDs to retrieve
225
+ * <p>The list of agent space identifiers to retrieve.</p>
226
226
  * @public
227
227
  */
228
228
  agentSpaceIds: string[] | undefined;
229
229
  }
230
230
  /**
231
- * Output for the BatchGetAgentSpaces operation
231
+ * <p>Output for the BatchGetAgentSpaces operation.</p>
232
232
  * @public
233
233
  */
234
234
  export interface BatchGetAgentSpacesOutput {
235
235
  /**
236
- * List of agent spaces that were successfully retrieved
236
+ * <p>The list of agent spaces that were found.</p>
237
237
  * @public
238
238
  */
239
239
  agentSpaces?: AgentSpace[] | undefined;
240
240
  /**
241
- * List of agent space IDs that could not be found
241
+ * <p>The list of agent space identifiers that were not found.</p>
242
242
  * @public
243
243
  */
244
244
  notFound?: string[] | undefined;
245
245
  }
246
246
  /**
247
- * Input for creating a new agent space
247
+ * <p>Input for creating a new agent space.</p>
248
248
  * @public
249
249
  */
250
250
  export interface CreateAgentSpaceInput {
251
251
  /**
252
- * Name of the agent space
252
+ * <p>The name of the agent space.</p>
253
253
  * @public
254
254
  */
255
255
  name: string | undefined;
256
256
  /**
257
- * Description of the agent space
257
+ * <p>A description of the agent space.</p>
258
258
  * @public
259
259
  */
260
260
  description?: string | undefined;
261
261
  /**
262
- * AWS resource configurations associated with the agent space
262
+ * <p>The AWS resources to associate with the agent space.</p>
263
263
  * @public
264
264
  */
265
265
  awsResources?: AWSResources | undefined;
266
266
  /**
267
- * Target domain IDs to associate with the agent space
267
+ * <p>The list of target domain identifiers to associate with the agent space.</p>
268
268
  * @public
269
269
  */
270
270
  targetDomainIds?: string[] | undefined;
271
271
  /**
272
- * Configuration for code review analysis, including controls scanning and general purpose scanning settings
272
+ * <p>The code review settings for the agent space.</p>
273
273
  * @public
274
274
  */
275
275
  codeReviewSettings?: CodeReviewSettings | undefined;
276
276
  /**
277
- * Identifier of the KMS key used to encrypt data. Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.
277
+ * <p>The identifier of the AWS KMS key to use for encrypting data in the agent space.</p>
278
278
  * @public
279
279
  */
280
280
  kmsKeyId?: string | undefined;
281
281
  /**
282
- * Tags to associate with the agent space
282
+ * <p>The tags to associate with the agent space.</p>
283
283
  * @public
284
284
  */
285
285
  tags?: Record<string, string> | undefined;
286
286
  }
287
287
  /**
288
- * Output for the CreateAgentSpace operation
288
+ * <p>Output for the CreateAgentSpace operation.</p>
289
289
  * @public
290
290
  */
291
291
  export interface CreateAgentSpaceOutput {
292
292
  /**
293
- * Unique identifier of the created agent space
293
+ * <p>The unique identifier of the created agent space.</p>
294
294
  * @public
295
295
  */
296
296
  agentSpaceId: string | undefined;
297
297
  /**
298
- * Name of the created agent space
298
+ * <p>The name of the agent space.</p>
299
299
  * @public
300
300
  */
301
301
  name: string | undefined;
302
302
  /**
303
- * Description of the created agent space
303
+ * <p>The description of the agent space.</p>
304
304
  * @public
305
305
  */
306
306
  description?: string | undefined;
307
307
  /**
308
- * AWS resource configurations associated with the agent space
308
+ * <p>The AWS resources associated with the agent space.</p>
309
309
  * @public
310
310
  */
311
311
  awsResources?: AWSResources | undefined;
312
312
  /**
313
- * List of target domain IDs registered with the agent space
313
+ * <p>The list of target domain identifiers associated with the agent space.</p>
314
314
  * @public
315
315
  */
316
316
  targetDomainIds?: string[] | undefined;
317
317
  /**
318
- * Configuration for code review analysis, including controls scanning and general purpose scanning settings
318
+ * <p>The code review settings for the agent space.</p>
319
319
  * @public
320
320
  */
321
321
  codeReviewSettings?: CodeReviewSettings | undefined;
322
322
  /**
323
- * Identifier of the KMS key used to encrypt data. Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.
323
+ * <p>The identifier of the AWS KMS key used to encrypt data in the agent space.</p>
324
324
  * @public
325
325
  */
326
326
  kmsKeyId?: string | undefined;
327
327
  /**
328
- * Timestamp when the agent space was created
328
+ * <p>The date and time the agent space was created, in UTC format.</p>
329
329
  * @public
330
330
  */
331
331
  createdAt?: Date | undefined;
332
332
  /**
333
- * Timestamp when the agent space was last updated
333
+ * <p>The date and time the agent space was last updated, in UTC format.</p>
334
334
  * @public
335
335
  */
336
336
  updatedAt?: Date | undefined;
337
337
  }
338
338
  /**
339
- * Input for deleting an agent space
339
+ * <p>Input for deleting an agent space.</p>
340
340
  * @public
341
341
  */
342
342
  export interface DeleteAgentSpaceInput {
343
343
  /**
344
- * Unique identifier of the agent space to delete
344
+ * <p>The unique identifier of the agent space to delete.</p>
345
345
  * @public
346
346
  */
347
347
  agentSpaceId: string | undefined;
348
348
  }
349
349
  /**
350
- * Output for the DeleteAgentSpace operation
350
+ * <p>Output for the DeleteAgentSpace operation.</p>
351
351
  * @public
352
352
  */
353
353
  export interface DeleteAgentSpaceOutput {
354
354
  /**
355
- * Unique identifier of the deleted agent space
355
+ * <p>The unique identifier of the deleted agent space.</p>
356
356
  * @public
357
357
  */
358
358
  agentSpaceId?: string | undefined;
359
359
  }
360
360
  /**
361
- * Input for listing agent spaces
361
+ * <p>Input for listing agent spaces.</p>
362
362
  * @public
363
363
  */
364
364
  export interface ListAgentSpacesInput {
365
365
  /**
366
- * Token for pagination
366
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
367
367
  * @public
368
368
  */
369
369
  nextToken?: string | undefined;
370
370
  /**
371
- * Maximum number of agent spaces to return
371
+ * <p>The maximum number of results to return in a single call.</p>
372
372
  * @public
373
373
  */
374
374
  maxResults?: number | undefined;
375
375
  }
376
376
  /**
377
- * Summary information for an agent space
377
+ * <p>Contains summary information about an agent space.</p>
378
378
  * @public
379
379
  */
380
380
  export interface AgentSpaceSummary {
381
381
  /**
382
- * Unique identifier of the agent space
382
+ * <p>The unique identifier of the agent space.</p>
383
383
  * @public
384
384
  */
385
385
  agentSpaceId: string | undefined;
386
386
  /**
387
- * Name of the agent space
387
+ * <p>The name of the agent space.</p>
388
388
  * @public
389
389
  */
390
390
  name: string | undefined;
391
391
  /**
392
- * Timestamp when the agent space was created
392
+ * <p>The date and time the agent space was created, in UTC format.</p>
393
393
  * @public
394
394
  */
395
395
  createdAt?: Date | undefined;
396
396
  /**
397
- * Timestamp when the agent space was last updated
397
+ * <p>The date and time the agent space was last updated, in UTC format.</p>
398
398
  * @public
399
399
  */
400
400
  updatedAt?: Date | undefined;
401
401
  }
402
402
  /**
403
- * Output for the ListAgentSpaces operation
403
+ * <p>Output for the ListAgentSpaces operation.</p>
404
404
  * @public
405
405
  */
406
406
  export interface ListAgentSpacesOutput {
407
407
  /**
408
- * List of agent space summaries
408
+ * <p>The list of agent space summaries.</p>
409
409
  * @public
410
410
  */
411
411
  agentSpaceSummaries?: AgentSpaceSummary[] | undefined;
412
412
  /**
413
- * Token for next page of results
413
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
414
414
  * @public
415
415
  */
416
416
  nextToken?: string | undefined;
417
417
  }
418
418
  /**
419
- * Input for updating an agent space
419
+ * <p>Input for updating an agent space.</p>
420
420
  * @public
421
421
  */
422
422
  export interface UpdateAgentSpaceInput {
423
423
  /**
424
- * ID of the agent space to update
424
+ * <p>The unique identifier of the agent space to update.</p>
425
425
  * @public
426
426
  */
427
427
  agentSpaceId: string | undefined;
428
428
  /**
429
- * Name of the agent space
429
+ * <p>The updated name of the agent space.</p>
430
430
  * @public
431
431
  */
432
432
  name?: string | undefined;
433
433
  /**
434
- * Description of the agent space
434
+ * <p>The updated description of the agent space.</p>
435
435
  * @public
436
436
  */
437
437
  description?: string | undefined;
438
438
  /**
439
- * AWS resource configurations associated with the agent space
439
+ * <p>The updated AWS resources to associate with the agent space.</p>
440
440
  * @public
441
441
  */
442
442
  awsResources?: AWSResources | undefined;
443
443
  /**
444
- * Target domain IDs to associate with the agent space
444
+ * <p>The updated list of target domain identifiers to associate with the agent space.</p>
445
445
  * @public
446
446
  */
447
447
  targetDomainIds?: string[] | undefined;
448
448
  /**
449
- * Configuration for code review analysis, including controls scanning and general purpose scanning settings
449
+ * <p>The updated code review settings for the agent space.</p>
450
450
  * @public
451
451
  */
452
452
  codeReviewSettings?: CodeReviewSettings | undefined;
453
453
  }
454
454
  /**
455
- * Output for the UpdateAgentSpace operation
455
+ * <p>Output for the UpdateAgentSpace operation.</p>
456
456
  * @public
457
457
  */
458
458
  export interface UpdateAgentSpaceOutput {
459
459
  /**
460
- * Unique identifier of the agent space
460
+ * <p>The unique identifier of the updated agent space.</p>
461
461
  * @public
462
462
  */
463
463
  agentSpaceId: string | undefined;
464
464
  /**
465
- * Name of the agent space
465
+ * <p>The name of the agent space.</p>
466
466
  * @public
467
467
  */
468
468
  name: string | undefined;
469
469
  /**
470
- * Description of the agent space
470
+ * <p>The description of the agent space.</p>
471
471
  * @public
472
472
  */
473
473
  description?: string | undefined;
474
474
  /**
475
- * AWS resource configurations associated with the agent space
475
+ * <p>The AWS resources associated with the agent space.</p>
476
476
  * @public
477
477
  */
478
478
  awsResources?: AWSResources | undefined;
479
479
  /**
480
- * List of target domain IDs registered with the agent space
480
+ * <p>The list of target domain identifiers associated with the agent space.</p>
481
481
  * @public
482
482
  */
483
483
  targetDomainIds?: string[] | undefined;
484
484
  /**
485
- * Configuration for code review analysis, including controls scanning and general purpose scanning settings
485
+ * <p>The code review settings for the agent space.</p>
486
486
  * @public
487
487
  */
488
488
  codeReviewSettings?: CodeReviewSettings | undefined;
489
489
  /**
490
- * Timestamp when the agent space was created
490
+ * <p>The date and time the agent space was created, in UTC format.</p>
491
491
  * @public
492
492
  */
493
493
  createdAt?: Date | undefined;
494
494
  /**
495
- * Timestamp when the agent space was last updated
495
+ * <p>The date and time the agent space was last updated, in UTC format.</p>
496
496
  * @public
497
497
  */
498
498
  updatedAt?: Date | undefined;
@@ -502,22 +502,22 @@ export interface UpdateAgentSpaceOutput {
502
502
  */
503
503
  export interface CreateApplicationRequest {
504
504
  /**
505
- * ARN of the IAM Identity Center instance used for user authentication. Optional for non-IdC applications
505
+ * <p>The Amazon Resource Name (ARN) of the IAM Identity Center instance to associate with the application.</p>
506
506
  * @public
507
507
  */
508
508
  idcInstanceArn?: string | undefined;
509
509
  /**
510
- * ARN of the IAM role that the application uses to access AWS resources on your behalf
510
+ * <p>The Amazon Resource Name (ARN) of the IAM role to associate with the application.</p>
511
511
  * @public
512
512
  */
513
513
  roleArn?: string | undefined;
514
514
  /**
515
- * Default KMS key identifier used to encrypt application data
515
+ * <p>The identifier of the default AWS KMS key to use for encrypting data in the application.</p>
516
516
  * @public
517
517
  */
518
518
  defaultKmsKeyId?: string | undefined;
519
519
  /**
520
- * Tags to associate with the application
520
+ * <p>The tags to associate with the application.</p>
521
521
  * @public
522
522
  */
523
523
  tags?: Record<string, string> | undefined;
@@ -527,7 +527,7 @@ export interface CreateApplicationRequest {
527
527
  */
528
528
  export interface CreateApplicationResponse {
529
529
  /**
530
- * Application ID
530
+ * <p>The unique identifier of the created application.</p>
531
531
  * @public
532
532
  */
533
533
  applicationId: string | undefined;
@@ -537,7 +537,7 @@ export interface CreateApplicationResponse {
537
537
  */
538
538
  export interface DeleteApplicationRequest {
539
539
  /**
540
- * Application ID
540
+ * <p>The unique identifier of the application to delete.</p>
541
541
  * @public
542
542
  */
543
543
  applicationId: string | undefined;
@@ -547,23 +547,23 @@ export interface DeleteApplicationRequest {
547
547
  */
548
548
  export interface GetApplicationRequest {
549
549
  /**
550
- * Application ID
550
+ * <p>The unique identifier of the application to retrieve.</p>
551
551
  * @public
552
552
  */
553
553
  applicationId: string | undefined;
554
554
  }
555
555
  /**
556
- * IdC configuration containing application and instance ARNs
556
+ * <p>The IAM Identity Center configuration for an application.</p>
557
557
  * @public
558
558
  */
559
559
  export interface IdCConfiguration {
560
560
  /**
561
- * ARN of the IAM Identity Center application associated with this application
561
+ * <p>The Amazon Resource Name (ARN) of the IAM Identity Center application.</p>
562
562
  * @public
563
563
  */
564
564
  idcApplicationArn?: string | undefined;
565
565
  /**
566
- * ARN of the IAM Identity Center instance used for user authentication
566
+ * <p>The Amazon Resource Name (ARN) of the IAM Identity Center instance.</p>
567
567
  * @public
568
568
  */
569
569
  idcInstanceArn?: string | undefined;
@@ -573,32 +573,32 @@ export interface IdCConfiguration {
573
573
  */
574
574
  export interface GetApplicationResponse {
575
575
  /**
576
- * Application ID
576
+ * <p>The unique identifier of the application.</p>
577
577
  * @public
578
578
  */
579
579
  applicationId: string | undefined;
580
580
  /**
581
- * Domain where the application is available
581
+ * <p>The domain associated with the application.</p>
582
582
  * @public
583
583
  */
584
584
  domain: string | undefined;
585
585
  /**
586
- * Name of the application, automatically assigned by the service
586
+ * <p>The name of the application.</p>
587
587
  * @public
588
588
  */
589
589
  applicationName?: string | undefined;
590
590
  /**
591
- * IAM Identity Center configuration for the application
591
+ * <p>The IAM Identity Center configuration for the application.</p>
592
592
  * @public
593
593
  */
594
594
  idcConfiguration?: IdCConfiguration | undefined;
595
595
  /**
596
- * ARN of the IAM role that the application uses to access AWS resources on your behalf
596
+ * <p>The Amazon Resource Name (ARN) of the IAM role associated with the application.</p>
597
597
  * @public
598
598
  */
599
599
  roleArn?: string | undefined;
600
600
  /**
601
- * Default KMS key identifier used to encrypt application data
601
+ * <p>The identifier of the default AWS KMS key used to encrypt data for the application.</p>
602
602
  * @public
603
603
  */
604
604
  defaultKmsKeyId?: string | undefined;
@@ -608,38 +608,38 @@ export interface GetApplicationResponse {
608
608
  */
609
609
  export interface ListApplicationsRequest {
610
610
  /**
611
- * Token for pagination
611
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
612
612
  * @public
613
613
  */
614
614
  nextToken?: string | undefined;
615
615
  /**
616
- * Maximum number of results to return
616
+ * <p>The maximum number of results to return in a single call.</p>
617
617
  * @public
618
618
  */
619
619
  maxResults?: number | undefined;
620
620
  }
621
621
  /**
622
- * Application summary for list operations
622
+ * <p>Contains summary information about an application.</p>
623
623
  * @public
624
624
  */
625
625
  export interface ApplicationSummary {
626
626
  /**
627
- * Unique identifier of the application
627
+ * <p>The unique identifier of the application.</p>
628
628
  * @public
629
629
  */
630
630
  applicationId: string | undefined;
631
631
  /**
632
- * Name of the application, automatically assigned by the service
632
+ * <p>The name of the application.</p>
633
633
  * @public
634
634
  */
635
635
  applicationName: string | undefined;
636
636
  /**
637
- * Domain where the application is available
637
+ * <p>The domain associated with the application.</p>
638
638
  * @public
639
639
  */
640
640
  domain: string | undefined;
641
641
  /**
642
- * Default KMS key identifier used to encrypt application data
642
+ * <p>The identifier of the default AWS KMS key used to encrypt data for the application.</p>
643
643
  * @public
644
644
  */
645
645
  defaultKmsKeyId?: string | undefined;
@@ -649,12 +649,12 @@ export interface ApplicationSummary {
649
649
  */
650
650
  export interface ListApplicationsResponse {
651
651
  /**
652
- * List of application summaries
652
+ * <p>The list of application summaries.</p>
653
653
  * @public
654
654
  */
655
655
  applicationSummaries: ApplicationSummary[] | undefined;
656
656
  /**
657
- * Token for next page of results
657
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
658
658
  * @public
659
659
  */
660
660
  nextToken?: string | undefined;
@@ -664,17 +664,17 @@ export interface ListApplicationsResponse {
664
664
  */
665
665
  export interface UpdateApplicationRequest {
666
666
  /**
667
- * Application ID
667
+ * <p>The unique identifier of the application to update.</p>
668
668
  * @public
669
669
  */
670
670
  applicationId: string | undefined;
671
671
  /**
672
- * ARN of the IAM role that the application uses to access AWS resources on your behalf
672
+ * <p>The updated Amazon Resource Name (ARN) of the IAM role for the application.</p>
673
673
  * @public
674
674
  */
675
675
  roleArn?: string | undefined;
676
676
  /**
677
- * Default KMS key identifier. Use an empty string to remove the default KMS key.
677
+ * <p>The updated identifier of the default AWS KMS key for the application.</p>
678
678
  * @public
679
679
  */
680
680
  defaultKmsKeyId?: string | undefined;
@@ -684,338 +684,338 @@ export interface UpdateApplicationRequest {
684
684
  */
685
685
  export interface UpdateApplicationResponse {
686
686
  /**
687
- * Application ID
687
+ * <p>The unique identifier of the updated application.</p>
688
688
  * @public
689
689
  */
690
690
  applicationId: string | undefined;
691
691
  }
692
692
  /**
693
- * Files containing relevant data for review
693
+ * <p>Represents an artifact that provides context for security testing, such as documentation, diagrams, or configuration files.</p>
694
694
  * @public
695
695
  */
696
696
  export interface Artifact {
697
697
  /**
698
- * The content of the artifact
698
+ * <p>The content of the artifact.</p>
699
699
  * @public
700
700
  */
701
701
  contents: string | undefined;
702
702
  /**
703
- * The file type of the artifact
703
+ * <p>The file type of the artifact.</p>
704
704
  * @public
705
705
  */
706
706
  type: ArtifactType | undefined;
707
707
  }
708
708
  /**
709
- * Metadata in relation to the artifact
709
+ * <p>Contains metadata about an artifact.</p>
710
710
  * @public
711
711
  */
712
712
  export interface ArtifactMetadataItem {
713
713
  /**
714
- * Unique identifier of the agent space
714
+ * <p>The unique identifier of the agent space that contains the artifact.</p>
715
715
  * @public
716
716
  */
717
717
  agentSpaceId: string | undefined;
718
718
  /**
719
- * Unique identifier of the artifact
719
+ * <p>The unique identifier of the artifact.</p>
720
720
  * @public
721
721
  */
722
722
  artifactId: string | undefined;
723
723
  /**
724
- * Name of the artifact file
724
+ * <p>The file name of the artifact.</p>
725
725
  * @public
726
726
  */
727
727
  fileName: string | undefined;
728
728
  /**
729
- * Timestamp when the artifact was last updated
729
+ * <p>The date and time the artifact was last updated, in UTC format.</p>
730
730
  * @public
731
731
  */
732
732
  updatedAt: Date | undefined;
733
733
  }
734
734
  /**
735
- * Summary information about an artifact
735
+ * <p>Contains summary information about an artifact.</p>
736
736
  * @public
737
737
  */
738
738
  export interface ArtifactSummary {
739
739
  /**
740
- * Unique identifier of the artifact
740
+ * <p>The unique identifier of the artifact.</p>
741
741
  * @public
742
742
  */
743
743
  artifactId: string | undefined;
744
744
  /**
745
- * Name of the artifact file
745
+ * <p>The file name of the artifact.</p>
746
746
  * @public
747
747
  */
748
748
  fileName: string | undefined;
749
749
  /**
750
- * Type of the artifact file
750
+ * <p>The file type of the artifact.</p>
751
751
  * @public
752
752
  */
753
753
  artifactType: ArtifactType | undefined;
754
754
  }
755
755
  /**
756
- * Information about a document relevant to security testing
756
+ * <p>Represents a document that provides context for security testing.</p>
757
757
  * @public
758
758
  */
759
759
  export interface DocumentInfo {
760
760
  /**
761
- * S3 storage location of the document
761
+ * <p>The Amazon S3 location of the document.</p>
762
762
  * @public
763
763
  */
764
764
  s3Location?: string | undefined;
765
765
  /**
766
- * Artifact ID of the document
766
+ * <p>The unique identifier of the artifact associated with the document.</p>
767
767
  * @public
768
768
  */
769
769
  artifactId?: string | undefined;
770
770
  }
771
771
  /**
772
- * Represents a web application endpoint to be tested
772
+ * <p>Represents a target endpoint for penetration testing.</p>
773
773
  * @public
774
774
  */
775
775
  export interface Endpoint {
776
776
  /**
777
- * URI of the endpoint to test
777
+ * <p>The URI of the endpoint.</p>
778
778
  * @public
779
779
  */
780
780
  uri?: string | undefined;
781
781
  }
782
782
  /**
783
- * Information about an integrated repository
783
+ * <p>Represents a code repository that is integrated with the service through a third-party provider.</p>
784
784
  * @public
785
785
  */
786
786
  export interface IntegratedRepository {
787
787
  /**
788
- * Integration identifier
788
+ * <p>The unique identifier of the integration that provides access to the repository.</p>
789
789
  * @public
790
790
  */
791
791
  integrationId: string | undefined;
792
792
  /**
793
- * External provider resource identifier, e.g., Github repository identifier
793
+ * <p>The provider-specific resource identifier for the repository.</p>
794
794
  * @public
795
795
  */
796
796
  providerResourceId: string | undefined;
797
797
  }
798
798
  /**
799
- * Information about a source code repository for static analysis
799
+ * <p>Represents a source code repository used for security analysis during a pentest.</p>
800
800
  * @public
801
801
  */
802
802
  export interface SourceCodeRepository {
803
803
  /**
804
- * S3 storage location of the repository
804
+ * <p>The Amazon S3 location of the source code repository archive.</p>
805
805
  * @public
806
806
  */
807
807
  s3Location?: string | undefined;
808
808
  }
809
809
  /**
810
- * Collection of assets to be tested or used during a pentest
810
+ * <p>The collection of assets used in a pentest configuration, including endpoints, actors, documents, source code repositories, and integrated repositories.</p>
811
811
  * @public
812
812
  */
813
813
  export interface Assets {
814
814
  /**
815
- * List of web application endpoints to test
815
+ * <p>The list of endpoints to test during the pentest.</p>
816
816
  * @public
817
817
  */
818
818
  endpoints?: Endpoint[] | undefined;
819
819
  /**
820
- * List of actors that interact with the system
820
+ * <p>The list of actors used during penetration testing.</p>
821
821
  * @public
822
822
  */
823
823
  actors?: Actor[] | undefined;
824
824
  /**
825
- * List of documents providing context for testing
825
+ * <p>The list of documents that provide context for the pentest.</p>
826
826
  * @public
827
827
  */
828
828
  documents?: DocumentInfo[] | undefined;
829
829
  /**
830
- * List of source code repositories for static analysis
830
+ * <p>The list of source code repositories to analyze during the pentest.</p>
831
831
  * @public
832
832
  */
833
833
  sourceCode?: SourceCodeRepository[] | undefined;
834
834
  /**
835
- * List of integrated code repositories
835
+ * <p>The list of integrated repositories associated with the pentest.</p>
836
836
  * @public
837
837
  */
838
838
  integratedRepositories?: IntegratedRepository[] | undefined;
839
839
  }
840
840
  /**
841
- * Input for deleting multiple pentests
841
+ * <p>Input for deleting multiple pentests.</p>
842
842
  * @public
843
843
  */
844
844
  export interface BatchDeletePentestsInput {
845
845
  /**
846
- * List of pentest IDs to delete
846
+ * <p>The list of pentest identifiers to delete.</p>
847
847
  * @public
848
848
  */
849
849
  pentestIds: string[] | undefined;
850
850
  /**
851
- * ID of the agent space where the pentests exist
851
+ * <p>The unique identifier of the agent space that contains the pentests to delete.</p>
852
852
  * @public
853
853
  */
854
854
  agentSpaceId: string | undefined;
855
855
  }
856
856
  /**
857
- * Reference to logs stored in CloudWatch
857
+ * <p>The Amazon CloudWatch Logs configuration for pentest job logging.</p>
858
858
  * @public
859
859
  */
860
860
  export interface CloudWatchLog {
861
861
  /**
862
- * Name of the CloudWatch log group
862
+ * <p>The name of the CloudWatch log group.</p>
863
863
  * @public
864
864
  */
865
865
  logGroup?: string | undefined;
866
866
  /**
867
- * Name of the CloudWatch log stream
867
+ * <p>The name of the CloudWatch log stream.</p>
868
868
  * @public
869
869
  */
870
870
  logStream?: string | undefined;
871
871
  }
872
872
  /**
873
- * Custom headers to be set for network requests
873
+ * <p>A custom HTTP header to include in network traffic during penetration testing.</p>
874
874
  * @public
875
875
  */
876
876
  export interface CustomHeader {
877
877
  /**
878
- * Name of header to set value for
878
+ * <p>The name of the custom header.</p>
879
879
  * @public
880
880
  */
881
881
  name?: string | undefined;
882
882
  /**
883
- * Value to set for header
883
+ * <p>The value of the custom header.</p>
884
884
  * @public
885
885
  */
886
886
  value?: string | undefined;
887
887
  }
888
888
  /**
889
- * Network traffic filtering rule
889
+ * <p>A rule that controls network traffic during penetration testing by allowing or denying traffic to specific URL patterns.</p>
890
890
  * @public
891
891
  */
892
892
  export interface NetworkTrafficRule {
893
893
  /**
894
- * Action to take when the rule matches
894
+ * <p>The effect of the rule. Valid values are ALLOW and DENY.</p>
895
895
  * @public
896
896
  */
897
897
  effect?: NetworkTrafficRuleEffect | undefined;
898
898
  /**
899
- * Pattern to match against
899
+ * <p>The URL pattern to match for the rule.</p>
900
900
  * @public
901
901
  */
902
902
  pattern?: string | undefined;
903
903
  /**
904
- * Type of network traffic rule
904
+ * <p>The type of the network traffic rule. Currently, only URL is supported.</p>
905
905
  * @public
906
906
  */
907
907
  networkTrafficRuleType?: NetworkTrafficRuleType | undefined;
908
908
  }
909
909
  /**
910
- * Configuration for network traffic filtering
910
+ * <p>The network traffic configuration for a pentest, including custom headers and traffic rules.</p>
911
911
  * @public
912
912
  */
913
913
  export interface NetworkTrafficConfig {
914
914
  /**
915
- * Traffic filtering rules
915
+ * <p>The list of network traffic rules that control which URLs are allowed or denied during testing.</p>
916
916
  * @public
917
917
  */
918
918
  rules?: NetworkTrafficRule[] | undefined;
919
919
  /**
920
- * Custom headers for requests
920
+ * <p>The list of custom HTTP headers to include in network traffic during testing.</p>
921
921
  * @public
922
922
  */
923
923
  customHeaders?: CustomHeader[] | undefined;
924
924
  }
925
925
  /**
926
- * Represents a pentest configuration and execution details
926
+ * <p>Represents a pentest configuration that defines the parameters for security testing, including target assets, risk type exclusions, and infrastructure settings.</p>
927
927
  * @public
928
928
  */
929
929
  export interface Pentest {
930
930
  /**
931
- * Unique identifier for the pentest
931
+ * <p>The unique identifier of the pentest.</p>
932
932
  * @public
933
933
  */
934
934
  pentestId: string | undefined;
935
935
  /**
936
- * ID of the agent space where the pentest exists
936
+ * <p>The unique identifier of the agent space that contains the pentest.</p>
937
937
  * @public
938
938
  */
939
939
  agentSpaceId: string | undefined;
940
940
  /**
941
- * Title or name of the pentest
941
+ * <p>The title of the pentest.</p>
942
942
  * @public
943
943
  */
944
944
  title: string | undefined;
945
945
  /**
946
- * Collection of assets to be tested or used during the pentest
946
+ * <p>The assets included in the pentest.</p>
947
947
  * @public
948
948
  */
949
949
  assets: Assets | undefined;
950
950
  /**
951
- * A list of risk types excluded from the pentest execution
951
+ * <p>The list of risk types excluded from the pentest.</p>
952
952
  * @public
953
953
  */
954
954
  excludeRiskTypes?: RiskType[] | undefined;
955
955
  /**
956
- * Service role ARN for accessing customer resources
956
+ * <p>The IAM service role used for the pentest.</p>
957
957
  * @public
958
958
  */
959
959
  serviceRole?: string | undefined;
960
960
  /**
961
- * CloudWatch log group and stream prefix where pentest execution logs are stored
961
+ * <p>The CloudWatch Logs configuration for the pentest.</p>
962
962
  * @public
963
963
  */
964
964
  logConfig?: CloudWatchLog | undefined;
965
965
  /**
966
- * VPC configuration that the Security Agent accesses
966
+ * <p>The VPC configuration for the pentest.</p>
967
967
  * @public
968
968
  */
969
969
  vpcConfig?: VpcConfig | undefined;
970
970
  /**
971
- * Configuration for network traffic filtering
971
+ * <p>The network traffic configuration for the pentest.</p>
972
972
  * @public
973
973
  */
974
974
  networkTrafficConfig?: NetworkTrafficConfig | undefined;
975
975
  /**
976
- * Strategy for code remediation on findings
976
+ * <p>The code remediation strategy for the pentest.</p>
977
977
  * @public
978
978
  */
979
979
  codeRemediationStrategy?: CodeRemediationStrategy | undefined;
980
980
  /**
981
- * Timestamp when the pentest was created
981
+ * <p>The date and time the pentest was created, in UTC format.</p>
982
982
  * @public
983
983
  */
984
984
  createdAt?: Date | undefined;
985
985
  /**
986
- * Timestamp when the pentest was last updated
986
+ * <p>The date and time the pentest was last updated, in UTC format.</p>
987
987
  * @public
988
988
  */
989
989
  updatedAt?: Date | undefined;
990
990
  }
991
991
  /**
992
- * Information about a failed pentest deletion attempt
992
+ * <p>Contains information about a pentest that failed to delete.</p>
993
993
  * @public
994
994
  */
995
995
  export interface DeletePentestFailure {
996
996
  /**
997
- * Identifier of the pentest that failed to delete
997
+ * <p>The unique identifier of the pentest that failed to delete.</p>
998
998
  * @public
999
999
  */
1000
1000
  pentestId?: string | undefined;
1001
1001
  /**
1002
- * Reason for the deletion failure
1002
+ * <p>The reason the pentest failed to delete.</p>
1003
1003
  * @public
1004
1004
  */
1005
1005
  reason?: string | undefined;
1006
1006
  }
1007
1007
  /**
1008
- * Output for the BatchDeletePentests operation
1008
+ * <p>Output for the BatchDeletePentests operation.</p>
1009
1009
  * @public
1010
1010
  */
1011
1011
  export interface BatchDeletePentestsOutput {
1012
1012
  /**
1013
- * List of successfully deleted pentests
1013
+ * <p>The list of pentests that were successfully deleted.</p>
1014
1014
  * @public
1015
1015
  */
1016
1016
  deleted?: Pentest[] | undefined;
1017
1017
  /**
1018
- * List of pentests that could not be deleted and the reasons for failure
1018
+ * <p>The list of pentests that failed to delete, including the reason for each failure.</p>
1019
1019
  * @public
1020
1020
  */
1021
1021
  failed?: DeletePentestFailure[] | undefined;
@@ -1025,12 +1025,12 @@ export interface BatchDeletePentestsOutput {
1025
1025
  */
1026
1026
  export interface BatchGetArtifactMetadataInput {
1027
1027
  /**
1028
- * Unique identifier of the agent space
1028
+ * <p>The unique identifier of the agent space that contains the artifacts.</p>
1029
1029
  * @public
1030
1030
  */
1031
1031
  agentSpaceId: string | undefined;
1032
1032
  /**
1033
- * List of artifact identifiers
1033
+ * <p>The list of artifact identifiers to retrieve metadata for.</p>
1034
1034
  * @public
1035
1035
  */
1036
1036
  artifactIds: string[] | undefined;
@@ -1040,708 +1040,713 @@ export interface BatchGetArtifactMetadataInput {
1040
1040
  */
1041
1041
  export interface BatchGetArtifactMetadataOutput {
1042
1042
  /**
1043
- * List of artifact metadata
1043
+ * <p>The list of artifact metadata items that were found.</p>
1044
1044
  * @public
1045
1045
  */
1046
1046
  artifactMetadataList: ArtifactMetadataItem[] | undefined;
1047
1047
  }
1048
1048
  /**
1049
- * Input for BatchGetFindings operation
1049
+ * <p>Input for BatchGetFindings operation.</p>
1050
1050
  * @public
1051
1051
  */
1052
1052
  export interface BatchGetFindingsInput {
1053
1053
  /**
1054
- * List of finding IDs to retrieve
1054
+ * <p>The list of finding identifiers to retrieve.</p>
1055
1055
  * @public
1056
1056
  */
1057
1057
  findingIds: string[] | undefined;
1058
1058
  /**
1059
- * ID of the agent space where the findings exist
1059
+ * <p>The unique identifier of the agent space that contains the findings.</p>
1060
1060
  * @public
1061
1061
  */
1062
1062
  agentSpaceId: string | undefined;
1063
1063
  }
1064
1064
  /**
1065
- * Code remediation details for a single repository
1065
+ * <p>Contains details about a code remediation task, including links to the code diff and pull request.</p>
1066
1066
  * @public
1067
1067
  */
1068
1068
  export interface CodeRemediationTaskDetails {
1069
1069
  /**
1070
- * Name of the repository
1070
+ * <p>The name of the repository where the remediation was applied.</p>
1071
1071
  * @public
1072
1072
  */
1073
1073
  repoName?: string | undefined;
1074
1074
  /**
1075
- * Link to the code diff for the remediation
1075
+ * <p>The link to the code diff for the remediation.</p>
1076
1076
  * @public
1077
1077
  */
1078
1078
  codeDiffLink?: string | undefined;
1079
1079
  /**
1080
- * Link to the pull request for the remediation
1080
+ * <p>The link to the pull request created for the remediation.</p>
1081
1081
  * @public
1082
1082
  */
1083
1083
  pullRequestLink?: string | undefined;
1084
1084
  }
1085
1085
  /**
1086
- * Information about task for code remediation
1086
+ * <p>Represents a code remediation task that was initiated to fix a security finding.</p>
1087
1087
  * @public
1088
1088
  */
1089
1089
  export interface CodeRemediationTask {
1090
1090
  /**
1091
- * Current status of the code remediation task
1091
+ * <p>The current status of the code remediation task.</p>
1092
1092
  * @public
1093
1093
  */
1094
1094
  status: CodeRemediationTaskStatus | undefined;
1095
1095
  /**
1096
- * Reason for the current code remediation task status
1096
+ * <p>The reason for the current status of the code remediation task.</p>
1097
1097
  * @public
1098
1098
  */
1099
1099
  statusReason?: string | undefined;
1100
1100
  /**
1101
- * Details of the code remediation for each repository
1101
+ * <p>The list of details for the code remediation task, including repository name, code diff link, and pull request link.</p>
1102
1102
  * @public
1103
1103
  */
1104
1104
  taskDetails?: CodeRemediationTaskDetails[] | undefined;
1105
1105
  }
1106
1106
  /**
1107
- * Represents a security vulnerability or issue discovered during testing
1107
+ * <p>Represents a security finding discovered during a pentest job. A finding contains details about a vulnerability, including its risk level, confidence, and remediation status.</p>
1108
1108
  * @public
1109
1109
  */
1110
1110
  export interface Finding {
1111
1111
  /**
1112
- * Unique identifier for the finding
1112
+ * <p>The unique identifier of the finding.</p>
1113
1113
  * @public
1114
1114
  */
1115
1115
  findingId: string | undefined;
1116
1116
  /**
1117
- * Identifier of the agent space that created this finding
1117
+ * <p>The unique identifier of the agent space associated with the finding.</p>
1118
1118
  * @public
1119
1119
  */
1120
1120
  agentSpaceId: string | undefined;
1121
1121
  /**
1122
- * Identifier of the parent pentest
1122
+ * <p>The unique identifier of the pentest associated with the finding.</p>
1123
1123
  * @public
1124
1124
  */
1125
1125
  pentestId?: string | undefined;
1126
1126
  /**
1127
- * Identifier of the pentest job
1127
+ * <p>The unique identifier of the pentest job that produced the finding.</p>
1128
1128
  * @public
1129
1129
  */
1130
1130
  pentestJobId?: string | undefined;
1131
1131
  /**
1132
- * Identifier of the associated task
1132
+ * <p>The unique identifier of the task that produced the finding.</p>
1133
1133
  * @public
1134
1134
  */
1135
1135
  taskId?: string | undefined;
1136
1136
  /**
1137
- * Name or title of the finding
1137
+ * <p>The name of the finding.</p>
1138
1138
  * @public
1139
1139
  */
1140
1140
  name?: string | undefined;
1141
1141
  /**
1142
- * Detailed description of the security vulnerability
1142
+ * <p>A description of the finding.</p>
1143
1143
  * @public
1144
1144
  */
1145
1145
  description?: string | undefined;
1146
1146
  /**
1147
- * Current status of the finding
1147
+ * <p>The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.</p>
1148
1148
  * @public
1149
1149
  */
1150
1150
  status?: FindingStatus | undefined;
1151
1151
  /**
1152
- * Type of security risk identified
1152
+ * <p>The type of security risk identified by the finding.</p>
1153
1153
  * @public
1154
1154
  */
1155
1155
  riskType?: string | undefined;
1156
1156
  /**
1157
- * Severity level of the identified risk
1157
+ * <p>The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.</p>
1158
1158
  * @public
1159
1159
  */
1160
1160
  riskLevel?: RiskLevel | undefined;
1161
1161
  /**
1162
- * Risk score associated with the finding
1162
+ * <p>The numerical risk score of the finding.</p>
1163
1163
  * @public
1164
1164
  */
1165
1165
  riskScore?: string | undefined;
1166
1166
  /**
1167
- * Justification for the assigned risk score
1167
+ * <p>The reasoning behind the finding, explaining why it was identified as a vulnerability.</p>
1168
1168
  * @public
1169
1169
  */
1170
1170
  reasoning?: string | undefined;
1171
1171
  /**
1172
- * Confidence level of the finding
1172
+ * <p>The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.</p>
1173
1173
  * @public
1174
1174
  */
1175
1175
  confidence?: ConfidenceLevel | undefined;
1176
1176
  /**
1177
- * Proof-of-concept code demonstrating the vulnerability
1177
+ * <p>The attack script used to reproduce the finding.</p>
1178
1178
  * @public
1179
1179
  */
1180
1180
  attackScript?: string | undefined;
1181
1181
  /**
1182
- * Code remediation task associated with this finding
1182
+ * <p>The code remediation task associated with the finding, if code remediation was initiated.</p>
1183
1183
  * @public
1184
1184
  */
1185
1185
  codeRemediationTask?: CodeRemediationTask | undefined;
1186
1186
  /**
1187
- * Identifier of the task or agent that last updated this finding
1187
+ * <p>The identifier of the entity that last updated the finding.</p>
1188
1188
  * @public
1189
1189
  */
1190
1190
  lastUpdatedBy?: string | undefined;
1191
1191
  /**
1192
- * Timestamp when the finding was created
1192
+ * <p>The date and time the finding was created, in UTC format.</p>
1193
1193
  * @public
1194
1194
  */
1195
1195
  createdAt?: Date | undefined;
1196
1196
  /**
1197
- * Timestamp when the finding was last updated
1197
+ * <p>The date and time the finding was last updated, in UTC format.</p>
1198
1198
  * @public
1199
1199
  */
1200
1200
  updatedAt?: Date | undefined;
1201
1201
  }
1202
1202
  /**
1203
- * Output for the BatchGetFindings operation
1203
+ * <p>Output for the BatchGetFindings operation.</p>
1204
1204
  * @public
1205
1205
  */
1206
1206
  export interface BatchGetFindingsOutput {
1207
1207
  /**
1208
- * List of successfully retrieved findings
1208
+ * <p>The list of findings that were found.</p>
1209
1209
  * @public
1210
1210
  */
1211
1211
  findings?: Finding[] | undefined;
1212
1212
  /**
1213
- * List of finding IDs that could not be found
1213
+ * <p>The list of finding identifiers that were not found.</p>
1214
1214
  * @public
1215
1215
  */
1216
1216
  notFound?: string[] | undefined;
1217
1217
  }
1218
1218
  /**
1219
- * Input for BatchGetPentestJobs operation
1219
+ * <p>Input for BatchGetPentestJobs operation.</p>
1220
1220
  * @public
1221
1221
  */
1222
1222
  export interface BatchGetPentestJobsInput {
1223
1223
  /**
1224
- * List of pentest job IDs to retrieve
1224
+ * <p>The list of pentest job identifiers to retrieve.</p>
1225
1225
  * @public
1226
1226
  */
1227
1227
  pentestJobIds: string[] | undefined;
1228
1228
  /**
1229
- * ID of the agent space where the pentest exists
1229
+ * <p>The unique identifier of the agent space that contains the pentest jobs.</p>
1230
1230
  * @public
1231
1231
  */
1232
1232
  agentSpaceId: string | undefined;
1233
1233
  }
1234
1234
  /**
1235
- * Error information regarding the pentest job
1235
+ * <p>Contains error information for a pentest job that encountered an error.</p>
1236
1236
  * @public
1237
1237
  */
1238
1238
  export interface ErrorInformation {
1239
1239
  /**
1240
- * Pentest job failure error code
1240
+ * <p>The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.</p>
1241
1241
  * @public
1242
1242
  */
1243
1243
  code?: ErrorCode | undefined;
1244
1244
  /**
1245
- * Pentest job failure error message
1245
+ * <p>A message describing the error.</p>
1246
1246
  * @public
1247
1247
  */
1248
1248
  message?: string | undefined;
1249
1249
  }
1250
1250
  /**
1251
- * Additional context about a pentest or task execution
1251
+ * <p>Contains contextual information about the execution of a pentest job, such as errors, warnings, or informational messages.</p>
1252
1252
  * @public
1253
1253
  */
1254
1254
  export interface ExecutionContext {
1255
1255
  /**
1256
- * The category of context
1256
+ * <p>The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO.</p>
1257
1257
  * @public
1258
1258
  */
1259
1259
  contextType?: ContextType | undefined;
1260
1260
  /**
1261
- * Context associated with a pentest or task execution
1261
+ * <p>The context message.</p>
1262
1262
  * @public
1263
1263
  */
1264
1264
  context?: string | undefined;
1265
1265
  /**
1266
- * Timestamp associated with a pentest or task execution
1266
+ * <p>The date and time the context was recorded, in UTC format.</p>
1267
1267
  * @public
1268
1268
  */
1269
1269
  timestamp?: Date | undefined;
1270
1270
  }
1271
1271
  /**
1272
- * Represents a single step in pentest job execution
1272
+ * <p>Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.</p>
1273
1273
  * @public
1274
1274
  */
1275
1275
  export interface Step {
1276
1276
  /**
1277
- * Name of the execution step
1277
+ * <p>The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.</p>
1278
1278
  * @public
1279
1279
  */
1280
1280
  name?: StepName | undefined;
1281
1281
  /**
1282
- * Current status of the step
1282
+ * <p>The current status of the step.</p>
1283
1283
  * @public
1284
1284
  */
1285
1285
  status?: StepStatus | undefined;
1286
1286
  /**
1287
- * Timestamp when the step was created
1287
+ * <p>The date and time the step was created, in UTC format.</p>
1288
1288
  * @public
1289
1289
  */
1290
1290
  createdAt?: Date | undefined;
1291
1291
  /**
1292
- * Timestamp when the step was last updated
1292
+ * <p>The date and time the step was last updated, in UTC format.</p>
1293
1293
  * @public
1294
1294
  */
1295
1295
  updatedAt?: Date | undefined;
1296
1296
  }
1297
1297
  /**
1298
- * Represents a pentest job
1298
+ * <p>Represents a pentest job, which is an execution instance of a pentest. A pentest job progresses through preflight, static analysis, pentest, and finalizing steps.</p>
1299
1299
  * @public
1300
1300
  */
1301
1301
  export interface PentestJob {
1302
1302
  /**
1303
- * Unique identifier of the pentest job
1303
+ * <p>The unique identifier of the pentest job.</p>
1304
1304
  * @public
1305
1305
  */
1306
1306
  pentestJobId?: string | undefined;
1307
1307
  /**
1308
- * Identifier of the parent pentest
1308
+ * <p>The unique identifier of the pentest associated with the job.</p>
1309
1309
  * @public
1310
1310
  */
1311
1311
  pentestId?: string | undefined;
1312
1312
  /**
1313
- * Title or name of the pentest
1313
+ * <p>The title of the pentest job.</p>
1314
1314
  * @public
1315
1315
  */
1316
1316
  title?: string | undefined;
1317
1317
  /**
1318
- * Overview or description of the pentest job
1318
+ * <p>An overview of the pentest job results.</p>
1319
1319
  * @public
1320
1320
  */
1321
1321
  overview?: string | undefined;
1322
1322
  /**
1323
- * Current status of the pentest job
1323
+ * <p>The current status of the pentest job.</p>
1324
1324
  * @public
1325
1325
  */
1326
1326
  status?: JobStatus | undefined;
1327
1327
  /**
1328
- * List of web application endpoints to test
1328
+ * <p>The list of endpoints being tested in the pentest job.</p>
1329
1329
  * @public
1330
1330
  */
1331
1331
  endpoints?: Endpoint[] | undefined;
1332
1332
  /**
1333
- * List of actors that interact with the system
1333
+ * <p>The list of actors used during the pentest job.</p>
1334
1334
  * @public
1335
1335
  */
1336
1336
  actors?: Actor[] | undefined;
1337
1337
  /**
1338
- * List of documents providing context for testing
1338
+ * <p>The list of documents providing context for the pentest job.</p>
1339
1339
  * @public
1340
1340
  */
1341
1341
  documents?: DocumentInfo[] | undefined;
1342
1342
  /**
1343
- * List of source code repositories for static analysis
1343
+ * <p>The list of source code repositories analyzed during the pentest job.</p>
1344
1344
  * @public
1345
1345
  */
1346
1346
  sourceCode?: SourceCodeRepository[] | undefined;
1347
1347
  /**
1348
- * List of URL paths to exclude from testing
1348
+ * <p>The list of paths excluded from the pentest job.</p>
1349
1349
  * @public
1350
1350
  */
1351
1351
  excludePaths?: Endpoint[] | undefined;
1352
1352
  /**
1353
- * List of allowed domains for network access
1353
+ * <p>The list of domains allowed during the pentest job.</p>
1354
1354
  * @public
1355
1355
  */
1356
1356
  allowedDomains?: Endpoint[] | undefined;
1357
1357
  /**
1358
- * A list of risk types excluded from the pentest job
1358
+ * <p>The list of risk types excluded from the pentest job.</p>
1359
1359
  * @public
1360
1360
  */
1361
1361
  excludeRiskTypes?: RiskType[] | undefined;
1362
1362
  /**
1363
- * List of execution steps for the pentest job
1363
+ * <p>The list of steps in the pentest job execution.</p>
1364
1364
  * @public
1365
1365
  */
1366
1366
  steps?: Step[] | undefined;
1367
1367
  /**
1368
- * A list of execution context messages associated with the pentest job
1368
+ * <p>The execution context messages for the pentest job.</p>
1369
1369
  * @public
1370
1370
  */
1371
1371
  executionContext?: ExecutionContext[] | undefined;
1372
1372
  /**
1373
- * Service role ARN for accessing customer resources
1373
+ * <p>The IAM service role used for the pentest job.</p>
1374
1374
  * @public
1375
1375
  */
1376
1376
  serviceRole?: string | undefined;
1377
1377
  /**
1378
- * CloudWatch log group and stream prefix where pentest job logs are stored
1378
+ * <p>The CloudWatch Logs configuration for the pentest job.</p>
1379
1379
  * @public
1380
1380
  */
1381
1381
  logConfig?: CloudWatchLog | undefined;
1382
1382
  /**
1383
- * VPC configuration that the Security Agent accesses
1383
+ * <p>The VPC configuration for the pentest job.</p>
1384
1384
  * @public
1385
1385
  */
1386
1386
  vpcConfig?: VpcConfig | undefined;
1387
1387
  /**
1388
- * Configuration for network traffic filtering
1388
+ * <p>The network traffic configuration for the pentest job.</p>
1389
1389
  * @public
1390
1390
  */
1391
1391
  networkTrafficConfig?: NetworkTrafficConfig | undefined;
1392
1392
  /**
1393
- * Error information regarding the pentest job
1393
+ * <p>Error information if the pentest job encountered an error.</p>
1394
1394
  * @public
1395
1395
  */
1396
1396
  errorInformation?: ErrorInformation | undefined;
1397
1397
  /**
1398
- * List of integrated code repositories
1398
+ * <p>The list of integrated repositories associated with the pentest job.</p>
1399
1399
  * @public
1400
1400
  */
1401
1401
  integratedRepositories?: IntegratedRepository[] | undefined;
1402
1402
  /**
1403
- * Strategy for code remediation on findings
1403
+ * <p>The code remediation strategy for the pentest job.</p>
1404
1404
  * @public
1405
1405
  */
1406
1406
  codeRemediationStrategy?: CodeRemediationStrategy | undefined;
1407
1407
  /**
1408
- * Timestamp when the pentest job was created
1408
+ * <p>The date and time the pentest job was created, in UTC format.</p>
1409
1409
  * @public
1410
1410
  */
1411
1411
  createdAt?: Date | undefined;
1412
1412
  /**
1413
- * Timestamp when the pentest job was last updated
1413
+ * <p>The date and time the pentest job was last updated, in UTC format.</p>
1414
1414
  * @public
1415
1415
  */
1416
1416
  updatedAt?: Date | undefined;
1417
1417
  }
1418
1418
  /**
1419
- * Output for the BatchGetPentestJobs operation
1419
+ * <p>Output for the BatchGetPentestJobs operation.</p>
1420
1420
  * @public
1421
1421
  */
1422
1422
  export interface BatchGetPentestJobsOutput {
1423
1423
  /**
1424
- * List of successfully retrieved pentest jobs
1424
+ * <p>The list of pentest jobs that were found.</p>
1425
1425
  * @public
1426
1426
  */
1427
1427
  pentestJobs?: PentestJob[] | undefined;
1428
1428
  /**
1429
- * List of pentest job IDs that could not be found
1429
+ * <p>The list of pentest job identifiers that were not found.</p>
1430
1430
  * @public
1431
1431
  */
1432
1432
  notFound?: string[] | undefined;
1433
1433
  }
1434
1434
  /**
1435
- * Input for retrieving multiple tasks by their IDs for a pentest job
1435
+ * <p>Input for retrieving multiple tasks associated with a pentest job.</p>
1436
1436
  * @public
1437
1437
  */
1438
1438
  export interface BatchGetPentestJobTasksInput {
1439
1439
  /**
1440
- * ID of the agent space where the pentest exists
1440
+ * <p>The unique identifier of the agent space that contains the tasks.</p>
1441
1441
  * @public
1442
1442
  */
1443
1443
  agentSpaceId: string | undefined;
1444
1444
  /**
1445
- * List of task IDs to retrieve
1445
+ * <p>The list of task identifiers to retrieve.</p>
1446
1446
  * @public
1447
1447
  */
1448
1448
  taskIds: string[] | undefined;
1449
1449
  }
1450
1450
  /**
1451
- * Represents a category classification for tasks
1451
+ * <p>Represents a category assigned to a security testing task.</p>
1452
1452
  * @public
1453
1453
  */
1454
1454
  export interface Category {
1455
1455
  /**
1456
- * Name of the category
1456
+ * <p>The name of the category.</p>
1457
1457
  * @public
1458
1458
  */
1459
1459
  name?: string | undefined;
1460
1460
  /**
1461
- * Whether this is the primary category for the task
1461
+ * <p>Indicates whether this is the primary category for the task.</p>
1462
1462
  * @public
1463
1463
  */
1464
1464
  isPrimary?: boolean | undefined;
1465
1465
  }
1466
1466
  /**
1467
- * Location information for execution logs
1467
+ * <p>The log location for a task, specifying where task execution logs are stored.</p>
1468
1468
  * @public
1469
1469
  */
1470
1470
  export interface LogLocation {
1471
1471
  /**
1472
- * Type of log storage
1472
+ * <p>The type of log storage. Currently, only CLOUDWATCH is supported.</p>
1473
1473
  * @public
1474
1474
  */
1475
1475
  logType?: LogType | undefined;
1476
1476
  /**
1477
- * CloudWatch log information if logs are stored in CloudWatch
1477
+ * <p>The CloudWatch Logs location for the task logs.</p>
1478
1478
  * @public
1479
1479
  */
1480
1480
  cloudWatchLog?: CloudWatchLog | undefined;
1481
1481
  }
1482
1482
  /**
1483
- * Represents a task within a pentest job
1483
+ * <p>Represents an individual security test task within a pentest job. Each task targets a specific risk type or endpoint and executes independently.</p>
1484
1484
  * @public
1485
1485
  */
1486
1486
  export interface Task {
1487
1487
  /**
1488
- * Unique identifier for the task
1488
+ * <p>The unique identifier of the task.</p>
1489
1489
  * @public
1490
1490
  */
1491
1491
  taskId: string | undefined;
1492
1492
  /**
1493
- * Identifier of the parent pentest
1493
+ * <p>The unique identifier of the pentest associated with the task.</p>
1494
1494
  * @public
1495
1495
  */
1496
1496
  pentestId?: string | undefined;
1497
1497
  /**
1498
- * Identifier of the pentest job this task belongs to
1498
+ * <p>The unique identifier of the pentest job that contains the task.</p>
1499
1499
  * @public
1500
1500
  */
1501
1501
  pentestJobId?: string | undefined;
1502
1502
  /**
1503
- * Identifier of the agent space this task belongs to
1503
+ * <p>The unique identifier of the agent space.</p>
1504
1504
  * @public
1505
1505
  */
1506
1506
  agentSpaceId?: string | undefined;
1507
1507
  /**
1508
- * Title or name of the task
1508
+ * <p>The title of the task.</p>
1509
1509
  * @public
1510
1510
  */
1511
1511
  title?: string | undefined;
1512
1512
  /**
1513
- * Detailed description of the task's purpose and scope
1513
+ * <p>A description of the task.</p>
1514
1514
  * @public
1515
1515
  */
1516
1516
  description?: string | undefined;
1517
1517
  /**
1518
- * List of categories associated with this task
1518
+ * <p>The list of categories assigned to the task.</p>
1519
1519
  * @public
1520
1520
  */
1521
1521
  categories?: Category[] | undefined;
1522
1522
  /**
1523
- * Type of security risk this task is designed to test
1523
+ * <p>The type of security risk the task is testing for.</p>
1524
1524
  * @public
1525
1525
  */
1526
1526
  riskType?: RiskType | undefined;
1527
1527
  /**
1528
- * Target endpoint for this security test
1528
+ * <p>The target endpoint being tested by the task.</p>
1529
1529
  * @public
1530
1530
  */
1531
1531
  targetEndpoint?: Endpoint | undefined;
1532
1532
  /**
1533
- * Current status of the task execution
1533
+ * <p>The current execution status of the task.</p>
1534
1534
  * @public
1535
1535
  */
1536
1536
  executionStatus?: TaskExecutionStatus | undefined;
1537
1537
  /**
1538
- * Location of execution logs for auditing and review
1538
+ * <p>The location of the task execution logs.</p>
1539
1539
  * @public
1540
1540
  */
1541
1541
  logsLocation?: LogLocation | undefined;
1542
1542
  /**
1543
- * Timestamp when the task was created
1543
+ * <p>The date and time the task was created, in UTC format.</p>
1544
1544
  * @public
1545
1545
  */
1546
1546
  createdAt?: Date | undefined;
1547
1547
  /**
1548
- * Timestamp when the task was last updated
1548
+ * <p>The date and time the task was last updated, in UTC format.</p>
1549
1549
  * @public
1550
1550
  */
1551
1551
  updatedAt?: Date | undefined;
1552
1552
  }
1553
1553
  /**
1554
- * Output for the BatchGetPentestJobTasks operation
1554
+ * <p>Output for the BatchGetPentestJobTasks operation.</p>
1555
1555
  * @public
1556
1556
  */
1557
1557
  export interface BatchGetPentestJobTasksOutput {
1558
1558
  /**
1559
- * List of successfully retrieved tasks
1559
+ * <p>The list of tasks that were found.</p>
1560
1560
  * @public
1561
1561
  */
1562
1562
  tasks?: Task[] | undefined;
1563
1563
  /**
1564
- * List of task IDs that could not be found
1564
+ * <p>The list of task identifiers that were not found.</p>
1565
1565
  * @public
1566
1566
  */
1567
1567
  notFound?: string[] | undefined;
1568
1568
  }
1569
1569
  /**
1570
- * Input for retrieving multiple pentests by their IDs
1570
+ * <p>Input for retrieving multiple pentests by their IDs.</p>
1571
1571
  * @public
1572
1572
  */
1573
1573
  export interface BatchGetPentestsInput {
1574
1574
  /**
1575
- * List of pentest IDs to retrieve
1575
+ * <p>The list of pentest identifiers to retrieve.</p>
1576
1576
  * @public
1577
1577
  */
1578
1578
  pentestIds: string[] | undefined;
1579
1579
  /**
1580
- * ID of the agent space where the pentest exists
1580
+ * <p>The unique identifier of the agent space that contains the pentests.</p>
1581
1581
  * @public
1582
1582
  */
1583
1583
  agentSpaceId: string | undefined;
1584
1584
  }
1585
1585
  /**
1586
- * Output for the BatchGetPentests operation
1586
+ * <p>Output for the BatchGetPentests operation.</p>
1587
1587
  * @public
1588
1588
  */
1589
1589
  export interface BatchGetPentestsOutput {
1590
1590
  /**
1591
- * List of successfully retrieved pentests
1591
+ * <p>The list of pentests that were found.</p>
1592
1592
  * @public
1593
1593
  */
1594
1594
  pentests?: Pentest[] | undefined;
1595
1595
  /**
1596
- * List of pentest IDs that could not be found
1596
+ * <p>The list of pentest identifiers that were not found.</p>
1597
1597
  * @public
1598
1598
  */
1599
1599
  notFound?: string[] | undefined;
1600
1600
  }
1601
1601
  /**
1602
- * Input for batch retrieving target domains
1602
+ * <p>Input for batch retrieving target domains.</p>
1603
1603
  * @public
1604
1604
  */
1605
1605
  export interface BatchGetTargetDomainsInput {
1606
1606
  /**
1607
- * List of target domain IDs to retrieve
1607
+ * <p>The list of target domain identifiers to retrieve.</p>
1608
1608
  * @public
1609
1609
  */
1610
1610
  targetDomainIds: string[] | undefined;
1611
1611
  }
1612
1612
  /**
1613
- * Represents dns txt verification details
1613
+ * <p>Contains DNS verification details for a target domain, including the DNS record to create for domain ownership verification.</p>
1614
1614
  * @public
1615
1615
  */
1616
1616
  export interface DnsVerification {
1617
1617
  /**
1618
- * Token used to verify domain ownership
1618
+ * <p>The verification token to include in the DNS record value.</p>
1619
1619
  * @public
1620
1620
  */
1621
1621
  token?: string | undefined;
1622
1622
  /**
1623
- * Record name to be added in DNS for target domain
1623
+ * <p>The name of the DNS record to create for verification.</p>
1624
1624
  * @public
1625
1625
  */
1626
1626
  dnsRecordName?: string | undefined;
1627
1627
  /**
1628
- * Type of record to be added in DNS for target domain
1628
+ * <p>The type of DNS record to create. Currently, only TXT is supported.</p>
1629
1629
  * @public
1630
1630
  */
1631
1631
  dnsRecordType?: DNSRecordType | undefined;
1632
1632
  }
1633
1633
  /**
1634
- * Represents http route verification details
1634
+ * <p>Contains HTTP route verification details for a target domain, including the route path and token to serve for domain ownership verification.</p>
1635
1635
  * @public
1636
1636
  */
1637
1637
  export interface HttpVerification {
1638
1638
  /**
1639
- * Token used to verify domain ownership
1639
+ * <p>The verification token to serve at the specified route path.</p>
1640
1640
  * @public
1641
1641
  */
1642
1642
  token?: string | undefined;
1643
1643
  /**
1644
- * Route path where verification token should be placed
1644
+ * <p>The HTTP route path where the verification token must be served.</p>
1645
1645
  * @public
1646
1646
  */
1647
1647
  routePath?: string | undefined;
1648
1648
  }
1649
1649
  /**
1650
- * Verification details to verify registered target domain
1650
+ * <p>Contains the verification details for a target domain, including the verification method and provider-specific details.</p>
1651
1651
  * @public
1652
1652
  */
1653
1653
  export interface VerificationDetails {
1654
1654
  /**
1655
- * Type of domain ownership verification method
1655
+ * <p>The verification method used for the target domain.</p>
1656
1656
  * @public
1657
1657
  */
1658
1658
  method?: DomainVerificationMethod | undefined;
1659
1659
  /**
1660
- * Represents dns txt verification details
1660
+ * <p>The DNS TXT verification details.</p>
1661
1661
  * @public
1662
1662
  */
1663
1663
  dnsTxt?: DnsVerification | undefined;
1664
1664
  /**
1665
- * Represents http route verification details
1665
+ * <p>The HTTP route verification details.</p>
1666
1666
  * @public
1667
1667
  */
1668
1668
  httpRoute?: HttpVerification | undefined;
1669
1669
  }
1670
1670
  /**
1671
- * Represents a target domain
1671
+ * <p>Represents a target domain registered for penetration testing. A target domain must be verified through DNS TXT or HTTP route verification before it can be used in pentests.</p>
1672
1672
  * @public
1673
1673
  */
1674
1674
  export interface TargetDomain {
1675
1675
  /**
1676
- * Unique identifier of the target domain
1676
+ * <p>The unique identifier of the target domain.</p>
1677
1677
  * @public
1678
1678
  */
1679
1679
  targetDomainId: string | undefined;
1680
1680
  /**
1681
- * Name of the registered target domain
1681
+ * <p>The domain name of the target domain.</p>
1682
1682
  * @public
1683
1683
  */
1684
1684
  domainName: string | undefined;
1685
1685
  /**
1686
- * Current verification status of the registered target domain
1686
+ * <p>The current verification status of the target domain.</p>
1687
1687
  * @public
1688
1688
  */
1689
1689
  verificationStatus?: TargetDomainStatus | undefined;
1690
1690
  /**
1691
- * Verification details to verify registered target domain
1691
+ * <p>The reason for the current target domain verification status.</p>
1692
+ * @public
1693
+ */
1694
+ verificationStatusReason?: string | undefined;
1695
+ /**
1696
+ * <p>The verification details for the target domain.</p>
1692
1697
  * @public
1693
1698
  */
1694
1699
  verificationDetails?: VerificationDetails | undefined;
1695
1700
  /**
1696
- * Timestamp when the target domain was registered
1701
+ * <p>The date and time the target domain was created, in UTC format.</p>
1697
1702
  * @public
1698
1703
  */
1699
1704
  createdAt?: Date | undefined;
1700
1705
  /**
1701
- * Timestamp when the target domain was last successfully verified
1706
+ * <p>The date and time the target domain was verified, in UTC format.</p>
1702
1707
  * @public
1703
1708
  */
1704
1709
  verifiedAt?: Date | undefined;
1705
1710
  }
1706
1711
  /**
1707
- * Output for the BatchGetTargetDomains operation
1712
+ * <p>Output for the BatchGetTargetDomains operation.</p>
1708
1713
  * @public
1709
1714
  */
1710
1715
  export interface BatchGetTargetDomainsOutput {
1711
1716
  /**
1712
- * List of target domains that were successfully retrieved
1717
+ * <p>The list of target domains that were found.</p>
1713
1718
  * @public
1714
1719
  */
1715
1720
  targetDomains?: TargetDomain[] | undefined;
1716
1721
  /**
1717
- * List of target domain IDs that could not be found
1722
+ * <p>The list of target domain identifiers that were not found.</p>
1718
1723
  * @public
1719
1724
  */
1720
1725
  notFound?: string[] | undefined;
1721
1726
  }
1722
1727
  /**
1723
- * Input parameters for GitHub integration
1728
+ * <p>The input required to create a GitHub integration, including the OAuth authorization code and CSRF state.</p>
1724
1729
  * @public
1725
1730
  */
1726
1731
  export interface GitHubIntegrationInput {
1727
1732
  /**
1728
- * Authorization code from OAuth flow
1733
+ * <p>The OAuth authorization code received from GitHub.</p>
1729
1734
  * @public
1730
1735
  */
1731
1736
  code: string | undefined;
1732
1737
  /**
1733
- * CSRF state token for OAuth security
1738
+ * <p>The CSRF state token for validating the OAuth flow.</p>
1734
1739
  * @public
1735
1740
  */
1736
1741
  state: string | undefined;
1737
1742
  /**
1738
- * Name of the GitHub organization
1743
+ * <p>The name of the GitHub organization to integrate with.</p>
1739
1744
  * @public
1740
1745
  */
1741
1746
  organizationName?: string | undefined;
1742
1747
  }
1743
1748
  /**
1744
- * Provider-specific input parameters for integration
1749
+ * <p>The provider-specific input for creating an integration. This is a union type that contains provider-specific configuration.</p>
1745
1750
  * @public
1746
1751
  */
1747
1752
  export type ProviderInput = ProviderInput.GithubMember | ProviderInput.$UnknownMember;
@@ -1750,7 +1755,7 @@ export type ProviderInput = ProviderInput.GithubMember | ProviderInput.$UnknownM
1750
1755
  */
1751
1756
  export declare namespace ProviderInput {
1752
1757
  /**
1753
- * GitHub integration input
1758
+ * <p>The GitHub-specific input for creating an integration.</p>
1754
1759
  * @public
1755
1760
  */
1756
1761
  interface GithubMember {
@@ -1778,27 +1783,27 @@ export declare namespace ProviderInput {
1778
1783
  */
1779
1784
  export interface CreateIntegrationInput {
1780
1785
  /**
1781
- * Provider to integrate with
1786
+ * <p>The integration provider. Currently, only GITHUB is supported.</p>
1782
1787
  * @public
1783
1788
  */
1784
1789
  provider: Provider | undefined;
1785
1790
  /**
1786
- * Provider-specific input parameters
1791
+ * <p>The provider-specific input required to create the integration.</p>
1787
1792
  * @public
1788
1793
  */
1789
1794
  input: ProviderInput | undefined;
1790
1795
  /**
1791
- * Display name for the integration
1796
+ * <p>The display name for the integration.</p>
1792
1797
  * @public
1793
1798
  */
1794
1799
  integrationDisplayName: string | undefined;
1795
1800
  /**
1796
- * KMS key ID for encrypting integration details
1801
+ * <p>The identifier of the AWS KMS key to use for encrypting data associated with the integration.</p>
1797
1802
  * @public
1798
1803
  */
1799
1804
  kmsKeyId?: string | undefined;
1800
1805
  /**
1801
- * Tags to associate with the integration
1806
+ * <p>The tags to associate with the integration.</p>
1802
1807
  * @public
1803
1808
  */
1804
1809
  tags?: Record<string, string> | undefined;
@@ -1808,24 +1813,24 @@ export interface CreateIntegrationInput {
1808
1813
  */
1809
1814
  export interface CreateIntegrationOutput {
1810
1815
  /**
1811
- * Unique identifier of the created integration
1816
+ * <p>The unique identifier of the created integration.</p>
1812
1817
  * @public
1813
1818
  */
1814
1819
  integrationId: string | undefined;
1815
1820
  }
1816
1821
  /**
1817
- * User membership configuration
1822
+ * <p>The configuration for a user membership, including the role assigned to the user within the agent space.</p>
1818
1823
  * @public
1819
1824
  */
1820
1825
  export interface UserConfig {
1821
1826
  /**
1822
- * Role of the user associated to the agent space
1827
+ * <p>The role assigned to the user. Currently, only MEMBER is supported.</p>
1823
1828
  * @public
1824
1829
  */
1825
1830
  role?: UserRole | undefined;
1826
1831
  }
1827
1832
  /**
1828
- * Member-specific configuration
1833
+ * <p>The configuration for a membership. This is a union type that contains member-type-specific configuration.</p>
1829
1834
  * @public
1830
1835
  */
1831
1836
  export type MembershipConfig = MembershipConfig.UserMember | MembershipConfig.$UnknownMember;
@@ -1834,7 +1839,7 @@ export type MembershipConfig = MembershipConfig.UserMember | MembershipConfig.$U
1834
1839
  */
1835
1840
  export declare namespace MembershipConfig {
1836
1841
  /**
1837
- * Configuration for user members
1842
+ * <p>The user configuration for the membership.</p>
1838
1843
  * @public
1839
1844
  */
1840
1845
  interface UserMember {
@@ -1858,197 +1863,202 @@ export declare namespace MembershipConfig {
1858
1863
  }
1859
1864
  }
1860
1865
  /**
1861
- * Request structure for adding a single member to an agent space
1866
+ * <p>Request structure for adding a single member to an agent space.</p>
1862
1867
  * @public
1863
1868
  */
1864
1869
  export interface CreateMembershipRequest {
1865
1870
  /**
1866
- * Application identifier
1871
+ * <p>The unique identifier of the application that contains the agent space.</p>
1867
1872
  * @public
1868
1873
  */
1869
1874
  applicationId: string | undefined;
1870
1875
  /**
1871
- * Agent space identifier
1876
+ * <p>The unique identifier of the agent space to grant access to.</p>
1872
1877
  * @public
1873
1878
  */
1874
1879
  agentSpaceId: string | undefined;
1875
1880
  /**
1876
- * Member identifier (userId or agentSpaceId)
1881
+ * <p>The unique identifier for the membership.</p>
1877
1882
  * @public
1878
1883
  */
1879
1884
  membershipId: string | undefined;
1880
1885
  /**
1881
- * Type of member (USER or AGENT_SPACE)
1886
+ * <p>The type of member. Currently, only USER is supported.</p>
1882
1887
  * @public
1883
1888
  */
1884
1889
  memberType: MembershipType | undefined;
1885
1890
  /**
1886
- * Membership details (user or agent specific)
1891
+ * <p>The configuration for the membership, such as the user role.</p>
1887
1892
  * @public
1888
1893
  */
1889
1894
  config?: MembershipConfig | undefined;
1890
1895
  }
1891
1896
  /**
1892
- * Response structure for adding a single member to an agent space
1897
+ * <p>Response structure for adding a single member to an agent space.</p>
1893
1898
  * @public
1894
1899
  */
1895
1900
  export interface CreateMembershipResponse {
1896
1901
  }
1897
1902
  /**
1898
- * Input for creating a new pentest
1903
+ * <p>Input for creating a new pentest.</p>
1899
1904
  * @public
1900
1905
  */
1901
1906
  export interface CreatePentestInput {
1902
1907
  /**
1903
- * Title of the pentest
1908
+ * <p>The title of the pentest.</p>
1904
1909
  * @public
1905
1910
  */
1906
1911
  title: string | undefined;
1907
1912
  /**
1908
- * ID of the agent space where the pentest should be created
1913
+ * <p>The unique identifier of the agent space to create the pentest in.</p>
1909
1914
  * @public
1910
1915
  */
1911
1916
  agentSpaceId: string | undefined;
1912
1917
  /**
1913
- * Assets to be tested during the pentest
1918
+ * <p>The assets to include in the pentest, such as endpoints, actors, documents, and source code.</p>
1914
1919
  * @public
1915
1920
  */
1916
1921
  assets?: Assets | undefined;
1917
1922
  /**
1918
- * A list of risk types excluded from the pentest execution
1923
+ * <p>The list of risk types to exclude from the pentest.</p>
1919
1924
  * @public
1920
1925
  */
1921
1926
  excludeRiskTypes?: RiskType[] | undefined;
1922
1927
  /**
1923
- * Service role ARN for accessing customer resources
1928
+ * <p>The IAM service role to use for the pentest.</p>
1924
1929
  * @public
1925
1930
  */
1926
1931
  serviceRole?: string | undefined;
1927
1932
  /**
1928
- * CloudWatch log group and stream prefix where pentest execution logs are stored
1933
+ * <p>The CloudWatch Logs configuration for the pentest.</p>
1929
1934
  * @public
1930
1935
  */
1931
1936
  logConfig?: CloudWatchLog | undefined;
1932
1937
  /**
1933
- * VPC configuration that the Security Agent accesses
1938
+ * <p>The VPC configuration for the pentest.</p>
1934
1939
  * @public
1935
1940
  */
1936
1941
  vpcConfig?: VpcConfig | undefined;
1937
1942
  /**
1938
- * Configuration for network traffic filtering
1943
+ * <p>The network traffic configuration for the pentest, including custom headers and traffic rules.</p>
1939
1944
  * @public
1940
1945
  */
1941
1946
  networkTrafficConfig?: NetworkTrafficConfig | undefined;
1942
1947
  /**
1943
- * Strategy for code remediation on findings
1948
+ * <p>The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.</p>
1944
1949
  * @public
1945
1950
  */
1946
1951
  codeRemediationStrategy?: CodeRemediationStrategy | undefined;
1947
1952
  }
1948
1953
  /**
1949
- * Output for the CreatePentest operation
1954
+ * <p>Output for the CreatePentest operation.</p>
1950
1955
  * @public
1951
1956
  */
1952
1957
  export interface CreatePentestOutput {
1953
1958
  /**
1954
- * Unique identifier of the created pentest
1959
+ * <p>The unique identifier of the created pentest.</p>
1955
1960
  * @public
1956
1961
  */
1957
1962
  pentestId?: string | undefined;
1958
1963
  /**
1959
- * Title of the created pentest
1964
+ * <p>The title of the pentest.</p>
1960
1965
  * @public
1961
1966
  */
1962
1967
  title?: string | undefined;
1963
1968
  /**
1964
- * Timestamp when the pentest was created
1969
+ * <p>The date and time the pentest was created, in UTC format.</p>
1965
1970
  * @public
1966
1971
  */
1967
1972
  createdAt?: Date | undefined;
1968
1973
  /**
1969
- * Timestamp when the pentest was last updated
1974
+ * <p>The date and time the pentest was last updated, in UTC format.</p>
1970
1975
  * @public
1971
1976
  */
1972
1977
  updatedAt?: Date | undefined;
1973
1978
  /**
1974
- * Assets to be tested in the created pentest
1979
+ * <p>The assets included in the pentest.</p>
1975
1980
  * @public
1976
1981
  */
1977
1982
  assets?: Assets | undefined;
1978
1983
  /**
1979
- * A list of risk types excluded from the pentest execution
1984
+ * <p>The list of risk types excluded from the pentest.</p>
1980
1985
  * @public
1981
1986
  */
1982
1987
  excludeRiskTypes?: RiskType[] | undefined;
1983
1988
  /**
1984
- * Service role ARN for accessing customer resources
1989
+ * <p>The IAM service role used for the pentest.</p>
1985
1990
  * @public
1986
1991
  */
1987
1992
  serviceRole?: string | undefined;
1988
1993
  /**
1989
- * CloudWatch log group and stream prefix where pentest execution logs are stored
1994
+ * <p>The CloudWatch Logs configuration for the pentest.</p>
1990
1995
  * @public
1991
1996
  */
1992
1997
  logConfig?: CloudWatchLog | undefined;
1993
1998
  /**
1994
- * ID of the agent space where the pentest was created
1999
+ * <p>The unique identifier of the agent space that contains the pentest.</p>
1995
2000
  * @public
1996
2001
  */
1997
2002
  agentSpaceId?: string | undefined;
1998
2003
  }
1999
2004
  /**
2000
- * Input for creating a new target domain
2005
+ * <p>Input for creating a new target domain.</p>
2001
2006
  * @public
2002
2007
  */
2003
2008
  export interface CreateTargetDomainInput {
2004
2009
  /**
2005
- * Domain name of the target domain
2010
+ * <p>The domain name to register as a target domain.</p>
2006
2011
  * @public
2007
2012
  */
2008
2013
  targetDomainName: string | undefined;
2009
2014
  /**
2010
- * Verification method for the target domain
2015
+ * <p>The method to use for verifying domain ownership. Valid values are DNS_TXT, HTTP_ROUTE, and PRIVATE_VPC.</p>
2011
2016
  * @public
2012
2017
  */
2013
2018
  verificationMethod: DomainVerificationMethod | undefined;
2014
2019
  /**
2015
- * Tags to associate with the target domain
2020
+ * <p>The tags to associate with the target domain.</p>
2016
2021
  * @public
2017
2022
  */
2018
2023
  tags?: Record<string, string> | undefined;
2019
2024
  }
2020
2025
  /**
2021
- * Output for the CreateTargetDomain operation
2026
+ * <p>Output for the CreateTargetDomain operation.</p>
2022
2027
  * @public
2023
2028
  */
2024
2029
  export interface CreateTargetDomainOutput {
2025
2030
  /**
2026
- * Unique identifier of the created target domain
2031
+ * <p>The unique identifier of the created target domain.</p>
2027
2032
  * @public
2028
2033
  */
2029
2034
  targetDomainId: string | undefined;
2030
2035
  /**
2031
- * Name of the created target domain
2036
+ * <p>The domain name of the target domain.</p>
2032
2037
  * @public
2033
2038
  */
2034
2039
  domainName: string | undefined;
2035
2040
  /**
2036
- * Current verification status of the registered target domain
2041
+ * <p>The current verification status of the target domain.</p>
2037
2042
  * @public
2038
2043
  */
2039
2044
  verificationStatus: TargetDomainStatus | undefined;
2040
2045
  /**
2041
- * Verification details to verify registered target domain
2046
+ * <p>The reason for the current target domain verification status.</p>
2047
+ * @public
2048
+ */
2049
+ verificationStatusReason?: string | undefined;
2050
+ /**
2051
+ * <p>The verification details for the target domain, including the verification token and instructions.</p>
2042
2052
  * @public
2043
2053
  */
2044
2054
  verificationDetails?: VerificationDetails | undefined;
2045
2055
  /**
2046
- * Timestamp when the target domain was registered
2056
+ * <p>The date and time the target domain was created, in UTC format.</p>
2047
2057
  * @public
2048
2058
  */
2049
2059
  createdAt?: Date | undefined;
2050
2060
  /**
2051
- * Timestamp when the target domain was last successfully verified
2061
+ * <p>The date and time the target domain was verified, in UTC format.</p>
2052
2062
  * @public
2053
2063
  */
2054
2064
  verifiedAt?: Date | undefined;
@@ -2058,12 +2068,12 @@ export interface CreateTargetDomainOutput {
2058
2068
  */
2059
2069
  export interface DeleteArtifactInput {
2060
2070
  /**
2061
- * Unique identifier of the agent space
2071
+ * <p>The unique identifier of the agent space that contains the artifact.</p>
2062
2072
  * @public
2063
2073
  */
2064
2074
  agentSpaceId: string | undefined;
2065
2075
  /**
2066
- * Unique identifier of the artifact
2076
+ * <p>The unique identifier of the artifact to delete.</p>
2067
2077
  * @public
2068
2078
  */
2069
2079
  artifactId: string | undefined;
@@ -2078,7 +2088,7 @@ export interface DeleteArtifactOutput {
2078
2088
  */
2079
2089
  export interface DeleteIntegrationInput {
2080
2090
  /**
2081
- * Unique identifier of the integration
2091
+ * <p>The unique identifier of the integration to delete.</p>
2082
2092
  * @public
2083
2093
  */
2084
2094
  integrationId: string | undefined;
@@ -2089,157 +2099,157 @@ export interface DeleteIntegrationInput {
2089
2099
  export interface DeleteIntegrationOutput {
2090
2100
  }
2091
2101
  /**
2092
- * Request structure for removing a single member from an agent space
2102
+ * <p>Request structure for removing a single member from an agent space.</p>
2093
2103
  * @public
2094
2104
  */
2095
2105
  export interface DeleteMembershipRequest {
2096
2106
  /**
2097
- * Application identifier
2107
+ * <p>The unique identifier of the application that contains the agent space.</p>
2098
2108
  * @public
2099
2109
  */
2100
2110
  applicationId: string | undefined;
2101
2111
  /**
2102
- * Agent space identifier
2112
+ * <p>The unique identifier of the agent space to revoke access from.</p>
2103
2113
  * @public
2104
2114
  */
2105
2115
  agentSpaceId: string | undefined;
2106
2116
  /**
2107
- * Member identifier (userId or agentSpaceId)
2117
+ * <p>The unique identifier of the membership to delete.</p>
2108
2118
  * @public
2109
2119
  */
2110
2120
  membershipId: string | undefined;
2111
2121
  /**
2112
- * Type of member (USER or AGENT_SPACE)
2122
+ * <p>The type of member to remove.</p>
2113
2123
  * @public
2114
2124
  */
2115
2125
  memberType?: MembershipType | undefined;
2116
2126
  }
2117
2127
  /**
2118
- * Response structure for removing a single member from an agent space
2128
+ * <p>Response structure for removing a single member from an agent space.</p>
2119
2129
  * @public
2120
2130
  */
2121
2131
  export interface DeleteMembershipResponse {
2122
2132
  }
2123
2133
  /**
2124
- * Input for deleting a target domain
2134
+ * <p>Input for deleting a target domain.</p>
2125
2135
  * @public
2126
2136
  */
2127
2137
  export interface DeleteTargetDomainInput {
2128
2138
  /**
2129
- * Unique identifier of the target domain to delete
2139
+ * <p>The unique identifier of the target domain to delete.</p>
2130
2140
  * @public
2131
2141
  */
2132
2142
  targetDomainId: string | undefined;
2133
2143
  }
2134
2144
  /**
2135
- * Output for the DeleteTargetDomain operation
2145
+ * <p>Output for the DeleteTargetDomain operation.</p>
2136
2146
  * @public
2137
2147
  */
2138
2148
  export interface DeleteTargetDomainOutput {
2139
2149
  /**
2140
- * Unique identifier of the deleted target domain
2150
+ * <p>The unique identifier of the deleted target domain.</p>
2141
2151
  * @public
2142
2152
  */
2143
2153
  targetDomainId?: string | undefined;
2144
2154
  }
2145
2155
  /**
2146
- * Represents a discovered endpoint during pentest execution
2156
+ * <p>Represents an endpoint discovered during a pentest job.</p>
2147
2157
  * @public
2148
2158
  */
2149
2159
  export interface DiscoveredEndpoint {
2150
2160
  /**
2151
- * The URI of the discovered endpoint
2161
+ * <p>The URI of the discovered endpoint.</p>
2152
2162
  * @public
2153
2163
  */
2154
2164
  uri: string | undefined;
2155
2165
  /**
2156
- * Identifier of the pentest job that discovered this endpoint
2166
+ * <p>The unique identifier of the pentest job that discovered the endpoint.</p>
2157
2167
  * @public
2158
2168
  */
2159
2169
  pentestJobId: string | undefined;
2160
2170
  /**
2161
- * Identifier of the task that discovered this endpoint
2171
+ * <p>The unique identifier of the task that discovered the endpoint.</p>
2162
2172
  * @public
2163
2173
  */
2164
2174
  taskId: string | undefined;
2165
2175
  /**
2166
- * Identifier of the agent space where the endpoint was discovered
2176
+ * <p>The unique identifier of the agent space associated with the discovered endpoint.</p>
2167
2177
  * @public
2168
2178
  */
2169
2179
  agentSpaceId: string | undefined;
2170
2180
  /**
2171
- * Optional evidence or additional information about the endpoint
2181
+ * <p>The evidence that led to the discovery of the endpoint.</p>
2172
2182
  * @public
2173
2183
  */
2174
2184
  evidence?: string | undefined;
2175
2185
  /**
2176
- * Operation or action associated with the endpoint
2186
+ * <p>The HTTP operation associated with the discovered endpoint.</p>
2177
2187
  * @public
2178
2188
  */
2179
2189
  operation?: string | undefined;
2180
2190
  /**
2181
- * Additional description of the endpoint
2191
+ * <p>A description of the discovered endpoint.</p>
2182
2192
  * @public
2183
2193
  */
2184
2194
  description?: string | undefined;
2185
2195
  }
2186
2196
  /**
2187
- * Summary information for a security finding
2197
+ * <p>Contains summary information about a security finding.</p>
2188
2198
  * @public
2189
2199
  */
2190
2200
  export interface FindingSummary {
2191
2201
  /**
2192
- * Unique identifier for the finding
2202
+ * <p>The unique identifier of the finding.</p>
2193
2203
  * @public
2194
2204
  */
2195
2205
  findingId: string | undefined;
2196
2206
  /**
2197
- * Identifier of the agent space that created this finding
2207
+ * <p>The unique identifier of the agent space associated with the finding.</p>
2198
2208
  * @public
2199
2209
  */
2200
2210
  agentSpaceId: string | undefined;
2201
2211
  /**
2202
- * Identifier of the parent pentest
2212
+ * <p>The unique identifier of the pentest associated with the finding.</p>
2203
2213
  * @public
2204
2214
  */
2205
2215
  pentestId?: string | undefined;
2206
2216
  /**
2207
- * Identifier of the pentest job
2217
+ * <p>The unique identifier of the pentest job that produced the finding.</p>
2208
2218
  * @public
2209
2219
  */
2210
2220
  pentestJobId?: string | undefined;
2211
2221
  /**
2212
- * Name or title of the finding
2222
+ * <p>The name of the finding.</p>
2213
2223
  * @public
2214
2224
  */
2215
2225
  name?: string | undefined;
2216
2226
  /**
2217
- * Current status of the finding
2227
+ * <p>The current status of the finding.</p>
2218
2228
  * @public
2219
2229
  */
2220
2230
  status?: FindingStatus | undefined;
2221
2231
  /**
2222
- * Type of security risk identified
2232
+ * <p>The type of security risk identified by the finding.</p>
2223
2233
  * @public
2224
2234
  */
2225
2235
  riskType?: string | undefined;
2226
2236
  /**
2227
- * Severity level of the identified risk
2237
+ * <p>The risk level of the finding.</p>
2228
2238
  * @public
2229
2239
  */
2230
2240
  riskLevel?: RiskLevel | undefined;
2231
2241
  /**
2232
- * Confidence level of the finding
2242
+ * <p>The confidence level of the finding.</p>
2233
2243
  * @public
2234
2244
  */
2235
2245
  confidence?: ConfidenceLevel | undefined;
2236
2246
  /**
2237
- * Timestamp when the finding was created
2247
+ * <p>The date and time the finding was created, in UTC format.</p>
2238
2248
  * @public
2239
2249
  */
2240
2250
  createdAt?: Date | undefined;
2241
2251
  /**
2242
- * Timestamp when the finding was last updated
2252
+ * <p>The date and time the finding was last updated, in UTC format.</p>
2243
2253
  * @public
2244
2254
  */
2245
2255
  updatedAt?: Date | undefined;
@@ -2249,12 +2259,12 @@ export interface FindingSummary {
2249
2259
  */
2250
2260
  export interface GetArtifactInput {
2251
2261
  /**
2252
- * Unique identifier of the agent space
2262
+ * <p>The unique identifier of the agent space that contains the artifact.</p>
2253
2263
  * @public
2254
2264
  */
2255
2265
  agentSpaceId: string | undefined;
2256
2266
  /**
2257
- * Unique identifier of the artifact
2267
+ * <p>The unique identifier of the artifact to retrieve.</p>
2258
2268
  * @public
2259
2269
  */
2260
2270
  artifactId: string | undefined;
@@ -2264,27 +2274,27 @@ export interface GetArtifactInput {
2264
2274
  */
2265
2275
  export interface GetArtifactOutput {
2266
2276
  /**
2267
- * Unique identifier of the agent space
2277
+ * <p>The unique identifier of the agent space that contains the artifact.</p>
2268
2278
  * @public
2269
2279
  */
2270
2280
  agentSpaceId: string | undefined;
2271
2281
  /**
2272
- * Unique identifier of the artifact
2282
+ * <p>The unique identifier of the artifact.</p>
2273
2283
  * @public
2274
2284
  */
2275
2285
  artifactId: string | undefined;
2276
2286
  /**
2277
- * Artifact details
2287
+ * <p>The artifact content and type.</p>
2278
2288
  * @public
2279
2289
  */
2280
2290
  artifact: Artifact | undefined;
2281
2291
  /**
2282
- * Name of the artifact file
2292
+ * <p>The file name of the artifact.</p>
2283
2293
  * @public
2284
2294
  */
2285
2295
  fileName: string | undefined;
2286
2296
  /**
2287
- * Timestamp when the artifact was last updated
2297
+ * <p>The date and time the artifact was last updated, in UTC format.</p>
2288
2298
  * @public
2289
2299
  */
2290
2300
  updatedAt: Date | undefined;
@@ -2294,7 +2304,7 @@ export interface GetArtifactOutput {
2294
2304
  */
2295
2305
  export interface GetIntegrationInput {
2296
2306
  /**
2297
- * Unique identifier of the integration
2307
+ * <p>The unique identifier of the integration to retrieve.</p>
2298
2308
  * @public
2299
2309
  */
2300
2310
  integrationId: string | undefined;
@@ -2304,90 +2314,90 @@ export interface GetIntegrationInput {
2304
2314
  */
2305
2315
  export interface GetIntegrationOutput {
2306
2316
  /**
2307
- * Unique identifier of the integration
2317
+ * <p>The unique identifier of the integration.</p>
2308
2318
  * @public
2309
2319
  */
2310
2320
  integrationId: string | undefined;
2311
2321
  /**
2312
- * Installation identifier from the provider
2322
+ * <p>The installation identifier from the integration provider.</p>
2313
2323
  * @public
2314
2324
  */
2315
2325
  installationId: string | undefined;
2316
2326
  /**
2317
- * Provider type
2327
+ * <p>The integration provider.</p>
2318
2328
  * @public
2319
2329
  */
2320
2330
  provider: Provider | undefined;
2321
2331
  /**
2322
- * Type of provider integration
2332
+ * <p>The type of the integration provider.</p>
2323
2333
  * @public
2324
2334
  */
2325
2335
  providerType: ProviderType | undefined;
2326
2336
  /**
2327
- * Display name for the integration
2337
+ * <p>The display name of the integration.</p>
2328
2338
  * @public
2329
2339
  */
2330
2340
  displayName?: string | undefined;
2331
2341
  /**
2332
- * KMS key ID for encrypting integration details
2342
+ * <p>The identifier of the AWS KMS key used to encrypt data associated with the integration.</p>
2333
2343
  * @public
2334
2344
  */
2335
2345
  kmsKeyId?: string | undefined;
2336
2346
  }
2337
2347
  /**
2338
- * Metadata specific to a GitHub repository integrated resource
2348
+ * <p>Contains metadata about a GitHub repository that is integrated with the service.</p>
2339
2349
  * @public
2340
2350
  */
2341
2351
  export interface GitHubRepositoryMetadata {
2342
2352
  /**
2343
- * Name of the resource e.g. repository name, etc
2353
+ * <p>The name of the GitHub repository.</p>
2344
2354
  * @public
2345
2355
  */
2346
2356
  name: string | undefined;
2347
2357
  /**
2348
- * Unique resource identifier from the vendor
2358
+ * <p>The provider-specific resource identifier for the GitHub repository.</p>
2349
2359
  * @public
2350
2360
  */
2351
2361
  providerResourceId: string | undefined;
2352
2362
  /**
2353
- * Owner of the repository
2363
+ * <p>The owner of the GitHub repository.</p>
2354
2364
  * @public
2355
2365
  */
2356
2366
  owner: string | undefined;
2357
2367
  /**
2358
- * Access / Visibility Type of the integrated resource
2368
+ * <p>The access type of the GitHub repository. Valid values are PRIVATE and PUBLIC.</p>
2359
2369
  * @public
2360
2370
  */
2361
2371
  accessType?: AccessType | undefined;
2362
2372
  }
2363
2373
  /**
2364
- * GitHub repository resource details
2374
+ * <p>Represents a GitHub repository resource used in an integration.</p>
2365
2375
  * @public
2366
2376
  */
2367
2377
  export interface GitHubRepositoryResource {
2368
2378
  /**
2369
- * Name of the resource e.g. repository name, etc
2379
+ * <p>The name of the GitHub repository.</p>
2370
2380
  * @public
2371
2381
  */
2372
2382
  name: string | undefined;
2373
2383
  /**
2374
- * Owner of the repository
2384
+ * <p>The owner of the GitHub repository.</p>
2375
2385
  * @public
2376
2386
  */
2377
2387
  owner: string | undefined;
2378
2388
  }
2379
2389
  /**
2380
- * Capabilities for GitHub repositories
2390
+ * <p>The capabilities enabled for a GitHub resource integration.</p>
2381
2391
  * @public
2382
2392
  */
2383
2393
  export interface GitHubResourceCapabilities {
2384
2394
  /**
2385
- * Post code review comments on pull requests
2395
+ * <p>Indicates whether the integration can leave comments on pull requests.</p>
2386
2396
  * @public
2387
2397
  */
2388
2398
  leaveComments?: boolean | undefined;
2389
2399
  /**
2390
- * Create pull requests with automated fixes
2400
+ * <p>Indicates whether the integration can create code remediation pull requests.</p>
2391
2401
  * @public
2392
2402
  */
2393
2403
  remediateCode?: boolean | undefined;
@@ -2397,7 +2407,7 @@ export interface GitHubResourceCapabilities {
2397
2407
  */
2398
2408
  export interface InitiateProviderRegistrationInput {
2399
2409
  /**
2400
- * Provider to register with
2410
+ * <p>The provider to initiate registration with. Currently, only GITHUB is supported.</p>
2401
2411
  * @public
2402
2412
  */
2403
2413
  provider: Provider | undefined;
@@ -2407,18 +2417,18 @@ export interface InitiateProviderRegistrationInput {
2407
2417
  */
2408
2418
  export interface InitiateProviderRegistrationOutput {
2409
2419
  /**
2410
- * OAuth redirect URL
2420
+ * <p>The URL to redirect the user to for completing the OAuth authorization.</p>
2411
2421
  * @public
2412
2422
  */
2413
2423
  redirectTo: string | undefined;
2414
2424
  /**
2415
- * CSRF state token for OAuth security
2425
+ * <p>The CSRF state token to use when completing the OAuth flow.</p>
2416
2426
  * @public
2417
2427
  */
2418
2428
  csrfState: string | undefined;
2419
2429
  }
2420
2430
  /**
2421
- * Integrated resource details from a provider
2431
+ * <p>Represents an integrated resource from a third-party provider. This is a union type that contains provider-specific resource information.</p>
2422
2432
  * @public
2423
2433
  */
2424
2434
  export type IntegratedResource = IntegratedResource.GithubRepositoryMember | IntegratedResource.$UnknownMember;
@@ -2427,7 +2437,7 @@ export type IntegratedResource = IntegratedResource.GithubRepositoryMember | Int
2427
2437
  */
2428
2438
  export declare namespace IntegratedResource {
2429
2439
  /**
2430
- * GitHub repository resource
2440
+ * <p>The GitHub repository resource information.</p>
2431
2441
  * @public
2432
2442
  */
2433
2443
  interface GithubRepositoryMember {
@@ -2451,7 +2461,7 @@ export declare namespace IntegratedResource {
2451
2461
  }
2452
2462
  }
2453
2463
  /**
2454
- * Provider-specific capabilities for integrated resources
2464
+ * <p>The capabilities for an integrated resource from a third-party provider. This is a union type that contains provider-specific capabilities.</p>
2455
2465
  * @public
2456
2466
  */
2457
2467
  export type ProviderResourceCapabilities = ProviderResourceCapabilities.GithubMember | ProviderResourceCapabilities.$UnknownMember;
@@ -2460,7 +2470,7 @@ export type ProviderResourceCapabilities = ProviderResourceCapabilities.GithubMe
2460
2470
  */
2461
2471
  export declare namespace ProviderResourceCapabilities {
2462
2472
  /**
2463
- * Capabilities for GitHub repositories
2473
+ * <p>The GitHub-specific resource capabilities.</p>
2464
2474
  * @public
2465
2475
  */
2466
2476
  interface GithubMember {
@@ -2484,23 +2494,23 @@ export declare namespace ProviderResourceCapabilities {
2484
2494
  }
2485
2495
  }
2486
2496
  /**
2487
- * Input item for updating an integrated resource
2497
+ * <p>Represents an input item for updating integrated resources, including the resource and its capabilities.</p>
2488
2498
  * @public
2489
2499
  */
2490
2500
  export interface IntegratedResourceInputItem {
2491
2501
  /**
2492
- * Configuration of the resource
2502
+ * <p>The integrated resource to update.</p>
2493
2503
  * @public
2494
2504
  */
2495
2505
  resource: IntegratedResource | undefined;
2496
2506
  /**
2497
- * Provider-specific capabilities for the resource
2507
+ * <p>The capabilities to enable for the integrated resource.</p>
2498
2508
  * @public
2499
2509
  */
2500
2510
  capabilities?: ProviderResourceCapabilities | undefined;
2501
2511
  }
2502
2512
  /**
2503
- * Metadata about an integrated resource
2513
+ * <p>Contains metadata about an integrated resource. This is a union type that contains provider-specific metadata.</p>
2504
2514
  * @public
2505
2515
  */
2506
2516
  export type IntegratedResourceMetadata = IntegratedResourceMetadata.GithubRepositoryMember | IntegratedResourceMetadata.$UnknownMember;
@@ -2509,7 +2519,7 @@ export type IntegratedResourceMetadata = IntegratedResourceMetadata.GithubReposi
2509
2519
  */
2510
2520
  export declare namespace IntegratedResourceMetadata {
2511
2521
  /**
2512
- * Metadata for a GitHub repository resource
2522
+ * <p>The GitHub repository metadata.</p>
2513
2523
  * @public
2514
2524
  */
2515
2525
  interface GithubRepositoryMember {
@@ -2533,28 +2543,28 @@ export declare namespace IntegratedResourceMetadata {
2533
2543
  }
2534
2544
  }
2535
2545
  /**
2536
- * Summary information about an integrated resource
2546
+ * <p>Contains summary information about an integrated resource.</p>
2537
2547
  * @public
2538
2548
  */
2539
2549
  export interface IntegratedResourceSummary {
2540
2550
  /**
2541
- * Unique identifier of the integration
2551
+ * <p>The unique identifier of the integration that provides access to the resource.</p>
2542
2552
  * @public
2543
2553
  */
2544
2554
  integrationId: string | undefined;
2545
2555
  /**
2546
- * The integrated resource details
2556
+ * <p>The metadata for the integrated resource.</p>
2547
2557
  * @public
2548
2558
  */
2549
2559
  resource: IntegratedResourceMetadata | undefined;
2550
2560
  /**
2551
- * Capabilities of the integrated resource
2561
+ * <p>The capabilities enabled for the integrated resource.</p>
2552
2562
  * @public
2553
2563
  */
2554
2564
  capabilities?: ProviderResourceCapabilities | undefined;
2555
2565
  }
2556
2566
  /**
2557
- * Filter criteria for integrations
2567
+ * <p>A filter for listing integrations. This is a union type where you can filter by provider or provider type.</p>
2558
2568
  * @public
2559
2569
  */
2560
2570
  export type IntegrationFilter = IntegrationFilter.ProviderMember | IntegrationFilter.ProviderTypeMember | IntegrationFilter.$UnknownMember;
@@ -2563,7 +2573,7 @@ export type IntegrationFilter = IntegrationFilter.ProviderMember | IntegrationFi
2563
2573
  */
2564
2574
  export declare namespace IntegrationFilter {
2565
2575
  /**
2566
- * Filter by provider
2576
+ * <p>Filter integrations by provider.</p>
2567
2577
  * @public
2568
2578
  */
2569
2579
  interface ProviderMember {
@@ -2572,7 +2582,7 @@ export declare namespace IntegrationFilter {
2572
2582
  $unknown?: never;
2573
2583
  }
2574
2584
  /**
2575
- * Filter by provider type
2585
+ * <p>Filter integrations by provider type.</p>
2576
2586
  * @public
2577
2587
  */
2578
2588
  interface ProviderTypeMember {
@@ -2603,48 +2613,48 @@ export declare namespace IntegrationFilter {
2603
2613
  */
2604
2614
  export interface ListIntegrationsInput {
2605
2615
  /**
2606
- * Filter criteria for integrations
2616
+ * <p>A filter to apply to the list of integrations.</p>
2607
2617
  * @public
2608
2618
  */
2609
2619
  filter?: IntegrationFilter | undefined;
2610
2620
  /**
2611
- * Token for pagination
2621
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2612
2622
  * @public
2613
2623
  */
2614
2624
  nextToken?: string | undefined;
2615
2625
  /**
2616
- * Maximum number of results to return
2626
+ * <p>The maximum number of results to return in a single call.</p>
2617
2627
  * @public
2618
2628
  */
2619
2629
  maxResults?: number | undefined;
2620
2630
  }
2621
2631
  /**
2622
- * Summary information about an integration
2632
+ * <p>Contains summary information about an integration.</p>
2623
2633
  * @public
2624
2634
  */
2625
2635
  export interface IntegrationSummary {
2626
2636
  /**
2627
- * Unique identifier of the integration
2637
+ * <p>The unique identifier of the integration.</p>
2628
2638
  * @public
2629
2639
  */
2630
2640
  integrationId: string | undefined;
2631
2641
  /**
2632
- * Installation identifier from the provider
2642
+ * <p>The installation identifier from the integration provider.</p>
2633
2643
  * @public
2634
2644
  */
2635
2645
  installationId: string | undefined;
2636
2646
  /**
2637
- * Provider type
2647
+ * <p>The integration provider.</p>
2638
2648
  * @public
2639
2649
  */
2640
2650
  provider: Provider | undefined;
2641
2651
  /**
2642
- * Type of provider integration
2652
+ * <p>The type of the integration provider.</p>
2643
2653
  * @public
2644
2654
  */
2645
2655
  providerType: ProviderType | undefined;
2646
2656
  /**
2647
- * Display name for the integration
2657
+ * <p>The display name of the integration.</p>
2648
2658
  * @public
2649
2659
  */
2650
2660
  displayName: string | undefined;
@@ -2654,12 +2664,12 @@ export interface IntegrationSummary {
2654
2664
  */
2655
2665
  export interface ListIntegrationsOutput {
2656
2666
  /**
2657
- * List of integration summaries
2667
+ * <p>The list of integration summaries.</p>
2658
2668
  * @public
2659
2669
  */
2660
2670
  integrationSummaries: IntegrationSummary[] | undefined;
2661
2671
  /**
2662
- * Token for pagination to retrieve the next set of results
2672
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2663
2673
  * @public
2664
2674
  */
2665
2675
  nextToken?: string | undefined;
@@ -2669,17 +2679,17 @@ export interface ListIntegrationsOutput {
2669
2679
  */
2670
2680
  export interface ListArtifactsInput {
2671
2681
  /**
2672
- * Unique identifier of the agent space
2682
+ * <p>The unique identifier of the agent space to list artifacts for.</p>
2673
2683
  * @public
2674
2684
  */
2675
2685
  agentSpaceId: string | undefined;
2676
2686
  /**
2677
- * Token for pagination
2687
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2678
2688
  * @public
2679
2689
  */
2680
2690
  nextToken?: string | undefined;
2681
2691
  /**
2682
- * Maximum number of results to return
2692
+ * <p>The maximum number of results to return in a single call.</p>
2683
2693
  * @public
2684
2694
  */
2685
2695
  maxResults?: number | undefined;
@@ -2689,126 +2699,126 @@ export interface ListArtifactsInput {
2689
2699
  */
2690
2700
  export interface ListArtifactsOutput {
2691
2701
  /**
2692
- * List of artifact summaries
2702
+ * <p>The list of artifact summaries.</p>
2693
2703
  * @public
2694
2704
  */
2695
2705
  artifactSummaries: ArtifactSummary[] | undefined;
2696
2706
  /**
2697
- * Token for pagination to retrieve the next set of results
2707
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2698
2708
  * @public
2699
2709
  */
2700
2710
  nextToken?: string | undefined;
2701
2711
  }
2702
2712
  /**
2703
- * Input for ListDiscoveredEndpoints operation
2713
+ * <p>Input for ListDiscoveredEndpoints operation.</p>
2704
2714
  * @public
2705
2715
  */
2706
2716
  export interface ListDiscoveredEndpointsInput {
2707
2717
  /**
2708
- * Maximum number of discovered endpoints to return in a single request (default: 50)
2718
+ * <p>The maximum number of results to return in a single call.</p>
2709
2719
  * @public
2710
2720
  */
2711
2721
  maxResults?: number | undefined;
2712
2722
  /**
2713
- * Identifier of the pentest job for which to retrieve discovered endpoints
2723
+ * <p>The unique identifier of the pentest job to list discovered endpoints for.</p>
2714
2724
  * @public
2715
2725
  */
2716
2726
  pentestJobId: string | undefined;
2717
2727
  /**
2718
- * ID of the agent space where the pentest job exists
2728
+ * <p>The unique identifier of the agent space.</p>
2719
2729
  * @public
2720
2730
  */
2721
2731
  agentSpaceId: string | undefined;
2722
2732
  /**
2723
- * Optional URI prefix filter to narrow down results
2733
+ * <p>A prefix to filter discovered endpoints by URI.</p>
2724
2734
  * @public
2725
2735
  */
2726
2736
  prefix?: string | undefined;
2727
2737
  /**
2728
- * Token for pagination
2738
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2729
2739
  * @public
2730
2740
  */
2731
2741
  nextToken?: string | undefined;
2732
2742
  }
2733
2743
  /**
2734
- * Output for the ListDiscoveredEndpoints operation
2744
+ * <p>Output for the ListDiscoveredEndpoints operation.</p>
2735
2745
  * @public
2736
2746
  */
2737
2747
  export interface ListDiscoveredEndpointsOutput {
2738
2748
  /**
2739
- * List of discovered endpoints for the pentest job
2749
+ * <p>The list of discovered endpoints.</p>
2740
2750
  * @public
2741
2751
  */
2742
2752
  discoveredEndpoints?: DiscoveredEndpoint[] | undefined;
2743
2753
  /**
2744
- * Token for pagination to retrieve the next set of results
2754
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2745
2755
  * @public
2746
2756
  */
2747
2757
  nextToken?: string | undefined;
2748
2758
  }
2749
2759
  /**
2750
- * Input for ListFindings operation with filtering support
2760
+ * <p>Input for ListFindings operation with filtering support.</p>
2751
2761
  * @public
2752
2762
  */
2753
2763
  export interface ListFindingsInput {
2754
2764
  /**
2755
- * Maximum number of findings to return in a single request (default: 50)
2765
+ * <p>The maximum number of results to return in a single call.</p>
2756
2766
  * @public
2757
2767
  */
2758
2768
  maxResults?: number | undefined;
2759
2769
  /**
2760
- * Identifier of the pentest job for which to retrieve associated findings
2770
+ * <p>The unique identifier of the pentest job to list findings for.</p>
2761
2771
  * @public
2762
2772
  */
2763
2773
  pentestJobId: string | undefined;
2764
2774
  /**
2765
- * ID of the agent space where the pentest job exists
2775
+ * <p>The unique identifier of the agent space.</p>
2766
2776
  * @public
2767
2777
  */
2768
2778
  agentSpaceId: string | undefined;
2769
2779
  /**
2770
- * Token for pagination
2780
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2771
2781
  * @public
2772
2782
  */
2773
2783
  nextToken?: string | undefined;
2774
2784
  /**
2775
- * Filter findings by risk type
2785
+ * <p>Filter findings by risk type.</p>
2776
2786
  * @public
2777
2787
  */
2778
2788
  riskType?: string | undefined;
2779
2789
  /**
2780
- * Filter findings by risk level
2790
+ * <p>Filter findings by risk level.</p>
2781
2791
  * @public
2782
2792
  */
2783
2793
  riskLevel?: RiskLevel | undefined;
2784
2794
  /**
2785
- * Filter findings by status
2795
+ * <p>Filter findings by status.</p>
2786
2796
  * @public
2787
2797
  */
2788
2798
  status?: FindingStatus | undefined;
2789
2799
  /**
2790
- * Filter findings by confidence level
2800
+ * <p>Filter findings by confidence level.</p>
2791
2801
  * @public
2792
2802
  */
2793
2803
  confidence?: ConfidenceLevel | undefined;
2794
2804
  /**
2795
- * Filter findings by name (case-insensitive substring search)
2805
+ * <p>Filter findings by name.</p>
2796
2806
  * @public
2797
2807
  */
2798
2808
  name?: string | undefined;
2799
2809
  }
2800
2810
  /**
2801
- * Output for the ListFindings operation
2811
+ * <p>Output for the ListFindings operation.</p>
2802
2812
  * @public
2803
2813
  */
2804
2814
  export interface ListFindingsOutput {
2805
2815
  /**
2806
- * List of finding summaries matching the filter criteria
2816
+ * <p>The list of finding summaries.</p>
2807
2817
  * @public
2808
2818
  */
2809
2819
  findingsSummaries?: FindingSummary[] | undefined;
2810
2820
  /**
2811
- * Token for pagination to retrieve the next set of results
2821
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2812
2822
  * @public
2813
2823
  */
2814
2824
  nextToken?: string | undefined;
@@ -2818,27 +2828,27 @@ export interface ListFindingsOutput {
2818
2828
  */
2819
2829
  export interface ListIntegratedResourcesInput {
2820
2830
  /**
2821
- * Unique identifier of the agent space
2831
+ * <p>The unique identifier of the agent space to list integrated resources for.</p>
2822
2832
  * @public
2823
2833
  */
2824
2834
  agentSpaceId: string | undefined;
2825
2835
  /**
2826
- * Filter integrated resources by a specific integration
2836
+ * <p>The unique identifier of the integration to filter by.</p>
2827
2837
  * @public
2828
2838
  */
2829
2839
  integrationId?: string | undefined;
2830
2840
  /**
2831
- * Filter integrated resources by resource type
2841
+ * <p>The type of resource to filter by.</p>
2832
2842
  * @public
2833
2843
  */
2834
2844
  resourceType?: ResourceType | undefined;
2835
2845
  /**
2836
- * Token for pagination
2846
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2837
2847
  * @public
2838
2848
  */
2839
2849
  nextToken?: string | undefined;
2840
2850
  /**
2841
- * Maximum number of results to return
2851
+ * <p>The maximum number of results to return in a single call.</p>
2842
2852
  * @public
2843
2853
  */
2844
2854
  maxResults?: number | undefined;
@@ -2848,65 +2858,65 @@ export interface ListIntegratedResourcesInput {
2848
2858
  */
2849
2859
  export interface ListIntegratedResourcesOutput {
2850
2860
  /**
2851
- * List of integrated resources
2861
+ * <p>The list of integrated resource summaries.</p>
2852
2862
  * @public
2853
2863
  */
2854
2864
  integratedResourceSummaries: IntegratedResourceSummary[] | undefined;
2855
2865
  /**
2856
- * Token for pagination to retrieve the next set of results
2866
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2857
2867
  * @public
2858
2868
  */
2859
2869
  nextToken?: string | undefined;
2860
2870
  }
2861
2871
  /**
2862
- * Request structure for listing agent space members
2872
+ * <p>Request structure for listing agent space members.</p>
2863
2873
  * @public
2864
2874
  */
2865
2875
  export interface ListMembershipsRequest {
2866
2876
  /**
2867
- * Application identifier
2877
+ * <p>The unique identifier of the application that contains the agent space.</p>
2868
2878
  * @public
2869
2879
  */
2870
2880
  applicationId: string | undefined;
2871
2881
  /**
2872
- * Agent space identifier
2882
+ * <p>The unique identifier of the agent space to list memberships for.</p>
2873
2883
  * @public
2874
2884
  */
2875
2885
  agentSpaceId: string | undefined;
2876
2886
  /**
2877
- * Filter by member type
2887
+ * <p>Filter memberships by member type.</p>
2878
2888
  * @public
2879
2889
  */
2880
2890
  memberType?: MembershipTypeFilter | undefined;
2881
2891
  /**
2882
- * Maximum number of results to return
2892
+ * <p>The maximum number of results to return in a single call.</p>
2883
2893
  * @public
2884
2894
  */
2885
2895
  maxResults?: number | undefined;
2886
2896
  /**
2887
- * Token for pagination
2897
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
2888
2898
  * @public
2889
2899
  */
2890
2900
  nextToken?: string | undefined;
2891
2901
  }
2892
2902
  /**
2893
- * User-specific metadata
2903
+ * <p>Contains metadata about a user member, including the username and email address.</p>
2894
2904
  * @public
2895
2905
  */
2896
2906
  export interface UserMetadata {
2897
2907
  /**
2898
- * User name/display name
2908
+ * <p>The username of the user.</p>
2899
2909
  * @public
2900
2910
  */
2901
2911
  username: string | undefined;
2902
2912
  /**
2903
- * User email address
2913
+ * <p>The email address of the user.</p>
2904
2914
  * @public
2905
2915
  */
2906
2916
  email: string | undefined;
2907
2917
  }
2908
2918
  /**
2909
- * Metadata associated with the member
2919
+ * <p>Contains metadata about a member. This is a union type that contains member-type-specific metadata.</p>
2910
2920
  * @public
2911
2921
  */
2912
2922
  export type MemberMetadata = MemberMetadata.UserMember | MemberMetadata.$UnknownMember;
@@ -2915,7 +2925,7 @@ export type MemberMetadata = MemberMetadata.UserMember | MemberMetadata.$Unknown
2915
2925
  */
2916
2926
  export declare namespace MemberMetadata {
2917
2927
  /**
2918
- * User metadata for USER members
2928
+ * <p>The user metadata for the member.</p>
2919
2929
  * @public
2920
2930
  */
2921
2931
  interface UserMember {
@@ -2939,631 +2949,636 @@ export declare namespace MemberMetadata {
2939
2949
  }
2940
2950
  }
2941
2951
  /**
2942
- * Membership summary for list operations
2952
+ * <p>Contains summary information about a membership.</p>
2943
2953
  * @public
2944
2954
  */
2945
2955
  export interface MembershipSummary {
2946
2956
  /**
2947
- * Member identifier (userId or agentSpaceId)
2957
+ * <p>The unique identifier of the membership.</p>
2948
2958
  * @public
2949
2959
  */
2950
2960
  membershipId: string | undefined;
2951
2961
  /**
2952
- * Application identifier
2962
+ * <p>The unique identifier of the application.</p>
2953
2963
  * @public
2954
2964
  */
2955
2965
  applicationId: string | undefined;
2956
2966
  /**
2957
- * Agent space identifier
2967
+ * <p>The unique identifier of the agent space.</p>
2958
2968
  * @public
2959
2969
  */
2960
2970
  agentSpaceId: string | undefined;
2961
2971
  /**
2962
- * Type of member
2972
+ * <p>The type of member.</p>
2963
2973
  * @public
2964
2974
  */
2965
2975
  memberType: MembershipType | undefined;
2966
2976
  /**
2967
- * Configuration specific to the member type
2977
+ * <p>The configuration for the membership.</p>
2968
2978
  * @public
2969
2979
  */
2970
2980
  config?: MembershipConfig | undefined;
2971
2981
  /**
2972
- * Member-specific metadata
2982
+ * <p>The metadata for the member.</p>
2973
2983
  * @public
2974
2984
  */
2975
2985
  metadata?: MemberMetadata | undefined;
2976
2986
  /**
2977
- * Timestamp when the membership was created (ISO 8601)
2987
+ * <p>The date and time the membership was created, in UTC format.</p>
2978
2988
  * @public
2979
2989
  */
2980
2990
  createdAt: Date | undefined;
2981
2991
  /**
2982
- * Timestamp when the membership was last updated (ISO 8601)
2992
+ * <p>The date and time the membership was last updated, in UTC format.</p>
2983
2993
  * @public
2984
2994
  */
2985
2995
  updatedAt: Date | undefined;
2986
2996
  /**
2987
- * User ID who created the membership
2997
+ * <p>The identifier of the entity that created the membership.</p>
2988
2998
  * @public
2989
2999
  */
2990
3000
  createdBy: string | undefined;
2991
3001
  /**
2992
- * User ID who last updated the membership
3002
+ * <p>The identifier of the entity that last updated the membership.</p>
2993
3003
  * @public
2994
3004
  */
2995
3005
  updatedBy: string | undefined;
2996
3006
  }
2997
3007
  /**
2998
- * Response structure for listing members associated to an agent space
3008
+ * <p>Response structure for listing members associated to an agent space.</p>
2999
3009
  * @public
3000
3010
  */
3001
3011
  export interface ListMembershipsResponse {
3002
3012
  /**
3003
- * List of membership summaries
3013
+ * <p>The list of membership summaries.</p>
3004
3014
  * @public
3005
3015
  */
3006
3016
  membershipSummaries: MembershipSummary[] | undefined;
3007
3017
  /**
3008
- * Token for next page of results
3018
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3009
3019
  * @public
3010
3020
  */
3011
3021
  nextToken?: string | undefined;
3012
3022
  }
3013
3023
  /**
3014
- * Input for ListPentestJobsForPentest operation
3024
+ * <p>Input for ListPentestJobsForPentest operation.</p>
3015
3025
  * @public
3016
3026
  */
3017
3027
  export interface ListPentestJobsForPentestInput {
3018
3028
  /**
3019
- * Maximum number of pentest jobs to return in a single request
3029
+ * <p>The maximum number of results to return in a single call.</p>
3020
3030
  * @public
3021
3031
  */
3022
3032
  maxResults?: number | undefined;
3023
3033
  /**
3024
- * Identifier of the pentest for which to retrieve associated jobs
3034
+ * <p>The unique identifier of the pentest to list jobs for.</p>
3025
3035
  * @public
3026
3036
  */
3027
3037
  pentestId: string | undefined;
3028
3038
  /**
3029
- * ID of the agent space where the pentest exists
3039
+ * <p>The unique identifier of the agent space.</p>
3030
3040
  * @public
3031
3041
  */
3032
3042
  agentSpaceId: string | undefined;
3033
3043
  /**
3034
- * Token for pagination
3044
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3035
3045
  * @public
3036
3046
  */
3037
3047
  nextToken?: string | undefined;
3038
3048
  }
3039
3049
  /**
3040
- * Summary information for a pentest job
3050
+ * <p>Contains summary information about a pentest job.</p>
3041
3051
  * @public
3042
3052
  */
3043
3053
  export interface PentestJobSummary {
3044
3054
  /**
3045
- * Unique identifier of the pentest job
3055
+ * <p>The unique identifier of the pentest job.</p>
3046
3056
  * @public
3047
3057
  */
3048
3058
  pentestJobId: string | undefined;
3049
3059
  /**
3050
- * Identifier of the parent pentest
3060
+ * <p>The unique identifier of the pentest associated with the job.</p>
3051
3061
  * @public
3052
3062
  */
3053
3063
  pentestId: string | undefined;
3054
3064
  /**
3055
- * Title or name of the pentest
3065
+ * <p>The title of the pentest job.</p>
3056
3066
  * @public
3057
3067
  */
3058
3068
  title?: string | undefined;
3059
3069
  /**
3060
- * Current status of the pentest job
3070
+ * <p>The current status of the pentest job.</p>
3061
3071
  * @public
3062
3072
  */
3063
3073
  status?: JobStatus | undefined;
3064
3074
  /**
3065
- * Timestamp when the pentest job was created
3075
+ * <p>The date and time the pentest job was created, in UTC format.</p>
3066
3076
  * @public
3067
3077
  */
3068
3078
  createdAt?: Date | undefined;
3069
3079
  /**
3070
- * Timestamp when the pentest job was last updated
3080
+ * <p>The date and time the pentest job was last updated, in UTC format.</p>
3071
3081
  * @public
3072
3082
  */
3073
3083
  updatedAt?: Date | undefined;
3074
3084
  }
3075
3085
  /**
3076
- * Output for the ListPentestJobsForPentest operation
3086
+ * <p>Output for the ListPentestJobsForPentest operation.</p>
3077
3087
  * @public
3078
3088
  */
3079
3089
  export interface ListPentestJobsForPentestOutput {
3080
3090
  /**
3081
- * List of pentest job summaries associated with the pentest
3091
+ * <p>The list of pentest job summaries.</p>
3082
3092
  * @public
3083
3093
  */
3084
3094
  pentestJobSummaries?: PentestJobSummary[] | undefined;
3085
3095
  /**
3086
- * Token for pagination to retrieve the next set of results
3096
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3087
3097
  * @public
3088
3098
  */
3089
3099
  nextToken?: string | undefined;
3090
3100
  }
3091
3101
  /**
3092
- * Input for listing tasks associated with a specific pentest job
3102
+ * <p>Input for listing tasks associated with a pentest job.</p>
3093
3103
  * @public
3094
3104
  */
3095
3105
  export interface ListPentestJobTasksInput {
3096
3106
  /**
3097
- * ID of the agent space where the pentest exists
3107
+ * <p>The unique identifier of the agent space.</p>
3098
3108
  * @public
3099
3109
  */
3100
3110
  agentSpaceId: string | undefined;
3101
3111
  /**
3102
- * Maximum number of tasks to return in a single request
3112
+ * <p>The maximum number of results to return in a single call.</p>
3103
3113
  * @public
3104
3114
  */
3105
3115
  maxResults?: number | undefined;
3106
3116
  /**
3107
- * Identifier of the pentest job whose tasks to list
3117
+ * <p>The unique identifier of the pentest job to list tasks for.</p>
3108
3118
  * @public
3109
3119
  */
3110
3120
  pentestJobId?: string | undefined;
3111
3121
  /**
3112
- * Filter tasks by step name
3122
+ * <p>Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.</p>
3113
3123
  * @public
3114
3124
  */
3115
3125
  stepName?: StepName | undefined;
3116
3126
  /**
3117
- * Filter tasks by category name.
3127
+ * <p>Filter tasks by category name.</p>
3118
3128
  * @public
3119
3129
  */
3120
3130
  categoryName?: string | undefined;
3121
3131
  /**
3122
- * Token for pagination to retrieve the next set of results
3132
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3123
3133
  * @public
3124
3134
  */
3125
3135
  nextToken?: string | undefined;
3126
3136
  }
3127
3137
  /**
3128
- * Summary information for a task
3138
+ * <p>Contains summary information about a task.</p>
3129
3139
  * @public
3130
3140
  */
3131
3141
  export interface TaskSummary {
3132
3142
  /**
3133
- * Unique identifier for the task
3143
+ * <p>The unique identifier of the task.</p>
3134
3144
  * @public
3135
3145
  */
3136
3146
  taskId: string | undefined;
3137
3147
  /**
3138
- * Identifier of the parent pentest
3148
+ * <p>The unique identifier of the pentest associated with the task.</p>
3139
3149
  * @public
3140
3150
  */
3141
3151
  pentestId?: string | undefined;
3142
3152
  /**
3143
- * Identifier of the pentest job this task belongs to
3153
+ * <p>The unique identifier of the pentest job that contains the task.</p>
3144
3154
  * @public
3145
3155
  */
3146
3156
  pentestJobId?: string | undefined;
3147
3157
  /**
3148
- * Identifier of the agent space this task belongs to
3158
+ * <p>The unique identifier of the agent space.</p>
3149
3159
  * @public
3150
3160
  */
3151
3161
  agentSpaceId?: string | undefined;
3152
3162
  /**
3153
- * Title or name of the task
3163
+ * <p>The title of the task.</p>
3154
3164
  * @public
3155
3165
  */
3156
3166
  title?: string | undefined;
3157
3167
  /**
3158
- * Type of security risk this task is designed to test
3168
+ * <p>The type of security risk the task is testing for.</p>
3159
3169
  * @public
3160
3170
  */
3161
3171
  riskType?: RiskType | undefined;
3162
3172
  /**
3163
- * Current status of the task execution
3173
+ * <p>The current execution status of the task.</p>
3164
3174
  * @public
3165
3175
  */
3166
3176
  executionStatus?: TaskExecutionStatus | undefined;
3167
3177
  /**
3168
- * Timestamp when the task was created
3178
+ * <p>The date and time the task was created, in UTC format.</p>
3169
3179
  * @public
3170
3180
  */
3171
3181
  createdAt?: Date | undefined;
3172
3182
  /**
3173
- * Timestamp when the task was last updated
3183
+ * <p>The date and time the task was last updated, in UTC format.</p>
3174
3184
  * @public
3175
3185
  */
3176
3186
  updatedAt?: Date | undefined;
3177
3187
  }
3178
3188
  /**
3179
- * Output for the ListPentestJobTasks operation
3189
+ * <p>Output for the ListPentestJobTasks operation.</p>
3180
3190
  * @public
3181
3191
  */
3182
3192
  export interface ListPentestJobTasksOutput {
3183
3193
  /**
3184
- * List of task summaries associated with the specified pentest job
3194
+ * <p>The list of task summaries.</p>
3185
3195
  * @public
3186
3196
  */
3187
3197
  taskSummaries?: TaskSummary[] | undefined;
3188
3198
  /**
3189
- * Token for pagination to retrieve the next set of results
3199
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3190
3200
  * @public
3191
3201
  */
3192
3202
  nextToken?: string | undefined;
3193
3203
  }
3194
3204
  /**
3195
- * Input for listing pentests with optional filtering
3205
+ * <p>Input for listing pentests with optional filtering.</p>
3196
3206
  * @public
3197
3207
  */
3198
3208
  export interface ListPentestsInput {
3199
3209
  /**
3200
- * Maximum number of pentests to return in a single request
3210
+ * <p>The maximum number of results to return in a single call.</p>
3201
3211
  * @public
3202
3212
  */
3203
3213
  maxResults?: number | undefined;
3204
3214
  /**
3205
- * Token for pagination
3215
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3206
3216
  * @public
3207
3217
  */
3208
3218
  nextToken?: string | undefined;
3209
3219
  /**
3210
- * ID of the agent space where the pentest exists
3220
+ * <p>The unique identifier of the agent space to list pentests for.</p>
3211
3221
  * @public
3212
3222
  */
3213
3223
  agentSpaceId: string | undefined;
3214
3224
  }
3215
3225
  /**
3216
- * Summary information for a pentest
3226
+ * <p>Contains summary information about a pentest.</p>
3217
3227
  * @public
3218
3228
  */
3219
3229
  export interface PentestSummary {
3220
3230
  /**
3221
- * Unique identifier for the pentest
3231
+ * <p>The unique identifier of the pentest.</p>
3222
3232
  * @public
3223
3233
  */
3224
3234
  pentestId: string | undefined;
3225
3235
  /**
3226
- * ID of the agent space where the pentest exists
3236
+ * <p>The unique identifier of the agent space that contains the pentest.</p>
3227
3237
  * @public
3228
3238
  */
3229
3239
  agentSpaceId: string | undefined;
3230
3240
  /**
3231
- * Title or name of the pentest
3241
+ * <p>The title of the pentest.</p>
3232
3242
  * @public
3233
3243
  */
3234
3244
  title: string | undefined;
3235
3245
  /**
3236
- * Timestamp when the pentest was created
3246
+ * <p>The date and time the pentest was created, in UTC format.</p>
3237
3247
  * @public
3238
3248
  */
3239
3249
  createdAt?: Date | undefined;
3240
3250
  /**
3241
- * Timestamp when the pentest was last updated
3251
+ * <p>The date and time the pentest was last updated, in UTC format.</p>
3242
3252
  * @public
3243
3253
  */
3244
3254
  updatedAt?: Date | undefined;
3245
3255
  }
3246
3256
  /**
3247
- * Output for the ListPentests operation
3257
+ * <p>Output for the ListPentests operation.</p>
3248
3258
  * @public
3249
3259
  */
3250
3260
  export interface ListPentestsOutput {
3251
3261
  /**
3252
- * List of pentest summaries matching the filter criteria
3262
+ * <p>The list of pentest summaries.</p>
3253
3263
  * @public
3254
3264
  */
3255
3265
  pentestSummaries?: PentestSummary[] | undefined;
3256
3266
  /**
3257
- * Token for pagination to retrieve the next set of results
3267
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3258
3268
  * @public
3259
3269
  */
3260
3270
  nextToken?: string | undefined;
3261
3271
  }
3262
3272
  /**
3263
- * Input for ListTagsForResource operation
3273
+ * <p>Input for ListTagsForResource operation.</p>
3264
3274
  * @public
3265
3275
  */
3266
3276
  export interface ListTagsForResourceInput {
3267
3277
  /**
3268
- * ARN of the resource to list tags for
3278
+ * <p>The Amazon Resource Name (ARN) of the resource to list tags for.</p>
3269
3279
  * @public
3270
3280
  */
3271
3281
  resourceArn: string | undefined;
3272
3282
  }
3273
3283
  /**
3274
- * Output for ListTagsForResource operation
3284
+ * <p>Output for ListTagsForResource operation.</p>
3275
3285
  * @public
3276
3286
  */
3277
3287
  export interface ListTagsForResourceOutput {
3278
3288
  /**
3279
- * Tags associated with the resource
3289
+ * <p>The tags associated with the resource.</p>
3280
3290
  * @public
3281
3291
  */
3282
3292
  tags?: Record<string, string> | undefined;
3283
3293
  }
3284
3294
  /**
3285
- * Input for listing target domains
3295
+ * <p>Input for listing target domains.</p>
3286
3296
  * @public
3287
3297
  */
3288
3298
  export interface ListTargetDomainsInput {
3289
3299
  /**
3290
- * Token for pagination
3300
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3291
3301
  * @public
3292
3302
  */
3293
3303
  nextToken?: string | undefined;
3294
3304
  /**
3295
- * Maximum number of target domains to return
3305
+ * <p>The maximum number of results to return in a single call.</p>
3296
3306
  * @public
3297
3307
  */
3298
3308
  maxResults?: number | undefined;
3299
3309
  }
3300
3310
  /**
3301
- * Summary information for a target domain
3311
+ * <p>Contains summary information about a target domain.</p>
3302
3312
  * @public
3303
3313
  */
3304
3314
  export interface TargetDomainSummary {
3305
3315
  /**
3306
- * Unique identifier of the target domain
3316
+ * <p>The unique identifier of the target domain.</p>
3307
3317
  * @public
3308
3318
  */
3309
3319
  targetDomainId: string | undefined;
3310
3320
  /**
3311
- * Name of the registered target domain
3321
+ * <p>The domain name of the target domain.</p>
3312
3322
  * @public
3313
3323
  */
3314
3324
  domainName: string | undefined;
3315
3325
  /**
3316
- * Current verification status of the registered target domain
3326
+ * <p>The current verification status of the target domain.</p>
3317
3327
  * @public
3318
3328
  */
3319
3329
  verificationStatus?: TargetDomainStatus | undefined;
3320
3330
  }
3321
3331
  /**
3322
- * Output for the ListTargetDomains operation
3332
+ * <p>Output for the ListTargetDomains operation.</p>
3323
3333
  * @public
3324
3334
  */
3325
3335
  export interface ListTargetDomainsOutput {
3326
3336
  /**
3327
- * List of target domain summaries
3337
+ * <p>The list of target domain summaries.</p>
3328
3338
  * @public
3329
3339
  */
3330
3340
  targetDomainSummaries?: TargetDomainSummary[] | undefined;
3331
3341
  /**
3332
- * Token for next page of results
3342
+ * <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.</p>
3333
3343
  * @public
3334
3344
  */
3335
3345
  nextToken?: string | undefined;
3336
3346
  }
3337
3347
  /**
3338
- * Input for the StartCodeRemediation operation
3348
+ * <p>Input for the StartCodeRemediation operation.</p>
3339
3349
  * @public
3340
3350
  */
3341
3351
  export interface StartCodeRemediationInput {
3342
3352
  /**
3343
- * ID of the agent space where the pentest job exists
3353
+ * <p>The unique identifier of the agent space.</p>
3344
3354
  * @public
3345
3355
  */
3346
3356
  agentSpaceId: string | undefined;
3347
3357
  /**
3348
- * Identifier of the pentest job to start code remediation for
3358
+ * <p>The unique identifier of the pentest job that produced the findings.</p>
3349
3359
  * @public
3350
3360
  */
3351
3361
  pentestJobId: string | undefined;
3352
3362
  /**
3353
- * Identifiers of the findings to start code remediation for
3363
+ * <p>The list of finding identifiers to initiate code remediation for.</p>
3354
3364
  * @public
3355
3365
  */
3356
3366
  findingIds: string[] | undefined;
3357
3367
  }
3358
3368
  /**
3359
- * Output for the StartCodeRemediation operation
3369
+ * <p>Output for the StartCodeRemediation operation.</p>
3360
3370
  * @public
3361
3371
  */
3362
3372
  export interface StartCodeRemediationOutput {
3363
3373
  }
3364
3374
  /**
3365
- * Input for starting the execution of a pentest
3375
+ * <p>Input for starting the execution of a pentest.</p>
3366
3376
  * @public
3367
3377
  */
3368
3378
  export interface StartPentestJobInput {
3369
3379
  /**
3370
- * ID of the agent space where the pentest exists
3380
+ * <p>The unique identifier of the agent space.</p>
3371
3381
  * @public
3372
3382
  */
3373
3383
  agentSpaceId: string | undefined;
3374
3384
  /**
3375
- * Identifier of the pentest to execute
3385
+ * <p>The unique identifier of the pentest to start a job for.</p>
3376
3386
  * @public
3377
3387
  */
3378
3388
  pentestId: string | undefined;
3379
3389
  }
3380
3390
  /**
3381
- * Output for the StartPentestJob operation
3391
+ * <p>Output for the StartPentestJob operation.</p>
3382
3392
  * @public
3383
3393
  */
3384
3394
  export interface StartPentestJobOutput {
3385
3395
  /**
3386
- * Title of the pentest job
3396
+ * <p>The title of the pentest job.</p>
3387
3397
  * @public
3388
3398
  */
3389
3399
  title?: string | undefined;
3390
3400
  /**
3391
- * Current status of the pentest job
3401
+ * <p>The current status of the pentest job.</p>
3392
3402
  * @public
3393
3403
  */
3394
3404
  status?: JobStatus | undefined;
3395
3405
  /**
3396
- * Timestamp when the pentest job was created
3406
+ * <p>The date and time the pentest job was created, in UTC format.</p>
3397
3407
  * @public
3398
3408
  */
3399
3409
  createdAt?: Date | undefined;
3400
3410
  /**
3401
- * Timestamp when the pentest job was last updated
3411
+ * <p>The date and time the pentest job was last updated, in UTC format.</p>
3402
3412
  * @public
3403
3413
  */
3404
3414
  updatedAt?: Date | undefined;
3405
3415
  /**
3406
- * Unique identifier of the pentest
3416
+ * <p>The unique identifier of the pentest.</p>
3407
3417
  * @public
3408
3418
  */
3409
3419
  pentestId?: string | undefined;
3410
3420
  /**
3411
- * Unique identifier of the pentest job
3421
+ * <p>The unique identifier of the started pentest job.</p>
3412
3422
  * @public
3413
3423
  */
3414
3424
  pentestJobId?: string | undefined;
3415
3425
  /**
3416
- * ID of the agent space where the pentest exists
3426
+ * <p>The unique identifier of the agent space.</p>
3417
3427
  * @public
3418
3428
  */
3419
3429
  agentSpaceId?: string | undefined;
3420
3430
  }
3421
3431
  /**
3422
- * Input for stopping the execution of a pentest
3432
+ * <p>Input for stopping the execution of a pentest.</p>
3423
3433
  * @public
3424
3434
  */
3425
3435
  export interface StopPentestJobInput {
3426
3436
  /**
3427
- * ID of the agent space where the pentest exists
3437
+ * <p>The unique identifier of the agent space.</p>
3428
3438
  * @public
3429
3439
  */
3430
3440
  agentSpaceId: string | undefined;
3431
3441
  /**
3432
- * Identifier of the pentest job to stop
3442
+ * <p>The unique identifier of the pentest job to stop.</p>
3433
3443
  * @public
3434
3444
  */
3435
3445
  pentestJobId: string | undefined;
3436
3446
  }
3437
3447
  /**
3438
- * Output for the StopPentestJob operation
3448
+ * <p>Output for the StopPentestJob operation.</p>
3439
3449
  * @public
3440
3450
  */
3441
3451
  export interface StopPentestJobOutput {
3442
3452
  }
3443
3453
  /**
3444
- * Input for TagResource operation
3454
+ * <p>Input for TagResource operation.</p>
3445
3455
  * @public
3446
3456
  */
3447
3457
  export interface TagResourceInput {
3448
3458
  /**
3449
- * ARN of the resource to tag
3459
+ * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
3450
3460
  * @public
3451
3461
  */
3452
3462
  resourceArn: string | undefined;
3453
3463
  /**
3454
- * Tags to add to the resource
3464
+ * <p>The tags to add to the resource.</p>
3455
3465
  * @public
3456
3466
  */
3457
3467
  tags: Record<string, string> | undefined;
3458
3468
  }
3459
3469
  /**
3460
- * Output for TagResource operation
3470
+ * <p>Output for TagResource operation.</p>
3461
3471
  * @public
3462
3472
  */
3463
3473
  export interface TagResourceOutput {
3464
3474
  }
3465
3475
  /**
3466
- * Input for updating a target domain
3476
+ * <p>Input for updating a target domain.</p>
3467
3477
  * @public
3468
3478
  */
3469
3479
  export interface UpdateTargetDomainInput {
3470
3480
  /**
3471
- * Unique identifier of the target domain to update
3481
+ * <p>The unique identifier of the target domain to update.</p>
3472
3482
  * @public
3473
3483
  */
3474
3484
  targetDomainId: string | undefined;
3475
3485
  /**
3476
- * Verification method for the target domain
3486
+ * <p>The updated verification method for the target domain.</p>
3477
3487
  * @public
3478
3488
  */
3479
3489
  verificationMethod: DomainVerificationMethod | undefined;
3480
3490
  }
3481
3491
  /**
3482
- * Output for the UpdateTargetDomain operation
3492
+ * <p>Output for the UpdateTargetDomain operation.</p>
3483
3493
  * @public
3484
3494
  */
3485
3495
  export interface UpdateTargetDomainOutput {
3486
3496
  /**
3487
- * Unique identifier of the target domain
3497
+ * <p>The unique identifier of the target domain.</p>
3488
3498
  * @public
3489
3499
  */
3490
3500
  targetDomainId: string | undefined;
3491
3501
  /**
3492
- * Name of the target domain
3502
+ * <p>The domain name of the target domain.</p>
3493
3503
  * @public
3494
3504
  */
3495
3505
  domainName: string | undefined;
3496
3506
  /**
3497
- * Current verification status of the registered target domain
3507
+ * <p>The current verification status of the target domain.</p>
3498
3508
  * @public
3499
3509
  */
3500
3510
  verificationStatus: TargetDomainStatus | undefined;
3501
3511
  /**
3502
- * Verification details to verify registered target domain
3512
+ * <p>The reason for the current target domain verification status.</p>
3513
+ * @public
3514
+ */
3515
+ verificationStatusReason?: string | undefined;
3516
+ /**
3517
+ * <p>The updated verification details for the target domain.</p>
3503
3518
  * @public
3504
3519
  */
3505
3520
  verificationDetails?: VerificationDetails | undefined;
3506
3521
  /**
3507
- * Timestamp when the target domain was registered
3522
+ * <p>The date and time the target domain was created, in UTC format.</p>
3508
3523
  * @public
3509
3524
  */
3510
3525
  createdAt?: Date | undefined;
3511
3526
  /**
3512
- * Timestamp when the target domain was last successfully verified
3527
+ * <p>The date and time the target domain was verified, in UTC format.</p>
3513
3528
  * @public
3514
3529
  */
3515
3530
  verifiedAt?: Date | undefined;
3516
3531
  }
3517
3532
  /**
3518
- * Input for UntagResource operation
3533
+ * <p>Input for UntagResource operation.</p>
3519
3534
  * @public
3520
3535
  */
3521
3536
  export interface UntagResourceInput {
3522
3537
  /**
3523
- * ARN of the resource to untag
3538
+ * <p>The Amazon Resource Name (ARN) of the resource to remove tags from.</p>
3524
3539
  * @public
3525
3540
  */
3526
3541
  resourceArn: string | undefined;
3527
3542
  /**
3528
- * List of tag keys to remove from the resource
3543
+ * <p>The list of tag keys to remove from the resource.</p>
3529
3544
  * @public
3530
3545
  */
3531
3546
  tagKeys: string[] | undefined;
3532
3547
  }
3533
3548
  /**
3534
- * Output for UntagResource operation
3549
+ * <p>Output for UntagResource operation.</p>
3535
3550
  * @public
3536
3551
  */
3537
3552
  export interface UntagResourceOutput {
3538
3553
  }
3539
3554
  /**
3540
- * Input for updating an existing security finding
3555
+ * <p>Input for updating an existing security finding.</p>
3541
3556
  * @public
3542
3557
  */
3543
3558
  export interface UpdateFindingInput {
3544
3559
  /**
3545
- * Identifier of the finding to update
3560
+ * <p>The unique identifier of the finding to update.</p>
3546
3561
  * @public
3547
3562
  */
3548
3563
  findingId: string | undefined;
3549
3564
  /**
3550
- * ID of the agent space where the finding exists
3565
+ * <p>The unique identifier of the agent space that contains the finding.</p>
3551
3566
  * @public
3552
3567
  */
3553
3568
  agentSpaceId: string | undefined;
3554
3569
  /**
3555
- * Updated severity level of the identified risk
3570
+ * <p>The updated risk level for the finding.</p>
3556
3571
  * @public
3557
3572
  */
3558
3573
  riskLevel?: RiskLevel | undefined;
3559
3574
  /**
3560
- * Updated status of the finding
3575
+ * <p>The updated status for the finding.</p>
3561
3576
  * @public
3562
3577
  */
3563
3578
  status?: FindingStatus | undefined;
3564
3579
  }
3565
3580
  /**
3566
- * Output for the UpdateFinding operation
3581
+ * <p>Output for the UpdateFinding operation.</p>
3567
3582
  * @public
3568
3583
  */
3569
3584
  export interface UpdateFindingOutput {
@@ -3573,17 +3588,17 @@ export interface UpdateFindingOutput {
3573
3588
  */
3574
3589
  export interface UpdateIntegratedResourcesInput {
3575
3590
  /**
3576
- * Unique identifier of the agent space
3591
+ * <p>The unique identifier of the agent space.</p>
3577
3592
  * @public
3578
3593
  */
3579
3594
  agentSpaceId: string | undefined;
3580
3595
  /**
3581
- * Unique identifier of the integration
3596
+ * <p>The unique identifier of the integration.</p>
3582
3597
  * @public
3583
3598
  */
3584
3599
  integrationId: string | undefined;
3585
3600
  /**
3586
- * List of integrated resources to update
3601
+ * <p>The list of integrated resource items to update.</p>
3587
3602
  * @public
3588
3603
  */
3589
3604
  items: IntegratedResourceInputItem[] | undefined;
@@ -3594,156 +3609,161 @@ export interface UpdateIntegratedResourcesInput {
3594
3609
  export interface UpdateIntegratedResourcesOutput {
3595
3610
  }
3596
3611
  /**
3597
- * Input for updating an existing pentest
3612
+ * <p>Input for updating an existing pentest.</p>
3598
3613
  * @public
3599
3614
  */
3600
3615
  export interface UpdatePentestInput {
3601
3616
  /**
3602
- * Identifier of the pentest to update
3617
+ * <p>The unique identifier of the pentest to update.</p>
3603
3618
  * @public
3604
3619
  */
3605
3620
  pentestId: string | undefined;
3606
3621
  /**
3607
- * ID of the agent space where the pentest exists
3622
+ * <p>The unique identifier of the agent space that contains the pentest.</p>
3608
3623
  * @public
3609
3624
  */
3610
3625
  agentSpaceId: string | undefined;
3611
3626
  /**
3612
- * New title for the pentest
3627
+ * <p>The updated title of the pentest.</p>
3613
3628
  * @public
3614
3629
  */
3615
3630
  title?: string | undefined;
3616
3631
  /**
3617
- * Updated assets to be tested
3632
+ * <p>The updated assets for the pentest.</p>
3618
3633
  * @public
3619
3634
  */
3620
3635
  assets?: Assets | undefined;
3621
3636
  /**
3622
- * A list of risk types excluded from the pentest execution
3637
+ * <p>The updated list of risk types to exclude from the pentest.</p>
3623
3638
  * @public
3624
3639
  */
3625
3640
  excludeRiskTypes?: RiskType[] | undefined;
3626
3641
  /**
3627
- * Updated service role ARN for accessing customer resources
3642
+ * <p>The updated IAM service role for the pentest.</p>
3628
3643
  * @public
3629
3644
  */
3630
3645
  serviceRole?: string | undefined;
3631
3646
  /**
3632
- * CloudWatch log group and stream prefix where pentest execution logs are stored
3647
+ * <p>The updated CloudWatch Logs configuration for the pentest.</p>
3633
3648
  * @public
3634
3649
  */
3635
3650
  logConfig?: CloudWatchLog | undefined;
3636
3651
  /**
3637
- * VPC configuration that the Security Agent accesses
3652
+ * <p>The updated VPC configuration for the pentest.</p>
3638
3653
  * @public
3639
3654
  */
3640
3655
  vpcConfig?: VpcConfig | undefined;
3641
3656
  /**
3642
- * Configuration for network traffic filtering
3657
+ * <p>The updated network traffic configuration for the pentest.</p>
3643
3658
  * @public
3644
3659
  */
3645
3660
  networkTrafficConfig?: NetworkTrafficConfig | undefined;
3646
3661
  /**
3647
- * Strategy for code remediation on findings
3662
+ * <p>The updated code remediation strategy for the pentest.</p>
3648
3663
  * @public
3649
3664
  */
3650
3665
  codeRemediationStrategy?: CodeRemediationStrategy | undefined;
3651
3666
  }
3652
3667
  /**
3653
- * Output for the UpdatePentest operation
3668
+ * <p>Output for the UpdatePentest operation.</p>
3654
3669
  * @public
3655
3670
  */
3656
3671
  export interface UpdatePentestOutput {
3657
3672
  /**
3658
- * Unique identifier of the updated pentest
3673
+ * <p>The unique identifier of the pentest.</p>
3659
3674
  * @public
3660
3675
  */
3661
3676
  pentestId?: string | undefined;
3662
3677
  /**
3663
- * Title of the updated pentest
3678
+ * <p>The title of the pentest.</p>
3664
3679
  * @public
3665
3680
  */
3666
3681
  title?: string | undefined;
3667
3682
  /**
3668
- * Timestamp when the pentest was created
3683
+ * <p>The date and time the pentest was created, in UTC format.</p>
3669
3684
  * @public
3670
3685
  */
3671
3686
  createdAt?: Date | undefined;
3672
3687
  /**
3673
- * Timestamp when the pentest was last updated
3688
+ * <p>The date and time the pentest was last updated, in UTC format.</p>
3674
3689
  * @public
3675
3690
  */
3676
3691
  updatedAt?: Date | undefined;
3677
3692
  /**
3678
- * Assets to be tested in the updated pentest
3693
+ * <p>The assets included in the pentest.</p>
3679
3694
  * @public
3680
3695
  */
3681
3696
  assets?: Assets | undefined;
3682
3697
  /**
3683
- * A list of risk types excluded from the pentest execution
3698
+ * <p>The list of risk types excluded from the pentest.</p>
3684
3699
  * @public
3685
3700
  */
3686
3701
  excludeRiskTypes?: RiskType[] | undefined;
3687
3702
  /**
3688
- * Service role ARN for accessing customer resources
3703
+ * <p>The IAM service role used for the pentest.</p>
3689
3704
  * @public
3690
3705
  */
3691
3706
  serviceRole?: string | undefined;
3692
3707
  /**
3693
- * CloudWatch log group and stream prefix where pentest execution logs are stored
3708
+ * <p>The CloudWatch Logs configuration for the pentest.</p>
3694
3709
  * @public
3695
3710
  */
3696
3711
  logConfig?: CloudWatchLog | undefined;
3697
3712
  /**
3698
- * ID of the agent space where the pentest exists
3713
+ * <p>The unique identifier of the agent space that contains the pentest.</p>
3699
3714
  * @public
3700
3715
  */
3701
3716
  agentSpaceId?: string | undefined;
3702
3717
  }
3703
3718
  /**
3704
- * Input for verifying ownership for a registered target domain in an agent space
3719
+ * <p>Input for verifying ownership for a registered target domain in an agent space.</p>
3705
3720
  * @public
3706
3721
  */
3707
3722
  export interface VerifyTargetDomainInput {
3708
3723
  /**
3709
- * Unique identifier of the target domain
3724
+ * <p>The unique identifier of the target domain to verify.</p>
3710
3725
  * @public
3711
3726
  */
3712
3727
  targetDomainId: string | undefined;
3713
3728
  }
3714
3729
  /**
3715
- * Output for verifying ownership for a registered target domain in an agent space
3730
+ * <p>Output for verifying ownership for a registered target domain in an agent space.</p>
3716
3731
  * @public
3717
3732
  */
3718
3733
  export interface VerifyTargetDomainOutput {
3719
3734
  /**
3720
- * Unique identifier of the target domain
3735
+ * <p>The unique identifier of the target domain.</p>
3721
3736
  * @public
3722
3737
  */
3723
3738
  targetDomainId?: string | undefined;
3724
3739
  /**
3725
- * Name of the registered target domain
3740
+ * <p>The domain name of the target domain.</p>
3726
3741
  * @public
3727
3742
  */
3728
3743
  domainName?: string | undefined;
3729
3744
  /**
3730
- * Timestamp when the target domain was registered
3745
+ * <p>The date and time the target domain was created, in UTC format.</p>
3731
3746
  * @public
3732
3747
  */
3733
3748
  createdAt?: Date | undefined;
3734
3749
  /**
3735
- * Timestamp when the target domain was last updated
3750
+ * <p>The date and time the target domain was last updated, in UTC format.</p>
3736
3751
  * @public
3737
3752
  */
3738
3753
  updatedAt?: Date | undefined;
3739
3754
  /**
3740
- * Timestamp when the target domain was last successfully verified
3755
+ * <p>The date and time the target domain was verified, in UTC format.</p>
3741
3756
  * @public
3742
3757
  */
3743
3758
  verifiedAt?: Date | undefined;
3744
3759
  /**
3745
- * Current verification status of the registered target domain
3760
+ * <p>The verification status of the target domain.</p>
3746
3761
  * @public
3747
3762
  */
3748
3763
  status?: TargetDomainStatus | undefined;
3764
+ /**
3765
+ * <p>The reason for the current target domain verification status.</p>
3766
+ * @public
3767
+ */
3768
+ verificationStatusReason?: string | undefined;
3749
3769
  }