aws-sdk-securityagent 1.0.0 → 1.1.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.
@@ -10,34 +10,35 @@
10
10
  module Aws::SecurityAgent
11
11
  module Types
12
12
 
13
- # AWS resource configurations associated with the agent space
13
+ # The AWS resources associated with an agent space, including VPCs, log
14
+ # groups, S3 buckets, secrets, Lambda functions, and IAM roles.
14
15
  #
15
16
  # @!attribute [rw] vpcs
16
- # VPC configurations that the Security Agent accesses in the customer
17
- # environment
17
+ # The VPC configurations associated with the agent space.
18
18
  # @return [Array<Types::VpcConfig>]
19
19
  #
20
20
  # @!attribute [rw] log_groups
21
- # CloudWatch log group ARNs or names used to store Security Agent logs
21
+ # The Amazon Resource Names (ARNs) of the CloudWatch log groups
22
+ # associated with the agent space.
22
23
  # @return [Array<String>]
23
24
  #
24
25
  # @!attribute [rw] s3_buckets
25
- # S3 bucket ARNs or names used to store Security Agent artifacts
26
+ # The Amazon Resource Names (ARNs) of the S3 buckets associated with
27
+ # the agent space.
26
28
  # @return [Array<String>]
27
29
  #
28
30
  # @!attribute [rw] secret_arns
29
- # SecretsManager secret ARNs or names used to store tester credentials
30
- # for pentests
31
+ # The Amazon Resource Names (ARNs) of the Secrets Manager secrets
32
+ # associated with the agent space.
31
33
  # @return [Array<String>]
32
34
  #
33
35
  # @!attribute [rw] lambda_function_arns
34
- # Lambda function ARNs or names used to retrieve tester credentials
35
- # for pentests
36
+ # The Amazon Resource Names (ARNs) of the Lambda functions associated
37
+ # with the agent space.
36
38
  # @return [Array<String>]
37
39
  #
38
40
  # @!attribute [rw] iam_roles
39
- # IAM role ARNs that the Security Agent can assume to access customer
40
- # resources
41
+ # The IAM roles associated with the agent space.
41
42
  # @return [Array<String>]
42
43
  #
43
44
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/AWSResources AWS API Documentation
@@ -53,10 +54,10 @@ module Aws::SecurityAgent
53
54
  include Aws::Structure
54
55
  end
55
56
 
56
- # Request denied due to insufficient permissions
57
+ # You do not have sufficient access to perform this action.
57
58
  #
58
59
  # @!attribute [rw] message
59
- # Error description
60
+ # Error description.
60
61
  # @return [String]
61
62
  #
62
63
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/AccessDeniedException AWS API Documentation
@@ -67,23 +68,24 @@ module Aws::SecurityAgent
67
68
  include Aws::Structure
68
69
  end
69
70
 
70
- # Represents an entity that interacts with the system during security
71
- # testing
71
+ # Represents an actor used during penetration testing. An actor defines
72
+ # a user or entity that interacts with the target application, including
73
+ # authentication credentials and target URIs.
72
74
  #
73
75
  # @!attribute [rw] identifier
74
- # Unique identifier for the actor (case-insensitive)
76
+ # The unique identifier for the actor.
75
77
  # @return [String]
76
78
  #
77
79
  # @!attribute [rw] uris
78
- # List of URIs accessible with the actor's credentials
80
+ # The list of URIs that the actor targets during testing.
79
81
  # @return [Array<String>]
80
82
  #
81
83
  # @!attribute [rw] authentication
82
- # Authentication information used by the actor to access resources
84
+ # The authentication configuration for the actor.
83
85
  # @return [Types::Authentication]
84
86
  #
85
87
  # @!attribute [rw] description
86
- # Additional description or details about the actor
88
+ # A description of the actor.
87
89
  # @return [String]
88
90
  #
89
91
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Actor AWS API Documentation
@@ -98,19 +100,20 @@ module Aws::SecurityAgent
98
100
  end
99
101
 
100
102
  # @!attribute [rw] agent_space_id
101
- # Unique identifier of the agent space
103
+ # The unique identifier of the agent space to add the artifact to.
102
104
  # @return [String]
103
105
  #
104
106
  # @!attribute [rw] artifact_content
105
- # Binary content of the artifact
107
+ # The binary content of the artifact to upload.
106
108
  # @return [String]
107
109
  #
108
110
  # @!attribute [rw] artifact_type
109
- # Type of the artifact file
111
+ # The file type of the artifact. Valid values include TXT, PNG, JPEG,
112
+ # MD, PDF, DOCX, DOC, JSON, and YAML.
110
113
  # @return [String]
111
114
  #
112
115
  # @!attribute [rw] file_name
113
- # Name of the artifact file
116
+ # The file name of the artifact.
114
117
  # @return [String]
115
118
  #
116
119
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/AddArtifactInput AWS API Documentation
@@ -125,7 +128,7 @@ module Aws::SecurityAgent
125
128
  end
126
129
 
127
130
  # @!attribute [rw] artifact_id
128
- # Unique identifier of the created artifact
131
+ # The unique identifier assigned to the uploaded artifact.
129
132
  # @return [String]
130
133
  #
131
134
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/AddArtifactOutput AWS API Documentation
@@ -136,45 +139,46 @@ module Aws::SecurityAgent
136
139
  include Aws::Structure
137
140
  end
138
141
 
139
- # Agent space structure
142
+ # Represents an agent space, which is a dedicated workspace for securing
143
+ # a specific application. An agent space contains the configuration,
144
+ # resources, and settings needed for security testing.
140
145
  #
141
146
  # @!attribute [rw] agent_space_id
142
- # Unique identifier of the agent space
147
+ # The unique identifier of the agent space.
143
148
  # @return [String]
144
149
  #
145
150
  # @!attribute [rw] name
146
- # Name of the agent space
151
+ # The name of the agent space.
147
152
  # @return [String]
148
153
  #
149
154
  # @!attribute [rw] description
150
- # Description of the agent space
155
+ # A description of the agent space.
151
156
  # @return [String]
152
157
  #
153
158
  # @!attribute [rw] aws_resources
154
- # AWS resource configurations
159
+ # The AWS resources associated with the agent space.
155
160
  # @return [Types::AWSResources]
156
161
  #
157
162
  # @!attribute [rw] target_domain_ids
158
- # List of target domain IDs registered with the agent space
163
+ # The list of target domain identifiers associated with the agent
164
+ # space.
159
165
  # @return [Array<String>]
160
166
  #
161
167
  # @!attribute [rw] code_review_settings
162
- # Configuration for code review analysis, including controls scanning
163
- # and general purpose scanning settings
168
+ # The code review settings for the agent space.
164
169
  # @return [Types::CodeReviewSettings]
165
170
  #
166
171
  # @!attribute [rw] kms_key_id
167
- # Identifier of the KMS key used to encrypt data. Can be a key ID, key
168
- # ARN, alias name, or alias ARN. If not specified, an AWS managed key
169
- # is used.
172
+ # The identifier of the AWS KMS key used to encrypt data in the agent
173
+ # space.
170
174
  # @return [String]
171
175
  #
172
176
  # @!attribute [rw] created_at
173
- # Timestamp when the agent space was created
177
+ # The date and time the agent space was created, in UTC format.
174
178
  # @return [Time]
175
179
  #
176
180
  # @!attribute [rw] updated_at
177
- # Timestamp when the agent space was last updated
181
+ # The date and time the agent space was last updated, in UTC format.
178
182
  # @return [Time]
179
183
  #
180
184
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/AgentSpace AWS API Documentation
@@ -193,22 +197,22 @@ module Aws::SecurityAgent
193
197
  include Aws::Structure
194
198
  end
195
199
 
196
- # Summary information for an agent space
200
+ # Contains summary information about an agent space.
197
201
  #
198
202
  # @!attribute [rw] agent_space_id
199
- # Unique identifier of the agent space
203
+ # The unique identifier of the agent space.
200
204
  # @return [String]
201
205
  #
202
206
  # @!attribute [rw] name
203
- # Name of the agent space
207
+ # The name of the agent space.
204
208
  # @return [String]
205
209
  #
206
210
  # @!attribute [rw] created_at
207
- # Timestamp when the agent space was created
211
+ # The date and time the agent space was created, in UTC format.
208
212
  # @return [Time]
209
213
  #
210
214
  # @!attribute [rw] updated_at
211
- # Timestamp when the agent space was last updated
215
+ # The date and time the agent space was last updated, in UTC format.
212
216
  # @return [Time]
213
217
  #
214
218
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/AgentSpaceSummary AWS API Documentation
@@ -222,22 +226,23 @@ module Aws::SecurityAgent
222
226
  include Aws::Structure
223
227
  end
224
228
 
225
- # Application summary for list operations
229
+ # Contains summary information about an application.
226
230
  #
227
231
  # @!attribute [rw] application_id
228
- # Unique identifier of the application
232
+ # The unique identifier of the application.
229
233
  # @return [String]
230
234
  #
231
235
  # @!attribute [rw] application_name
232
- # Name of the application, automatically assigned by the service
236
+ # The name of the application.
233
237
  # @return [String]
234
238
  #
235
239
  # @!attribute [rw] domain
236
- # Domain where the application is available
240
+ # The domain associated with the application.
237
241
  # @return [String]
238
242
  #
239
243
  # @!attribute [rw] default_kms_key_id
240
- # Default KMS key identifier used to encrypt application data
244
+ # The identifier of the default AWS KMS key used to encrypt data for
245
+ # the application.
241
246
  # @return [String]
242
247
  #
243
248
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ApplicationSummary AWS API Documentation
@@ -251,14 +256,15 @@ module Aws::SecurityAgent
251
256
  include Aws::Structure
252
257
  end
253
258
 
254
- # Files containing relevant data for review
259
+ # Represents an artifact that provides context for security testing,
260
+ # such as documentation, diagrams, or configuration files.
255
261
  #
256
262
  # @!attribute [rw] contents
257
- # The content of the artifact
263
+ # The content of the artifact.
258
264
  # @return [String]
259
265
  #
260
266
  # @!attribute [rw] type
261
- # The file type of the artifact
267
+ # The file type of the artifact.
262
268
  # @return [String]
263
269
  #
264
270
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Artifact AWS API Documentation
@@ -270,22 +276,22 @@ module Aws::SecurityAgent
270
276
  include Aws::Structure
271
277
  end
272
278
 
273
- # Metadata in relation to the artifact
279
+ # Contains metadata about an artifact.
274
280
  #
275
281
  # @!attribute [rw] agent_space_id
276
- # Unique identifier of the agent space
282
+ # The unique identifier of the agent space that contains the artifact.
277
283
  # @return [String]
278
284
  #
279
285
  # @!attribute [rw] artifact_id
280
- # Unique identifier of the artifact
286
+ # The unique identifier of the artifact.
281
287
  # @return [String]
282
288
  #
283
289
  # @!attribute [rw] file_name
284
- # Name of the artifact file
290
+ # The file name of the artifact.
285
291
  # @return [String]
286
292
  #
287
293
  # @!attribute [rw] updated_at
288
- # Timestamp when the artifact was last updated
294
+ # The date and time the artifact was last updated, in UTC format.
289
295
  # @return [Time]
290
296
  #
291
297
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ArtifactMetadataItem AWS API Documentation
@@ -299,18 +305,18 @@ module Aws::SecurityAgent
299
305
  include Aws::Structure
300
306
  end
301
307
 
302
- # Summary information about an artifact
308
+ # Contains summary information about an artifact.
303
309
  #
304
310
  # @!attribute [rw] artifact_id
305
- # Unique identifier of the artifact
311
+ # The unique identifier of the artifact.
306
312
  # @return [String]
307
313
  #
308
314
  # @!attribute [rw] file_name
309
- # Name of the artifact file
315
+ # The file name of the artifact.
310
316
  # @return [String]
311
317
  #
312
318
  # @!attribute [rw] artifact_type
313
- # Type of the artifact file
319
+ # The file type of the artifact.
314
320
  # @return [String]
315
321
  #
316
322
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ArtifactSummary AWS API Documentation
@@ -323,26 +329,28 @@ module Aws::SecurityAgent
323
329
  include Aws::Structure
324
330
  end
325
331
 
326
- # Collection of assets to be tested or used during a pentest
332
+ # The collection of assets used in a pentest configuration, including
333
+ # endpoints, actors, documents, source code repositories, and integrated
334
+ # repositories.
327
335
  #
328
336
  # @!attribute [rw] endpoints
329
- # List of web application endpoints to test
337
+ # The list of endpoints to test during the pentest.
330
338
  # @return [Array<Types::Endpoint>]
331
339
  #
332
340
  # @!attribute [rw] actors
333
- # List of actors that interact with the system
341
+ # The list of actors used during penetration testing.
334
342
  # @return [Array<Types::Actor>]
335
343
  #
336
344
  # @!attribute [rw] documents
337
- # List of documents providing context for testing
345
+ # The list of documents that provide context for the pentest.
338
346
  # @return [Array<Types::DocumentInfo>]
339
347
  #
340
348
  # @!attribute [rw] source_code
341
- # List of source code repositories for static analysis
349
+ # The list of source code repositories to analyze during the pentest.
342
350
  # @return [Array<Types::SourceCodeRepository>]
343
351
  #
344
352
  # @!attribute [rw] integrated_repositories
345
- # List of integrated code repositories
353
+ # The list of integrated repositories associated with the pentest.
346
354
  # @return [Array<Types::IntegratedRepository>]
347
355
  #
348
356
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Assets AWS API Documentation
@@ -357,14 +365,17 @@ module Aws::SecurityAgent
357
365
  include Aws::Structure
358
366
  end
359
367
 
360
- # Authentication information used to access protected resources
368
+ # The authentication configuration for an actor, specifying the provider
369
+ # type and credentials.
361
370
  #
362
371
  # @!attribute [rw] provider_type
363
- # Provider type for the authentication credentials
372
+ # The type of authentication provider. Valid values include
373
+ # SECRETS\_MANAGER, AWS\_LAMBDA, AWS\_IAM\_ROLE, and AWS\_INTERNAL.
364
374
  # @return [String]
365
375
  #
366
376
  # @!attribute [rw] value
367
- # Authentication credential value or reference
377
+ # The authentication value, such as a secret ARN, Lambda function ARN,
378
+ # or IAM role ARN, depending on the provider type.
368
379
  # @return [String]
369
380
  #
370
381
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Authentication AWS API Documentation
@@ -376,14 +387,15 @@ module Aws::SecurityAgent
376
387
  include Aws::Structure
377
388
  end
378
389
 
379
- # Input for deleting multiple pentests
390
+ # Input for deleting multiple pentests.
380
391
  #
381
392
  # @!attribute [rw] pentest_ids
382
- # List of pentest IDs to delete
393
+ # The list of pentest identifiers to delete.
383
394
  # @return [Array<String>]
384
395
  #
385
396
  # @!attribute [rw] agent_space_id
386
- # ID of the agent space where the pentests exist
397
+ # The unique identifier of the agent space that contains the pentests
398
+ # to delete.
387
399
  # @return [String]
388
400
  #
389
401
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchDeletePentestsInput AWS API Documentation
@@ -395,15 +407,15 @@ module Aws::SecurityAgent
395
407
  include Aws::Structure
396
408
  end
397
409
 
398
- # Output for the BatchDeletePentests operation
410
+ # Output for the BatchDeletePentests operation.
399
411
  #
400
412
  # @!attribute [rw] deleted
401
- # List of successfully deleted pentests
413
+ # The list of pentests that were successfully deleted.
402
414
  # @return [Array<Types::Pentest>]
403
415
  #
404
416
  # @!attribute [rw] failed
405
- # List of pentests that could not be deleted and the reasons for
406
- # failure
417
+ # The list of pentests that failed to delete, including the reason for
418
+ # each failure.
407
419
  # @return [Array<Types::DeletePentestFailure>]
408
420
  #
409
421
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchDeletePentestsOutput AWS API Documentation
@@ -415,10 +427,10 @@ module Aws::SecurityAgent
415
427
  include Aws::Structure
416
428
  end
417
429
 
418
- # Input for batch retrieving agent spaces
430
+ # Input for batch retrieving agent spaces.
419
431
  #
420
432
  # @!attribute [rw] agent_space_ids
421
- # List of agent space IDs to retrieve
433
+ # The list of agent space identifiers to retrieve.
422
434
  # @return [Array<String>]
423
435
  #
424
436
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetAgentSpacesInput AWS API Documentation
@@ -429,14 +441,14 @@ module Aws::SecurityAgent
429
441
  include Aws::Structure
430
442
  end
431
443
 
432
- # Output for the BatchGetAgentSpaces operation
444
+ # Output for the BatchGetAgentSpaces operation.
433
445
  #
434
446
  # @!attribute [rw] agent_spaces
435
- # List of agent spaces that were successfully retrieved
447
+ # The list of agent spaces that were found.
436
448
  # @return [Array<Types::AgentSpace>]
437
449
  #
438
450
  # @!attribute [rw] not_found
439
- # List of agent space IDs that could not be found
451
+ # The list of agent space identifiers that were not found.
440
452
  # @return [Array<String>]
441
453
  #
442
454
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetAgentSpacesOutput AWS API Documentation
@@ -449,11 +461,12 @@ module Aws::SecurityAgent
449
461
  end
450
462
 
451
463
  # @!attribute [rw] agent_space_id
452
- # Unique identifier of the agent space
464
+ # The unique identifier of the agent space that contains the
465
+ # artifacts.
453
466
  # @return [String]
454
467
  #
455
468
  # @!attribute [rw] artifact_ids
456
- # List of artifact identifiers
469
+ # The list of artifact identifiers to retrieve metadata for.
457
470
  # @return [Array<String>]
458
471
  #
459
472
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetArtifactMetadataInput AWS API Documentation
@@ -466,7 +479,7 @@ module Aws::SecurityAgent
466
479
  end
467
480
 
468
481
  # @!attribute [rw] artifact_metadata_list
469
- # List of artifact metadata
482
+ # The list of artifact metadata items that were found.
470
483
  # @return [Array<Types::ArtifactMetadataItem>]
471
484
  #
472
485
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetArtifactMetadataOutput AWS API Documentation
@@ -477,14 +490,14 @@ module Aws::SecurityAgent
477
490
  include Aws::Structure
478
491
  end
479
492
 
480
- # Input for BatchGetFindings operation
493
+ # Input for BatchGetFindings operation.
481
494
  #
482
495
  # @!attribute [rw] finding_ids
483
- # List of finding IDs to retrieve
496
+ # The list of finding identifiers to retrieve.
484
497
  # @return [Array<String>]
485
498
  #
486
499
  # @!attribute [rw] agent_space_id
487
- # ID of the agent space where the findings exist
500
+ # The unique identifier of the agent space that contains the findings.
488
501
  # @return [String]
489
502
  #
490
503
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetFindingsInput AWS API Documentation
@@ -496,14 +509,14 @@ module Aws::SecurityAgent
496
509
  include Aws::Structure
497
510
  end
498
511
 
499
- # Output for the BatchGetFindings operation
512
+ # Output for the BatchGetFindings operation.
500
513
  #
501
514
  # @!attribute [rw] findings
502
- # List of successfully retrieved findings
515
+ # The list of findings that were found.
503
516
  # @return [Array<Types::Finding>]
504
517
  #
505
518
  # @!attribute [rw] not_found
506
- # List of finding IDs that could not be found
519
+ # The list of finding identifiers that were not found.
507
520
  # @return [Array<String>]
508
521
  #
509
522
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetFindingsOutput AWS API Documentation
@@ -515,14 +528,14 @@ module Aws::SecurityAgent
515
528
  include Aws::Structure
516
529
  end
517
530
 
518
- # Input for retrieving multiple tasks by their IDs for a pentest job
531
+ # Input for retrieving multiple tasks associated with a pentest job.
519
532
  #
520
533
  # @!attribute [rw] agent_space_id
521
- # ID of the agent space where the pentest exists
534
+ # The unique identifier of the agent space that contains the tasks.
522
535
  # @return [String]
523
536
  #
524
537
  # @!attribute [rw] task_ids
525
- # List of task IDs to retrieve
538
+ # The list of task identifiers to retrieve.
526
539
  # @return [Array<String>]
527
540
  #
528
541
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetPentestJobTasksInput AWS API Documentation
@@ -534,14 +547,14 @@ module Aws::SecurityAgent
534
547
  include Aws::Structure
535
548
  end
536
549
 
537
- # Output for the BatchGetPentestJobTasks operation
550
+ # Output for the BatchGetPentestJobTasks operation.
538
551
  #
539
552
  # @!attribute [rw] tasks
540
- # List of successfully retrieved tasks
553
+ # The list of tasks that were found.
541
554
  # @return [Array<Types::Task>]
542
555
  #
543
556
  # @!attribute [rw] not_found
544
- # List of task IDs that could not be found
557
+ # The list of task identifiers that were not found.
545
558
  # @return [Array<String>]
546
559
  #
547
560
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetPentestJobTasksOutput AWS API Documentation
@@ -553,14 +566,15 @@ module Aws::SecurityAgent
553
566
  include Aws::Structure
554
567
  end
555
568
 
556
- # Input for BatchGetPentestJobs operation
569
+ # Input for BatchGetPentestJobs operation.
557
570
  #
558
571
  # @!attribute [rw] pentest_job_ids
559
- # List of pentest job IDs to retrieve
572
+ # The list of pentest job identifiers to retrieve.
560
573
  # @return [Array<String>]
561
574
  #
562
575
  # @!attribute [rw] agent_space_id
563
- # ID of the agent space where the pentest exists
576
+ # The unique identifier of the agent space that contains the pentest
577
+ # jobs.
564
578
  # @return [String]
