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.
@@ -476,19 +476,22 @@ module Aws::SecurityAgent
476
476
 
477
477
  # @!group API Operations
478
478
 
479
- # Adds an Artifact for the given agent space
479
+ # Uploads an artifact to an agent space. Artifacts provide additional
480
+ # context for security testing, such as architecture diagrams, API
481
+ # specifications, or configuration files.
480
482
  #
481
483
  # @option params [required, String] :agent_space_id
482
- # Unique identifier of the agent space
484
+ # The unique identifier of the agent space to add the artifact to.
483
485
  #
484
486
  # @option params [required, String, StringIO, File] :artifact_content
485
- # Binary content of the artifact
487
+ # The binary content of the artifact to upload.
486
488
  #
487
489
  # @option params [required, String] :artifact_type
488
- # Type of the artifact file
490
+ # The file type of the artifact. Valid values include TXT, PNG, JPEG,
491
+ # MD, PDF, DOCX, DOC, JSON, and YAML.
489
492
  #
490
493
  # @option params [required, String] :file_name
491
- # Name of the artifact file
494
+ # The file name of the artifact.
492
495
  #
493
496
  # @return [Types::AddArtifactOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
494
497
  #
@@ -516,13 +519,14 @@ module Aws::SecurityAgent
516
519
  req.send_request(options)
517
520
  end
518
521
 
519
- # Deletes multiple pentests in a single request
522
+ # Deletes one or more pentests from an agent space.
520
523
  #
521
524
  # @option params [required, Array<String>] :pentest_ids
522
- # List of pentest IDs to delete
525
+ # The list of pentest identifiers to delete.
523
526
  #
524
527
  # @option params [required, String] :agent_space_id
525
- # ID of the agent space where the pentests exist
528
+ # The unique identifier of the agent space that contains the pentests to
529
+ # delete.
526
530
  #
527
531
  # @return [Types::BatchDeletePentestsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
528
532
  #
@@ -592,10 +596,10 @@ module Aws::SecurityAgent
592
596
  req.send_request(options)
593
597
  end
594
598
 
595
- # Retrieves multiple agent spaces in a single request
599
+ # Retrieves information about one or more agent spaces.
596
600
  #
597
601
  # @option params [required, Array<String>] :agent_space_ids
598
- # List of agent space IDs to retrieve
602
+ # The list of agent space identifiers to retrieve.
599
603
  #
600
604
  # @return [Types::BatchGetAgentSpacesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
601
605
  #
@@ -649,13 +653,13 @@ module Aws::SecurityAgent
649
653
  req.send_request(options)
650
654
  end
651
655
 
652
- # Retrieve the list of artifact metadata for the given agent space
656
+ # Retrieves metadata for one or more artifacts in an agent space.
653
657
  #
654
658
  # @option params [required, String] :agent_space_id
655
- # Unique identifier of the agent space
659
+ # The unique identifier of the agent space that contains the artifacts.
656
660
  #
657
661
  # @option params [required, Array<String>] :artifact_ids
658
- # List of artifact identifiers
662
+ # The list of artifact identifiers to retrieve metadata for.
659
663
  #
660
664
  # @return [Types::BatchGetArtifactMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
661
665
  #
@@ -685,13 +689,14 @@ module Aws::SecurityAgent
685
689
  req.send_request(options)
686
690
  end
687
691
 
688
- # Retrieves multiple findings in a single request
692
+ # Retrieves information about one or more security findings in an agent
693
+ # space.
689
694
  #
690
695
  # @option params [required, Array<String>] :finding_ids
691
- # List of finding IDs to retrieve
696
+ # The list of finding identifiers to retrieve.
692
697
  #
693
698
  # @option params [required, String] :agent_space_id
694
- # ID of the agent space where the findings exist
699
+ # The unique identifier of the agent space that contains the findings.
695
700
  #
696
701
  # @return [Types::BatchGetFindingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
697
702
  #
@@ -743,13 +748,13 @@ module Aws::SecurityAgent
743
748
  req.send_request(options)
744
749
  end
745
750
 
746
- # Retrieves multiple tasks for a pentest job in a single request
751
+ # Retrieves information about one or more tasks within a pentest job.
747
752
  #
748
753
  # @option params [required, String] :agent_space_id
749
- # ID of the agent space where the pentest exists
754
+ # The unique identifier of the agent space that contains the tasks.
750
755
  #
751
756
  # @option params [required, Array<String>] :task_ids
752
- # List of task IDs to retrieve
757
+ # The list of task identifiers to retrieve.
753
758
  #
754
759
  # @return [Types::BatchGetPentestJobTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
755
760
  #
@@ -795,13 +800,15 @@ module Aws::SecurityAgent
795
800
  req.send_request(options)
796
801
  end
797
802
 
798
- # Retrieves multiple pentest jobs in a single request
803
+ # Retrieves information about one or more pentest jobs in an agent
804
+ # space.
799
805
  #
800
806
  # @option params [required, Array<String>] :pentest_job_ids
801
- # List of pentest job IDs to retrieve
807
+ # The list of pentest job identifiers to retrieve.
802
808
  #
803
809
  # @option params [required, String] :agent_space_id
804
- # ID of the agent space where the pentest exists
810
+ # The unique identifier of the agent space that contains the pentest
811
+ # jobs.
805
812
  #
806
813
  # @return [Types::BatchGetPentestJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
807
814
  #
@@ -887,13 +894,13 @@ module Aws::SecurityAgent
887
894
  req.send_request(options)
888
895
  end
889
896
 
890
- # Retrieves multiple pentests in a single request
897
+ # Retrieves information about one or more pentests in an agent space.
891
898
  #
892
899
  # @option params [required, Array<String>] :pentest_ids
893
- # List of pentest IDs to retrieve
900
+ # The list of pentest identifiers to retrieve.
894
901
  #
895
902
  # @option params [required, String] :agent_space_id
896
- # ID of the agent space where the pentest exists
903
+ # The unique identifier of the agent space that contains the pentests.
897
904
  #
898
905
  # @return [Types::BatchGetPentestsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
899
906
  #
@@ -962,10 +969,10 @@ module Aws::SecurityAgent
962
969
  req.send_request(options)
963
970
  end
964
971
 
965
- # Retrieves multiple target domains in a single request
972
+ # Retrieves information about one or more target domains.
966
973
  #
967
974
  # @option params [required, Array<String>] :target_domain_ids
968
- # List of target domain IDs to retrieve
975
+ # The list of target domain identifiers to retrieve.
969
976
  #
970
977
  # @return [Types::BatchGetTargetDomainsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
971
978
  #
@@ -984,7 +991,8 @@ module Aws::SecurityAgent
984
991
  # resp.target_domains[0].target_domain_id #=> String
985
992
  # resp.target_domains[0].domain_name #=> String
986
993
  # resp.target_domains[0].verification_status #=> String, one of "PENDING", "VERIFIED", "FAILED", "UNREACHABLE"
987
- # resp.target_domains[0].verification_details.method #=> String, one of "DNS_TXT", "HTTP_ROUTE"
994
+ # resp.target_domains[0].verification_status_reason #=> String
995
+ # resp.target_domains[0].verification_details.method #=> String, one of "DNS_TXT", "HTTP_ROUTE", "PRIVATE_VPC"
988
996
  # resp.target_domains[0].verification_details.dns_txt.token #=> String
