Rename RetrieveAwsOnDemandTask operation id (#2275)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 16:19:13.708125",
-            "spec_repo_commit": "1a11ef53"
+            "regenerated": "2025-03-06 17:12:16.957125",
+            "spec_repo_commit": "9dd2b6ae"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 16:19:13.723185",
-            "spec_repo_commit": "1a11ef53"
+            "regenerated": "2025-03-06 17:12:16.974299",
+            "spec_repo_commit": "9dd2b6ae"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -4122,6 +4122,8 @@ components:
             of EC2 instances, lambda functions, AMI, ECR, RDS and S3 buckets.
           example: arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba
           type: string
+      required:
+      - arn
       type: object
     AwsOnDemandCreateData:
       description: Object for a single AWS on demand task.
@@ -4219,6 +4221,11 @@ components:
           description: Indicates if scanning for vulnerabilities in hosts is enabled.
           example: true
           type: boolean
+      required:
+      - lambda
+      - sensitive_data
+      - vuln_containers_os
+      - vuln_host_os
       type: object
     AwsScanOptionsCreateData:
       description: Object for the scan options of a single AWS account.
@@ -33982,7 +33989,9 @@ paths:
         permissions:
         - security_monitoring_findings_read
     post:
-      description: Trigger the scan of an AWS resource with a high priority.
+      description: Trigger the scan of an AWS resource with a high priority. Agentless
+        scanning must be activated for the AWS account containing the resource to
+        scan.
       operationId: CreateAwsOnDemandTask
       requestBody:
         content:
@@ -34015,7 +34024,7 @@ paths:
   /api/v2/agentless_scanning/ondemand/aws/{task_id}:
     get:
       description: Fetch the data of a specific on demand task.
-      operationId: RetrieveAwsOnDemandTask
+      operationId: GetAwsOnDemandTask
       parameters:
       - $ref: '#/components/parameters/OnDemandTaskId'
       responses:
@@ -53068,8 +53077,9 @@ tags:
   name: Action Connection
 - description: "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin
     your hosts, running containers, and serverless functions\u2014all without\nrequiring
-    teams to install Agents on every host or where Agents cannot be installed.\nGo
-    to https://www.datadoghq.com/blog/agentless-scanning/ to learn more."
+    teams to install Agents on every host or where Agents cannot be installed.\nAgentless
+    offers also Sensitive Data Scanning capabilities on your storage.\nGo to https://www.datadoghq.com/blog/agentless-scanning/
+    to learn more."
   name: Agentless Scanning
 - description: Datadog App Builder provides a low-code solution to rapidly develop
     and integrate secure, customized applications into your monitoring stack that

cassettes/features/v2/agentless_scanning/Post-AWS-Scan-Options-returns-Conflict-response.frozen

@@ -1 +1 @@
-2025-03-01T20:02:10.630Z
+2025-03-06T11:57:47.413Z

cassettes/features/v2/agentless_scanning/Post-AWS-Scan-Options-returns-Conflict-response.yml

@@ -2,4 +2,4 @@
 
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V2::AgentlessScanningAPI.new
-p api_instance.retrieve_aws_on_demand_task("63d6b4f5-e5d0-4d90-824a-9580f05f026a")
+p api_instance.get_aws_on_demand_task("63d6b4f5-e5d0-4d90-824a-9580f05f026a")

examples/v2/agentless-scanning/RetrieveAwsOnDemandTask.rb renamed to examples/v2/agentless-scanning/GetAwsOnDemandTask.rb

@@ -853,7 +853,7 @@
     "v2.CreateAwsOnDemandTask" => {
             "body" => "AwsOnDemandCreateRequest",
     },
-    "v2.RetrieveAwsOnDemandTask" => {
+    "v2.GetAwsOnDemandTask" => {
             "task_id" => "String",
     },
     "v2.ListAPIKeys" => {

features/scenarios_model_mapping.rb

@@ -3,7 +3,8 @@ Feature: Agentless Scanning
   Datadog Agentless Scanning provides visibility into risks and
   vulnerabilities within your hosts, running containers, and serverless
   functions—all without requiring teams to install Agents on every host or
-  where Agents cannot be installed. Go to
+  where Agents cannot be installed. Agentless offers also Sensitive Data
+  Scanning capabilities on your storage. Go to
   https://www.datadoghq.com/blog/agentless-scanning/ to learn more.
 
   Background:
@@ -34,21 +35,21 @@ Feature: Agentless Scanning
 
   @team:DataDog/k9-agentless
   Scenario: Get AWS On Demand task by id returns "Bad Request" response
-    Given new "RetrieveAwsOnDemandTask" request
+    Given new "GetAwsOnDemandTask" request
     And request contains "task_id" parameter with value "invalid-uuid"
     When the request is sent
     Then the response status is 400 Bad Request
 
   @team:DataDog/k9-agentless
   Scenario: Get AWS On Demand task by id returns "Not Found" response
-    Given new "RetrieveAwsOnDemandTask" request
+    Given new "GetAwsOnDemandTask" request
     And request contains "task_id" parameter with value "00000000-0000-0000-824a-000000000000"
     When the request is sent
     Then the response status is 404 Not Found
 
   @team:DataDog/k9-agentless
   Scenario: Get AWS On Demand task by id returns "OK." response
-    Given new "RetrieveAwsOnDemandTask" request
+    Given new "GetAwsOnDemandTask" request
     And request contains "task_id" parameter with value "63d6b4f5-e5d0-4d90-824a-9580f05f026a"
     When the request is sent
     Then the response status is 200 OK
@@ -115,7 +116,7 @@ Feature: Agentless Scanning
   @team:DataDog/k9-agentless
   Scenario: Post AWS Scan Options returns "Conflict" response
     Given new "CreateAwsScanOptions" request
-    And body with value {"data":{"type":"aws_scan_options","id":"000000000002","attributes":{"vuln_host_os":true,"vuln_containers_os":true,"lambda":false}}}
+    And body with value {"data":{"type":"aws_scan_options","id":"000000000002","attributes":{"vuln_host_os":true,"vuln_containers_os":true,"sensitive_data":false,"lambda":false}}}
     When the request is sent
     Then the response status is 409 Conflict
 

features/v2/agentless_scanning.feature

@@ -73,7 +73,7 @@
       "type": "idempotent"
     }
   },
-  "RetrieveAwsOnDemandTask": {
+  "GetAwsOnDemandTask": {
     "tag": "Agentless Scanning",
     "undo": {
       "type": "safe"

features/v2/undo.json

@@ -33,7 +33,7 @@ def create_aws_on_demand_task(body, opts = {})
 
     # Post an AWS on demand task.
     #
-    # Trigger the scan of an AWS resource with a high priority.
+    # Trigger the scan of an AWS resource with a high priority. Agentless scanning must be activated for the AWS account containing the resource to scan.
     #
     # @param body [AwsOnDemandCreateRequest] The definition of the on demand task.
     # @param opts [Hash] the optional parameters
@@ -222,27 +222,32 @@ def delete_aws_scan_options_with_http_info(account_id, opts = {})
       return data, status_code, headers
     end
 
-    # Get AWS On Demand tasks.
+    # Get AWS On Demand task by id.
     #
-    # @see #list_aws_on_demand_tasks_with_http_info
-    def list_aws_on_demand_tasks(opts = {})
-      data, _status_code, _headers = list_aws_on_demand_tasks_with_http_info(opts)
+    # @see #get_aws_on_demand_task_with_http_info
+    def get_aws_on_demand_task(task_id, opts = {})
+      data, _status_code, _headers = get_aws_on_demand_task_with_http_info(task_id, opts)
       data
     end
 
-    # Get AWS On Demand tasks.
+    # Get AWS On Demand task by id.
     #
-    # Fetches the most recent 1000 AWS on demand tasks.
+    # Fetch the data of a specific on demand task.
     #
+    # @param task_id [String] The UUID of the task.
     # @param opts [Hash] the optional parameters
-    # @return [Array<(AwsOnDemandListResponse, Integer, Hash)>] AwsOnDemandListResponse data, response status code and response headers
-    def list_aws_on_demand_tasks_with_http_info(opts = {})
+    # @return [Array<(AwsOnDemandResponse, Integer, Hash)>] AwsOnDemandResponse data, response status code and response headers
+    def get_aws_on_demand_task_with_http_info(task_id, opts = {})
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.list_aws_on_demand_tasks ...'
+        @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.get_aws_on_demand_task ...'
+      end
+      # verify the required parameter 'task_id' is set
+      if @api_client.config.client_side_validation && task_id.nil?
+        fail ArgumentError, "Missing the required parameter 'task_id' when calling AgentlessScanningAPI.get_aws_on_demand_task"
       end
       # resource path
-      local_var_path = '/api/v2/agentless_scanning/ondemand/aws'
+      local_var_path = '/api/v2/agentless_scanning/ondemand/aws/{task_id}'.sub('{task_id}', CGI.escape(task_id.to_s).gsub('%2F', '/'))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -259,13 +264,13 @@ def list_aws_on_demand_tasks_with_http_info(opts = {})
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'AwsOnDemandListResponse'
+      return_type = opts[:debug_return_type] || 'AwsOnDemandResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
 
       new_options = opts.merge(
-        :operation => :list_aws_on_demand_tasks,
+        :operation => :get_aws_on_demand_task,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -277,32 +282,32 @@ def list_aws_on_demand_tasks_with_http_info(opts = {})
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AgentlessScanningAPI#list_aws_on_demand_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AgentlessScanningAPI#get_aws_on_demand_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get AWS Scan Options.
+    # Get AWS On Demand tasks.
     #
-    # @see #list_aws_scan_options_with_http_info
-    def list_aws_scan_options(opts = {})
-      data, _status_code, _headers = list_aws_scan_options_with_http_info(opts)
+    # @see #list_aws_on_demand_tasks_with_http_info
+    def list_aws_on_demand_tasks(opts = {})
+      data, _status_code, _headers = list_aws_on_demand_tasks_with_http_info(opts)
       data
     end
 
-    # Get AWS Scan Options.
+    # Get AWS On Demand tasks.
     #
-    # Fetches the scan options configured for AWS accounts.
+    # Fetches the most recent 1000 AWS on demand tasks.
     #
     # @param opts [Hash] the optional parameters
-    # @return [Array<(AwsScanOptionsListResponse, Integer, Hash)>] AwsScanOptionsListResponse data, response status code and response headers
-    def list_aws_scan_options_with_http_info(opts = {})
+    # @return [Array<(AwsOnDemandListResponse, Integer, Hash)>] AwsOnDemandListResponse data, response status code and response headers
+    def list_aws_on_demand_tasks_with_http_info(opts = {})
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.list_aws_scan_options ...'
+        @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.list_aws_on_demand_tasks ...'
       end
       # resource path
-      local_var_path = '/api/v2/agentless_scanning/accounts/aws'
+      local_var_path = '/api/v2/agentless_scanning/ondemand/aws'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -319,13 +324,13 @@ def list_aws_scan_options_with_http_info(opts = {})
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'AwsScanOptionsListResponse'
+      return_type = opts[:debug_return_type] || 'AwsOnDemandListResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
 
       new_options = opts.merge(
-        :operation => :list_aws_scan_options,
+        :operation => :list_aws_on_demand_tasks,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -337,37 +342,32 @@ def list_aws_scan_options_with_http_info(opts = {})
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AgentlessScanningAPI#list_aws_scan_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AgentlessScanningAPI#list_aws_on_demand_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get AWS On Demand task by id.
+    # Get AWS Scan Options.
     #
-    # @see #retrieve_aws_on_demand_task_with_http_info
-    def retrieve_aws_on_demand_task(task_id, opts = {})
-      data, _status_code, _headers = retrieve_aws_on_demand_task_with_http_info(task_id, opts)
+    # @see #list_aws_scan_options_with_http_info
+    def list_aws_scan_options(opts = {})
+      data, _status_code, _headers = list_aws_scan_options_with_http_info(opts)
       data
     end
 
-    # Get AWS On Demand task by id.
+    # Get AWS Scan Options.
     #
-    # Fetch the data of a specific on demand task.
+    # Fetches the scan options configured for AWS accounts.
     #
-    # @param task_id [String] The UUID of the task.
     # @param opts [Hash] the optional parameters
-    # @return [Array<(AwsOnDemandResponse, Integer, Hash)>] AwsOnDemandResponse data, response status code and response headers
-    def retrieve_aws_on_demand_task_with_http_info(task_id, opts = {})
+    # @return [Array<(AwsScanOptionsListResponse, Integer, Hash)>] AwsScanOptionsListResponse data, response status code and response headers
+    def list_aws_scan_options_with_http_info(opts = {})
 
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.retrieve_aws_on_demand_task ...'
-      end
-      # verify the required parameter 'task_id' is set
-      if @api_client.config.client_side_validation && task_id.nil?
-        fail ArgumentError, "Missing the required parameter 'task_id' when calling AgentlessScanningAPI.retrieve_aws_on_demand_task"
+        @api_client.config.logger.debug 'Calling API: AgentlessScanningAPI.list_aws_scan_options ...'
       end
       # resource path
-      local_var_path = '/api/v2/agentless_scanning/ondemand/aws/{task_id}'.sub('{task_id}', CGI.escape(task_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/api/v2/agentless_scanning/accounts/aws'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -384,13 +384,13 @@ def retrieve_aws_on_demand_task_with_http_info(task_id, opts = {})
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'AwsOnDemandResponse'
+      return_type = opts[:debug_return_type] || 'AwsScanOptionsListResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
 
       new_options = opts.merge(
-        :operation => :retrieve_aws_on_demand_task,
+        :operation => :list_aws_scan_options,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -402,7 +402,7 @@ def retrieve_aws_on_demand_task_with_http_info(task_id, opts = {})
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AgentlessScanningAPI#retrieve_aws_on_demand_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: AgentlessScanningAPI#list_aws_scan_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

lib/datadog_api_client/v2/api/agentless_scanning_api.rb

@@ -22,7 +22,7 @@ class AwsOnDemandCreateAttributes
     include BaseGenericModel
 
     # The arn of the resource to scan. Agentless supports the scan of EC2 instances, lambda functions, AMI, ECR, RDS and S3 buckets.
-    attr_accessor :arn
+    attr_reader :arn
 
     attr_accessor :additional_properties
 
@@ -65,6 +65,24 @@ def initialize(attributes = {})
       end
     end
 
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @arn.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param arn [Object] Object to be assigned
+    # @!visibility private
+    def arn=(arn)
+      if arn.nil?
+        fail ArgumentError, 'invalid value for "arn", arn cannot be nil.'
+      end
+      @arn = arn
+    end
+
     # Returns the object in the form of hash, with additionalProperties support.
     # @return [Hash] Returns the object in the form of hash
     # @!visibility private