565
579
  #
566
580
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetPentestJobsInput AWS API Documentation
@@ -572,14 +586,14 @@ module Aws::SecurityAgent
572
586
  include Aws::Structure
573
587
  end
574
588
 
575
- # Output for the BatchGetPentestJobs operation
589
+ # Output for the BatchGetPentestJobs operation.
576
590
  #
577
591
  # @!attribute [rw] pentest_jobs
578
- # List of successfully retrieved pentest jobs
592
+ # The list of pentest jobs that were found.
579
593
  # @return [Array<Types::PentestJob>]
580
594
  #
581
595
  # @!attribute [rw] not_found
582
- # List of pentest job IDs that could not be found
596
+ # The list of pentest job identifiers that were not found.
583
597
  # @return [Array<String>]
584
598
  #
585
599
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetPentestJobsOutput AWS API Documentation
@@ -591,14 +605,14 @@ module Aws::SecurityAgent
591
605
  include Aws::Structure
592
606
  end
593
607
 
594
- # Input for retrieving multiple pentests by their IDs
608
+ # Input for retrieving multiple pentests by their IDs.
595
609
  #
596
610
  # @!attribute [rw] pentest_ids
597
- # List of pentest IDs to retrieve
611
+ # The list of pentest identifiers to retrieve.
598
612
  # @return [Array<String>]
599
613
  #
600
614
  # @!attribute [rw] agent_space_id
601
- # ID of the agent space where the pentest exists
615
+ # The unique identifier of the agent space that contains the pentests.
602
616
  # @return [String]
603
617
  #
604
618
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetPentestsInput AWS API Documentation
@@ -610,14 +624,14 @@ module Aws::SecurityAgent
610
624
  include Aws::Structure
611
625
  end
612
626
 
613
- # Output for the BatchGetPentests operation
627
+ # Output for the BatchGetPentests operation.
614
628
  #
615
629
  # @!attribute [rw] pentests
616
- # List of successfully retrieved pentests
630
+ # The list of pentests that were found.
617
631
  # @return [Array<Types::Pentest>]
618
632
  #
619
633
  # @!attribute [rw] not_found
620
- # List of pentest IDs that could not be found
634
+ # The list of pentest identifiers that were not found.
621
635
  # @return [Array<String>]
622
636
  #
623
637
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetPentestsOutput AWS API Documentation
@@ -629,10 +643,10 @@ module Aws::SecurityAgent
629
643
  include Aws::Structure
630
644
  end
631
645
 
632
- # Input for batch retrieving target domains
646
+ # Input for batch retrieving target domains.
633
647
  #
634
648
  # @!attribute [rw] target_domain_ids
635
- # List of target domain IDs to retrieve
649
+ # The list of target domain identifiers to retrieve.
636
650
  # @return [Array<String>]
637
651
  #
638
652
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetTargetDomainsInput AWS API Documentation
@@ -643,14 +657,14 @@ module Aws::SecurityAgent
643
657
  include Aws::Structure
644
658
  end
645
659
 
646
- # Output for the BatchGetTargetDomains operation
660
+ # Output for the BatchGetTargetDomains operation.
647
661
  #
648
662
  # @!attribute [rw] target_domains
649
- # List of target domains that were successfully retrieved
663
+ # The list of target domains that were found.
650
664
  # @return [Array<Types::TargetDomain>]
651
665
  #
652
666
  # @!attribute [rw] not_found
653
- # List of target domain IDs that could not be found
667
+ # The list of target domain identifiers that were not found.
654
668
  # @return [Array<String>]
655
669
  #
656
670
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/BatchGetTargetDomainsOutput AWS API Documentation
@@ -662,14 +676,14 @@ module Aws::SecurityAgent
662
676
  include Aws::Structure
663
677
  end
664
678
 
665
- # Represents a category classification for tasks
679
+ # Represents a category assigned to a security testing task.
666
680
  #
667
681
  # @!attribute [rw] name
668
- # Name of the category
682
+ # The name of the category.
669
683
  # @return [String]
670
684
  #
671
685
  # @!attribute [rw] is_primary
672
- # Whether this is the primary category for the task
686
+ # Indicates whether this is the primary category for the task.
673
687
  # @return [Boolean]
674
688
  #
675
689
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Category AWS API Documentation
@@ -681,14 +695,14 @@ module Aws::SecurityAgent
681
695
  include Aws::Structure
682
696
  end
683
697
 
684
- # Reference to logs stored in CloudWatch
698
+ # The Amazon CloudWatch Logs configuration for pentest job logging.
685
699
  #
686
700
  # @!attribute [rw] log_group
687
- # Name of the CloudWatch log group
701
+ # The name of the CloudWatch log group.
688
702
  # @return [String]
689
703
  #
690
704
  # @!attribute [rw] log_stream
691
- # Name of the CloudWatch log stream
705
+ # The name of the CloudWatch log stream.
692
706
  # @return [String]
693
707
  #
694
708
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CloudWatchLog AWS API Documentation
@@ -700,18 +714,20 @@ module Aws::SecurityAgent
700
714
  include Aws::Structure
701
715
  end
702
716
 
703
- # Information about task for code remediation
717
+ # Represents a code remediation task that was initiated to fix a
718
+ # security finding.
704
719
  #
705
720
  # @!attribute [rw] status
706
- # Current status of the code remediation task
721
+ # The current status of the code remediation task.
707
722
  # @return [String]
708
723
  #
709
724
  # @!attribute [rw] status_reason
710
- # Reason for the current code remediation task status
725
+ # The reason for the current status of the code remediation task.
711
726
  # @return [String]
712
727
  #
713
728
  # @!attribute [rw] task_details
714
- # Details of the code remediation for each repository
729
+ # The list of details for the code remediation task, including
730
+ # repository name, code diff link, and pull request link.
715
731
  # @return [Array<Types::CodeRemediationTaskDetails>]
716
732
  #
717
733
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CodeRemediationTask AWS API Documentation
@@ -724,18 +740,19 @@ module Aws::SecurityAgent
724
740
  include Aws::Structure
725
741
  end
726
742
 
727
- # Code remediation details for a single repository
743
+ # Contains details about a code remediation task, including links to the
744
+ # code diff and pull request.
728
745
  #
729
746
  # @!attribute [rw] repo_name
730
- # Name of the repository
747
+ # The name of the repository where the remediation was applied.
731
748
  # @return [String]
732
749
  #
733
750
  # @!attribute [rw] code_diff_link
734
- # Link to the code diff for the remediation
751
+ # The link to the code diff for the remediation.
735
752
  # @return [String]
736
753
  #
737
754
  # @!attribute [rw] pull_request_link
738
- # Link to the pull request for the remediation
755
+ # The link to the pull request created for the remediation.
739
756
  # @return [String]
740
757
  #
741
758
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CodeRemediationTaskDetails AWS API Documentation
@@ -748,14 +765,16 @@ module Aws::SecurityAgent
748
765
  include Aws::Structure
749
766
  end
750
767
 
751
- # Details of code review settings
768
+ # The code review settings for an agent space, controlling which types
769
+ # of scanning are enabled.
752
770
  #
753
771
  # @!attribute [rw] controls_scanning
754
- # Whether Controls are utilized for code review analysis
772
+ # Indicates whether controls scanning is enabled for code reviews.
755
773
  # @return [Boolean]
756
774
  #
757
775
  # @!attribute [rw] general_purpose_scanning
758
- # Whether general purpose analysis is performed for code review
776
+ # Indicates whether general-purpose scanning is enabled for code
777
+ # reviews.
759
778
  # @return [Boolean]
760
779
  #
761
780
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CodeReviewSettings AWS API Documentation
@@ -767,10 +786,11 @@ module Aws::SecurityAgent
767
786
  include Aws::Structure
768
787
  end
769
788
 
770
- # Request conflicts with current resource state
789
+ # The request could not be completed due to a conflict with the current
790
+ # state of the resource.
771
791
  #
772
792
  # @!attribute [rw] message
773
- # Error description
793
+ # Error description.
774
794
  # @return [String]
775
795
  #
776
796
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ConflictException AWS API Documentation
@@ -781,37 +801,36 @@ module Aws::SecurityAgent
781
801
  include Aws::Structure
782
802
  end
783
803
 
784
- # Input for creating a new agent space
804
+ # Input for creating a new agent space.
785
805
  #
786
806
  # @!attribute [rw] name
787
- # Name of the agent space
807
+ # The name of the agent space.
788
808
  # @return [String]
789
809
  #
790
810
  # @!attribute [rw] description
791
- # Description of the agent space
811
+ # A description of the agent space.
792
812
  # @return [String]
793
813
  #
794
814
  # @!attribute [rw] aws_resources
795
- # AWS resource configurations associated with the agent space
815
+ # The AWS resources to associate with the agent space.
796
816
  # @return [Types::AWSResources]
797
817
  #
798
818
  # @!attribute [rw] target_domain_ids
799
- # Target domain IDs to associate with the agent space
819
+ # The list of target domain identifiers to associate with the agent
820
+ # space.
800
821
  # @return [Array<String>]
801
822
  #
802
823
  # @!attribute [rw] code_review_settings
803
- # Configuration for code review analysis, including controls scanning
804
- # and general purpose scanning settings
824
+ # The code review settings for the agent space.
805
825
  # @return [Types::CodeReviewSettings]
806
826
  #
807
827
  # @!attribute [rw] kms_key_id
808
- # Identifier of the KMS key used to encrypt data. Can be a key ID, key
809
- # ARN, alias name, or alias ARN. If not specified, an AWS managed key
810
- # is used.
828
+ # The identifier of the AWS KMS key to use for encrypting data in the
829
+ # agent space.
811
830
  # @return [String]
812
831
  #
813
832
  # @!attribute [rw] tags
814
- # Tags to associate with the agent space
833
+ # The tags to associate with the agent space.
815
834
  # @return [Hash<String,String>]
816
835
  #
817
836
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateAgentSpaceInput AWS API Documentation
@@ -828,45 +847,44 @@ module Aws::SecurityAgent
828
847
  include Aws::Structure
829
848
  end
830
849
 
831
- # Output for the CreateAgentSpace operation
850
+ # Output for the CreateAgentSpace operation.
832
851
  #
833
852
  # @!attribute [rw] agent_space_id
834
- # Unique identifier of the created agent space
853
+ # The unique identifier of the created agent space.
835
854
  # @return [String]
836
855
  #
837
856
  # @!attribute [rw] name
838
- # Name of the created agent space
857
+ # The name of the agent space.
839
858
  # @return [String]
840
859
  #
841
860
  # @!attribute [rw] description
842
- # Description of the created agent space
861
+ # The description of the agent space.
843
862
  # @return [String]
844
863
  #
845
864
  # @!attribute [rw] aws_resources
846
- # AWS resource configurations associated with the agent space
865
+ # The AWS resources associated with the agent space.
847
866
  # @return [Types::AWSResources]
848
867
  #
849
868
  # @!attribute [rw] target_domain_ids
850
- # List of target domain IDs registered with the agent space
869
+ # The list of target domain identifiers associated with the agent
870
+ # space.
851
871
  # @return [Array<String>]
852
872
  #
853
873
  # @!attribute [rw] code_review_settings
854
- # Configuration for code review analysis, including controls scanning
855
- # and general purpose scanning settings
874
+ # The code review settings for the agent space.
856
875
  # @return [Types::CodeReviewSettings]
857
876
  #
858
877
  # @!attribute [rw] kms_key_id
859
- # Identifier of the KMS key used to encrypt data. Can be a key ID, key
860
- # ARN, alias name, or alias ARN. If not specified, an AWS managed key
861
- # is used.
878
+ # The identifier of the AWS KMS key used to encrypt data in the agent
879
+ # space.
862
880
  # @return [String]
863
881
  #
864
882
  # @!attribute [rw] created_at
865
- # Timestamp when the agent space was created
883
+ # The date and time the agent space was created, in UTC format.
866
884
  # @return [Time]
867
885
  #
868
886
  # @!attribute [rw] updated_at
869
- # Timestamp when the agent space was last updated
887
+ # The date and time the agent space was last updated, in UTC format.
870
888
  # @return [Time]
871
889
  #
872
890
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateAgentSpaceOutput AWS API Documentation
@@ -886,21 +904,22 @@ module Aws::SecurityAgent
886
904
  end
887
905
 
888
906
  # @!attribute [rw] idc_instance_arn
889
- # ARN of the IAM Identity Center instance used for user
890
- # authentication. Optional for non-IdC applications
907
+ # The Amazon Resource Name (ARN) of the IAM Identity Center instance
908
+ # to associate with the application.
891
909
  # @return [String]
892
910
  #
893
911
  # @!attribute [rw] role_arn
894
- # ARN of the IAM role that the application uses to access AWS
895
- # resources on your behalf
912
+ # The Amazon Resource Name (ARN) of the IAM role to associate with the
913
+ # application.
896
914
  # @return [String]
897
915
  #
898
916
  # @!attribute [rw] default_kms_key_id
899
- # Default KMS key identifier used to encrypt application data
917
+ # The identifier of the default AWS KMS key to use for encrypting data
918
+ # in the application.
900
919
  # @return [String]
901
920
  #
902
921
  # @!attribute [rw] tags
903
- # Tags to associate with the application
922
+ # The tags to associate with the application.
904
923
  # @return [Hash<String,String>]
905
924
  #
906
925
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateApplicationRequest AWS API Documentation
@@ -915,7 +934,7 @@ module Aws::SecurityAgent
915
934
  end
916
935
 
917
936
  # @!attribute [rw] application_id
918
- # Application ID
937
+ # The unique identifier of the created application.
919
938
  # @return [String]
920
939
  #
921
940
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateApplicationResponse AWS API Documentation
@@ -927,23 +946,24 @@ module Aws::SecurityAgent
927
946
  end
928
947
 
929
948
  # @!attribute [rw] provider
930
- # Provider to integrate with
949
+ # The integration provider. Currently, only GITHUB is supported.
931
950
  # @return [String]
932
951
  #
933
952
  # @!attribute [rw] input
934
- # Provider-specific input parameters
953
+ # The provider-specific input required to create the integration.
935
954
  # @return [Types::ProviderInput]
936
955
  #
937
956
  # @!attribute [rw] integration_display_name
938
- # Display name for the integration
957
+ # The display name for the integration.
939
958
  # @return [String]
940
959
  #
941
960
  # @!attribute [rw] kms_key_id
942
- # KMS key ID for encrypting integration details
961
+ # The identifier of the AWS KMS key to use for encrypting data
962
+ # associated with the integration.
943
963
  # @return [String]
944
964
  #
945
965
  # @!attribute [rw] tags
946
- # Tags to associate with the integration
966
+ # The tags to associate with the integration.
947
967
  # @return [Hash<String,String>]
948
968
  #
949
969
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateIntegrationInput AWS API Documentation
@@ -959,7 +979,7 @@ module Aws::SecurityAgent
959
979
  end
960
980
 
961
981
  # @!attribute [rw] integration_id
962
- # Unique identifier of the created integration
982
+ # The unique identifier of the created integration.
963
983
  # @return [String]
964
984
  #
965
985
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateIntegrationOutput AWS API Documentation
@@ -970,26 +990,27 @@ module Aws::SecurityAgent
970
990
  include Aws::Structure
971
991
  end
972
992
 
973
- # Request structure for adding a single member to an agent space
993
+ # Request structure for adding a single member to an agent space.
974
994
  #
975
995
  # @!attribute [rw] application_id
976
- # Application identifier
996
+ # The unique identifier of the application that contains the agent
997
+ # space.
977
998
  # @return [String]
978
999
  #
979
1000
  # @!attribute [rw] agent_space_id
980
- # Agent space identifier
1001
+ # The unique identifier of the agent space to grant access to.
981
1002
  # @return [String]
982
1003
  #
983
1004
  # @!attribute [rw] membership_id
984
- # Member identifier (userId or agentSpaceId)
1005
+ # The unique identifier for the membership.
985
1006
  # @return [String]
986
1007
  #
987
1008
  # @!attribute [rw] member_type
988
- # Type of member (USER or AGENT\_SPACE)
1009
+ # The type of member. Currently, only USER is supported.
989
1010
  # @return [String]
990
1011
  #
991
1012
  # @!attribute [rw] config
992
- # Membership details (user or agent specific)
1013
+ # The configuration for the membership, such as the user role.
993
1014
  # @return [Types::MembershipConfig]
994
1015
  #
995
1016
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateMembershipRequest AWS API Documentation
@@ -1004,49 +1025,51 @@ module Aws::SecurityAgent
1004
1025
  include Aws::Structure
1005
1026
  end
1006
1027
 
1007
- # Response structure for adding a single member to an agent space
1028
+ # Response structure for adding a single member to an agent space.
1008
1029
  #
1009
1030
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateMembershipResponse AWS API Documentation
1010
1031
  #
1011
1032
  class CreateMembershipResponse < Aws::EmptyStructure; end
1012
1033
 
1013
- # Input for creating a new pentest
1034
+ # Input for creating a new pentest.
1014
1035
  #
1015
1036
  # @!attribute [rw] title
1016
- # Title of the pentest
1037
+ # The title of the pentest.
1017
1038
  # @return [String]
1018
1039
  #
1019
1040
  # @!attribute [rw] agent_space_id
1020
- # ID of the agent space where the pentest should be created
1041
+ # The unique identifier of the agent space to create the pentest in.
1021
1042
  # @return [String]
1022
1043
  #
1023
1044
  # @!attribute [rw] assets
1024
- # Assets to be tested during the pentest
1045
+ # The assets to include in the pentest, such as endpoints, actors,
1046
+ # documents, and source code.
1025
1047
  # @return [Types::Assets]
1026
1048
  #
1027
1049
  # @!attribute [rw] exclude_risk_types
1028
- # A list of risk types excluded from the pentest execution
1050
+ # The list of risk types to exclude from the pentest.
1029
1051
  # @return [Array<String>]
1030
1052
  #
1031
1053
  # @!attribute [rw] service_role
1032
- # Service role ARN for accessing customer resources
1054
+ # The IAM service role to use for the pentest.
1033
1055
  # @return [String]
1034
1056
  #
1035
1057
  # @!attribute [rw] log_config
1036
- # CloudWatch log group and stream prefix where pentest execution logs
1037
- # are stored
1058
+ # The CloudWatch Logs configuration for the pentest.
1038
1059
  # @return [Types::CloudWatchLog]
1039
1060
  #
1040
1061
  # @!attribute [rw] vpc_config
1041
- # VPC configuration that the Security Agent accesses
1062
+ # The VPC configuration for the pentest.
1042
1063
  # @return [Types::VpcConfig]
1043
1064
  #
1044
1065
  # @!attribute [rw] network_traffic_config
1045
- # Configuration for network traffic filtering
1066
+ # The network traffic configuration for the pentest, including custom
1067
+ # headers and traffic rules.
1046
1068
  # @return [Types::NetworkTrafficConfig]
1047
1069
  #
1048
1070
  # @!attribute [rw] code_remediation_strategy
1049
- # Strategy for code remediation on findings
1071
+ # The code remediation strategy for the pentest. Valid values are
1072
+ # AUTOMATIC and DISABLED.
1050
1073
  # @return [String]
1051
1074
  #
1052
1075
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreatePentestInput AWS API Documentation
@@ -1065,43 +1088,42 @@ module Aws::SecurityAgent
1065
1088
  include Aws::Structure
1066
1089
  end
1067
1090
 
1068
- # Output for the CreatePentest operation
1091
+ # Output for the CreatePentest operation.
1069
1092
  #
1070
1093
  # @!attribute [rw] pentest_id
1071
- # Unique identifier of the created pentest
1094
+ # The unique identifier of the created pentest.
1072
1095
  # @return [String]
1073
1096
  #
1074
1097
  # @!attribute [rw] title
1075
- # Title of the created pentest
1098
+ # The title of the pentest.
1076
1099
  # @return [String]
1077
1100
  #
1078
1101
  # @!attribute [rw] created_at
1079
- # Timestamp when the pentest was created
1102
+ # The date and time the pentest was created, in UTC format.
1080
1103
  # @return [Time]
1081
1104
  #
1082
1105
  # @!attribute [rw] updated_at
1083
- # Timestamp when the pentest was last updated
1106
+ # The date and time the pentest was last updated, in UTC format.
1084
1107
  # @return [Time]
1085
1108
  #
1086
1109
  # @!attribute [rw] assets
1087
- # Assets to be tested in the created pentest
1110
+ # The assets included in the pentest.
1088
1111
  # @return [Types::Assets]
1089
1112
  #
1090
1113
  # @!attribute [rw] exclude_risk_types
1091
- # A list of risk types excluded from the pentest execution
1114
+ # The list of risk types excluded from the pentest.
1092
1115
  # @return [Array<String>]
1093
1116
  #
1094
1117
  # @!attribute [rw] service_role
1095
- # Service role ARN for accessing customer resources
1118
+ # The IAM service role used for the pentest.
1096
1119
  # @return [String]
1097
1120
  #
1098
1121
  # @!attribute [rw] log_config
1099
- # CloudWatch log group and stream prefix where pentest execution logs
1100
- # are stored
1122
+ # The CloudWatch Logs configuration for the pentest.
1101
1123
  # @return [Types::CloudWatchLog]
1102
1124
  #
1103
1125
  # @!attribute [rw] agent_space_id
1104
- # ID of the agent space where the pentest was created
1126
+ # The unique identifier of the agent space that contains the pentest.
1105
1127
  # @return [String]
1106
1128
  #
1107
1129
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreatePentestOutput AWS API Documentation
@@ -1120,18 +1142,19 @@ module Aws::SecurityAgent
1120
1142
  include Aws::Structure