989
997
  # resp.target_domains[0].verification_details.dns_txt.dns_record_name #=> String
990
998
  # resp.target_domains[0].verification_details.dns_txt.dns_record_type #=> String, one of "TXT"
@@ -1004,31 +1012,31 @@ module Aws::SecurityAgent
1004
1012
  req.send_request(options)
1005
1013
  end
1006
1014
 
1007
- # Creates an agent space record
1015
+ # Creates a new agent space. An agent space is a dedicated workspace for
1016
+ # securing a specific application.
1008
1017
  #
1009
1018
  # @option params [required, String] :name
1010
- # Name of the agent space
1019
+ # The name of the agent space.
1011
1020
  #
1012
1021
  # @option params [String] :description
1013
- # Description of the agent space
1022
+ # A description of the agent space.
1014
1023
  #
1015
1024
  # @option params [Types::AWSResources] :aws_resources
1016
- # AWS resource configurations associated with the agent space
1025
+ # The AWS resources to associate with the agent space.
1017
1026
  #
1018
1027
  # @option params [Array<String>] :target_domain_ids
1019
- # Target domain IDs to associate with the agent space
1028
+ # The list of target domain identifiers to associate with the agent
1029
+ # space.
1020
1030
  #
1021
1031
  # @option params [Types::CodeReviewSettings] :code_review_settings
1022
- # Configuration for code review analysis, including controls scanning
1023
- # and general purpose scanning settings
1032
+ # The code review settings for the agent space.
1024
1033
  #
1025
1034
  # @option params [String] :kms_key_id
1026
- # Identifier of the KMS key used to encrypt data. Can be a key ID, key
1027
- # ARN, alias name, or alias ARN. If not specified, an AWS managed key is
1028
- # used.
1035
+ # The identifier of the AWS KMS key to use for encrypting data in the
1036
+ # agent space.
1029
1037
  #
1030
1038
  # @option params [Hash<String,String>] :tags
1031
- # Tags to associate with the agent space
1039
+ # The tags to associate with the agent space.
1032
1040
  #
1033
1041
  # @return [Types::CreateAgentSpaceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1034
1042
  #
@@ -1110,21 +1118,23 @@ module Aws::SecurityAgent
1110
1118
  req.send_request(options)
1111
1119
  end
1112
1120
 
1113
- # Creates a new application
1121
+ # Creates a new application. An application is the top-level
1122
+ # organizational unit that supports IAM Identity Center integration.
1114
1123
  #
1115
1124
  # @option params [String] :idc_instance_arn
1116
- # ARN of the IAM Identity Center instance used for user authentication.
1117
- # Optional for non-IdC applications
1125
+ # The Amazon Resource Name (ARN) of the IAM Identity Center instance to
1126
+ # associate with the application.
1118
1127
  #
1119
1128
  # @option params [String] :role_arn
1120
- # ARN of the IAM role that the application uses to access AWS resources
1121
- # on your behalf
1129
+ # The Amazon Resource Name (ARN) of the IAM role to associate with the
1130
+ # application.
1122
1131
  #
1123
1132
  # @option params [String] :default_kms_key_id
1124
- # Default KMS key identifier used to encrypt application data
1133
+ # The identifier of the default AWS KMS key to use for encrypting data
1134
+ # in the application.
1125
1135
  #
1126
1136
  # @option params [Hash<String,String>] :tags
1127
- # Tags to associate with the application
1137
+ # The tags to associate with the application.
1128
1138
  #
1129
1139
  # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1130
1140
  #
@@ -1154,23 +1164,24 @@ module Aws::SecurityAgent
1154
1164
  req.send_request(options)
1155
1165
  end
1156
1166
 
1157
- # Creates the Integration of the Security Agent App with an external
1158
- # Provider
1167
+ # Creates a new integration with a third-party provider, such as GitHub,
1168
+ # for code review and remediation.
1159
1169
  #
1160
1170
  # @option params [required, String] :provider
1161
- # Provider to integrate with
1171
+ # The integration provider. Currently, only GITHUB is supported.
1162
1172
  #
1163
1173
  # @option params [required, Types::ProviderInput] :input
1164
- # Provider-specific input parameters
1174
+ # The provider-specific input required to create the integration.
1165
1175
  #
1166
1176
  # @option params [required, String] :integration_display_name
1167
- # Display name for the integration
1177
+ # The display name for the integration.
1168
1178
  #
1169
1179
  # @option params [String] :kms_key_id
1170
- # KMS key ID for encrypting integration details
1180
+ # The identifier of the AWS KMS key to use for encrypting data
1181
+ # associated with the integration.
1171
1182
  #
1172
1183
  # @option params [Hash<String,String>] :tags
1173
- # Tags to associate with the integration
1184
+ # The tags to associate with the integration.
1174
1185
  #
1175
1186
  # @return [Types::CreateIntegrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1176
1187
  #
@@ -1207,22 +1218,24 @@ module Aws::SecurityAgent
1207
1218
  req.send_request(options)
1208
1219
  end
1209
1220
 
1210
- # Adds a single member to an agent space with specified role
1221
+ # Creates a new membership, granting a user access to an agent space
1222
+ # within an application.
1211
1223
  #
1212
1224
  # @option params [required, String] :application_id
1213
- # Application identifier
1225
+ # The unique identifier of the application that contains the agent
1226
+ # space.
1214
1227
  #
1215
1228
  # @option params [required, String] :agent_space_id
1216
- # Agent space identifier
1229
+ # The unique identifier of the agent space to grant access to.
1217
1230
  #
1218
1231
  # @option params [required, String] :membership_id
1219
- # Member identifier (userId or agentSpaceId)
1232
+ # The unique identifier for the membership.
1220
1233
  #
1221
1234
  # @option params [required, String] :member_type
1222
- # Type of member (USER or AGENT\_SPACE)
1235
+ # The type of member. Currently, only USER is supported.
1223
1236
  #
1224
1237
  # @option params [Types::MembershipConfig] :config
1225
- # Membership details (user or agent specific)
1238
+ # The configuration for the membership, such as the user role.
1226
1239
  #
1227
1240
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1228
1241
  #
@@ -1249,35 +1262,39 @@ module Aws::SecurityAgent
1249
1262
  req.send_request(options)
1250
1263
  end
1251
1264
 
1252
- # Creates a new pentest configuration
1265
+ # Creates a new pentest configuration in an agent space. A pentest
1266
+ # defines the security test parameters, including target assets, risk
1267
+ # type exclusions, and logging configuration.
1253
1268
  #
1254
1269
  # @option params [required, String] :title
1255
- # Title of the pentest
1270
+ # The title of the pentest.
1256
1271
  #
1257
1272
  # @option params [required, String] :agent_space_id
1258
- # ID of the agent space where the pentest should be created
1273
+ # The unique identifier of the agent space to create the pentest in.
1259
1274
  #
1260
1275
  # @option params [Types::Assets] :assets
