Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetConfiguration

Retrieves setting configurations for Amazon Inspector scans. If you specify an accountId, this operation returns the scan configuration for that member account. You must be the delegated administrator for the specified member account. If you do not specify an accountId, this operation returns your own scan configuration.

Request Syntax


POST /configuration/get HTTP/1.1
Content-type: application/json

{
   "accountId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountId

The 12-digit AWS account ID of the member account whose scan configuration you want to retrieve. When specified, you must be the delegated administrator for this member account. If not specified, the operation returns your own configuration.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ec2Configuration": { 
      "scanModeState": { 
         "scanMode": "string",
         "scanModeStatus": "string"
      },
      "vmScannerState": { 
         "activated": boolean,
         "activatedAt": number,
         "status": "string"
      }
   },
   "ecrConfiguration": { 
      "rescanDurationState": { 
         "pullDateRescanDuration": "string",
         "pullDateRescanMode": "string",
         "rescanDuration": "string",
         "status": "string",
         "updatedAt": number
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ec2Configuration

Specifies how the Amazon EC2 automated scan mode is currently configured for your environment.

Type: Ec2ConfigurationState object

ecrConfiguration

Specifies how the ECR automated re-scan duration is currently configured for your environment.

Type: EcrConfigurationState object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported AWS Region.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

fields: The fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400