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

StartConfigurationChecks

Initiates configuration check operations against a specified application.

Request Syntax


POST /start-configuration-checks HTTP/1.1
Content-type: application/json

{
   "ApplicationId": "string",
   "ConfigurationCheckIds": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ApplicationId

The ID of the application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Pattern: [\w\d\.-]+

Required: Yes

ConfigurationCheckIds

The list of configuration checks to perform.

Type: Array of strings

Valid Values: SAP_CHECK_01 | SAP_CHECK_02 | SAP_CHECK_03

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConfigurationCheckOperations": [ 
      { 
         "ApplicationId": "string",
         "ConfigurationCheckDescription": "string",
         "ConfigurationCheckId": "string",
         "ConfigurationCheckName": "string",
         "EndTime": number,
         "Id": "string",
         "RuleStatusCounts": { 
            "Failed": number,
            "Info": number,
            "Passed": number,
            "Unknown": number,
            "Warning": number
         },
         "StartTime": number,
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}

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.

ConfigurationCheckOperations

The configuration check operations that were started.

Type: Array of ConfigurationCheckOperation objects

Errors

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

ConflictException

A conflict has occurred.

HTTP Status Code: 409

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource is not available.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400