1261
- # Assets to be tested during the pentest
1276
+ # The assets to include in the pentest, such as endpoints, actors,
1277
+ # documents, and source code.
1262
1278
  #
1263
1279
  # @option params [Array<String>] :exclude_risk_types
1264
- # A list of risk types excluded from the pentest execution
1280
+ # The list of risk types to exclude from the pentest.
1265
1281
  #
1266
1282
  # @option params [String] :service_role
1267
- # Service role ARN for accessing customer resources
1283
+ # The IAM service role to use for the pentest.
1268
1284
  #
1269
1285
  # @option params [Types::CloudWatchLog] :log_config
1270
- # CloudWatch log group and stream prefix where pentest execution logs
1271
- # are stored
1286
+ # The CloudWatch Logs configuration for the pentest.
1272
1287
  #
1273
1288
  # @option params [Types::VpcConfig] :vpc_config
1274
- # VPC configuration that the Security Agent accesses
1289
+ # The VPC configuration for the pentest.
1275
1290
  #
1276
1291
  # @option params [Types::NetworkTrafficConfig] :network_traffic_config
1277
- # Configuration for network traffic filtering
1292
+ # The network traffic configuration for the pentest, including custom
1293
+ # headers and traffic rules.
1278
1294
  #
1279
1295
  # @option params [String] :code_remediation_strategy
1280
- # Strategy for code remediation on findings
1296
+ # The code remediation strategy for the pentest. Valid values are
1297
+ # AUTOMATIC and DISABLED.
1281
1298
  #
1282
1299
  # @return [Types::CreatePentestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1283
1300
  #
@@ -1399,22 +1416,26 @@ module Aws::SecurityAgent
1399
1416
  req.send_request(options)
1400
1417
  end
1401
1418
 
1402
- # Creates a target domain record
1419
+ # Creates a new target domain for penetration testing. A target domain
1420
+ # is a web domain that must be registered and verified before it can be
1421
+ # tested.
1403
1422
  #
1404
1423
  # @option params [required, String] :target_domain_name
1405
- # Domain name of the target domain
1424
+ # The domain name to register as a target domain.
1406
1425
  #
1407
1426
  # @option params [required, String] :verification_method
1408
- # Verification method for the target domain
1427
+ # The method to use for verifying domain ownership. Valid values are
1428
+ # DNS\_TXT, HTTP\_ROUTE, and PRIVATE\_VPC.
1409
1429
  #
1410
1430
  # @option params [Hash<String,String>] :tags
1411
- # Tags to associate with the target domain
1431
+ # The tags to associate with the target domain.
1412
1432
  #
1413
1433
  # @return [Types::CreateTargetDomainOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1414
1434
  #
1415
1435
  # * {Types::CreateTargetDomainOutput#target_domain_id #target_domain_id} => String
1416
1436
  # * {Types::CreateTargetDomainOutput#domain_name #domain_name} => String
1417
1437
  # * {Types::CreateTargetDomainOutput#verification_status #verification_status} => String
1438
+ # * {Types::CreateTargetDomainOutput#verification_status_reason #verification_status_reason} => String
1418
1439
  # * {Types::CreateTargetDomainOutput#verification_details #verification_details} => Types::VerificationDetails
1419
1440
  # * {Types::CreateTargetDomainOutput#created_at #created_at} => Time
1420
1441
  # * {Types::CreateTargetDomainOutput#verified_at #verified_at} => Time
@@ -1423,7 +1444,7 @@ module Aws::SecurityAgent
1423
1444
  #
1424
1445
  # resp = client.create_target_domain({
1425
1446
  # target_domain_name: "String", # required
1426
- # verification_method: "DNS_TXT", # required, accepts DNS_TXT, HTTP_ROUTE
1447
+ # verification_method: "DNS_TXT", # required, accepts DNS_TXT, HTTP_ROUTE, PRIVATE_VPC
1427
1448
  # tags: {
1428
1449
  # "TagKey" => "TagValue",
1429
1450
  # },
@@ -1434,7 +1455,8 @@ module Aws::SecurityAgent
1434
1455
  # resp.target_domain_id #=> String
1435
1456
  # resp.domain_name #=> String
1436
1457
  # resp.verification_status #=> String, one of "PENDING", "VERIFIED", "FAILED", "UNREACHABLE"
1437
- # resp.verification_details.method #=> String, one of "DNS_TXT", "HTTP_ROUTE"
1458
+ # resp.verification_status_reason #=> String
1459
+ # resp.verification_details.method #=> String, one of "DNS_TXT", "HTTP_ROUTE", "PRIVATE_VPC"
1438
1460
  # resp.verification_details.dns_txt.token #=> String
1439
1461
  # resp.verification_details.dns_txt.dns_record_name #=> String
1440
1462
  # resp.verification_details.dns_txt.dns_record_type #=> String, one of "TXT"
@@ -1452,10 +1474,11 @@ module Aws::SecurityAgent
1452
1474
  req.send_request(options)
1453
1475
  end
1454
1476
 
1455
- # Deletes an agent space record
1477
+ # Deletes an agent space and all of its associated resources, including
1478
+ # pentests, findings, and artifacts.
1456
1479
  #
1457
1480
  # @option params [required, String] :agent_space_id
1458
- # Unique identifier of the agent space to delete
1481
+ # The unique identifier of the agent space to delete.
1459
1482
  #
1460
1483
  # @return [Types::DeleteAgentSpaceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1461
1484
  #
@@ -1480,10 +1503,11 @@ module Aws::SecurityAgent
1480
1503
  req.send_request(options)
1481
1504
  end
1482
1505
 
1483
- # Deletes an application
1506
+ # Deletes an application and its associated configuration, including IAM
1507
+ # Identity Center settings.
1484
1508
  #
1485
1509
  # @option params [required, String] :application_id
1486
- # Application ID
1510
+ # The unique identifier of the application to delete.
1487
1511
  #
1488
1512
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1489
1513
  #
@@ -1502,13 +1526,13 @@ module Aws::SecurityAgent
1502
1526
  req.send_request(options)
1503
1527
  end
1504
1528
 
1505
- # Delete an Artifact from the given agent space
1529
+ # Deletes an artifact from an agent space.
1506
1530
  #
1507
1531
  # @option params [required, String] :agent_space_id
1508
- # Unique identifier of the agent space
1532
+ # The unique identifier of the agent space that contains the artifact.
1509
1533
  #
1510
1534
  # @option params [required, String] :artifact_id
1511
- # Unique identifier of the artifact
1535
+ # The unique identifier of the artifact to delete.
1512
1536
  #
1513
1537
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1514
1538
  #
@@ -1528,11 +1552,10 @@ module Aws::SecurityAgent
1528
1552
  req.send_request(options)
1529
1553
  end
1530
1554
 
1531
- # Deletes the Integration of the Security Agent App with an external
1532
- # Provider
1555
+ # Deletes an integration with a third-party provider.
1533
1556
  #
1534
1557
  # @option params [required, String] :integration_id
1535
- # Unique identifier of the integration
1558
+ # The unique identifier of the integration to delete.
1536
1559
  #
1537
1560
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1538
1561
  #