1121
1143
  end
1122
1144
 
1123
- # Input for creating a new target domain
1145
+ # Input for creating a new target domain.
1124
1146
  #
1125
1147
  # @!attribute [rw] target_domain_name
1126
- # Domain name of the target domain
1148
+ # The domain name to register as a target domain.
1127
1149
  # @return [String]
1128
1150
  #
1129
1151
  # @!attribute [rw] verification_method
1130
- # Verification method for the target domain
1152
+ # The method to use for verifying domain ownership. Valid values are
1153
+ # DNS\_TXT, HTTP\_ROUTE, and PRIVATE\_VPC.
1131
1154
  # @return [String]
1132
1155
  #
1133
1156
  # @!attribute [rw] tags
1134
- # Tags to associate with the target domain
1157
+ # The tags to associate with the target domain.
1135
1158
  # @return [Hash<String,String>]
1136
1159
  #
1137
1160
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateTargetDomainInput AWS API Documentation
@@ -1144,30 +1167,35 @@ module Aws::SecurityAgent
1144
1167
  include Aws::Structure
1145
1168
  end
1146
1169
 
1147
- # Output for the CreateTargetDomain operation
1170
+ # Output for the CreateTargetDomain operation.
1148
1171
  #
1149
1172
  # @!attribute [rw] target_domain_id
1150
- # Unique identifier of the created target domain
1173
+ # The unique identifier of the created target domain.
1151
1174
  # @return [String]
1152
1175
  #
1153
1176
  # @!attribute [rw] domain_name
1154
- # Name of the created target domain
1177
+ # The domain name of the target domain.
1155
1178
  # @return [String]
1156
1179
  #
1157
1180
  # @!attribute [rw] verification_status
1158
- # Current verification status of the registered target domain
1181
+ # The current verification status of the target domain.
1182
+ # @return [String]
1183
+ #
1184
+ # @!attribute [rw] verification_status_reason
1185
+ # The reason for the current target domain verification status.
1159
1186
  # @return [String]
1160
1187
  #
1161
1188
  # @!attribute [rw] verification_details
1162
- # Verification details to verify registered target domain
1189
+ # The verification details for the target domain, including the
1190
+ # verification token and instructions.
1163
1191
  # @return [Types::VerificationDetails]
1164
1192
  #
1165
1193
  # @!attribute [rw] created_at
1166
- # Timestamp when the target domain was registered
1194
+ # The date and time the target domain was created, in UTC format.
1167
1195
  # @return [Time]
1168
1196
  #
1169
1197
  # @!attribute [rw] verified_at
1170
- # Timestamp when the target domain was last successfully verified
1198
+ # The date and time the target domain was verified, in UTC format.
1171
1199
  # @return [Time]
1172
1200
  #
1173
1201
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CreateTargetDomainOutput AWS API Documentation
@@ -1176,6 +1204,7 @@ module Aws::SecurityAgent
1176
1204
  :target_domain_id,
1177
1205
  :domain_name,
1178
1206
  :verification_status,
1207
+ :verification_status_reason,
1179
1208
  :verification_details,
1180
1209
  :created_at,
1181
1210
  :verified_at)
@@ -1183,14 +1212,15 @@ module Aws::SecurityAgent
1183
1212
  include Aws::Structure
1184
1213
  end
1185
1214
 
1186
- # Custom headers to be set for network requests
1215
+ # A custom HTTP header to include in network traffic during penetration
1216
+ # testing.
1187
1217
  #
1188
1218
  # @!attribute [rw] name
1189
- # Name of header to set value for
1219
+ # The name of the custom header.
1190
1220
  # @return [String]
1191
1221
  #
1192
1222
  # @!attribute [rw] value
1193
- # Value to set for header
1223
+ # The value of the custom header.
1194
1224
  # @return [String]
1195
1225
  #
1196
1226
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/CustomHeader AWS API Documentation
@@ -1202,10 +1232,10 @@ module Aws::SecurityAgent
1202
1232
  include Aws::Structure
1203
1233
  end
1204
1234
 
1205
- # Input for deleting an agent space
1235
+ # Input for deleting an agent space.
1206
1236
  #
1207
1237
  # @!attribute [rw] agent_space_id
1208
- # Unique identifier of the agent space to delete
1238
+ # The unique identifier of the agent space to delete.
1209
1239
  # @return [String]
1210
1240
  #
1211
1241
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteAgentSpaceInput AWS API Documentation
@@ -1216,10 +1246,10 @@ module Aws::SecurityAgent
1216
1246
  include Aws::Structure
1217
1247
  end
1218
1248
 
1219
- # Output for the DeleteAgentSpace operation
1249
+ # Output for the DeleteAgentSpace operation.
1220
1250
  #
1221
1251
  # @!attribute [rw] agent_space_id
1222
- # Unique identifier of the deleted agent space
1252
+ # The unique identifier of the deleted agent space.
1223
1253
  # @return [String]
1224
1254
  #
1225
1255
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteAgentSpaceOutput AWS API Documentation
@@ -1231,7 +1261,7 @@ module Aws::SecurityAgent
1231
1261
  end
1232
1262
 
1233
1263
  # @!attribute [rw] application_id
1234
- # Application ID
1264
+ # The unique identifier of the application to delete.
1235
1265
  # @return [String]
1236
1266
  #
1237
1267
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteApplicationRequest AWS API Documentation
@@ -1243,11 +1273,11 @@ module Aws::SecurityAgent
1243
1273
  end
1244
1274
 
1245
1275
  # @!attribute [rw] agent_space_id
1246
- # Unique identifier of the agent space
1276
+ # The unique identifier of the agent space that contains the artifact.
1247
1277
  # @return [String]
1248
1278
  #
1249
1279
  # @!attribute [rw] artifact_id
1250
- # Unique identifier of the artifact
1280
+ # The unique identifier of the artifact to delete.
1251
1281
  # @return [String]
1252
1282
  #
1253
1283
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteArtifactInput AWS API Documentation
@@ -1264,7 +1294,7 @@ module Aws::SecurityAgent
1264
1294
  class DeleteArtifactOutput < Aws::EmptyStructure; end
1265
1295
 
1266
1296
  # @!attribute [rw] integration_id
1267
- # Unique identifier of the integration
1297
+ # The unique identifier of the integration to delete.
1268
1298
  # @return [String]
1269
1299
  #
1270
1300
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteIntegrationInput AWS API Documentation
@@ -1279,22 +1309,23 @@ module Aws::SecurityAgent
1279
1309
  #
1280
1310
  class DeleteIntegrationOutput < Aws::EmptyStructure; end
1281
1311
 
1282
- # Request structure for removing a single member from an agent space
1312
+ # Request structure for removing a single member from an agent space.
1283
1313
  #
1284
1314
  # @!attribute [rw] application_id
1285
- # Application identifier
1315
+ # The unique identifier of the application that contains the agent
1316
+ # space.
1286
1317
  # @return [String]
1287
1318
  #
1288
1319
  # @!attribute [rw] agent_space_id
1289
- # Agent space identifier
1320
+ # The unique identifier of the agent space to revoke access from.
1290
1321
  # @return [String]
1291
1322
  #
1292
1323
  # @!attribute [rw] membership_id
1293
- # Member identifier (userId or agentSpaceId)
1324
+ # The unique identifier of the membership to delete.
1294
1325
  # @return [String]
1295
1326
  #
1296
1327
  # @!attribute [rw] member_type
1297
- # Type of member (USER or AGENT\_SPACE)
1328
+ # The type of member to remove.
1298
1329
  # @return [String]
1299
1330
  #
1300
1331
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteMembershipRequest AWS API Documentation
@@ -1308,20 +1339,20 @@ module Aws::SecurityAgent
1308
1339
  include Aws::Structure
1309
1340
  end
1310
1341
 
1311
- # Response structure for removing a single member from an agent space
1342
+ # Response structure for removing a single member from an agent space.
1312
1343
  #
1313
1344
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteMembershipResponse AWS API Documentation
1314
1345
  #
1315
1346
  class DeleteMembershipResponse < Aws::EmptyStructure; end
1316
1347
 
1317
- # Information about a failed pentest deletion attempt
1348
+ # Contains information about a pentest that failed to delete.
1318
1349
  #
1319
1350
  # @!attribute [rw] pentest_id
1320
- # Identifier of the pentest that failed to delete
1351
+ # The unique identifier of the pentest that failed to delete.
1321
1352
  # @return [String]
1322
1353
  #
1323
1354
  # @!attribute [rw] reason
1324
- # Reason for the deletion failure
1355
+ # The reason the pentest failed to delete.
1325
1356
  # @return [String]
1326
1357
  #
1327
1358
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeletePentestFailure AWS API Documentation
@@ -1333,10 +1364,10 @@ module Aws::SecurityAgent
1333
1364
  include Aws::Structure
1334
1365
  end
1335
1366
 
1336
- # Input for deleting a target domain
1367
+ # Input for deleting a target domain.
1337
1368
  #
1338
1369
  # @!attribute [rw] target_domain_id
1339
- # Unique identifier of the target domain to delete
1370
+ # The unique identifier of the target domain to delete.
1340
1371
  # @return [String]
1341
1372
  #
1342
1373
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteTargetDomainInput AWS API Documentation
@@ -1347,10 +1378,10 @@ module Aws::SecurityAgent
1347
1378
  include Aws::Structure
1348
1379
  end
1349
1380
 
1350
- # Output for the DeleteTargetDomain operation
1381
+ # Output for the DeleteTargetDomain operation.
1351
1382
  #
1352
1383
  # @!attribute [rw] target_domain_id
1353
- # Unique identifier of the deleted target domain
1384
+ # The unique identifier of the deleted target domain.
1354
1385
  # @return [String]
1355
1386
  #
1356
1387
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DeleteTargetDomainOutput AWS API Documentation
@@ -1361,34 +1392,36 @@ module Aws::SecurityAgent
1361
1392
  include Aws::Structure
1362
1393
  end
1363
1394
 
1364
- # Represents a discovered endpoint during pentest execution
1395
+ # Represents an endpoint discovered during a pentest job.
1365
1396
  #
1366
1397
  # @!attribute [rw] uri
1367
- # The URI of the discovered endpoint
1398
+ # The URI of the discovered endpoint.
1368
1399
  # @return [String]
1369
1400
  #
1370
1401
  # @!attribute [rw] pentest_job_id
1371
- # Identifier of the pentest job that discovered this endpoint
1402
+ # The unique identifier of the pentest job that discovered the
1403
+ # endpoint.
1372
1404
  # @return [String]
1373
1405
  #
1374
1406
  # @!attribute [rw] task_id
1375
- # Identifier of the task that discovered this endpoint
1407
+ # The unique identifier of the task that discovered the endpoint.
1376
1408
  # @return [String]
1377
1409
  #
1378
1410
  # @!attribute [rw] agent_space_id
1379
- # Identifier of the agent space where the endpoint was discovered
1411
+ # The unique identifier of the agent space associated with the
1412
+ # discovered endpoint.
1380
1413
  # @return [String]
1381
1414
  #
1382
1415
  # @!attribute [rw] evidence
1383
- # Optional evidence or additional information about the endpoint
1416
+ # The evidence that led to the discovery of the endpoint.
1384
1417
  # @return [String]
1385
1418
  #
1386
1419
  # @!attribute [rw] operation
1387
- # Operation or action associated with the endpoint
1420
+ # The HTTP operation associated with the discovered endpoint.
1388
1421
  # @return [String]
1389
1422
  #
1390
1423
  # @!attribute [rw] description
1391
- # Additional description of the endpoint
1424
+ # A description of the discovered endpoint.
1392
1425
  # @return [String]
1393
1426
  #
1394
1427
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DiscoveredEndpoint AWS API Documentation
@@ -1405,18 +1438,19 @@ module Aws::SecurityAgent
1405
1438
  include Aws::Structure
1406
1439
  end
1407
1440
 
1408
- # Represents dns txt verification details
1441
+ # Contains DNS verification details for a target domain, including the
1442
+ # DNS record to create for domain ownership verification.
1409
1443
  #
1410
1444
  # @!attribute [rw] token
1411
- # Token used to verify domain ownership
1445
+ # The verification token to include in the DNS record value.
1412
1446
  # @return [String]
1413
1447
  #
1414
1448
  # @!attribute [rw] dns_record_name
1415
- # Record name to be added in DNS for target domain
1449
+ # The name of the DNS record to create for verification.
1416
1450
  # @return [String]
1417
1451
  #
1418
1452
  # @!attribute [rw] dns_record_type
1419
- # Type of record to be added in DNS for target domain
1453
+ # The type of DNS record to create. Currently, only TXT is supported.
1420
1454
  # @return [String]
1421
1455
  #
1422
1456
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DnsVerification AWS API Documentation
@@ -1429,14 +1463,14 @@ module Aws::SecurityAgent
1429
1463
  include Aws::Structure
1430
1464
  end
1431
1465
 
1432
- # Information about a document relevant to security testing
1466
+ # Represents a document that provides context for security testing.
1433
1467
  #
1434
1468
  # @!attribute [rw] s3_location
1435
- # S3 storage location of the document
1469
+ # The Amazon S3 location of the document.
1436
1470
  # @return [String]
1437
1471
  #
1438
1472
  # @!attribute [rw] artifact_id
1439
- # Artifact ID of the document
1473
+ # The unique identifier of the artifact associated with the document.
1440
1474
  # @return [String]
1441
1475
  #
1442
1476
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/DocumentInfo AWS API Documentation
@@ -1448,10 +1482,10 @@ module Aws::SecurityAgent
1448
1482
  include Aws::Structure
1449
1483
  end
1450
1484
 
1451
- # Represents a web application endpoint to be tested
1485
+ # Represents a target endpoint for penetration testing.
1452
1486
  #
1453
1487
  # @!attribute [rw] uri
1454
- # URI of the endpoint to test
1488
+ # The URI of the endpoint.
1455
1489
  # @return [String]
1456
1490
  #
1457
1491
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Endpoint AWS API Documentation
@@ -1462,14 +1496,16 @@ module Aws::SecurityAgent
1462
1496
  include Aws::Structure
1463
1497
  end
1464
1498
 
1465
- # Error information regarding the pentest job
1499
+ # Contains error information for a pentest job that encountered an
1500
+ # error.
1466
1501
  #
1467
1502
  # @!attribute [rw] code
1468
- # Pentest job failure error code
1503
+ # The error code. Valid values include CLIENT\_ERROR, INTERNAL\_ERROR,
1504
+ # and STOPPED\_BY\_USER.
1469
1505
  # @return [String]
1470
1506
  #
1471
1507
  # @!attribute [rw] message
1472
- # Pentest job failure error message
1508
+ # A message describing the error.
1473
1509
  # @return [String]
1474
1510
  #
1475
1511
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ErrorInformation AWS API Documentation
@@ -1481,18 +1517,20 @@ module Aws::SecurityAgent
1481
1517
  include Aws::Structure
1482
1518
  end
1483
1519
 
1484
- # Additional context about a pentest or task execution
1520
+ # Contains contextual information about the execution of a pentest job,
1521
+ # such as errors, warnings, or informational messages.
1485
1522
  #
1486
1523
  # @!attribute [rw] context_type
1487
- # The category of context
1524
+ # The type of context. Valid values include ERROR, CLIENT\_ERROR,
1525
+ # WARNING, and INFO.
1488
1526
  # @return [String]
1489
1527
  #
1490
1528
  # @!attribute [rw] context
1491
- # Context associated with a pentest or task execution
1529
+ # The context message.
1492
1530
  # @return [String]
1493
1531
  #
1494
1532
  # @!attribute [rw] timestamp
1495
- # Timestamp associated with a pentest or task execution
1533
+ # The date and time the context was recorded, in UTC format.
1496
1534
  # @return [Time]
1497
1535
  #
1498
1536
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ExecutionContext AWS API Documentation
@@ -1505,78 +1543,86 @@ module Aws::SecurityAgent
1505
1543
  include Aws::Structure
1506
1544
  end
1507
1545
 
1508
- # Represents a security vulnerability or issue discovered during testing
1546
+ # Represents a security finding discovered during a pentest job. A
1547
+ # finding contains details about a vulnerability, including its risk
1548
+ # level, confidence, and remediation status.
1509
1549
  #
1510
1550
  # @!attribute [rw] finding_id
1511
- # Unique identifier for the finding
1551
+ # The unique identifier of the finding.
1512
1552
  # @return [String]
1513
1553
  #
1514
1554
  # @!attribute [rw] agent_space_id
1515
- # Identifier of the agent space that created this finding
1555
+ # The unique identifier of the agent space associated with the
1556
+ # finding.
1516
1557
  # @return [String]
1517
1558
  #
1518
1559
  # @!attribute [rw] pentest_id
1519
- # Identifier of the parent pentest
1560
+ # The unique identifier of the pentest associated with the finding.
1520
1561
  # @return [String]
1521
1562
  #
1522
1563
  # @!attribute [rw] pentest_job_id
1523
- # Identifier of the pentest job
1564
+ # The unique identifier of the pentest job that produced the finding.
1524
1565
  # @return [String]
1525
1566
  #
1526
1567
  # @!attribute [rw] task_id
1527
- # Identifier of the associated task
1568
+ # The unique identifier of the task that produced the finding.
1528
1569
  # @return [String]
1529
1570
  #
1530
1571
  # @!attribute [rw] name
1531
- # Name or title of the finding
1572
+ # The name of the finding.
1532
1573
  # @return [String]
1533
1574
  #
1534
1575
  # @!attribute [rw] description
1535
- # Detailed description of the security vulnerability
1576
+ # A description of the finding.
1536
1577
  # @return [String]
1537
1578
  #
1538
1579
  # @!attribute [rw] status
1539
- # Current status of the finding
1580
+ # The current status of the finding. Valid values include ACTIVE,
1581
+ # RESOLVED, ACCEPTED, and FALSE\_POSITIVE.
1540
1582
  # @return [String]
1541
1583
  #
1542
1584
  # @!attribute [rw] risk_type
1543
- # Type of security risk identified
1585
+ # The type of security risk identified by the finding.
1544
1586
  # @return [String]
1545
1587
  #
1546
1588
  # @!attribute [rw] risk_level
1547
- # Severity level of the identified risk
1589
+ # The risk level of the finding. Valid values include UNKNOWN,
1590
+ # INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.
1548
1591
  # @return [String]
1549
1592
  #
1550
1593
  # @!attribute [rw] risk_score
1551
- # Risk score associated with the finding
1594
+ # The numerical risk score of the finding.
1552
1595
  # @return [String]
1553
1596
  #
1554
1597
  # @!attribute [rw] reasoning
1555
- # Justification for the assigned risk score
1598
+ # The reasoning behind the finding, explaining why it was identified
1599
+ # as a vulnerability.
1556
1600
  # @return [String]
1557
1601
  #
1558
1602
  # @!attribute [rw] confidence
1559
- # Confidence level of the finding
1603
+ # The confidence level of the finding. Valid values include
1604
+ # FALSE\_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.
1560
1605
  # @return [String]
1561
1606
  #
1562
1607
  # @!attribute [rw] attack_script
1563
- # Proof-of-concept code demonstrating the vulnerability
1608
+ # The attack script used to reproduce the finding.
1564
1609
  # @return [String]
1565
1610
  #
1566
1611
  # @!attribute [rw] code_remediation_task
1567
- # Code remediation task associated with this finding
1612
+ # The code remediation task associated with the finding, if code
1613
+ # remediation was initiated.
1568
1614
  # @return [Types::CodeRemediationTask]
1569
1615
  #
1570
1616
  # @!attribute [rw] last_updated_by
1571
- # Identifier of the task or agent that last updated this finding
1617
+ # The identifier of the entity that last updated the finding.
1572
1618
  # @return [String]
1573
1619
  #
1574
1620
  # @!attribute [rw] created_at
1575
- # Timestamp when the finding was created
1621
+ # The date and time the finding was created, in UTC format.
1576
1622
  # @return [Time]
1577
1623
  #
1578
1624
  # @!attribute [rw] updated_at
1579
- # Timestamp when the finding was last updated
1625
+ # The date and time the finding was last updated, in UTC format.
1580
1626
  # @return [Time]
1581
1627
  #
1582
1628
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Finding AWS API Documentation
@@ -1604,50 +1650,51 @@ module Aws::SecurityAgent
1604
1650
  include Aws::Structure
1605
1651
  end
1606
1652
 
1607
- # Summary information for a security finding
1653
+ # Contains summary information about a security finding.
1608
1654
  #
1609
1655
  # @!attribute [rw] finding_id
1610
- # Unique identifier for the finding
1656
+ # The unique identifier of the finding.
1611
1657
  # @return [String]
1612
1658
  #
1613
1659
  # @!attribute [rw] agent_space_id
1614
- # Identifier of the agent space that created this finding
1660
+ # The unique identifier of the agent space associated with the
1661
+ # finding.
1615
1662
  # @return [String]
1616
1663
  #
1617
1664
  # @!attribute [rw] pentest_id
1618
- # Identifier of the parent pentest
1665
+ # The unique identifier of the pentest associated with the finding.
1619
1666
  # @return [String]
1620
1667
  #
1621
1668
  # @!attribute [rw] pentest_job_id
1622
- # Identifier of the pentest job
1669
+ # The unique identifier of the pentest job that produced the finding.
1623
1670
  # @return [String]
1624
1671
  #
1625
1672
  # @!attribute [rw] name
1626
- # Name or title of the finding
1673
+ # The name of the finding.
1627
1674
  # @return [String]
1628
1675
  #
1629
1676
  # @!attribute [rw] status
1630
- # Current status of the finding
1677
+ # The current status of the finding.
1631
1678
  # @return [String]