@@ -1551,19 +1574,20 @@ module Aws::SecurityAgent
1551
1574
  req.send_request(options)
1552
1575
  end
1553
1576
 
1554
- # Removes a single member associated to an agent space
1577
+ # Deletes a membership, revoking a user's access to an agent space.
1555
1578
  #
1556
1579
  # @option params [required, String] :application_id
1557
- # Application identifier
1580
+ # The unique identifier of the application that contains the agent
1581
+ # space.
1558
1582
  #
1559
1583
  # @option params [required, String] :agent_space_id
1560
- # Agent space identifier
1584
+ # The unique identifier of the agent space to revoke access from.
1561
1585
  #
1562
1586
  # @option params [required, String] :membership_id
1563
- # Member identifier (userId or agentSpaceId)
1587
+ # The unique identifier of the membership to delete.
1564
1588
  #
1565
1589
  # @option params [String] :member_type
1566
- # Type of member (USER or AGENT\_SPACE)
1590
+ # The type of member to remove.
1567
1591
  #
1568
1592
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1569
1593
  #
@@ -1585,10 +1609,11 @@ module Aws::SecurityAgent
1585
1609
  req.send_request(options)
1586
1610
  end
1587
1611
 
1588
- # Deletes a target domain record
1612
+ # Deletes a target domain registration. After deletion, the domain can
1613
+ # no longer be used for penetration testing.
1589
1614
  #
1590
1615
  # @option params [required, String] :target_domain_id
1591
- # Unique identifier of the target domain to delete
1616
+ # The unique identifier of the target domain to delete.
1592
1617
  #
1593
1618
  # @return [Types::DeleteTargetDomainOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1594
1619
  #
@@ -1613,10 +1638,10 @@ module Aws::SecurityAgent
1613
1638
  req.send_request(options)
1614
1639
  end
1615
1640
 
1616
- # Retrieves application details by application ID
1641
+ # Retrieves information about an application.
1617
1642
  #
1618
1643
  # @option params [required, String] :application_id
1619
- # Application ID
1644
+ # The unique identifier of the application to retrieve.
1620
1645
  #
1621
1646
  # @return [Types::GetApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1622
1647
  #
@@ -1652,13 +1677,13 @@ module Aws::SecurityAgent
1652
1677
  req.send_request(options)
1653
1678
  end
1654
1679
 
1655
- # Retrieve an Artifact for the given agent space
1680
+ # Retrieves an artifact from an agent space.
1656
1681
  #
1657
1682
  # @option params [required, String] :agent_space_id
1658
- # Unique identifier of the agent space
1683
+ # The unique identifier of the agent space that contains the artifact.
1659
1684
  #
1660
1685
  # @option params [required, String] :artifact_id
1661
- # Unique identifier of the artifact
1686
+ # The unique identifier of the artifact to retrieve.
1662
1687
  #
1663
1688
  # @return [Types::GetArtifactOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1664
1689
  #
@@ -1693,10 +1718,10 @@ module Aws::SecurityAgent
1693
1718
  req.send_request(options)
1694
1719
  end
1695
1720
 
1696
- # Gets Integration metadata from the provided id
1721
+ # Retrieves information about an integration.
1697
1722
  #
1698
1723
  # @option params [required, String] :integration_id
1699
- # Unique identifier of the integration
1724
+ # The unique identifier of the integration to retrieve.
1700
1725
  #
1701
1726
  # @return [Types::GetIntegrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1702
1727
  #
@@ -1731,11 +1756,13 @@ module Aws::SecurityAgent
1731
1756
  req.send_request(options)
1732
1757
  end
1733
1758
 
1734
- # Initiates the registration of Security Agent App for an external
1735
- # Provider
1759
+ # Initiates the OAuth registration flow with a third-party provider.
1760
+ # Returns a redirect URL and CSRF state token for completing the
1761
+ # authorization.
1736
1762
  #
1737
1763
  # @option params [required, String] :provider
1738
- # Provider to register with
1764
+ # The provider to initiate registration with. Currently, only GITHUB is
1765
+ # supported.
1739
1766
  #
1740
1767
  # @return [Types::InitiateProviderRegistrationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1741
1768
  #
@@ -1762,13 +1789,16 @@ module Aws::SecurityAgent
1762
1789
  req.send_request(options)
1763
1790
  end
1764
1791
 
1765
- # Lists agent spaces
1792
+ # Returns a paginated list of agent space summaries in your account.
1766
1793
  #
1767
1794
  # @option params [String] :next_token
1768
- # Token for pagination
1795
+ # A token to use for paginating results that are returned in the
1796
+ # response. Set the value of this parameter to null for the first
1797
+ # request. For subsequent calls, use the nextToken value returned from
1798
+ # the previous request.
1769
1799
  #
1770
1800
  # @option params [Integer] :max_results
1771
- # Maximum number of agent spaces to return
1801
+ # The maximum number of results to return in a single call.
1772
1802
  #
1773
1803
  # @return [Types::ListAgentSpacesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1774
1804
  #
@@ -1802,13 +1832,16 @@ module Aws::SecurityAgent
1802
1832
  req.send_request(options)
1803
1833
  end
1804
1834
 
1805
- # Lists all applications in the account
1835
+ # Returns a paginated list of application summaries in your account.
1806
1836
  #
1807
1837
  # @option params [String] :next_token
1808
- # Token for pagination
1838
+ # A token to use for paginating results that are returned in the
1839
+ # response. Set the value of this parameter to null for the first
1840
+ # request. For subsequent calls, use the nextToken value returned from
1841
+ # the previous request.
1809
1842
  #
1810
1843
  # @option params [Integer] :max_results
1811
- # Maximum number of results to return
1844
+ # The maximum number of results to return in a single call.
1812
1845
  #
1813
1846
  # @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1814
1847
  #
@@ -1842,16 +1875,20 @@ module Aws::SecurityAgent
1842
1875
  req.send_request(options)
1843
1876
  end
1844
1877
 
1845
- # Lists the artifacts for the associated agent space
1878
+ # Returns a paginated list of artifact summaries for the specified agent
1879
+ # space.
1846
1880
  #
1847
1881
  # @option params [required, String] :agent_space_id
1848
- # Unique identifier of the agent space
1882
+ # The unique identifier of the agent space to list artifacts for.
1849
1883
  #
1850
1884
  # @option params [String] :next_token
1851
- # Token for pagination
1885
+ # A token to use for paginating results that are returned in the
1886
+ # response. Set the value of this parameter to null for the first
1887
+ # request. For subsequent calls, use the nextToken value returned from
1888
+ # the previous request.
1852
1889
  #
1853
1890
  # @option params [Integer] :max_results
1854
- # Maximum number of results to return
1891
+ # The maximum number of results to return in a single call.
1855
1892
  #
1856
1893
  # @return [Types::ListArtifactsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1857
1894
  #
@@ -1885,25 +1922,27 @@ module Aws::SecurityAgent
1885
1922
  req.send_request(options)
1886
1923
  end
1887
1924
 
1888
- # Lists discovered endpoints associated with a pentest job with optional
1889
- # URI prefix filtering
1925
+ # Returns a paginated list of endpoints discovered during a pentest job
1926
+ # execution.
1890
1927
  #
1891
1928
  # @option params [Integer] :max_results
1892
- # Maximum number of discovered endpoints to return in a single request
1893
- # (default: 50)
1929
+ # The maximum number of results to return in a single call.
1894
1930
  #
1895
1931
  # @option params [required, String] :pentest_job_id
1896
- # Identifier of the pentest job for which to retrieve discovered
1897
- # endpoints
1932
+ # The unique identifier of the pentest job to list discovered endpoints
1933
+ # for.
1898
1934
  #
1899
1935
  # @option params [required, String] :agent_space_id
1900
- # ID of the agent space where the pentest job exists
1936
+ # The unique identifier of the agent space.
1901
1937
  #
1902
1938
  # @option params [String] :prefix
1903
- # Optional URI prefix filter to narrow down results
1939
+ # A prefix to filter discovered endpoints by URI.
1904
1940
  #
1905
1941
  # @option params [String] :next_token
1906
- # Token for pagination
1942
+ # A token to use for paginating results that are returned in the
1943
+ # response. Set the value of this parameter to null for the first
1944
+ # request. For subsequent calls, use the nextToken value returned from
1945
+ # the previous request.
1907
1946
  #
1908
1947
  # @return [Types::ListDiscoveredEndpointsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1909
1948
  #
@@ -1943,37 +1982,37 @@ module Aws::SecurityAgent
1943
1982
  req.send_request(options)
1944
1983
  end
1945
1984
 
1946
- # Lists findings with filtering and pagination support. When filters are
1947
- # applied, the actual number of results returned may be less than the
1948
- # specified limit
1985
+ # Lists the security findings for a pentest job.
1949
1986
  #
1950
1987
  # @option params [Integer] :max_results
1951
- # Maximum number of findings to return in a single request (default: 50)
1988
+ # The maximum number of results to return in a single call.
1952
1989
  #
1953
1990
  # @option params [required, String] :pentest_job_id
1954
- # Identifier of the pentest job for which to retrieve associated
1955
- # findings
1991
+ # The unique identifier of the pentest job to list findings for.
1956
1992
  #
1957
1993
  # @option params [required, String] :agent_space_id
1958
- # ID of the agent space where the pentest job exists
1994
+ # The unique identifier of the agent space.
1959
1995
  #
1960
1996
  # @option params [String] :next_token
1961
- # Token for pagination
1997
+ # A token to use for paginating results that are returned in the
1998
+ # response. Set the value of this parameter to null for the first
1999
+ # request. For subsequent calls, use the nextToken value returned from
2000
+ # the previous request.
1962
2001
  #
1963
2002
  # @option params [String] :risk_type
1964
- # Filter findings by risk type
2003
+ # Filter findings by risk type.
1965
2004
  #
1966
2005
  # @option params [String] :risk_level
1967
- # Filter findings by risk level
2006
+ # Filter findings by risk level.
1968
2007
  #
1969
2008
  # @option params [String] :status
1970
- # Filter findings by status
2009
+ # Filter findings by status.
1971
2010
  #
1972
2011
  # @option params [String] :confidence
1973
- # Filter findings by confidence level
2012
+ # Filter findings by confidence level.
1974
2013
  #
1975
2014
  # @option params [String] :name
1976
- # Filter findings by name (case-insensitive substring search)
2015
+ # Filter findings by name.
1977
2016
  #
1978
2017
  # @return [Types::ListFindingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1979
2018
  #
@@ -2021,22 +2060,27 @@ module Aws::SecurityAgent
2021
2060
  req.send_request(options)
2022
2061
  end
2023
2062
 
2024
- # Lists the integrated resources for an agent space
2063
+ # Lists the integrated resources for an agent space, optionally filtered
2064
+ # by integration or resource type.
2025
2065
  #
2026
2066
  # @option params [required, String] :agent_space_id
2027
- # Unique identifier of the agent space
2067
+ # The unique identifier of the agent space to list integrated resources
2068
+ # for.
2028
2069
  #
2029
2070
  # @option params [String] :integration_id
2030
- # Filter integrated resources by a specific integration
2071
+ # The unique identifier of the integration to filter by.
2031
2072
  #
2032
2073
  # @option params [String] :resource_type
2033
- # Filter integrated resources by resource type
2074
+ # The type of resource to filter by.
2034
2075
  #
2035
2076
  # @option params [String] :next_token
2036
- # Token for pagination
2077
+ # A token to use for paginating results that are returned in the
2078
+ # response. Set the value of this parameter to null for the first
2079
+ # request. For subsequent calls, use the nextToken value returned from
2080
+ # the previous request.
2037
2081
  #
2038
2082
  # @option params [Integer] :max_results
2039
- # Maximum number of results to return
2083
+ # The maximum number of results to return in a single call.
2040
2084
  #
2041
2085
  # @return [Types::ListIntegratedResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2042
2086
  #
@@ -2076,16 +2120,20 @@ module Aws::SecurityAgent
2076
2120
  req.send_request(options)
2077
2121
  end
2078
2122
 
2079
- # Retrieves the Integrations associated with the user's account
2123
+ # Lists the integrations in your account, optionally filtered by
2124
+ # provider or provider type.
2080
2125
  #
2081
2126
  # @option params [Types::IntegrationFilter] :filter
2082
- # Filter criteria for integrations
2127
+ # A filter to apply to the list of integrations.
2083
2128
  #
2084
2129
  # @option params [String] :next_token
2085
- # Token for pagination
2130
+ # A token to use for paginating results that are returned in the
2131
+ # response. Set the value of this parameter to null for the first
2132
+ # request. For subsequent calls, use the nextToken value returned from
2133
+ # the previous request.
2086
2134
  #
2087
2135
  # @option params [Integer] :max_results
2088
- # Maximum number of results to return
2136
+ # The maximum number of results to return in a single call.
2089
2137
  #
2090
2138
  # @return [Types::ListIntegrationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2091
2139
  #
@@ -2124,22 +2172,27 @@ module Aws::SecurityAgent
2124
2172
  req.send_request(options)
2125
2173
  end
2126
2174
 
2127
- # Lists all members associated to an agent space with pagination support
2175
+ # Returns a paginated list of membership summaries for the specified
2176
+ # agent space within an application.
2128
2177
  #
2129
2178
  # @option params [required, String] :application_id
2130
- # Application identifier
2179
+ # The unique identifier of the application that contains the agent
2180
+ # space.
2131
2181
  #
2132
2182
  # @option params [required, String] :agent_space_id
2133
- # Agent space identifier
2183
+ # The unique identifier of the agent space to list memberships for.
2134
2184
  #
2135
2185
  # @option params [String] :member_type
2136
- # Filter by member type
2186
+ # Filter memberships by member type.
2137
2187
  #
2138
2188
  # @option params [Integer] :max_results
2139
- # Maximum number of results to return
2189
+ # The maximum number of results to return in a single call.
2140
2190
  #
2141
2191
  # @option params [String] :next_token
2142
- # Token for pagination
2192
+ # A token to use for paginating results that are returned in the
2193
+ # response. Set the value of this parameter to null for the first
2194
+ # request. For subsequent calls, use the nextToken value returned from
2195
+ # the previous request.
2143
2196
  #