1632
1679
  #
1633
1680
  # @!attribute [rw] risk_type
1634
- # Type of security risk identified
1681
+ # The type of security risk identified by the finding.
1635
1682
  # @return [String]
1636
1683
  #
1637
1684
  # @!attribute [rw] risk_level
1638
- # Severity level of the identified risk
1685
+ # The risk level of the finding.
1639
1686
  # @return [String]
1640
1687
  #
1641
1688
  # @!attribute [rw] confidence
1642
- # Confidence level of the finding
1689
+ # The confidence level of the finding.
1643
1690
  # @return [String]
1644
1691
  #
1645
1692
  # @!attribute [rw] created_at
1646
- # Timestamp when the finding was created
1693
+ # The date and time the finding was created, in UTC format.
1647
1694
  # @return [Time]
1648
1695
  #
1649
1696
  # @!attribute [rw] updated_at
1650
- # Timestamp when the finding was last updated
1697
+ # The date and time the finding was last updated, in UTC format.
1651
1698
  # @return [Time]
1652
1699
  #
1653
1700
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/FindingSummary AWS API Documentation
@@ -1669,7 +1716,7 @@ module Aws::SecurityAgent
1669
1716
  end
1670
1717
 
1671
1718
  # @!attribute [rw] application_id
1672
- # Application ID
1719
+ # The unique identifier of the application to retrieve.
1673
1720
  # @return [String]
1674
1721
  #
1675
1722
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GetApplicationRequest AWS API Documentation
@@ -1681,28 +1728,29 @@ module Aws::SecurityAgent
1681
1728
  end
1682
1729
 
1683
1730
  # @!attribute [rw] application_id
1684
- # Application ID
1731
+ # The unique identifier of the application.
1685
1732
  # @return [String]
1686
1733
  #
1687
1734
  # @!attribute [rw] domain
1688
- # Domain where the application is available
1735
+ # The domain associated with the application.
1689
1736
  # @return [String]
1690
1737
  #
1691
1738
  # @!attribute [rw] application_name
1692
- # Name of the application, automatically assigned by the service
1739
+ # The name of the application.
1693
1740
  # @return [String]
1694
1741
  #
1695
1742
  # @!attribute [rw] idc_configuration
1696
- # IAM Identity Center configuration for the application
1743
+ # The IAM Identity Center configuration for the application.
1697
1744
  # @return [Types::IdCConfiguration]
1698
1745
  #
1699
1746
  # @!attribute [rw] role_arn
1700
- # ARN of the IAM role that the application uses to access AWS
1701
- # resources on your behalf
1747
+ # The Amazon Resource Name (ARN) of the IAM role associated with the
1748
+ # application.
1702
1749
  # @return [String]
1703
1750
  #
1704
1751
  # @!attribute [rw] default_kms_key_id
1705
- # Default KMS key identifier used to encrypt application data
1752
+ # The identifier of the default AWS KMS key used to encrypt data for
1753
+ # the application.
1706
1754
  # @return [String]
1707
1755
  #
1708
1756
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GetApplicationResponse AWS API Documentation
@@ -1719,11 +1767,11 @@ module Aws::SecurityAgent
1719
1767
  end
1720
1768
 
1721
1769
  # @!attribute [rw] agent_space_id
1722
- # Unique identifier of the agent space
1770
+ # The unique identifier of the agent space that contains the artifact.
1723
1771
  # @return [String]
1724
1772
  #
1725
1773
  # @!attribute [rw] artifact_id
1726
- # Unique identifier of the artifact
1774
+ # The unique identifier of the artifact to retrieve.
1727
1775
  # @return [String]
1728
1776
  #
1729
1777
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GetArtifactInput AWS API Documentation
@@ -1736,23 +1784,23 @@ module Aws::SecurityAgent
1736
1784
  end
1737
1785
 
1738
1786
  # @!attribute [rw] agent_space_id
1739
- # Unique identifier of the agent space
1787
+ # The unique identifier of the agent space that contains the artifact.
1740
1788
  # @return [String]
1741
1789
  #
1742
1790
  # @!attribute [rw] artifact_id
1743
- # Unique identifier of the artifact
1791
+ # The unique identifier of the artifact.
1744
1792
  # @return [String]
1745
1793
  #
1746
1794
  # @!attribute [rw] artifact
1747
- # Artifact details
1795
+ # The artifact content and type.
1748
1796
  # @return [Types::Artifact]
1749
1797
  #
1750
1798
  # @!attribute [rw] file_name
1751
- # Name of the artifact file
1799
+ # The file name of the artifact.
1752
1800
  # @return [String]
1753
1801
  #
1754
1802
  # @!attribute [rw] updated_at
1755
- # Timestamp when the artifact was last updated
1803
+ # The date and time the artifact was last updated, in UTC format.
1756
1804
  # @return [Time]
1757
1805
  #
1758
1806
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GetArtifactOutput AWS API Documentation
@@ -1768,7 +1816,7 @@ module Aws::SecurityAgent
1768
1816
  end
1769
1817
 
1770
1818
  # @!attribute [rw] integration_id
1771
- # Unique identifier of the integration
1819
+ # The unique identifier of the integration to retrieve.
1772
1820
  # @return [String]
1773
1821
  #
1774
1822
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GetIntegrationInput AWS API Documentation
@@ -1780,27 +1828,28 @@ module Aws::SecurityAgent
1780
1828
  end
1781
1829
 
1782
1830
  # @!attribute [rw] integration_id
1783
- # Unique identifier of the integration
1831
+ # The unique identifier of the integration.
1784
1832
  # @return [String]
1785
1833
  #
1786
1834
  # @!attribute [rw] installation_id
1787
- # Installation identifier from the provider
1835
+ # The installation identifier from the integration provider.
1788
1836
  # @return [String]
1789
1837
  #
1790
1838
  # @!attribute [rw] provider
1791
- # Provider type
1839
+ # The integration provider.
1792
1840
  # @return [String]
1793
1841
  #
1794
1842
  # @!attribute [rw] provider_type
1795
- # Type of provider integration
1843
+ # The type of the integration provider.
1796
1844
  # @return [String]
1797
1845
  #
1798
1846
  # @!attribute [rw] display_name
1799
- # Display name for the integration
1847
+ # The display name of the integration.
1800
1848
  # @return [String]
1801
1849
  #
1802
1850
  # @!attribute [rw] kms_key_id
1803
- # KMS key ID for encrypting integration details
1851
+ # The identifier of the AWS KMS key used to encrypt data associated
1852
+ # with the integration.
1804
1853
  # @return [String]
1805
1854
  #
1806
1855
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GetIntegrationOutput AWS API Documentation
@@ -1816,18 +1865,19 @@ module Aws::SecurityAgent
1816
1865
  include Aws::Structure
1817
1866
  end
1818
1867
 
1819
- # Input parameters for GitHub integration
1868
+ # The input required to create a GitHub integration, including the OAuth
1869
+ # authorization code and CSRF state.
1820
1870
  #
1821
1871
  # @!attribute [rw] code
1822
- # Authorization code from OAuth flow
1872
+ # The OAuth authorization code received from GitHub.
1823
1873
  # @return [String]
1824
1874
  #
1825
1875
  # @!attribute [rw] state
1826
- # CSRF state token for OAuth security
1876
+ # The CSRF state token for validating the OAuth flow.
1827
1877
  # @return [String]
1828
1878
  #
1829
1879
  # @!attribute [rw] organization_name
1830
- # Name of the GitHub organization
1880
+ # The name of the GitHub organization to integrate with.
1831
1881
  # @return [String]
1832
1882
  #
1833
1883
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GitHubIntegrationInput AWS API Documentation
@@ -1840,22 +1890,24 @@ module Aws::SecurityAgent
1840
1890
  include Aws::Structure
1841
1891
  end
1842
1892
 
1843
- # Metadata specific to a GitHub repository integrated resource
1893
+ # Contains metadata about a GitHub repository that is integrated with
1894
+ # the service.
1844
1895
  #
1845
1896
  # @!attribute [rw] name
1846
- # Name of the resource e.g. repository name, etc
1897
+ # The name of the GitHub repository.
1847
1898
  # @return [String]
1848
1899
  #
1849
1900
  # @!attribute [rw] provider_resource_id
1850
- # Unique resource identifier from the vendor
1901
+ # The provider-specific resource identifier for the GitHub repository.
1851
1902
  # @return [String]
1852
1903
  #
1853
1904
  # @!attribute [rw] owner
1854
- # Owner of the repository
1905
+ # The owner of the GitHub repository.
1855
1906
  # @return [String]
1856
1907
  #
1857
1908
  # @!attribute [rw] access_type
1858
- # Access / Visibility Type of the integrated resource
1909
+ # The access type of the GitHub repository. Valid values are PRIVATE
1910
+ # and PUBLIC.
1859
1911
  # @return [String]
1860
1912
  #
1861
1913
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GitHubRepositoryMetadata AWS API Documentation
@@ -1869,14 +1921,14 @@ module Aws::SecurityAgent
1869
1921
  include Aws::Structure
1870
1922
  end
1871
1923
 
1872
- # GitHub repository resource details
1924
+ # Represents a GitHub repository resource used in an integration.
1873
1925
  #
1874
1926
  # @!attribute [rw] name
1875
- # Name of the resource e.g. repository name, etc
1927
+ # The name of the GitHub repository.
1876
1928
  # @return [String]
1877
1929
  #
1878
1930
  # @!attribute [rw] owner
1879
- # Owner of the repository
1931
+ # The owner of the GitHub repository.
1880
1932
  # @return [String]
1881
1933
  #
1882
1934
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GitHubRepositoryResource AWS API Documentation
@@ -1888,14 +1940,16 @@ module Aws::SecurityAgent
1888
1940
  include Aws::Structure
1889
1941
  end
1890
1942
 
1891
- # Capabilities for GitHub repositories
1943
+ # The capabilities enabled for a GitHub resource integration.
1892
1944
  #
1893
1945
  # @!attribute [rw] leave_comments
1894
- # Post code review comments on pull requests
1946
+ # Indicates whether the integration can leave comments on pull
1947
+ # requests.
1895
1948
  # @return [Boolean]
1896
1949
  #
1897
1950
  # @!attribute [rw] remediate_code
1898
- # Create pull requests with automated fixes
1951
+ # Indicates whether the integration can create code remediation pull
1952
+ # requests.
1899
1953
  # @return [Boolean]
1900
1954
  #
1901
1955
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/GitHubResourceCapabilities AWS API Documentation
@@ -1907,14 +1961,16 @@ module Aws::SecurityAgent
1907
1961
  include Aws::Structure
1908
1962
  end
1909
1963
 
1910
- # Represents http route verification details
1964
+ # Contains HTTP route verification details for a target domain,
1965
+ # including the route path and token to serve for domain ownership
1966
+ # verification.
1911
1967
  #
1912
1968
  # @!attribute [rw] token
1913
- # Token used to verify domain ownership
1969
+ # The verification token to serve at the specified route path.
1914
1970
  # @return [String]
1915
1971
  #
1916
1972
  # @!attribute [rw] route_path
1917
- # Route path where verification token should be placed
1973
+ # The HTTP route path where the verification token must be served.
1918
1974
  # @return [String]
1919
1975
  #
1920
1976
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/HttpVerification AWS API Documentation
@@ -1926,15 +1982,15 @@ module Aws::SecurityAgent
1926
1982
  include Aws::Structure
1927
1983
  end
1928
1984
 
1929
- # IdC configuration containing application and instance ARNs
1985
+ # The IAM Identity Center configuration for an application.
1930
1986
  #
1931
1987
  # @!attribute [rw] idc_application_arn
1932
- # ARN of the IAM Identity Center application associated with this
1933
- # application
1988
+ # The Amazon Resource Name (ARN) of the IAM Identity Center
1989
+ # application.
1934
1990
  # @return [String]
1935
1991
  #
1936
1992
  # @!attribute [rw] idc_instance_arn
1937
- # ARN of the IAM Identity Center instance used for user authentication
1993
+ # The Amazon Resource Name (ARN) of the IAM Identity Center instance.
1938
1994
  # @return [String]
1939
1995
  #
1940
1996
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IdCConfiguration AWS API Documentation
@@ -1947,7 +2003,8 @@ module Aws::SecurityAgent
1947
2003
  end
1948
2004
 
1949
2005
  # @!attribute [rw] provider
1950
- # Provider to register with
2006
+ # The provider to initiate registration with. Currently, only GITHUB
2007
+ # is supported.
1951
2008
  # @return [String]
1952
2009
  #
1953
2010
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/InitiateProviderRegistrationInput AWS API Documentation
@@ -1959,11 +2016,12 @@ module Aws::SecurityAgent
1959
2016
  end
1960
2017
 
1961
2018
  # @!attribute [rw] redirect_to
1962
- # OAuth redirect URL
2019
+ # The URL to redirect the user to for completing the OAuth
2020
+ # authorization.
1963
2021
  # @return [String]
1964
2022
  #
1965
2023
  # @!attribute [rw] csrf_state
1966
- # CSRF state token for OAuth security
2024
+ # The CSRF state token to use when completing the OAuth flow.
1967
2025
  # @return [String]
1968
2026
  #
1969
2027
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/InitiateProviderRegistrationOutput AWS API Documentation
@@ -1975,15 +2033,16 @@ module Aws::SecurityAgent
1975
2033
  include Aws::Structure
1976
2034
  end
1977
2035
 
1978
- # Information about an integrated repository
2036
+ # Represents a code repository that is integrated with the service
2037
+ # through a third-party provider.
1979
2038
  #
1980
2039
  # @!attribute [rw] integration_id
1981
- # Integration identifier
2040
+ # The unique identifier of the integration that provides access to the
2041
+ # repository.
1982
2042
  # @return [String]
1983
2043
  #
1984
2044
  # @!attribute [rw] provider_resource_id
1985
- # External provider resource identifier, e.g., Github repository
1986
- # identifier
2045
+ # The provider-specific resource identifier for the repository.
1987
2046
  # @return [String]
1988
2047
  #
1989
2048
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IntegratedRepository AWS API Documentation
@@ -1995,12 +2054,13 @@ module Aws::SecurityAgent
1995
2054
  include Aws::Structure
1996
2055
  end
1997
2056
 
1998
- # Integrated resource details from a provider
2057
+ # Represents an integrated resource from a third-party provider. This is
2058
+ # a union type that contains provider-specific resource information.
1999
2059
  #
2000
2060
  # @note IntegratedResource is a union - when making an API calls you must set exactly one of the members.
2001
2061
  #
2002
2062
  # @!attribute [rw] github_repository
2003
- # GitHub repository resource
2063
+ # The GitHub repository resource information.
2004
2064
  # @return [Types::GitHubRepositoryResource]
2005
2065
  #
2006
2066
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IntegratedResource AWS API Documentation
@@ -2016,14 +2076,15 @@ module Aws::SecurityAgent
2016
2076
  class Unknown < IntegratedResource; end
2017
2077
  end
2018
2078
 
2019
- # Input item for updating an integrated resource
2079
+ # Represents an input item for updating integrated resources, including
2080
+ # the resource and its capabilities.
2020
2081
  #
2021
2082
  # @!attribute [rw] resource
2022
- # Configuration of the resource
2083
+ # The integrated resource to update.
2023
2084
  # @return [Types::IntegratedResource]
2024
2085
  #
2025
2086
  # @!attribute [rw] capabilities
2026
- # Provider-specific capabilities for the resource
2087
+ # The capabilities to enable for the integrated resource.
2027
2088
  # @return [Types::ProviderResourceCapabilities]
2028
2089
  #
2029
2090
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IntegratedResourceInputItem AWS API Documentation
@@ -2035,12 +2096,13 @@ module Aws::SecurityAgent
2035
2096
  include Aws::Structure
2036
2097
  end
2037
2098
 
2038
- # Metadata about an integrated resource
2099
+ # Contains metadata about an integrated resource. This is a union type
2100
+ # that contains provider-specific metadata.
2039
2101
  #
2040
2102
  # @note IntegratedResourceMetadata is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of IntegratedResourceMetadata corresponding to the set member.
2041
2103
  #
2042
2104
  # @!attribute [rw] github_repository
2043
- # Metadata for a GitHub repository resource
2105
+ # The GitHub repository metadata.
2044
2106
  # @return [Types::GitHubRepositoryMetadata]
2045
2107
  #
2046
2108
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IntegratedResourceMetadata AWS API Documentation
@@ -2056,18 +2118,19 @@ module Aws::SecurityAgent
2056
2118
  class Unknown < IntegratedResourceMetadata; end
2057
2119
  end
2058
2120
 
2059
- # Summary information about an integrated resource
2121
+ # Contains summary information about an integrated resource.
2060
2122
  #
2061
2123
  # @!attribute [rw] integration_id
2062
- # Unique identifier of the integration
2124
+ # The unique identifier of the integration that provides access to the
2125
+ # resource.
2063
2126
  # @return [String]
2064
2127
  #
2065
2128
  # @!attribute [rw] resource
2066
- # The integrated resource details
2129
+ # The metadata for the integrated resource.
2067
2130
  # @return [Types::IntegratedResourceMetadata]
2068
2131
  #
2069
2132
  # @!attribute [rw] capabilities
2070
- # Capabilities of the integrated resource
2133
+ # The capabilities enabled for the integrated resource.
2071
2134
  # @return [Types::ProviderResourceCapabilities]
2072
2135
  #
2073
2136
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IntegratedResourceSummary AWS API Documentation
@@ -2080,16 +2143,17 @@ module Aws::SecurityAgent
2080
2143
  include Aws::Structure
2081
2144
  end
2082
2145
 
2083
- # Filter criteria for integrations
2146
+ # A filter for listing integrations. This is a union type where you can
2147
+ # filter by provider or provider type.
2084
2148
  #
2085
2149
  # @note IntegrationFilter is a union - when making an API calls you must set exactly one of the members.
2086
2150
  #
2087
2151
  # @!attribute [rw] provider
2088
- # Filter by provider
2152
+ # Filter integrations by provider.
2089
2153
  # @return [String]
2090
2154
  #
2091
2155
  # @!attribute [rw] provider_type
2092
- # Filter by provider type
2156
+ # Filter integrations by provider type.
2093
2157
  # @return [String]
2094
2158
  #
2095
2159
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IntegrationFilter AWS API Documentation
@@ -2107,26 +2171,26 @@ module Aws::SecurityAgent
2107
2171
  class Unknown < IntegrationFilter; end
2108
2172
  end
2109
2173
 
2110
- # Summary information about an integration
2174
+ # Contains summary information about an integration.
2111
2175
  #
2112
2176
  # @!attribute [rw] integration_id
2113
- # Unique identifier of the integration
2177
+ # The unique identifier of the integration.
2114
2178
  # @return [String]
2115
2179
  #
2116
2180
  # @!attribute [rw] installation_id
2117
- # Installation identifier from the provider
2181
+ # The installation identifier from the integration provider.
2118
2182
  # @return [String]
2119
2183
  #
2120
2184
  # @!attribute [rw] provider
2121
- # Provider type
2185
+ # The integration provider.
2122
2186
  # @return [String]
2123
2187
  #
2124
2188
  # @!attribute [rw] provider_type
2125
- # Type of provider integration
2189
+ # The type of the integration provider.
2126
2190
  # @return [String]
2127
2191
  #
2128
2192
  # @!attribute [rw] display_name
2129
- # Display name for the integration
2193
+ # The display name of the integration.
2130
2194
  # @return [String]
2131
2195
  #
2132
2196
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/IntegrationSummary AWS API Documentation
@@ -2141,10 +2205,10 @@ module Aws::SecurityAgent
2141
2205
  include Aws::Structure
2142
2206
  end
2143
2207
 
2144
- # Unexpected server error occurred
2208
+ # An unexpected error occurred during the processing of your request.
2145
2209
  #
2146
2210
  # @!attribute [rw] message
2147
- # Error description
2211
+ # Error description.
2148
2212
  # @return [String]
2149
2213
  #
2150
2214
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/InternalServerException AWS API Documentation
@@ -2155,14 +2219,17 @@ module Aws::SecurityAgent
2155
2219
  include Aws::Structure
2156
2220
  end
2157
2221
 
2158
- # Input for listing agent spaces
2222
+ # Input for listing agent spaces.
2159
2223
  #
2160
2224
  # @!attribute [rw] next_token
2161
- # Token for pagination
2225
+ # A token to use for paginating results that are returned in the
2226
+ # response. Set the value of this parameter to null for the first
2227
+ # request. For subsequent calls, use the nextToken value returned from
2228
+ # the previous request.
2162
2229
  # @return [String]
2163
2230
  #
2164
2231
  # @!attribute [rw] max_results
2165
- # Maximum number of agent spaces to return
2232
+ # The maximum number of results to return in a single call.
2166
2233
  # @return [Integer]
2167
2234
  #
2168
2235
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListAgentSpacesInput AWS API Documentation
@@ -2174,14 +2241,17 @@ module Aws::SecurityAgent
2174
2241
  include Aws::Structure
2175
2242
  end
2176
2243
 
2177
- # Output for the ListAgentSpaces operation
2244
+ # Output for the ListAgentSpaces operation.
2178
2245
  #
2179
2246
  # @!attribute [rw] agent_space_summaries
2180
- # List of agent space summaries
2247
+ # The list of agent space summaries.
2181
2248
  # @return [Array<Types::AgentSpaceSummary>]
2182
2249
  #
2183
2250
  # @!attribute [rw] next_token
2184
- # Token for next page of results
2251
+ # A token to use for paginating results that are returned in the
2252
+ # response. Set the value of this parameter to null for the first
2253
+ # request. For subsequent calls, use the nextToken value returned from
2254
+ # the previous request.
2185
2255
  # @return [String]
2186
2256
  #
2187
2257
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListAgentSpacesOutput AWS API Documentation
@@ -2194,11 +2264,14 @@ module Aws::SecurityAgent
2194
2264
  end
2195
2265
 
2196
2266
  # @!attribute [rw] next_token
2197
- # Token for pagination
2267
+ # A token to use for paginating results that are returned in the
2268
+ # response. Set the value of this parameter to null for the first
2269
+ # request. For subsequent calls, use the nextToken value returned from
2270
+ # the previous request.
2198
2271
  # @return [String]
2199
2272
  #
2200
2273
  # @!attribute [rw] max_results
2201
- # Maximum number of results to return
2274
+ # The maximum number of results to return in a single call.
2202
2275
  # @return [Integer]
2203
2276
  #
2204
2277
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListApplicationsRequest AWS API Documentation
@@ -2211,11 +2284,14 @@ module Aws::SecurityAgent
2211
2284
  end
2212
2285
 
2213
2286
  # @!attribute [rw] application_summaries
2214
- # List of application summaries
2287
+ # The list of application summaries.
2215
2288
  # @return [Array<Types::ApplicationSummary>]
2216
2289
  #
2217
2290
  # @!attribute [rw] next_token
2218
- # Token for next page of results
2291
+ # A token to use for paginating results that are returned in the
2292
+ # response. Set the value of this parameter to null for the first
2293
+ # request. For subsequent calls, use the nextToken value returned from
2294
+ # the previous request.
2219
2295
  # @return [String]
2220
2296
  #
2221
2297
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListApplicationsResponse AWS API Documentation
@@ -2228,15 +2304,18 @@ module Aws::SecurityAgent
2228
2304
  end
2229
2305
 
2230
2306
  # @!attribute [rw] agent_space_id
2231
- # Unique identifier of the agent space
2307
+ # The unique identifier of the agent space to list artifacts for.
2232
2308
  # @return [String]
2233
2309
  #
2234
2310
  # @!attribute [rw] next_token
2235
- # Token for pagination
2311
+ # A token to use for paginating results that are returned in the
2312
+ # response. Set the value of this parameter to null for the first
2313
+ # request. For subsequent calls, use the nextToken value returned from
2314
+ # the previous request.
2236
2315
  # @return [String]
2237
2316
  #
2238
2317
  # @!attribute [rw] max_results
2239
- # Maximum number of results to return
2318
+ # The maximum number of results to return in a single call.
2240
2319
  # @return [Integer]
2241
2320
  #
2242
2321
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListArtifactsInput AWS API Documentation
@@ -2250,11 +2329,14 @@ module Aws::SecurityAgent
2250
2329
  end
2251
2330
 
2252
2331
  # @!attribute [rw] artifact_summaries
2253
- # List of artifact summaries
2332
+ # The list of artifact summaries.
2254
2333
  # @return [Array<Types::ArtifactSummary>]
2255
2334
  #
2256
2335
  # @!attribute [rw] next_token
2257
- # Token for pagination to retrieve the next set of results
2336
+ # A token to use for paginating results that are returned in the
2337
+ # response. Set the value of this parameter to null for the first
2338
+ # request. For subsequent calls, use the nextToken value returned from
2339
+ # the previous request.
2258
2340
  # @return [String]
2259
2341
  #
2260
2342
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListArtifactsOutput AWS API Documentation
@@ -2266,28 +2348,30 @@ module Aws::SecurityAgent
2266
2348
  include Aws::Structure
2267
2349
  end
2268
2350
 
2269
- # Input for ListDiscoveredEndpoints operation
2351
+ # Input for ListDiscoveredEndpoints operation.
2270
2352
  #
2271
2353
  # @!attribute [rw] max_results
2272
- # Maximum number of discovered endpoints to return in a single request
2273
- # (default: 50)
2354
+ # The maximum number of results to return in a single call.
2274
2355
  # @return [Integer]
2275
2356
  #
2276
2357
  # @!attribute [rw] pentest_job_id
2277
- # Identifier of the pentest job for which to retrieve discovered
2278
- # endpoints
2358
+ # The unique identifier of the pentest job to list discovered
2359
+ # endpoints for.
2279
2360
  # @return [String]
2280
2361
  #
2281
2362
  # @!attribute [rw] agent_space_id
2282
- # ID of the agent space where the pentest job exists
2363
+ # The unique identifier of the agent space.
2283
2364
  # @return [String]
2284
2365
  #
2285
2366
  # @!attribute [rw] prefix
2286
- # Optional URI prefix filter to narrow down results
2367
+ # A prefix to filter discovered endpoints by URI.
2287
2368
  # @return [String]
2288
2369
  #
2289
2370
  # @!attribute [rw] next_token
2290
- # Token for pagination
2371
+ # A token to use for paginating results that are returned in the
2372
+ # response. Set the value of this parameter to null for the first
2373
+ # request. For subsequent calls, use the nextToken value returned from
2374
+ # the previous request.
2291
2375
  # @return [String]
2292
2376
  #
2293
2377
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListDiscoveredEndpointsInput AWS API Documentation
@@ -2302,14 +2386,17 @@ module Aws::SecurityAgent
2302
2386
  include Aws::Structure
2303
2387
  end
2304
2388
 
2305
- # Output for the ListDiscoveredEndpoints operation
2389
+ # Output for the ListDiscoveredEndpoints operation.
2306
2390
  #
2307
2391
  # @!attribute [rw] discovered_endpoints
2308
- # List of discovered endpoints for the pentest job
2392
+ # The list of discovered endpoints.
2309
2393
  # @return [Array<Types::DiscoveredEndpoint>]
2310
2394
  #
2311
2395
  # @!attribute [rw] next_token
2312
- # Token for pagination to retrieve the next set of results
2396
+ # A token to use for paginating results that are returned in the
2397
+ # response. Set the value of this parameter to null for the first
2398
+ # request. For subsequent calls, use the nextToken value returned from
2399
+ # the previous request.
2313
2400
  # @return [String]
2314
2401
  #
2315
2402
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListDiscoveredEndpointsOutput AWS API Documentation
@@ -2321,44 +2408,45 @@ module Aws::SecurityAgent
2321
2408
  include Aws::Structure
2322
2409
  end
2323
2410
 
2324
- # Input for ListFindings operation with filtering support
2411
+ # Input for ListFindings operation with filtering support.
2325
2412
  #
2326
2413
  # @!attribute [rw] max_results
2327
- # Maximum number of findings to return in a single request (default:
2328
- # 50)
2414
+ # The maximum number of results to return in a single call.
2329
2415
  # @return [Integer]
2330
2416
  #
2331
2417
  # @!attribute [rw] pentest_job_id
2332
- # Identifier of the pentest job for which to retrieve associated
2333
- # findings
2418
+ # The unique identifier of the pentest job to list findings for.
2334
2419
  # @return [String]
2335
2420
  #
2336
2421
  # @!attribute [rw] agent_space_id
2337
- # ID of the agent space where the pentest job exists
2422
+ # The unique identifier of the agent space.
2338
2423
  # @return [String]
2339
2424
  #
2340
2425
  # @!attribute [rw] next_token
2341
- # Token for pagination
2426
+ # A token to use for paginating results that are returned in the
2427
+ # response. Set the value of this parameter to null for the first
2428
+ # request. For subsequent calls, use the nextToken value returned from
2429
+ # the previous request.
2342
2430
  # @return [String]
2343
2431
  #
2344
2432
  # @!attribute [rw] risk_type
2345
- # Filter findings by risk type
2433
+ # Filter findings by risk type.
2346
2434
  # @return [String]
2347
2435
  #
2348
2436
  # @!attribute [rw] risk_level
2349
- # Filter findings by risk level
2437
+ # Filter findings by risk level.
2350
2438
  # @return [String]
2351
2439
  #
2352
2440
  # @!attribute [rw] status
2353
- # Filter findings by status
2441
+ # Filter findings by status.
2354
2442
  # @return [String]
2355
2443
  #
2356
2444
  # @!attribute [rw] confidence
2357
- # Filter findings by confidence level
2445
+ # Filter findings by confidence level.
2358
2446
  # @return [String]
2359
2447
  #
2360
2448
  # @!attribute [rw] name
2361
- # Filter findings by name (case-insensitive substring search)
2449
+ # Filter findings by name.
2362
2450
  # @return [String]
2363
2451
  #
2364
2452
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListFindingsInput AWS API Documentation
@@ -2377,14 +2465,17 @@ module Aws::SecurityAgent
2377
2465
  include Aws::Structure
2378
2466
  end
2379
2467
 
2380
- # Output for the ListFindings operation
2468
+ # Output for the ListFindings operation.
2381
2469
  #
2382
2470
  # @!attribute [rw] findings_summaries
2383
- # List of finding summaries matching the filter criteria
2471
+ # The list of finding summaries.
2384
2472
  # @return [Array<Types::FindingSummary>]
2385
2473
  #
2386
2474
  # @!attribute [rw] next_token
2387
- # Token for pagination to retrieve the next set of results
2475
+ # A token to use for paginating results that are returned in the
2476
+ # response. Set the value of this parameter to null for the first
2477
+ # request. For subsequent calls, use the nextToken value returned from
2478
+ # the previous request.
2388
2479
  # @return [String]
2389
2480
  #
2390
2481
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListFindingsOutput AWS API Documentation
@@ -2397,23 +2488,27 @@ module Aws::SecurityAgent
2397
2488
  end
2398
2489
 
2399
2490
  # @!attribute [rw] agent_space_id
2400
- # Unique identifier of the agent space
2491
+ # The unique identifier of the agent space to list integrated
2492
+ # resources for.
2401
2493
  # @return [String]
2402
2494
  #
2403
2495
  # @!attribute [rw] integration_id
2404
- # Filter integrated resources by a specific integration
2496
+ # The unique identifier of the integration to filter by.
2405
2497
  # @return [String]
2406
2498
  #
2407
2499
  # @!attribute [rw] resource_type
2408
- # Filter integrated resources by resource type
2500
+ # The type of resource to filter by.
2409
2501
  # @return [String]
2410
2502
  #
2411
2503
  # @!attribute [rw] next_token
2412
- # Token for pagination
2504
+ # A token to use for paginating results that are returned in the
2505
+ # response. Set the value of this parameter to null for the first
2506
+ # request. For subsequent calls, use the nextToken value returned from
2507
+ # the previous request.
2413
2508
  # @return [String]
2414
2509
  #
2415
2510
  # @!attribute [rw] max_results
2416
- # Maximum number of results to return
2511
+ # The maximum number of results to return in a single call.
2417
2512
  # @return [Integer]
2418
2513
  #
2419
2514
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListIntegratedResourcesInput AWS API Documentation
@@ -2429,11 +2524,14 @@ module Aws::SecurityAgent
2429
2524
  end
2430
2525
 
2431
2526
  # @!attribute [rw] integrated_resource_summaries
2432
- # List of integrated resources
2527
+ # The list of integrated resource summaries.
2433
2528
  # @return [Array<Types::IntegratedResourceSummary>]
2434
2529
  #
2435
2530
  # @!attribute [rw] next_token
2436
- # Token for pagination to retrieve the next set of results
2531
+ # A token to use for paginating results that are returned in the
2532
+ # response. Set the value of this parameter to null for the first
2533
+ # request. For subsequent calls, use the nextToken value returned from
2534
+ # the previous request.
2437
2535
  # @return [String]
2438
2536
  #
2439
2537
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListIntegratedResourcesOutput AWS API Documentation
@@ -2446,15 +2544,18 @@ module Aws::SecurityAgent
2446
2544
  end
2447
2545
 
2448
2546
  # @!attribute [rw] filter
2449
- # Filter criteria for integrations
2547
+ # A filter to apply to the list of integrations.
2450
2548
  # @return [Types::IntegrationFilter]
2451
2549
  #
2452
2550
  # @!attribute [rw] next_token
2453
- # Token for pagination
2551
+ # A token to use for paginating results that are returned in the
2552
+ # response. Set the value of this parameter to null for the first
2553
+ # request. For subsequent calls, use the nextToken value returned from
2554
+ # the previous request.
2454
2555
  # @return [String]
2455
2556
  #
2456
2557
  # @!attribute [rw] max_results
2457
- # Maximum number of results to return
2558
+ # The maximum number of results to return in a single call.
2458
2559
  # @return [Integer]
2459
2560
  #
2460
2561
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListIntegrationsInput AWS API Documentation
@@ -2468,11 +2569,14 @@ module Aws::SecurityAgent
2468
2569
  end
2469
2570
 
2470
2571
  # @!attribute [rw] integration_summaries
2471
- # List of integration summaries
2572
+ # The list of integration summaries.
2472
2573
  # @return [Array<Types::IntegrationSummary>]
2473
2574
  #
2474
2575
  # @!attribute [rw] next_token
2475
- # Token for pagination to retrieve the next set of results
2576
+ # A token to use for paginating results that are returned in the
2577
+ # response. Set the value of this parameter to null for the first
2578
+ # request. For subsequent calls, use the nextToken value returned from
2579
+ # the previous request.
2476
2580
  # @return [String]
2477
2581
  #
2478
2582
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListIntegrationsOutput AWS API Documentation
@@ -2484,26 +2588,30 @@ module Aws::SecurityAgent
2484
2588
  include Aws::Structure
2485
2589
  end
2486
2590
 
2487
- # Request structure for listing agent space members
2591
+ # Request structure for listing agent space members.
2488
2592
  #
2489
2593
  # @!attribute [rw] application_id
2490
- # Application identifier
2594
+ # The unique identifier of the application that contains the agent
2595
+ # space.
2491
2596
  # @return [String]
2492
2597
  #
2493
2598
  # @!attribute [rw] agent_space_id
2494
- # Agent space identifier
2599
+ # The unique identifier of the agent space to list memberships for.
2495
2600
  # @return [String]
2496
2601
  #
2497
2602
  # @!attribute [rw] member_type
2498
- # Filter by member type
2603
+ # Filter memberships by member type.
2499
2604
  # @return [String]
2500
2605
  #
2501
2606
  # @!attribute [rw] max_results
2502
- # Maximum number of results to return
2607
+ # The maximum number of results to return in a single call.
2503
2608
  # @return [Integer]
2504
2609
  #
2505
2610
  # @!attribute [rw] next_token
2506
- # Token for pagination
2611
+ # A token to use for paginating results that are returned in the
2612
+ # response. Set the value of this parameter to null for the first
2613
+ # request. For subsequent calls, use the nextToken value returned from
2614
+ # the previous request.
2507
2615
  # @return [String]
2508
2616
  #
2509
2617
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListMembershipsRequest AWS API Documentation
@@ -2518,14 +2626,17 @@ module Aws::SecurityAgent
2518
2626
  include Aws::Structure
2519
2627
  end
2520
2628
 
2521
- # Response structure for listing members associated to an agent space
2629
+ # Response structure for listing members associated to an agent space.
2522
2630
  #
2523
2631
  # @!attribute [rw] membership_summaries
2524
- # List of membership summaries
2632
+ # The list of membership summaries.
2525
2633
  # @return [Array<Types::MembershipSummary>]
2526
2634
  #
2527
2635
  # @!attribute [rw] next_token
2528
- # Token for next page of results
2636
+ # A token to use for paginating results that are returned in the
2637
+ # response. Set the value of this parameter to null for the first
2638
+ # request. For subsequent calls, use the nextToken value returned from
2639
+ # the previous request.
2529
2640
  # @return [String]
2530
2641
  #
2531
2642
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListMembershipsResponse AWS API Documentation
@@ -2537,22 +2648,23 @@ module Aws::SecurityAgent
2537
2648
  include Aws::Structure
2538
2649
  end
2539
2650
 
2540
- # Input for listing tasks associated with a specific pentest job
2651
+ # Input for listing tasks associated with a pentest job.
2541
2652
  #
2542
2653
  # @!attribute [rw] agent_space_id
2543
- # ID of the agent space where the pentest exists
2654
+ # The unique identifier of the agent space.
2544
2655
  # @return [String]
2545
2656
  #
2546
2657
  # @!attribute [rw] max_results
2547
- # Maximum number of tasks to return in a single request
2658
+ # The maximum number of results to return in a single call.
2548
2659
  # @return [Integer]
2549
2660
  #
2550
2661
  # @!attribute [rw] pentest_job_id
2551
- # Identifier of the pentest job whose tasks to list
2662
+ # The unique identifier of the pentest job to list tasks for.
2552
2663
  # @return [String]
2553
2664
  #
2554
2665
  # @!attribute [rw] step_name
2555
- # Filter tasks by step name
2666
+ # Filter tasks by step name. Valid values include PREFLIGHT,
2667
+ # STATIC\_ANALYSIS, PENTEST, and FINALIZING.
2556
2668
  # @return [String]
2557
2669
  #
2558
2670
  # @!attribute [rw] category_name
@@ -2560,7 +2672,10 @@ module Aws::SecurityAgent
2560
2672
  # @return [String]
2561
2673
  #
2562
2674
  # @!attribute [rw] next_token
2563
- # Token for pagination to retrieve the next set of results
2675
+ # A token to use for paginating results that are returned in the
2676
+ # response. Set the value of this parameter to null for the first
2677
+ # request. For subsequent calls, use the nextToken value returned from
2678
+ # the previous request.
2564
2679
  # @return [String]
2565
2680
  #
2566
2681
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListPentestJobTasksInput AWS API Documentation
@@ -2576,14 +2691,17 @@ module Aws::SecurityAgent
2576
2691
  include Aws::Structure
2577
2692
  end
2578
2693
 
2579
- # Output for the ListPentestJobTasks operation
2694
+ # Output for the ListPentestJobTasks operation.
2580
2695
  #
2581
2696
  # @!attribute [rw] task_summaries
2582
- # List of task summaries associated with the specified pentest job
2697
+ # The list of task summaries.
2583
2698
  # @return [Array<Types::TaskSummary>]
2584
2699
  #
2585
2700
  # @!attribute [rw] next_token
2586
- # Token for pagination to retrieve the next set of results
2701
+ # A token to use for paginating results that are returned in the
2702
+ # response. Set the value of this parameter to null for the first
2703
+ # request. For subsequent calls, use the nextToken value returned from
2704
+ # the previous request.
2587
2705
  # @return [String]
2588
2706
  #
2589
2707
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListPentestJobTasksOutput AWS API Documentation
@@ -2595,22 +2713,25 @@ module Aws::SecurityAgent
2595
2713
  include Aws::Structure
2596
2714
  end
2597
2715
 
2598
- # Input for ListPentestJobsForPentest operation
2716
+ # Input for ListPentestJobsForPentest operation.
2599
2717
  #
2600
2718
  # @!attribute [rw] max_results
2601
- # Maximum number of pentest jobs to return in a single request
2719
+ # The maximum number of results to return in a single call.
2602
2720
  # @return [Integer]
2603
2721
  #
2604
2722
  # @!attribute [rw] pentest_id
2605
- # Identifier of the pentest for which to retrieve associated jobs
2723
+ # The unique identifier of the pentest to list jobs for.
2606
2724
  # @return [String]
2607
2725
  #
2608
2726
  # @!attribute [rw] agent_space_id
2609
- # ID of the agent space where the pentest exists
2727
+ # The unique identifier of the agent space.
2610
2728
  # @return [String]
2611
2729
  #
2612
2730
  # @!attribute [rw] next_token
2613
- # Token for pagination
2731
+ # A token to use for paginating results that are returned in the
2732
+ # response. Set the value of this parameter to null for the first
2733
+ # request. For subsequent calls, use the nextToken value returned from
2734
+ # the previous request.
2614
2735
  # @return [String]
2615
2736
  #
2616
2737
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListPentestJobsForPentestInput AWS API Documentation
@@ -2624,14 +2745,17 @@ module Aws::SecurityAgent
2624
2745
  include Aws::Structure
2625
2746
  end
2626
2747
 
2627
- # Output for the ListPentestJobsForPentest operation
2748
+ # Output for the ListPentestJobsForPentest operation.
2628
2749
  #
2629
2750
  # @!attribute [rw] pentest_job_summaries
2630
- # List of pentest job summaries associated with the pentest
2751
+ # The list of pentest job summaries.
2631
2752
  # @return [Array<Types::PentestJobSummary>]
2632
2753
  #
2633
2754
  # @!attribute [rw] next_token
2634
- # Token for pagination to retrieve the next set of results
2755
+ # A token to use for paginating results that are returned in the
2756
+ # response. Set the value of this parameter to null for the first
2757
+ # request. For subsequent calls, use the nextToken value returned from
2758
+ # the previous request.
2635
2759
  # @return [String]
2636
2760
  #
2637
2761
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListPentestJobsForPentestOutput AWS API Documentation
@@ -2643,18 +2767,21 @@ module Aws::SecurityAgent
2643
2767
  include Aws::Structure
2644
2768
  end
2645
2769
 
2646
- # Input for listing pentests with optional filtering
2770
+ # Input for listing pentests with optional filtering.
2647
2771
  #
2648
2772
  # @!attribute [rw] max_results
2649
- # Maximum number of pentests to return in a single request
2773
+ # The maximum number of results to return in a single call.
2650
2774
  # @return [Integer]
2651
2775
  #
2652
2776
  # @!attribute [rw] next_token
2653
- # Token for pagination
2777
+ # A token to use for paginating results that are returned in the
2778
+ # response. Set the value of this parameter to null for the first
2779
+ # request. For subsequent calls, use the nextToken value returned from
2780
+ # the previous request.
2654
2781
  # @return [String]
2655
2782
  #
2656
2783
  # @!attribute [rw] agent_space_id