2144
2197
  # @return [Types::ListMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2145
2198
  #
@@ -2183,25 +2236,30 @@ module Aws::SecurityAgent
2183
2236
  req.send_request(options)
2184
2237
  end
2185
2238
 
2186
- # Lists tasks associated with a specific pentest job
2239
+ # Returns a paginated list of task summaries for the specified pentest
2240
+ # job, optionally filtered by step name or category.
2187
2241
  #
2188
2242
  # @option params [required, String] :agent_space_id
2189
- # ID of the agent space where the pentest exists
2243
+ # The unique identifier of the agent space.
2190
2244
  #
2191
2245
  # @option params [Integer] :max_results
2192
- # Maximum number of tasks to return in a single request
2246
+ # The maximum number of results to return in a single call.
2193
2247
  #
2194
2248
  # @option params [String] :pentest_job_id
2195
- # Identifier of the pentest job whose tasks to list
2249
+ # The unique identifier of the pentest job to list tasks for.
2196
2250
  #
2197
2251
  # @option params [String] :step_name
2198
- # Filter tasks by step name
2252
+ # Filter tasks by step name. Valid values include PREFLIGHT,
2253
+ # STATIC\_ANALYSIS, PENTEST, and FINALIZING.
2199
2254
  #
2200
2255
  # @option params [String] :category_name
2201
2256
  # Filter tasks by category name.
2202
2257
  #
2203
2258
  # @option params [String] :next_token
2204
- # Token for pagination to retrieve the next set of results
2259
+ # A token to use for paginating results that are returned in the
2260
+ # response. Set the value of this parameter to null for the first
2261
+ # request. For subsequent calls, use the nextToken value returned from
2262
+ # the previous request.
2205
2263
  #
2206
2264
  # @return [Types::ListPentestJobTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2207
2265
  #
@@ -2244,19 +2302,23 @@ module Aws::SecurityAgent
2244
2302
  req.send_request(options)
2245
2303
  end
2246
2304
 
2247
- # Lists pentest jobs associated with a pentest
2305
+ # Returns a paginated list of pentest job summaries for the specified
2306
+ # pentest configuration.
2248
2307
  #
2249
2308
  # @option params [Integer] :max_results
2250
- # Maximum number of pentest jobs to return in a single request
2309
+ # The maximum number of results to return in a single call.
2251
2310
  #
2252
2311
  # @option params [required, String] :pentest_id
2253
- # Identifier of the pentest for which to retrieve associated jobs
2312
+ # The unique identifier of the pentest to list jobs for.
2254
2313
  #
2255
2314
  # @option params [required, String] :agent_space_id
2256
- # ID of the agent space where the pentest exists
2315
+ # The unique identifier of the agent space.
2257
2316
  #
2258
2317
  # @option params [String] :next_token
2259
- # Token for pagination
2318
+ # A token to use for paginating results that are returned in the
2319
+ # response. Set the value of this parameter to null for the first
2320
+ # request. For subsequent calls, use the nextToken value returned from
2321
+ # the previous request.
2260
2322
  #
2261
2323
  # @return [Types::ListPentestJobsForPentestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2262
2324
  #
@@ -2294,16 +2356,20 @@ module Aws::SecurityAgent
2294
2356
  req.send_request(options)
2295
2357
  end
2296
2358
 
2297
- # Lists pentests with optional filtering by status
2359
+ # Returns a paginated list of pentest summaries for the specified agent
2360
+ # space.
2298
2361
  #
2299
2362
  # @option params [Integer] :max_results
2300
- # Maximum number of pentests to return in a single request
2363
+ # The maximum number of results to return in a single call.
2301
2364
  #
2302
2365
  # @option params [String] :next_token
2303
- # Token for pagination
2366
+ # A token to use for paginating results that are returned in the
2367
+ # response. Set the value of this parameter to null for the first
2368
+ # request. For subsequent calls, use the nextToken value returned from
2369
+ # the previous request.
2304
2370
  #
2305
2371
  # @option params [required, String] :agent_space_id
2306
- # ID of the agent space where the pentest exists
2372
+ # The unique identifier of the agent space to list pentests for.
2307
2373
  #
2308
2374
  # @return [Types::ListPentestsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2309
2375
  #
@@ -2339,10 +2405,10 @@ module Aws::SecurityAgent
2339
2405
  req.send_request(options)
2340
2406
  end
2341
2407
 
2342
- # Lists tags for a Security Agent resource
2408
+ # Returns the tags associated with the specified resource.
2343
2409
  #
2344
2410
  # @option params [required, String] :resource_arn
2345
- # ARN of the resource to list tags for
2411
+ # The Amazon Resource Name (ARN) of the resource to list tags for.
2346
2412
  #
2347
2413
  # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2348
2414
  #
@@ -2368,13 +2434,16 @@ module Aws::SecurityAgent
2368
2434
  req.send_request(options)
2369
2435
  end
2370
2436
 
2371
- # Lists target domains
2437
+ # Returns a paginated list of target domain summaries in your account.
2372
2438
  #
2373
2439
  # @option params [String] :next_token
2374
- # Token for pagination
2440
+ # A token to use for paginating results that are returned in the
2441
+ # response. Set the value of this parameter to null for the first
2442
+ # request. For subsequent calls, use the nextToken value returned from
2443
+ # the previous request.
2375
2444
  #
2376
2445
  # @option params [Integer] :max_results
2377
- # Maximum number of target domains to return
2446
+ # The maximum number of results to return in a single call.
2378
2447
  #
2379
2448
  # @return [Types::ListTargetDomainsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2380
2449
  #
@@ -2407,16 +2476,18 @@ module Aws::SecurityAgent
2407
2476
  req.send_request(options)
2408
2477
  end
2409
2478
 
2410
- # Starts code remediation for the specified findings
2479
+ # Initiates code remediation for one or more security findings. This
2480
+ # creates pull requests in integrated repositories to fix the identified
2481
+ # vulnerabilities.
2411
2482
  #
2412
2483
  # @option params [required, String] :agent_space_id
2413
- # ID of the agent space where the pentest job exists
2484
+ # The unique identifier of the agent space.
2414
2485
  #
2415
2486
  # @option params [required, String] :pentest_job_id
2416
- # Identifier of the pentest job to start code remediation for
2487
+ # The unique identifier of the pentest job that produced the findings.
2417
2488
  #
2418
2489
  # @option params [required, Array<String>] :finding_ids
2419
- # Identifiers of the findings to start code remediation for
2490
+ # The list of finding identifiers to initiate code remediation for.
2420
2491
  #
2421
2492
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2422
2493
  #
@@ -2437,13 +2508,14 @@ module Aws::SecurityAgent
2437
2508
  req.send_request(options)
2438
2509
  end
2439
2510
 
2440
- # Initiates the execution of a pentest
2511
+ # Starts a new pentest job for a pentest configuration. The job executes
2512
+ # the security tests defined in the pentest.
2441
2513
  #
2442
2514
  # @option params [required, String] :agent_space_id
2443
- # ID of the agent space where the pentest exists
2515
+ # The unique identifier of the agent space.
2444
2516
  #