2657
- # ID of the agent space where the pentest exists
2784
+ # The unique identifier of the agent space to list pentests for.
2658
2785
  # @return [String]
2659
2786
  #
2660
2787
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListPentestsInput AWS API Documentation
@@ -2667,14 +2794,17 @@ module Aws::SecurityAgent
2667
2794
  include Aws::Structure
2668
2795
  end
2669
2796
 
2670
- # Output for the ListPentests operation
2797
+ # Output for the ListPentests operation.
2671
2798
  #
2672
2799
  # @!attribute [rw] pentest_summaries
2673
- # List of pentest summaries matching the filter criteria
2800
+ # The list of pentest summaries.
2674
2801
  # @return [Array<Types::PentestSummary>]
2675
2802
  #
2676
2803
  # @!attribute [rw] next_token
2677
- # Token for pagination to retrieve the next set of results
2804
+ # A token to use for paginating results that are returned in the
2805
+ # response. Set the value of this parameter to null for the first
2806
+ # request. For subsequent calls, use the nextToken value returned from
2807
+ # the previous request.
2678
2808
  # @return [String]
2679
2809
  #
2680
2810
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListPentestsOutput AWS API Documentation
@@ -2686,10 +2816,10 @@ module Aws::SecurityAgent
2686
2816
  include Aws::Structure
2687
2817
  end
2688
2818
 
2689
- # Input for ListTagsForResource operation
2819
+ # Input for ListTagsForResource operation.
2690
2820
  #
2691
2821
  # @!attribute [rw] resource_arn
2692
- # ARN of the resource to list tags for
2822
+ # The Amazon Resource Name (ARN) of the resource to list tags for.
2693
2823
  # @return [String]
2694
2824
  #
2695
2825
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListTagsForResourceInput AWS API Documentation
@@ -2700,10 +2830,10 @@ module Aws::SecurityAgent
2700
2830
  include Aws::Structure
2701
2831
  end
2702
2832
 
2703
- # Output for ListTagsForResource operation
2833
+ # Output for ListTagsForResource operation.
2704
2834
  #
2705
2835
  # @!attribute [rw] tags
2706
- # Tags associated with the resource
2836
+ # The tags associated with the resource.
2707
2837
  # @return [Hash<String,String>]
2708
2838
  #
2709
2839
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListTagsForResourceOutput AWS API Documentation
@@ -2714,14 +2844,17 @@ module Aws::SecurityAgent
2714
2844
  include Aws::Structure
2715
2845
  end
2716
2846
 
2717
- # Input for listing target domains
2847
+ # Input for listing target domains.
2718
2848
  #
2719
2849
  # @!attribute [rw] next_token
2720
- # Token for pagination
2850
+ # A token to use for paginating results that are returned in the
2851
+ # response. Set the value of this parameter to null for the first
2852
+ # request. For subsequent calls, use the nextToken value returned from
2853
+ # the previous request.
2721
2854
  # @return [String]
2722
2855
  #
2723
2856
  # @!attribute [rw] max_results
2724
- # Maximum number of target domains to return
2857
+ # The maximum number of results to return in a single call.
2725
2858
  # @return [Integer]
2726
2859
  #
2727
2860
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListTargetDomainsInput AWS API Documentation
@@ -2733,14 +2866,17 @@ module Aws::SecurityAgent
2733
2866
  include Aws::Structure
2734
2867
  end
2735
2868
 
2736
- # Output for the ListTargetDomains operation
2869
+ # Output for the ListTargetDomains operation.
2737
2870
  #
2738
2871
  # @!attribute [rw] target_domain_summaries
2739
- # List of target domain summaries
2872
+ # The list of target domain summaries.
2740
2873
  # @return [Array<Types::TargetDomainSummary>]
2741
2874
  #
2742
2875
  # @!attribute [rw] next_token
2743
- # Token for next page of results
2876
+ # A token to use for paginating results that are returned in the
2877
+ # response. Set the value of this parameter to null for the first
2878
+ # request. For subsequent calls, use the nextToken value returned from
2879
+ # the previous request.
2744
2880
  # @return [String]
2745
2881
  #
2746
2882
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ListTargetDomainsOutput AWS API Documentation
@@ -2752,14 +2888,15 @@ module Aws::SecurityAgent
2752
2888
  include Aws::Structure
2753
2889
  end
2754
2890
 
2755
- # Location information for execution logs
2891
+ # The log location for a task, specifying where task execution logs are
2892
+ # stored.
2756
2893
  #
2757
2894
  # @!attribute [rw] log_type
2758
- # Type of log storage
2895
+ # The type of log storage. Currently, only CLOUDWATCH is supported.
2759
2896
  # @return [String]
2760
2897
  #
2761
2898
  # @!attribute [rw] cloud_watch_log
2762
- # CloudWatch log information if logs are stored in CloudWatch
2899
+ # The CloudWatch Logs location for the task logs.
2763
2900
  # @return [Types::CloudWatchLog]
2764
2901
  #
2765
2902
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/LogLocation AWS API Documentation
@@ -2771,12 +2908,13 @@ module Aws::SecurityAgent
2771
2908
  include Aws::Structure
2772
2909
  end
2773
2910
 
2774
- # Metadata associated with the member
2911
+ # Contains metadata about a member. This is a union type that contains
2912
+ # member-type-specific metadata.
2775
2913
  #
2776
2914
  # @note MemberMetadata is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MemberMetadata corresponding to the set member.
2777
2915
  #
2778
2916
  # @!attribute [rw] user
2779
- # User metadata for USER members
2917
+ # The user metadata for the member.
2780
2918
  # @return [Types::UserMetadata]
2781
2919
  #
2782
2920
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/MemberMetadata AWS API Documentation
@@ -2792,14 +2930,15 @@ module Aws::SecurityAgent
2792
2930
  class Unknown < MemberMetadata; end
2793
2931
  end
2794
2932
 
2795
- # Member-specific configuration
2933
+ # The configuration for a membership. This is a union type that contains
2934
+ # member-type-specific configuration.
2796
2935
  #
2797
2936
  # @note MembershipConfig is a union - when making an API calls you must set exactly one of the members.
2798
2937
  #
2799
2938
  # @note MembershipConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MembershipConfig corresponding to the set member.
2800
2939
  #
2801
2940
  # @!attribute [rw] user
2802
- # Configuration for user members
2941
+ # The user configuration for the membership.
2803
2942
  # @return [Types::UserConfig]
2804
2943
  #
2805
2944
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/MembershipConfig AWS API Documentation
@@ -2815,46 +2954,46 @@ module Aws::SecurityAgent
2815
2954
  class Unknown < MembershipConfig; end
2816
2955
  end
2817
2956
 
2818
- # Membership summary for list operations
2957
+ # Contains summary information about a membership.
2819
2958
  #
2820
2959
  # @!attribute [rw] membership_id
2821
- # Member identifier (userId or agentSpaceId)
2960
+ # The unique identifier of the membership.
2822
2961
  # @return [String]
2823
2962
  #
2824
2963
  # @!attribute [rw] application_id
2825
- # Application identifier
2964
+ # The unique identifier of the application.
2826
2965
  # @return [String]
2827
2966
  #
2828
2967
  # @!attribute [rw] agent_space_id
2829
- # Agent space identifier
2968
+ # The unique identifier of the agent space.
2830
2969
  # @return [String]
2831
2970
  #
2832
2971
  # @!attribute [rw] member_type
2833
- # Type of member
2972
+ # The type of member.
2834
2973
  # @return [String]
2835
2974
  #
2836
2975
  # @!attribute [rw] config
2837
- # Configuration specific to the member type
2976
+ # The configuration for the membership.
2838
2977
  # @return [Types::MembershipConfig]
2839
2978
  #
2840
2979
  # @!attribute [rw] metadata
2841
- # Member-specific metadata
2980
+ # The metadata for the member.
2842
2981
  # @return [Types::MemberMetadata]
2843
2982
  #
2844
2983
  # @!attribute [rw] created_at
2845
- # Timestamp when the membership was created (ISO 8601)
2984
+ # The date and time the membership was created, in UTC format.
2846
2985
  # @return [Time]
2847
2986
  #
2848
2987
  # @!attribute [rw] updated_at
2849
- # Timestamp when the membership was last updated (ISO 8601)
2988
+ # The date and time the membership was last updated, in UTC format.
2850
2989
  # @return [Time]
2851
2990
  #
2852
2991
  # @!attribute [rw] created_by
2853
- # User ID who created the membership
2992
+ # The identifier of the entity that created the membership.
2854
2993
  # @return [String]
2855
2994
  #
2856
2995
  # @!attribute [rw] updated_by
2857
- # User ID who last updated the membership
2996
+ # The identifier of the entity that last updated the membership.
2858
2997
  # @return [String]
2859
2998
  #
2860
2999
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/MembershipSummary AWS API Documentation
@@ -2874,14 +3013,17 @@ module Aws::SecurityAgent
2874
3013
  include Aws::Structure
2875
3014
  end
2876
3015
 
2877
- # Configuration for network traffic filtering
3016
+ # The network traffic configuration for a pentest, including custom
3017
+ # headers and traffic rules.
2878
3018
  #
2879
3019
  # @!attribute [rw] rules
2880
- # Traffic filtering rules
3020
+ # The list of network traffic rules that control which URLs are
3021
+ # allowed or denied during testing.
2881
3022
  # @return [Array<Types::NetworkTrafficRule>]
2882
3023
  #
2883
3024
  # @!attribute [rw] custom_headers
2884
- # Custom headers for requests
3025
+ # The list of custom HTTP headers to include in network traffic during
3026
+ # testing.
2885
3027
  # @return [Array<Types::CustomHeader>]
2886
3028
  #
2887
3029
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/NetworkTrafficConfig AWS API Documentation
@@ -2893,18 +3035,20 @@ module Aws::SecurityAgent
2893
3035
  include Aws::Structure
2894
3036
  end
2895
3037
 
2896
- # Network traffic filtering rule
3038
+ # A rule that controls network traffic during penetration testing by
3039
+ # allowing or denying traffic to specific URL patterns.
2897
3040
  #
2898
3041
  # @!attribute [rw] effect
2899
- # Action to take when the rule matches
3042
+ # The effect of the rule. Valid values are ALLOW and DENY.
2900
3043
  # @return [String]
2901
3044
  #
2902
3045
  # @!attribute [rw] pattern
2903
- # Pattern to match against
3046
+ # The URL pattern to match for the rule.
2904
3047
  # @return [String]
2905
3048
  #
2906
3049
  # @!attribute [rw] network_traffic_rule_type
2907
- # Type of network traffic rule
3050
+ # The type of the network traffic rule. Currently, only URL is
3051
+ # supported.
2908
3052
  # @return [String]
2909
3053
  #
2910
3054
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/NetworkTrafficRule AWS API Documentation
@@ -2917,55 +3061,56 @@ module Aws::SecurityAgent
2917
3061
  include Aws::Structure
2918
3062
  end
2919
3063
 
2920
- # Represents a pentest configuration and execution details
3064
+ # Represents a pentest configuration that defines the parameters for
3065
+ # security testing, including target assets, risk type exclusions, and
3066
+ # infrastructure settings.
2921
3067
  #
2922
3068
  # @!attribute [rw] pentest_id
2923
- # Unique identifier for the pentest
3069
+ # The unique identifier of the pentest.
2924
3070
  # @return [String]
2925
3071
  #
2926
3072
  # @!attribute [rw] agent_space_id
2927
- # ID of the agent space where the pentest exists
3073
+ # The unique identifier of the agent space that contains the pentest.
2928
3074
  # @return [String]
2929
3075
  #
2930
3076
  # @!attribute [rw] title
2931
- # Title or name of the pentest
3077
+ # The title of the pentest.
2932
3078
  # @return [String]
2933
3079
  #
2934
3080
  # @!attribute [rw] assets
2935
- # Collection of assets to be tested or used during the pentest
3081
+ # The assets included in the pentest.
2936
3082
  # @return [Types::Assets]
2937
3083
  #
2938
3084
  # @!attribute [rw] exclude_risk_types
2939
- # A list of risk types excluded from the pentest execution
3085
+ # The list of risk types excluded from the pentest.
2940
3086
  # @return [Array<String>]
2941
3087
  #
2942
3088
  # @!attribute [rw] service_role
2943
- # Service role ARN for accessing customer resources
3089
+ # The IAM service role used for the pentest.
2944
3090
  # @return [String]
2945
3091
  #
2946
3092
  # @!attribute [rw] log_config
2947
- # CloudWatch log group and stream prefix where pentest execution logs
2948
- # are stored
3093
+ # The CloudWatch Logs configuration for the pentest.
2949
3094
  # @return [Types::CloudWatchLog]
2950
3095
  #
2951
3096
  # @!attribute [rw] vpc_config
2952
- # VPC configuration that the Security Agent accesses
3097
+ # The VPC configuration for the pentest.
2953
3098
  # @return [Types::VpcConfig]
2954
3099
  #
2955
3100
  # @!attribute [rw] network_traffic_config
2956
- # Configuration for network traffic filtering
3101
+ # The network traffic configuration for the pentest.
2957
3102
  # @return [Types::NetworkTrafficConfig]
2958
3103
  #
2959
3104
  # @!attribute [rw] code_remediation_strategy
2960
- # Strategy for code remediation on findings
3105
+ # The code remediation strategy for the pentest.
2961
3106
  # @return [String]
2962
3107
  #
2963
3108
  # @!attribute [rw] created_at
2964
- # Timestamp when the pentest was created
3109
+ # The date and time the pentest was created, in UTC format.
2965
3110
  # @return [Time]
2966
3111
  #
2967
3112
  # @!attribute [rw] updated_at
2968
- # Timestamp when the pentest was last updated
3113
+ # The date and time the pentest was last updated, in UTC format.
2969
3114
  # @return [Time]
2970
3115
  #
2971
3116
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Pentest AWS API Documentation
@@ -2987,99 +3132,101 @@ module Aws::SecurityAgent
2987
3132
  include Aws::Structure
2988
3133
  end
2989
3134
 
2990
- # Represents a pentest job
3135
+ # Represents a pentest job, which is an execution instance of a pentest.
3136
+ # A pentest job progresses through preflight, static analysis, pentest,
3137
+ # and finalizing steps.
2991
3138
  #
2992
3139
  # @!attribute [rw] pentest_job_id
2993
- # Unique identifier of the pentest job
3140
+ # The unique identifier of the pentest job.
2994
3141
  # @return [String]
2995
3142
  #
2996
3143
  # @!attribute [rw] pentest_id
2997
- # Identifier of the parent pentest
3144
+ # The unique identifier of the pentest associated with the job.
2998
3145
  # @return [String]
2999
3146
  #
3000
3147
  # @!attribute [rw] title
3001
- # Title or name of the pentest
3148
+ # The title of the pentest job.
3002
3149
  # @return [String]
3003
3150
  #
3004
3151
  # @!attribute [rw] overview
3005
- # Overview or description of the pentest job
3152
+ # An overview of the pentest job results.
3006
3153
  # @return [String]
3007
3154
  #
3008
3155
  # @!attribute [rw] status
3009
- # Current status of the pentest job
3156
+ # The current status of the pentest job.
3010
3157
  # @return [String]
3011
3158
  #
3012
3159
  # @!attribute [rw] endpoints
3013
- # List of web application endpoints to test
3160
+ # The list of endpoints being tested in the pentest job.
3014
3161
  # @return [Array<Types::Endpoint>]
3015
3162
  #
3016
3163
  # @!attribute [rw] actors
3017
- # List of actors that interact with the system
3164
+ # The list of actors used during the pentest job.
3018
3165
  # @return [Array<Types::Actor>]
3019
3166
  #
3020
3167
  # @!attribute [rw] documents
3021
- # List of documents providing context for testing
3168
+ # The list of documents providing context for the pentest job.
3022
3169
  # @return [Array<Types::DocumentInfo>]
3023
3170
  #
3024
3171
  # @!attribute [rw] source_code
3025
- # List of source code repositories for static analysis
3172
+ # The list of source code repositories analyzed during the pentest
3173
+ # job.
3026
3174
  # @return [Array<Types::SourceCodeRepository>]
3027
3175
  #
3028
3176
  # @!attribute [rw] exclude_paths
3029
- # List of URL paths to exclude from testing
3177
+ # The list of paths excluded from the pentest job.
3030
3178
  # @return [Array<Types::Endpoint>]
3031
3179
  #
3032
3180
  # @!attribute [rw] allowed_domains
3033
- # List of allowed domains for network access
3181
+ # The list of domains allowed during the pentest job.
3034
3182
  # @return [Array<Types::Endpoint>]
3035
3183
  #
3036
3184
  # @!attribute [rw] exclude_risk_types
3037
- # A list of risk types excluded from the pentest job
3185
+ # The list of risk types excluded from the pentest job.
3038
3186
  # @return [Array<String>]
3039
3187
  #
3040
3188
  # @!attribute [rw] steps
3041
- # List of execution steps for the pentest job
3189
+ # The list of steps in the pentest job execution.
3042
3190
  # @return [Array<Types::Step>]
3043
3191
  #
3044
3192
  # @!attribute [rw] execution_context
3045
- # A list of execution context messages associated with the pentest job
3193
+ # The execution context messages for the pentest job.
3046
3194
  # @return [Array<Types::ExecutionContext>]
3047
3195
  #
3048
3196
  # @!attribute [rw] service_role
3049
- # Service role ARN for accessing customer resources
3197
+ # The IAM service role used for the pentest job.
3050
3198
  # @return [String]
3051
3199
  #
3052
3200
  # @!attribute [rw] log_config
3053
- # CloudWatch log group and stream prefix where pentest job logs are
3054
- # stored
3201
+ # The CloudWatch Logs configuration for the pentest job.
3055
3202
  # @return [Types::CloudWatchLog]
3056
3203
  #
3057
3204
  # @!attribute [rw] vpc_config
3058
- # VPC configuration that the Security Agent accesses
3205
+ # The VPC configuration for the pentest job.
3059
3206
  # @return [Types::VpcConfig]
3060
3207
  #
3061
3208
  # @!attribute [rw] network_traffic_config
3062
- # Configuration for network traffic filtering
3209
+ # The network traffic configuration for the pentest job.
3063
3210
  # @return [Types::NetworkTrafficConfig]
3064
3211
  #
3065
3212
  # @!attribute [rw] error_information
3066
- # Error information regarding the pentest job
3213
+ # Error information if the pentest job encountered an error.
3067
3214
  # @return [Types::ErrorInformation]
3068
3215
  #
3069
3216
  # @!attribute [rw] integrated_repositories
3070
- # List of integrated code repositories
3217
+ # The list of integrated repositories associated with the pentest job.
3071
3218
  # @return [Array<Types::IntegratedRepository>]
3072
3219
  #
3073
3220
  # @!attribute [rw] code_remediation_strategy
3074
- # Strategy for code remediation on findings
3221
+ # The code remediation strategy for the pentest job.
3075
3222
  # @return [String]
3076
3223
  #
3077
3224
  # @!attribute [rw] created_at
3078
- # Timestamp when the pentest job was created
3225
+ # The date and time the pentest job was created, in UTC format.
3079
3226
  # @return [Time]
3080
3227
  #
3081
3228
  # @!attribute [rw] updated_at
3082
- # Timestamp when the pentest job was last updated
3229
+ # The date and time the pentest job was last updated, in UTC format.
3083
3230
  # @return [Time]
3084
3231
  #
3085
3232
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/PentestJob AWS API Documentation
@@ -3112,30 +3259,30 @@ module Aws::SecurityAgent
3112
3259
  include Aws::Structure
3113
3260
  end
3114
3261
 
3115
- # Summary information for a pentest job
3262
+ # Contains summary information about a pentest job.
3116
3263
  #
3117
3264
  # @!attribute [rw] pentest_job_id
3118
- # Unique identifier of the pentest job
3265
+ # The unique identifier of the pentest job.
3119
3266
  # @return [String]
3120
3267
  #
3121
3268
  # @!attribute [rw] pentest_id
3122
- # Identifier of the parent pentest
3269
+ # The unique identifier of the pentest associated with the job.
3123
3270
  # @return [String]
3124
3271
  #
3125
3272
  # @!attribute [rw] title
3126
- # Title or name of the pentest
3273
+ # The title of the pentest job.
3127
3274
  # @return [String]
3128
3275
  #
3129
3276
  # @!attribute [rw] status
3130
- # Current status of the pentest job
3277
+ # The current status of the pentest job.
3131
3278
  # @return [String]
3132
3279
  #
3133
3280
  # @!attribute [rw] created_at
3134
- # Timestamp when the pentest job was created
3281
+ # The date and time the pentest job was created, in UTC format.
3135
3282
  # @return [Time]
3136
3283
  #
3137
3284
  # @!attribute [rw] updated_at
3138
- # Timestamp when the pentest job was last updated
3285
+ # The date and time the pentest job was last updated, in UTC format.
3139
3286
  # @return [Time]
3140
3287
  #
3141
3288
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/PentestJobSummary AWS API Documentation
@@ -3151,26 +3298,26 @@ module Aws::SecurityAgent
3151
3298
  include Aws::Structure
3152
3299
  end
3153
3300
 
3154
- # Summary information for a pentest
3301
+ # Contains summary information about a pentest.
3155
3302
  #
3156
3303
  # @!attribute [rw] pentest_id
3157
- # Unique identifier for the pentest
3304
+ # The unique identifier of the pentest.
3158
3305
  # @return [String]
3159
3306
  #
3160
3307
  # @!attribute [rw] agent_space_id
3161
- # ID of the agent space where the pentest exists
3308
+ # The unique identifier of the agent space that contains the pentest.
3162
3309
  # @return [String]