2445
2517
  # @option params [required, String] :pentest_id
2446
- # Identifier of the pentest to execute
2518
+ # The unique identifier of the pentest to start a job for.
2447
2519
  #
2448
2520
  # @return [Types::StartPentestJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2449
2521
  #
@@ -2481,13 +2553,14 @@ module Aws::SecurityAgent
2481
2553
  req.send_request(options)
2482
2554
  end
2483
2555
 
2484
- # Stops the execution of a running pentest
2556
+ # Stops a running pentest job. The job transitions to a stopping state
2557
+ # and then to stopped after cleanup completes.
2485
2558
  #
2486
2559
  # @option params [required, String] :agent_space_id
2487
- # ID of the agent space where the pentest exists
2560
+ # The unique identifier of the agent space.
2488
2561
  #
2489
2562
  # @option params [required, String] :pentest_job_id
2490
- # Identifier of the pentest job to stop
2563
+ # The unique identifier of the pentest job to stop.
2491
2564
  #
2492
2565
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2493
2566
  #
@@ -2507,13 +2580,13 @@ module Aws::SecurityAgent
2507
2580
  req.send_request(options)
2508
2581
  end
2509
2582
 
2510
- # Adds tags to a Security Agent resource
2583
+ # Adds tags to a resource.
2511
2584
  #
2512
2585
  # @option params [required, String] :resource_arn
2513
- # ARN of the resource to tag
2586
+ # The Amazon Resource Name (ARN) of the resource to tag.
2514
2587
  #
2515
2588
  # @option params [required, Hash<String,String>] :tags
2516
- # Tags to add to the resource
2589
+ # The tags to add to the resource.
2517
2590
  #
2518
2591
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2519
2592
  #
@@ -2535,13 +2608,13 @@ module Aws::SecurityAgent
2535
2608
  req.send_request(options)
2536
2609
  end
2537
2610
 
2538
- # Removes tags from a Security Agent resource
2611
+ # Removes tags from a resource.
2539
2612
  #
2540
2613
  # @option params [required, String] :resource_arn
2541
- # ARN of the resource to untag
2614
+ # The Amazon Resource Name (ARN) of the resource to remove tags from.
2542
2615
  #
2543
2616
  # @option params [required, Array<String>] :tag_keys
2544
- # List of tag keys to remove from the resource
2617
+ # The list of tag keys to remove from the resource.
2545
2618
  #
2546
2619
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2547
2620
  #
@@ -2561,26 +2634,28 @@ module Aws::SecurityAgent
2561
2634
  req.send_request(options)
2562
2635
  end
2563
2636
 
2564
- # Updates an agent space record
2637
+ # Updates the configuration of an existing agent space, including its
2638
+ # name, description, AWS resources, target domains, and code review
2639
+ # settings.
2565
2640
  #
2566
2641
  # @option params [required, String] :agent_space_id
2567
- # ID of the agent space to update
2642
+ # The unique identifier of the agent space to update.
2568
2643
  #
2569
2644
  # @option params [String] :name
2570
- # Name of the agent space
2645
+ # The updated name of the agent space.
2571
2646
  #
2572
2647
  # @option params [String] :description
2573
- # Description of the agent space
2648
+ # The updated description of the agent space.
2574
2649
  #
2575
2650
  # @option params [Types::AWSResources] :aws_resources
2576
- # AWS resource configurations associated with the agent space
2651
+ # The updated AWS resources to associate with the agent space.
2577
2652
  #
2578
2653
  # @option params [Array<String>] :target_domain_ids
2579
- # Target domain IDs to associate with the agent space
2654
+ # The updated list of target domain identifiers to associate with the
2655
+ # agent space.
2580
2656
  #
2581
2657
  # @option params [Types::CodeReviewSettings] :code_review_settings
2582
- # Configuration for code review analysis, including controls scanning
2583
- # and general purpose scanning settings
2658
+ # The updated code review settings for the agent space.
2584
2659
  #
2585
2660
  # @return [Types::UpdateAgentSpaceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2586
2661
  #
@@ -2657,18 +2732,18 @@ module Aws::SecurityAgent
2657
2732
  req.send_request(options)
2658
2733
  end
2659
2734
 
2660
- # Updates application configuration
2735
+ # Updates the configuration of an existing application, including the
2736
+ # IAM role and default KMS key.
2661
2737
  #
2662
2738
  # @option params [required, String] :application_id
2663
- # Application ID
2739
+ # The unique identifier of the application to update.
2664
2740
  #
2665
2741
  # @option params [String] :role_arn
2666
- # ARN of the IAM role that the application uses to access AWS resources
2667
- # on your behalf
2742
+ # The updated Amazon Resource Name (ARN) of the IAM role for the
2743
+ # application.
2668
2744
  #
2669
2745
  # @option params [String] :default_kms_key_id
2670
- # Default KMS key identifier. Use an empty string to remove the default
2671
- # KMS key.
2746
+ # The updated identifier of the default AWS KMS key for the application.
2672
2747
  #
2673
2748
  # @return [Types::UpdateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2674
2749
  #
@@ -2695,19 +2770,19 @@ module Aws::SecurityAgent
2695
2770
  req.send_request(options)
2696
2771
  end
2697
2772
 
2698
- # Updates an existing security finding with new details or status
2773
+ # Updates the status or risk level of a security finding.
2699
2774
  #
2700
2775
  # @option params [required, String] :finding_id
2701
- # Identifier of the finding to update
2776
+ # The unique identifier of the finding to update.
2702
2777
  #
2703
2778
  # @option params [required, String] :agent_space_id
2704
- # ID of the agent space where the finding exists
2779
+ # The unique identifier of the agent space that contains the finding.
2705
2780
  #
2706
2781
  # @option params [String] :risk_level
2707
- # Updated severity level of the identified risk
2782
+ # The updated risk level for the finding.
2708
2783
  #
2709
2784
  # @option params [String] :status
2710
- # Updated status of the finding
2785
+ # The updated status for the finding.
2711
2786
  #
2712
2787
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2713
2788
  #
@@ -2729,16 +2804,17 @@ module Aws::SecurityAgent
2729
2804
  req.send_request(options)
2730
2805
  end
2731
2806
 
2732
- # Updates the integrated resources for an agent space
2807
+ # Updates the integrated resources for an agent space, including their
2808
+ # capabilities.
2733
2809
  #
2734
2810
  # @option params [required, String] :agent_space_id
2735
- # Unique identifier of the agent space
2811
+ # The unique identifier of the agent space.
2736
2812
  #
2737
2813
  # @option params [required, String] :integration_id
2738
- # Unique identifier of the integration
2814
+ # The unique identifier of the integration.
2739
2815
  #
2740
2816
  # @option params [required, Array<Types::IntegratedResourceInputItem>] :items
2741
- # List of integrated resources to update
2817
+ # The list of integrated resource items to update.
2742
2818
  #
2743
2819
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2744
2820
  #
@@ -2774,38 +2850,37 @@ module Aws::SecurityAgent
2774
2850
  req.send_request(options)
2775
2851
  end
2776
2852
 