3163
3310
  #
3164
3311
  # @!attribute [rw] title
3165
- # Title or name of the pentest
3312
+ # The title of the pentest.
3166
3313
  # @return [String]
3167
3314
  #
3168
3315
  # @!attribute [rw] created_at
3169
- # Timestamp when the pentest was created
3316
+ # The date and time the pentest was created, in UTC format.
3170
3317
  # @return [Time]
3171
3318
  #
3172
3319
  # @!attribute [rw] updated_at
3173
- # Timestamp when the pentest was last updated
3320
+ # The date and time the pentest was last updated, in UTC format.
3174
3321
  # @return [Time]
3175
3322
  #
3176
3323
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/PentestSummary AWS API Documentation
@@ -3185,12 +3332,13 @@ module Aws::SecurityAgent
3185
3332
  include Aws::Structure
3186
3333
  end
3187
3334
 
3188
- # Provider-specific input parameters for integration
3335
+ # The provider-specific input for creating an integration. This is a
3336
+ # union type that contains provider-specific configuration.
3189
3337
  #
3190
3338
  # @note ProviderInput is a union - when making an API calls you must set exactly one of the members.
3191
3339
  #
3192
3340
  # @!attribute [rw] github
3193
- # GitHub integration input
3341
+ # The GitHub-specific input for creating an integration.
3194
3342
  # @return [Types::GitHubIntegrationInput]
3195
3343
  #
3196
3344
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ProviderInput AWS API Documentation
@@ -3206,14 +3354,16 @@ module Aws::SecurityAgent
3206
3354
  class Unknown < ProviderInput; end
3207
3355
  end
3208
3356
 
3209
- # Provider-specific capabilities for integrated resources
3357
+ # The capabilities for an integrated resource from a third-party
3358
+ # provider. This is a union type that contains provider-specific
3359
+ # capabilities.
3210
3360
  #
3211
3361
  # @note ProviderResourceCapabilities is a union - when making an API calls you must set exactly one of the members.
3212
3362
  #
3213
3363
  # @note ProviderResourceCapabilities is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ProviderResourceCapabilities corresponding to the set member.
3214
3364
  #
3215
3365
  # @!attribute [rw] github
3216
- # Capabilities for GitHub repositories
3366
+ # The GitHub-specific resource capabilities.
3217
3367
  # @return [Types::GitHubResourceCapabilities]
3218
3368
  #
3219
3369
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ProviderResourceCapabilities AWS API Documentation
@@ -3229,10 +3379,12 @@ module Aws::SecurityAgent
3229
3379
  class Unknown < ProviderResourceCapabilities; end
3230
3380
  end
3231
3381
 
3232
- # Specified resource was not found
3382
+ # The specified resource was not found. Verify that the resource
3383
+ # identifier is correct and that the resource exists in the specified
3384
+ # agent space or account.
3233
3385
  #
3234
3386
  # @!attribute [rw] message
3235
- # Error description
3387
+ # Error description.
3236
3388
  # @return [String]
3237
3389
  #
3238
3390
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ResourceNotFoundException AWS API Documentation
@@ -3243,10 +3395,11 @@ module Aws::SecurityAgent
3243
3395
  include Aws::Structure
3244
3396
  end
3245
3397
 
3246
- # Information about a source code repository for static analysis
3398
+ # Represents a source code repository used for security analysis during
3399
+ # a pentest.
3247
3400
  #
3248
3401
  # @!attribute [rw] s3_location
3249
- # S3 storage location of the repository
3402
+ # The Amazon S3 location of the source code repository archive.
3250
3403
  # @return [String]
3251
3404
  #
3252
3405
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/SourceCodeRepository AWS API Documentation
@@ -3257,18 +3410,18 @@ module Aws::SecurityAgent
3257
3410
  include Aws::Structure
3258
3411
  end
3259
3412
 
3260
- # Input for the StartCodeRemediation operation
3413
+ # Input for the StartCodeRemediation operation.
3261
3414
  #
3262
3415
  # @!attribute [rw] agent_space_id
3263
- # ID of the agent space where the pentest job exists
3416
+ # The unique identifier of the agent space.
3264
3417
  # @return [String]
3265
3418
  #
3266
3419
  # @!attribute [rw] pentest_job_id
3267
- # Identifier of the pentest job to start code remediation for
3420
+ # The unique identifier of the pentest job that produced the findings.
3268
3421
  # @return [String]
3269
3422
  #
3270
3423
  # @!attribute [rw] finding_ids
3271
- # Identifiers of the findings to start code remediation for
3424
+ # The list of finding identifiers to initiate code remediation for.
3272
3425
  # @return [Array<String>]
3273
3426
  #
3274
3427
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/StartCodeRemediationInput AWS API Documentation
@@ -3281,20 +3434,20 @@ module Aws::SecurityAgent
3281
3434
  include Aws::Structure
3282
3435
  end
3283
3436
 
3284
- # Output for the StartCodeRemediation operation
3437
+ # Output for the StartCodeRemediation operation.
3285
3438
  #
3286
3439
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/StartCodeRemediationOutput AWS API Documentation
3287
3440
  #
3288
3441
  class StartCodeRemediationOutput < Aws::EmptyStructure; end
3289
3442
 
3290
- # Input for starting the execution of a pentest
3443
+ # Input for starting the execution of a pentest.
3291
3444
  #
3292
3445
  # @!attribute [rw] agent_space_id
3293
- # ID of the agent space where the pentest exists
3446
+ # The unique identifier of the agent space.
3294
3447
  # @return [String]
3295
3448
  #
3296
3449
  # @!attribute [rw] pentest_id
3297
- # Identifier of the pentest to execute
3450
+ # The unique identifier of the pentest to start a job for.
3298
3451
  # @return [String]
3299
3452
  #
3300
3453
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/StartPentestJobInput AWS API Documentation
@@ -3306,34 +3459,34 @@ module Aws::SecurityAgent
3306
3459
  include Aws::Structure
3307
3460
  end
3308
3461
 
3309
- # Output for the StartPentestJob operation
3462
+ # Output for the StartPentestJob operation.
3310
3463
  #
3311
3464
  # @!attribute [rw] title
3312
- # Title of the pentest job
3465
+ # The title of the pentest job.
3313
3466
  # @return [String]
3314
3467
  #
3315
3468
  # @!attribute [rw] status
3316
- # Current status of the pentest job
3469
+ # The current status of the pentest job.
3317
3470
  # @return [String]
3318
3471
  #
3319
3472
  # @!attribute [rw] created_at
3320
- # Timestamp when the pentest job was created
3473
+ # The date and time the pentest job was created, in UTC format.
3321
3474
  # @return [Time]
3322
3475
  #
3323
3476
  # @!attribute [rw] updated_at
3324
- # Timestamp when the pentest job was last updated
3477
+ # The date and time the pentest job was last updated, in UTC format.
3325
3478
  # @return [Time]
3326
3479
  #
3327
3480
  # @!attribute [rw] pentest_id
3328
- # Unique identifier of the pentest
3481
+ # The unique identifier of the pentest.
3329
3482
  # @return [String]
3330
3483
  #
3331
3484
  # @!attribute [rw] pentest_job_id
3332
- # Unique identifier of the pentest job
3485
+ # The unique identifier of the started pentest job.
3333
3486
  # @return [String]
3334
3487
  #
3335
3488
  # @!attribute [rw] agent_space_id
3336
- # ID of the agent space where the pentest exists
3489
+ # The unique identifier of the agent space.
3337
3490
  # @return [String]
3338
3491
  #
3339
3492
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/StartPentestJobOutput AWS API Documentation
@@ -3350,22 +3503,24 @@ module Aws::SecurityAgent
3350
3503
  include Aws::Structure
3351
3504
  end
3352
3505
 
3353
- # Represents a single step in pentest job execution
3506
+ # Represents a step in the pentest job execution pipeline. Steps include
3507
+ # preflight, static analysis, pentest, and finalizing.
3354
3508
  #
3355
3509
  # @!attribute [rw] name
3356
- # Name of the execution step
3510
+ # The name of the step. Valid values include PREFLIGHT,
3511
+ # STATIC\_ANALYSIS, PENTEST, and FINALIZING.
3357
3512
  # @return [String]
3358
3513
  #
3359
3514
  # @!attribute [rw] status
3360
- # Current status of the step
3515
+ # The current status of the step.
3361
3516
  # @return [String]
3362
3517
  #
3363
3518
  # @!attribute [rw] created_at
3364
- # Timestamp when the step was created
3519
+ # The date and time the step was created, in UTC format.
3365
3520
  # @return [Time]
3366
3521
  #
3367
3522
  # @!attribute [rw] updated_at
3368
- # Timestamp when the step was last updated
3523
+ # The date and time the step was last updated, in UTC format.
3369
3524
  # @return [Time]
3370
3525
  #
3371
3526
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Step AWS API Documentation
@@ -3379,14 +3534,14 @@ module Aws::SecurityAgent
3379
3534
  include Aws::Structure
3380
3535
  end
3381
3536
 
3382
- # Input for stopping the execution of a pentest
3537
+ # Input for stopping the execution of a pentest.
3383
3538
  #
3384
3539
  # @!attribute [rw] agent_space_id
3385
- # ID of the agent space where the pentest exists
3540
+ # The unique identifier of the agent space.
3386
3541
  # @return [String]
3387
3542
  #
3388
3543
  # @!attribute [rw] pentest_job_id
3389
- # Identifier of the pentest job to stop
3544
+ # The unique identifier of the pentest job to stop.
3390
3545
  # @return [String]
3391
3546
  #
3392
3547
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/StopPentestJobInput AWS API Documentation
@@ -3398,20 +3553,20 @@ module Aws::SecurityAgent
3398
3553
  include Aws::Structure
3399
3554
  end
3400
3555
 
3401
- # Output for the StopPentestJob operation
3556
+ # Output for the StopPentestJob operation.
3402
3557
  #
3403
3558
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/StopPentestJobOutput AWS API Documentation
3404
3559
  #
3405
3560
  class StopPentestJobOutput < Aws::EmptyStructure; end
3406
3561
 
3407
- # Input for TagResource operation
3562
+ # Input for TagResource operation.
3408
3563
  #
3409
3564
  # @!attribute [rw] resource_arn
3410
- # ARN of the resource to tag
3565
+ # The Amazon Resource Name (ARN) of the resource to tag.
3411
3566
  # @return [String]
3412
3567
  #
3413
3568
  # @!attribute [rw] tags
3414
- # Tags to add to the resource
3569
+ # The tags to add to the resource.
3415
3570
  # @return [Hash<String,String>]
3416
3571
  #
3417
3572
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/TagResourceInput AWS API Documentation
@@ -3423,36 +3578,42 @@ module Aws::SecurityAgent
3423
3578
  include Aws::Structure
3424
3579
  end
3425
3580
 
3426
- # Output for TagResource operation
3581
+ # Output for TagResource operation.
3427
3582
  #
3428
3583
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/TagResourceOutput AWS API Documentation
3429
3584
  #
3430
3585
  class TagResourceOutput < Aws::EmptyStructure; end
3431
3586
 
3432
- # Represents a target domain
3587
+ # Represents a target domain registered for penetration testing. A
3588
+ # target domain must be verified through DNS TXT or HTTP route
3589
+ # verification before it can be used in pentests.
3433
3590
  #
3434
3591
  # @!attribute [rw] target_domain_id
3435
- # Unique identifier of the target domain
3592
+ # The unique identifier of the target domain.
3436
3593
  # @return [String]
3437
3594
  #
3438
3595
  # @!attribute [rw] domain_name
3439
- # Name of the registered target domain
3596
+ # The domain name of the target domain.
3440
3597
  # @return [String]
3441
3598
  #
3442
3599
  # @!attribute [rw] verification_status
3443
- # Current verification status of the registered target domain
3600
+ # The current verification status of the target domain.
3601
+ # @return [String]
3602
+ #
3603
+ # @!attribute [rw] verification_status_reason
3604
+ # The reason for the current target domain verification status.
3444
3605
  # @return [String]
3445
3606
  #
3446
3607
  # @!attribute [rw] verification_details
3447
- # Verification details to verify registered target domain
3608
+ # The verification details for the target domain.
3448
3609
  # @return [Types::VerificationDetails]
3449
3610
  #
3450
3611
  # @!attribute [rw] created_at
3451
- # Timestamp when the target domain was registered
3612
+ # The date and time the target domain was created, in UTC format.
3452
3613
  # @return [Time]
3453
3614
  #
3454
3615
  # @!attribute [rw] verified_at
3455
- # Timestamp when the target domain was last successfully verified
3616
+ # The date and time the target domain was verified, in UTC format.
3456
3617
  # @return [Time]
3457
3618
  #
3458
3619
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/TargetDomain AWS API Documentation
@@ -3461,6 +3622,7 @@ module Aws::SecurityAgent
3461
3622
  :target_domain_id,
3462
3623
  :domain_name,
3463
3624
  :verification_status,
3625
+ :verification_status_reason,
3464
3626
  :verification_details,
3465
3627
  :created_at,
3466
3628
  :verified_at)
@@ -3468,18 +3630,18 @@ module Aws::SecurityAgent
3468
3630
  include Aws::Structure
3469
3631
  end
3470
3632
 
3471
- # Summary information for a target domain
3633
+ # Contains summary information about a target domain.
3472
3634
  #
3473
3635
  # @!attribute [rw] target_domain_id
3474
- # Unique identifier of the target domain
3636
+ # The unique identifier of the target domain.
3475
3637
  # @return [String]
3476
3638
  #
3477
3639
  # @!attribute [rw] domain_name
3478
- # Name of the registered target domain
3640
+ # The domain name of the target domain.
3479
3641
  # @return [String]
3480
3642
  #
3481
3643
  # @!attribute [rw] verification_status
3482
- # Current verification status of the registered target domain
3644
+ # The current verification status of the target domain.
3483
3645
  # @return [String]
3484
3646
  #
3485
3647
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/TargetDomainSummary AWS API Documentation
@@ -3492,58 +3654,60 @@ module Aws::SecurityAgent
3492
3654
  include Aws::Structure
3493
3655
  end
3494
3656
 
3495
- # Represents a task within a pentest job
3657
+ # Represents an individual security test task within a pentest job. Each
3658
+ # task targets a specific risk type or endpoint and executes
3659
+ # independently.
3496
3660
  #
3497
3661
  # @!attribute [rw] task_id
3498
- # Unique identifier for the task
3662
+ # The unique identifier of the task.
3499
3663
  # @return [String]
3500
3664
  #
3501
3665
  # @!attribute [rw] pentest_id
3502
- # Identifier of the parent pentest
3666
+ # The unique identifier of the pentest associated with the task.
3503
3667
  # @return [String]
3504
3668
  #
3505
3669
  # @!attribute [rw] pentest_job_id
3506
- # Identifier of the pentest job this task belongs to
3670
+ # The unique identifier of the pentest job that contains the task.
3507
3671
  # @return [String]
3508
3672
  #
3509
3673
  # @!attribute [rw] agent_space_id
3510
- # Identifier of the agent space this task belongs to
3674
+ # The unique identifier of the agent space.
3511
3675
  # @return [String]
3512
3676
  #
3513
3677
  # @!attribute [rw] title
3514
- # Title or name of the task
3678
+ # The title of the task.
3515
3679
  # @return [String]
3516
3680
  #
3517
3681
  # @!attribute [rw] description
3518
- # Detailed description of the task's purpose and scope
3682
+ # A description of the task.
3519
3683
  # @return [String]
3520
3684
  #
3521
3685
  # @!attribute [rw] categories
3522
- # List of categories associated with this task
3686
+ # The list of categories assigned to the task.
3523
3687
  # @return [Array<Types::Category>]
3524
3688
  #
3525
3689
  # @!attribute [rw] risk_type
3526
- # Type of security risk this task is designed to test
3690
+ # The type of security risk the task is testing for.
3527
3691
  # @return [String]
3528
3692
  #
3529
3693
  # @!attribute [rw] target_endpoint
3530
- # Target endpoint for this security test
3694
+ # The target endpoint being tested by the task.
3531
3695
  # @return [Types::Endpoint]
3532
3696
  #
3533
3697
  # @!attribute [rw] execution_status
3534
- # Current status of the task execution
3698
+ # The current execution status of the task.
3535
3699
  # @return [String]
3536
3700
  #
3537
3701
  # @!attribute [rw] logs_location
3538
- # Location of execution logs for auditing and review
3702
+ # The location of the task execution logs.
3539
3703
  # @return [Types::LogLocation]
3540
3704
  #
3541
3705
  # @!attribute [rw] created_at
3542
- # Timestamp when the task was created
3706
+ # The date and time the task was created, in UTC format.
3543
3707
  # @return [Time]
3544
3708
  #
3545
3709
  # @!attribute [rw] updated_at
3546
- # Timestamp when the task was last updated
3710
+ # The date and time the task was last updated, in UTC format.
3547
3711
  # @return [Time]
3548
3712
  #
3549
3713
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/Task AWS API Documentation
@@ -3566,42 +3730,42 @@ module Aws::SecurityAgent
3566
3730
  include Aws::Structure
3567
3731
  end
3568
3732
 
3569
- # Summary information for a task
3733
+ # Contains summary information about a task.
3570
3734
  #
3571
3735
  # @!attribute [rw] task_id
3572
- # Unique identifier for the task
3736
+ # The unique identifier of the task.
3573
3737
  # @return [String]
3574
3738
  #
3575
3739
  # @!attribute [rw] pentest_id
3576
- # Identifier of the parent pentest
3740
+ # The unique identifier of the pentest associated with the task.
3577
3741
  # @return [String]
3578
3742
  #
3579
3743
  # @!attribute [rw] pentest_job_id
3580
- # Identifier of the pentest job this task belongs to
3744
+ # The unique identifier of the pentest job that contains the task.
3581
3745
  # @return [String]
3582
3746
  #
3583
3747
  # @!attribute [rw] agent_space_id
3584
- # Identifier of the agent space this task belongs to
3748
+ # The unique identifier of the agent space.
3585
3749
  # @return [String]
3586
3750
  #
3587
3751
  # @!attribute [rw] title
3588
- # Title or name of the task
3752
+ # The title of the task.
3589
3753
  # @return [String]
3590
3754
  #
3591
3755
  # @!attribute [rw] risk_type
3592
- # Type of security risk this task is designed to test
3756
+ # The type of security risk the task is testing for.
3593
3757
  # @return [String]
3594
3758
  #
3595
3759
  # @!attribute [rw] execution_status
3596
- # Current status of the task execution
3760
+ # The current execution status of the task.
3597
3761
  # @return [String]
3598
3762
  #
3599
3763
  # @!attribute [rw] created_at
3600
- # Timestamp when the task was created
3764
+ # The date and time the task was created, in UTC format.
3601
3765
  # @return [Time]
3602
3766
  #
3603
3767
  # @!attribute [rw] updated_at
3604
- # Timestamp when the task was last updated
3768
+ # The date and time the task was last updated, in UTC format.
3605
3769
  # @return [Time]
3606
3770
  #
3607
3771
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/TaskSummary AWS API Documentation
@@ -3620,18 +3784,18 @@ module Aws::SecurityAgent
3620
3784
  include Aws::Structure
3621
3785
  end
3622
3786
 
3623
- # Request denied due to throttling
3787
+ # The request was denied due to request throttling.
3624
3788
  #
3625
3789
  # @!attribute [rw] message
3626
- # Error description
3790
+ # Error description.
3627
3791
  # @return [String]
3628
3792
  #
3629
3793
  # @!attribute [rw] service_code
3630
- # Service code for throttling limit
3794
+ # Service code for throttling limit.
3631
3795
  # @return [String]
3632
3796
  #
3633
3797
  # @!attribute [rw] quota_code
3634
- # Quota code for throttling limit
3798
+ # Quota code for throttling limit.
3635
3799
  # @return [String]
3636
3800
  #
3637
3801
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ThrottlingException AWS API Documentation
@@ -3644,14 +3808,14 @@ module Aws::SecurityAgent
3644
3808
  include Aws::Structure
3645
3809
  end
3646
3810
 
3647
- # Input for UntagResource operation
3811
+ # Input for UntagResource operation.
3648
3812
  #
3649
3813
  # @!attribute [rw] resource_arn
3650
- # ARN of the resource to untag
3814
+ # The Amazon Resource Name (ARN) of the resource to remove tags from.
3651
3815
  # @return [String]
3652
3816
  #
3653
3817
  # @!attribute [rw] tag_keys
3654
- # List of tag keys to remove from the resource
3818
+ # The list of tag keys to remove from the resource.
3655
3819
  # @return [Array<String>]
3656
3820
  #
3657
3821
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UntagResourceInput AWS API Documentation
@@ -3663,37 +3827,37 @@ module Aws::SecurityAgent
3663
3827
  include Aws::Structure
3664
3828
  end
3665
3829
 
3666
- # Output for UntagResource operation
3830
+ # Output for UntagResource operation.
3667
3831
  #
3668
3832
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UntagResourceOutput AWS API Documentation
3669
3833
  #
3670
3834
  class UntagResourceOutput < Aws::EmptyStructure; end
3671
3835
 
3672
- # Input for updating an agent space
3836
+ # Input for updating an agent space.
3673
3837
  #
3674
3838
  # @!attribute [rw] agent_space_id
3675
- # ID of the agent space to update
3839
+ # The unique identifier of the agent space to update.
3676
3840
  # @return [String]
3677
3841
  #
3678
3842
  # @!attribute [rw] name
3679
- # Name of the agent space
3843
+ # The updated name of the agent space.
3680
3844
  # @return [String]
3681
3845
  #
3682
3846
  # @!attribute [rw] description
3683
- # Description of the agent space
3847
+ # The updated description of the agent space.
3684
3848
  # @return [String]
3685
3849
  #
3686
3850
  # @!attribute [rw] aws_resources
3687
- # AWS resource configurations associated with the agent space
3851
+ # The updated AWS resources to associate with the agent space.
3688
3852
  # @return [Types::AWSResources]
3689
3853
  #
3690
3854
  # @!attribute [rw] target_domain_ids
3691
- # Target domain IDs to associate with the agent space
3855
+ # The updated list of target domain identifiers to associate with the
3856
+ # agent space.
3692
3857
  # @return [Array<String>]
3693
3858
  #
3694
3859
  # @!attribute [rw] code_review_settings
3695
- # Configuration for code review analysis, including controls scanning
3696
- # and general purpose scanning settings
3860
+ # The updated code review settings for the agent space.
3697
3861
  # @return [Types::CodeReviewSettings]
3698
3862
  #
3699
3863
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateAgentSpaceInput AWS API Documentation
@@ -3709,39 +3873,39 @@ module Aws::SecurityAgent
3709
3873
  include Aws::Structure
3710
3874
  end
3711
3875
 
3712
- # Output for the UpdateAgentSpace operation
3876
+ # Output for the UpdateAgentSpace operation.
3713
3877
  #
3714
3878
  # @!attribute [rw] agent_space_id
3715
- # Unique identifier of the agent space
3879
+ # The unique identifier of the updated agent space.
3716
3880
  # @return [String]
3717
3881
  #
3718
3882
  # @!attribute [rw] name
3719
- # Name of the agent space
3883
+ # The name of the agent space.
3720
3884
  # @return [String]
3721
3885
  #
3722
3886
  # @!attribute [rw] description
3723
- # Description of the agent space
3887
+ # The description of the agent space.
3724
3888
  # @return [String]
3725
3889
  #
3726
3890
  # @!attribute [rw] aws_resources
3727
- # AWS resource configurations associated with the agent space
3891
+ # The AWS resources associated with the agent space.
3728
3892
  # @return [Types::AWSResources]
3729
3893
  #
3730
3894
  # @!attribute [rw] target_domain_ids
3731
- # List of target domain IDs registered with the agent space
3895
+ # The list of target domain identifiers associated with the agent
3896
+ # space.
3732
3897
  # @return [Array<String>]
3733
3898
  #
3734
3899
  # @!attribute [rw] code_review_settings
3735
- # Configuration for code review analysis, including controls scanning
3736
- # and general purpose scanning settings
3900
+ # The code review settings for the agent space.
3737
3901
  # @return [Types::CodeReviewSettings]
3738
3902
  #
3739
3903
  # @!attribute [rw] created_at
3740
- # Timestamp when the agent space was created
3904
+ # The date and time the agent space was created, in UTC format.
3741
3905
  # @return [Time]
3742
3906
  #
3743
3907
  # @!attribute [rw] updated_at
3744
- # Timestamp when the agent space was last updated
3908
+ # The date and time the agent space was last updated, in UTC format.
3745
3909
  # @return [Time]
3746
3910
  #
3747
3911
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateAgentSpaceOutput AWS API Documentation
@@ -3760,17 +3924,17 @@ module Aws::SecurityAgent
3760
3924
  end
3761
3925
 
3762
3926
  # @!attribute [rw] application_id
3763
- # Application ID
3927
+ # The unique identifier of the application to update.
3764
3928
  # @return [String]
3765
3929
  #
3766
3930
  # @!attribute [rw] role_arn
3767
- # ARN of the IAM role that the application uses to access AWS
3768
- # resources on your behalf
3931
+ # The updated Amazon Resource Name (ARN) of the IAM role for the
3932
+ # application.
3769
3933
  # @return [String]
3770
3934
  #
3771
3935
  # @!attribute [rw] default_kms_key_id
3772
- # Default KMS key identifier. Use an empty string to remove the
3773
- # default KMS key.
3936
+ # The updated identifier of the default AWS KMS key for the
3937
+ # application.
3774
3938
  # @return [String]
3775
3939
  #
3776
3940
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateApplicationRequest AWS API Documentation
@@ -3784,7 +3948,7 @@ module Aws::SecurityAgent
3784
3948
  end
3785
3949
 
3786
3950
  # @!attribute [rw] application_id
3787
- # Application ID
3951
+ # The unique identifier of the updated application.
3788
3952
  # @return [String]
3789
3953
  #
3790
3954
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateApplicationResponse AWS API Documentation
@@ -3795,22 +3959,22 @@ module Aws::SecurityAgent
3795
3959
  include Aws::Structure
3796
3960
  end
3797
3961
 
3798
- # Input for updating an existing security finding
3962
+ # Input for updating an existing security finding.
3799
3963
  #
3800
3964
  # @!attribute [rw] finding_id
3801
- # Identifier of the finding to update
3965
+ # The unique identifier of the finding to update.
3802
3966
  # @return [String]
3803
3967
  #
3804
3968
  # @!attribute [rw] agent_space_id
3805
- # ID of the agent space where the finding exists
3969
+ # The unique identifier of the agent space that contains the finding.
3806
3970
  # @return [String]
3807
3971
  #
3808
3972
  # @!attribute [rw] risk_level
3809
- # Updated severity level of the identified risk
3973
+ # The updated risk level for the finding.
3810
3974
  # @return [String]
3811
3975
  #
3812
3976
  # @!attribute [rw] status
3813
- # Updated status of the finding
3977
+ # The updated status for the finding.
3814
3978
  # @return [String]
3815
3979
  #
3816
3980
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateFindingInput AWS API Documentation
@@ -3824,22 +3988,22 @@ module Aws::SecurityAgent
3824
3988
  include Aws::Structure
3825
3989
  end
3826
3990
 
3827
- # Output for the UpdateFinding operation
3991
+ # Output for the UpdateFinding operation.
3828
3992
  #
3829
3993
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateFindingOutput AWS API Documentation
3830
3994
  #
3831
3995
  class UpdateFindingOutput < Aws::EmptyStructure; end
3832
3996
 
3833
3997
  # @!attribute [rw] agent_space_id
3834
- # Unique identifier of the agent space
3998
+ # The unique identifier of the agent space.
3835
3999
  # @return [String]
3836
4000
  #
3837
4001
  # @!attribute [rw] integration_id
3838
- # Unique identifier of the integration
4002
+ # The unique identifier of the integration.
3839
4003
  # @return [String]
3840
4004
  #
3841
4005
  # @!attribute [rw] items
3842
- # List of integrated resources to update
4006
+ # The list of integrated resource items to update.
3843
4007
  # @return [Array<Types::IntegratedResourceInputItem>]
3844
4008
  #
3845
4009
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateIntegratedResourcesInput AWS API Documentation
@@ -3856,47 +4020,46 @@ module Aws::SecurityAgent
3856
4020
  #
3857
4021
  class UpdateIntegratedResourcesOutput < Aws::EmptyStructure; end
3858
4022
 
3859
- # Input for updating an existing pentest
4023
+ # Input for updating an existing pentest.
3860
4024
  #
3861
4025
  # @!attribute [rw] pentest_id
3862
- # Identifier of the pentest to update
4026
+ # The unique identifier of the pentest to update.
3863
4027
  # @return [String]
3864
4028
  #
3865
4029
  # @!attribute [rw] agent_space_id
3866
- # ID of the agent space where the pentest exists
4030
+ # The unique identifier of the agent space that contains the pentest.
3867
4031
  # @return [String]
3868
4032
  #
3869
4033
  # @!attribute [rw] title
3870
- # New title for the pentest
4034
+ # The updated title of the pentest.
3871
4035
  # @return [String]
3872
4036
  #
3873
4037
  # @!attribute [rw] assets
3874
- # Updated assets to be tested
4038
+ # The updated assets for the pentest.
3875
4039
  # @return [Types::Assets]
3876
4040
  #
3877
4041
  # @!attribute [rw] exclude_risk_types
3878
- # A list of risk types excluded from the pentest execution
4042
+ # The updated list of risk types to exclude from the pentest.
3879
4043
  # @return [Array<String>]
3880
4044
  #
3881
4045
  # @!attribute [rw] service_role
3882
- # Updated service role ARN for accessing customer resources
4046
+ # The updated IAM service role for the pentest.
3883
4047
  # @return [String]
3884
4048
  #
3885
4049
  # @!attribute [rw] log_config
3886
- # CloudWatch log group and stream prefix where pentest execution logs
3887
- # are stored
4050
+ # The updated CloudWatch Logs configuration for the pentest.
3888
4051
  # @return [Types::CloudWatchLog]
3889
4052
  #
3890
4053
  # @!attribute [rw] vpc_config
3891
- # VPC configuration that the Security Agent accesses
4054
+ # The updated VPC configuration for the pentest.
3892
4055
  # @return [Types::VpcConfig]
3893
4056
  #
3894
4057
  # @!attribute [rw] network_traffic_config
3895
- # Configuration for network traffic filtering
4058
+ # The updated network traffic configuration for the pentest.
3896
4059
  # @return [Types::NetworkTrafficConfig]
3897
4060
  #
3898
4061
  # @!attribute [rw] code_remediation_strategy
3899
- # Strategy for code remediation on findings
4062
+ # The updated code remediation strategy for the pentest.
3900
4063
  # @return [String]
3901
4064
  #
3902
4065
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdatePentestInput AWS API Documentation
@@ -3916,43 +4079,42 @@ module Aws::SecurityAgent
3916
4079
  include Aws::Structure
3917
4080
  end
3918
4081
 
3919
- # Output for the UpdatePentest operation
4082
+ # Output for the UpdatePentest operation.
3920
4083
  #
3921
4084
  # @!attribute [rw] pentest_id
3922
- # Unique identifier of the updated pentest
4085
+ # The unique identifier of the pentest.
3923
4086
  # @return [String]
3924
4087
  #
3925
4088
  # @!attribute [rw] title
3926
- # Title of the updated pentest
4089
+ # The title of the pentest.
3927
4090
  # @return [String]
3928
4091
  #
3929
4092
  # @!attribute [rw] created_at
3930
- # Timestamp when the pentest was created
4093
+ # The date and time the pentest was created, in UTC format.
3931
4094
  # @return [Time]
3932
4095
  #
3933
4096
  # @!attribute [rw] updated_at
3934
- # Timestamp when the pentest was last updated
4097
+ # The date and time the pentest was last updated, in UTC format.
3935
4098
  # @return [Time]
3936
4099
  #
3937
4100
  # @!attribute [rw] assets
3938
- # Assets to be tested in the updated pentest
4101
+ # The assets included in the pentest.
3939
4102
  # @return [Types::Assets]
3940
4103
  #
3941
4104
  # @!attribute [rw] exclude_risk_types
3942
- # A list of risk types excluded from the pentest execution
4105
+ # The list of risk types excluded from the pentest.
3943
4106
  # @return [Array<String>]
3944
4107
  #
3945
4108
  # @!attribute [rw] service_role
3946
- # Service role ARN for accessing customer resources
4109
+ # The IAM service role used for the pentest.
3947
4110
  # @return [String]
3948
4111
  #
3949
4112
  # @!attribute [rw] log_config
3950
- # CloudWatch log group and stream prefix where pentest execution logs
3951
- # are stored
4113
+ # The CloudWatch Logs configuration for the pentest.
3952
4114
  # @return [Types::CloudWatchLog]
3953
4115
  #
3954
4116
  # @!attribute [rw] agent_space_id
3955
- # ID of the agent space where the pentest exists
4117
+ # The unique identifier of the agent space that contains the pentest.
3956
4118
  # @return [String]
3957
4119
  #
3958
4120
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdatePentestOutput AWS API Documentation
@@ -3971,14 +4133,14 @@ module Aws::SecurityAgent
3971
4133
  include Aws::Structure
3972
4134
  end
3973
4135
 
3974
- # Input for updating a target domain
4136
+ # Input for updating a target domain.
3975
4137
  #
3976
4138
  # @!attribute [rw] target_domain_id
3977
- # Unique identifier of the target domain to update
4139
+ # The unique identifier of the target domain to update.
3978
4140
  # @return [String]
3979
4141
  #
3980
4142
  # @!attribute [rw] verification_method
3981
- # Verification method for the target domain
4143
+ # The updated verification method for the target domain.
3982
4144
  # @return [String]
3983
4145
  #
3984
4146
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateTargetDomainInput AWS API Documentation
@@ -3990,30 +4152,34 @@ module Aws::SecurityAgent
3990
4152
  include Aws::Structure
3991
4153
  end
3992
4154
 
3993
- # Output for the UpdateTargetDomain operation
4155
+ # Output for the UpdateTargetDomain operation.
3994
4156
  #
3995
4157
  # @!attribute [rw] target_domain_id
3996
- # Unique identifier of the target domain
4158
+ # The unique identifier of the target domain.
3997
4159
  # @return [String]
3998
4160
  #
3999
4161
  # @!attribute [rw] domain_name
4000
- # Name of the target domain
4162
+ # The domain name of the target domain.
4001
4163
  # @return [String]
4002
4164
  #
4003
4165
  # @!attribute [rw] verification_status
4004
- # Current verification status of the registered target domain
4166
+ # The current verification status of the target domain.
4167
+ # @return [String]
4168
+ #
4169
+ # @!attribute [rw] verification_status_reason
4170
+ # The reason for the current target domain verification status.
4005
4171
  # @return [String]
4006
4172
  #
4007
4173
  # @!attribute [rw] verification_details
4008
- # Verification details to verify registered target domain
4174
+ # The updated verification details for the target domain.
4009
4175
  # @return [Types::VerificationDetails]
4010
4176
  #
4011
4177
  # @!attribute [rw] created_at
4012
- # Timestamp when the target domain was registered
4178
+ # The date and time the target domain was created, in UTC format.
4013
4179
  # @return [Time]
4014
4180
  #
4015
4181
  # @!attribute [rw] verified_at
4016
- # Timestamp when the target domain was last successfully verified
4182
+ # The date and time the target domain was verified, in UTC format.
4017
4183
  # @return [Time]
4018
4184
  #
4019
4185
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UpdateTargetDomainOutput AWS API Documentation
@@ -4022,6 +4188,7 @@ module Aws::SecurityAgent
4022
4188
  :target_domain_id,
4023
4189
  :domain_name,
4024
4190
  :verification_status,
4191
+ :verification_status_reason,
4025
4192
  :verification_details,
4026
4193
  :created_at,
4027
4194
  :verified_at)
@@ -4029,10 +4196,11 @@ module Aws::SecurityAgent
4029
4196
  include Aws::Structure
4030
4197
  end
4031
4198
 
4032
- # User membership configuration
4199
+ # The configuration for a user membership, including the role assigned
4200
+ # to the user within the agent space.
4033
4201
  #
4034
4202
  # @!attribute [rw] role
4035
- # Role of the user associated to the agent space
4203
+ # The role assigned to the user. Currently, only MEMBER is supported.
4036
4204
  # @return [String]
4037
4205
  #
4038
4206
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UserConfig AWS API Documentation
@@ -4043,14 +4211,15 @@ module Aws::SecurityAgent
4043
4211
  include Aws::Structure
4044
4212
  end
4045
4213
 
4046
- # User-specific metadata
4214
+ # Contains metadata about a user member, including the username and
4215
+ # email address.
4047
4216
  #
4048
4217
  # @!attribute [rw] username
4049
- # User name/display name
4218
+ # The username of the user.
4050
4219
  # @return [String]
4051
4220
  #
4052
4221
  # @!attribute [rw] email
4053
- # User email address
4222
+ # The email address of the user.
4054
4223
  # @return [String]
4055
4224
  #
4056
4225
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/UserMetadata AWS API Documentation
@@ -4062,18 +4231,14 @@ module Aws::SecurityAgent
4062
4231
  include Aws::Structure
4063
4232
  end
4064
4233
 
4065
- # A standard error for input validation failures. This should be thrown
4066
- # by services when a member of the input structure falls outside of the
4067
- # modeled or documented constraints.
4234
+ # The input fails to satisfy the constraints specified by the service.
4068
4235
  #
4069
4236
  # @!attribute [rw] message
4070
4237
  # A summary of the validation failure.
4071
4238
  # @return [String]
4072
4239
  #
4073
4240
  # @!attribute [rw] field_list
4074
- # A list of specific failures encountered while validating the input.
4075
- # A member can appear in this list more than once if it failed to
4076
- # satisfy multiple constraints.
4241
+ # A list of specific failures encountered during validation.
4077
4242
  # @return [Array<Types::ValidationExceptionField>]
4078
4243
  #
4079
4244
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/ValidationException AWS API Documentation
@@ -4089,7 +4254,7 @@ module Aws::SecurityAgent
4089
4254
  #
4090
4255
  # @!attribute [rw] path
4091
4256
  # A JSONPointer expression to the structure member whose value failed
4092
- # to satisfy the modeled constraints.
4257
+ # to satisfy the modeled constraint.
4093
4258
  # @return [String]
4094
4259
  #
4095
4260
  # @!attribute [rw] message
@@ -4105,18 +4270,19 @@ module Aws::SecurityAgent
4105
4270
  include Aws::Structure
4106
4271
  end
4107
4272
 
4108
- # Verification details to verify registered target domain
4273
+ # Contains the verification details for a target domain, including the
4274
+ # verification method and provider-specific details.
4109
4275
  #
4110
4276
  # @!attribute [rw] method
4111
- # Type of domain ownership verification method
4277
+ # The verification method used for the target domain.
4112
4278
  # @return [String]
4113
4279
  #
4114
4280
  # @!attribute [rw] dns_txt
4115
- # Represents dns txt verification details
4281
+ # The DNS TXT verification details.
4116
4282
  # @return [Types::DnsVerification]
4117
4283
  #
4118
4284
  # @!attribute [rw] http_route
4119
- # Represents http route verification details
4285
+ # The HTTP route verification details.
4120
4286
  # @return [Types::HttpVerification]
4121
4287
  #
4122
4288
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/VerificationDetails AWS API Documentation
@@ -4130,10 +4296,10 @@ module Aws::SecurityAgent
4130
4296
  end
4131
4297
 
4132
4298
  # Input for verifying ownership for a registered target domain in an
4133
- # agent space
4299
+ # agent space.
4134
4300
  #
4135
4301
  # @!attribute [rw] target_domain_id
4136
- # Unique identifier of the target domain
4302
+ # The unique identifier of the target domain to verify.
4137
4303
  # @return [String]
4138
4304
  #
4139
4305
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/VerifyTargetDomainInput AWS API Documentation
@@ -4145,30 +4311,34 @@ module Aws::SecurityAgent
4145
4311
  end
4146
4312
 
4147
4313
  # Output for verifying ownership for a registered target domain in an
4148
- # agent space
4314
+ # agent space.
4149
4315
  #
4150
4316
  # @!attribute [rw] target_domain_id
4151
- # Unique identifier of the target domain
4317
+ # The unique identifier of the target domain.
4152
4318
  # @return [String]
4153
4319
  #
4154
4320
  # @!attribute [rw] domain_name
4155
- # Name of the registered target domain
4321
+ # The domain name of the target domain.
4156
4322
  # @return [String]
4157
4323
  #
4158
4324
  # @!attribute [rw] created_at
4159
- # Timestamp when the target domain was registered
4325
+ # The date and time the target domain was created, in UTC format.
4160
4326
  # @return [Time]
4161
4327
  #
4162
4328
  # @!attribute [rw] updated_at
4163
- # Timestamp when the target domain was last updated
4329
+ # The date and time the target domain was last updated, in UTC format.
4164
4330
  # @return [Time]
4165
4331
  #
4166
4332
  # @!attribute [rw] verified_at
4167
- # Timestamp when the target domain was last successfully verified
4333
+ # The date and time the target domain was verified, in UTC format.
4168
4334
  # @return [Time]
4169
4335
  #
4170
4336
  # @!attribute [rw] status
4171
- # Current verification status of the registered target domain
4337
+ # The verification status of the target domain.
4338
+ # @return [String]
4339
+ #
4340
+ # @!attribute [rw] verification_status_reason
4341
+ # The reason for the current target domain verification status.
4172
4342
  # @return [String]
4173
4343
  #
4174
4344
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/VerifyTargetDomainOutput AWS API Documentation
@@ -4179,23 +4349,27 @@ module Aws::SecurityAgent
4179
4349
  :created_at,
4180
4350
  :updated_at,
4181
4351
  :verified_at,
4182
- :status)
4352
+ :status,
4353
+ :verification_status_reason)
4183
4354
  SENSITIVE = []
4184
4355
  include Aws::Structure
4185
4356
  end
4186
4357
 
4187
- # Customer VPC configuration that the Security Agent accesses
4358
+ # The VPC configuration for a pentest, specifying the VPC, security
4359
+ # groups, and subnets to use during testing.
4188
4360
  #
4189
4361
  # @!attribute [rw] vpc_arn
4190
- # ARN or ID of the customer VPC
4362
+ # The Amazon Resource Name (ARN) of the VPC.
4191
4363
  # @return [String]
4192
4364
  #
4193
4365
  # @!attribute [rw] security_group_arns
4194
- # List of security group ARNs or IDs in the customer VPC
4366
+ # The Amazon Resource Names (ARNs) of the security groups for the VPC
4367
+ # configuration.
4195
4368
  # @return [Array<String>]
4196
4369
  #
4197
4370
  # @!attribute [rw] subnet_arns
4198
- # List of subnet ARNs or IDs in the customer VPC
4371
+ # The Amazon Resource Names (ARNs) of the subnets for the VPC
4372
+ # configuration.
4199
4373
  # @return [Array<String>]
4200
4374
  #
4201
4375
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/VpcConfig AWS API Documentation