2777
- # Updates an existing pentest with new configuration or settings
2853
+ # Updates an existing pentest configuration.
2778
2854
  #
2779
2855
  # @option params [required, String] :pentest_id
2780
- # Identifier of the pentest to update
2856
+ # The unique identifier of the pentest to update.
2781
2857
  #
2782
2858
  # @option params [required, String] :agent_space_id
2783
- # ID of the agent space where the pentest exists
2859
+ # The unique identifier of the agent space that contains the pentest.
2784
2860
  #
2785
2861
  # @option params [String] :title
2786
- # New title for the pentest
2862
+ # The updated title of the pentest.
2787
2863
  #
2788
2864
  # @option params [Types::Assets] :assets
2789
- # Updated assets to be tested
2865
+ # The updated assets for the pentest.
2790
2866
  #
2791
2867
  # @option params [Array<String>] :exclude_risk_types
2792
- # A list of risk types excluded from the pentest execution
2868
+ # The updated list of risk types to exclude from the pentest.
2793
2869
  #
2794
2870
  # @option params [String] :service_role
2795
- # Updated service role ARN for accessing customer resources
2871
+ # The updated IAM service role for the pentest.
2796
2872
  #
2797
2873
  # @option params [Types::CloudWatchLog] :log_config
2798
- # CloudWatch log group and stream prefix where pentest execution logs
2799
- # are stored
2874
+ # The updated CloudWatch Logs configuration for the pentest.
2800
2875
  #
2801
2876
  # @option params [Types::VpcConfig] :vpc_config
2802
- # VPC configuration that the Security Agent accesses
2877
+ # The updated VPC configuration for the pentest.
2803
2878
  #
2804
2879
  # @option params [Types::NetworkTrafficConfig] :network_traffic_config
2805
- # Configuration for network traffic filtering
2880
+ # The updated network traffic configuration for the pentest.
2806
2881
  #
2807
2882
  # @option params [String] :code_remediation_strategy
2808
- # Strategy for code remediation on findings
2883
+ # The updated code remediation strategy for the pentest.
2809
2884
  #
2810
2885
  # @return [Types::UpdatePentestOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2811
2886
  #
@@ -2928,19 +3003,20 @@ module Aws::SecurityAgent
2928
3003
  req.send_request(options)
2929
3004
  end
2930
3005
 
2931
- # Updates a target domain record
3006
+ # Updates the verification method for a target domain.
2932
3007
  #
2933
3008
  # @option params [required, String] :target_domain_id
2934
- # Unique identifier of the target domain to update
3009
+ # The unique identifier of the target domain to update.
2935
3010
  #
2936
3011
  # @option params [required, String] :verification_method
2937
- # Verification method for the target domain
3012
+ # The updated verification method for the target domain.
2938
3013
  #
2939
3014
  # @return [Types::UpdateTargetDomainOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2940
3015
  #
2941
3016
  # * {Types::UpdateTargetDomainOutput#target_domain_id #target_domain_id} => String
2942
3017
  # * {Types::UpdateTargetDomainOutput#domain_name #domain_name} => String
2943
3018
  # * {Types::UpdateTargetDomainOutput#verification_status #verification_status} => String
3019
+ # * {Types::UpdateTargetDomainOutput#verification_status_reason #verification_status_reason} => String
2944
3020
  # * {Types::UpdateTargetDomainOutput#verification_details #verification_details} => Types::VerificationDetails
2945
3021
  # * {Types::UpdateTargetDomainOutput#created_at #created_at} => Time
2946
3022
  # * {Types::UpdateTargetDomainOutput#verified_at #verified_at} => Time
@@ -2949,7 +3025,7 @@ module Aws::SecurityAgent
2949
3025
  #
2950
3026
  # resp = client.update_target_domain({
2951
3027
  # target_domain_id: "TargetDomainId", # required
2952
- # verification_method: "DNS_TXT", # required, accepts DNS_TXT, HTTP_ROUTE
3028
+ # verification_method: "DNS_TXT", # required, accepts DNS_TXT, HTTP_ROUTE, PRIVATE_VPC
2953
3029
  # })
2954
3030
  #
2955
3031
  # @example Response structure
@@ -2957,7 +3033,8 @@ module Aws::SecurityAgent
2957
3033
  # resp.target_domain_id #=> String
2958
3034
  # resp.domain_name #=> String
2959
3035
  # resp.verification_status #=> String, one of "PENDING", "VERIFIED", "FAILED", "UNREACHABLE"
2960
- # resp.verification_details.method #=> String, one of "DNS_TXT", "HTTP_ROUTE"
3036
+ # resp.verification_status_reason #=> String
3037
+ # resp.verification_details.method #=> String, one of "DNS_TXT", "HTTP_ROUTE", "PRIVATE_VPC"
2961
3038
  # resp.verification_details.dns_txt.token #=> String
2962
3039
  # resp.verification_details.dns_txt.dns_record_name #=> String
2963
3040
  # resp.verification_details.dns_txt.dns_record_type #=> String, one of "TXT"
@@ -2975,10 +3052,11 @@ module Aws::SecurityAgent
2975
3052
  req.send_request(options)
2976
3053
  end
2977
3054
 
2978
- # Verifies ownership for a registered target domain
3055
+ # Initiates verification of a target domain. This checks whether the
3056
+ # domain ownership verification token has been properly configured.
2979
3057
  #
2980
3058
  # @option params [required, String] :target_domain_id
2981
- # Unique identifier of the target domain
3059
+ # The unique identifier of the target domain to verify.
2982
3060
  #
2983
3061
  # @return [Types::VerifyTargetDomainOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2984
3062
  #
@@ -2988,6 +3066,7 @@ module Aws::SecurityAgent
2988
3066
  # * {Types::VerifyTargetDomainOutput#updated_at #updated_at} => Time
2989
3067
  # * {Types::VerifyTargetDomainOutput#verified_at #verified_at} => Time
2990
3068
  # * {Types::VerifyTargetDomainOutput#status #status} => String
3069
+ # * {Types::VerifyTargetDomainOutput#verification_status_reason #verification_status_reason} => String
2991
3070
  #
2992
3071
  # @example Request syntax with placeholder values
2993
3072
  #
@@ -3003,6 +3082,7 @@ module Aws::SecurityAgent
3003
3082
  # resp.updated_at #=> Time
3004
3083
  # resp.verified_at #=> Time
3005
3084
  # resp.status #=> String, one of "PENDING", "VERIFIED", "FAILED", "UNREACHABLE"
3085
+ # resp.verification_status_reason #=> String
3006
3086
  #
3007
3087
  # @see http://docs.aws.amazon.com/goto/WebAPI/securityagent-2025-09-06/VerifyTargetDomain AWS API Documentation
3008
3088
  #
@@ -3031,7 +3111,7 @@ module Aws::SecurityAgent
3031
3111
  tracer: tracer
3032
3112
  )
3033
3113
  context[:gem_name] = 'aws-sdk-securityagent'
3034
- context[:gem_version] = '1.0.0'
3114
+ context[:gem_version] = '1.1.0'
3035
3115
  Seahorse::Client::Request.new(handlers, context)
3036
3116
  end
3037
3117