Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

StartBatchDeleteConfigurationTask

Important

AWS Application Discovery Service will discontinue onboarding new customers starting November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. Existing customers can continue to use the service as normal. For more information, see AWS Application Discovery Service availability change.

Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.

Request Syntax


{
   "configurationIds": [ "string" ],
   "configurationType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

configurationIds

The list of configuration IDs that will be deleted by the task.

Type: Array of strings

Length Constraints: Maximum length of 200.

Pattern: \S*

Required: Yes

configurationType

The type of configuration item to delete. Supported types are: SERVER.

Type: String

Valid Values: SERVER

Required: Yes

Response Syntax


{
   "taskId": "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.

taskId

The unique identifier associated with the newly started deletion task.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors

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

AuthorizationErrorException

The user does not have permission to perform the action. Check the IAM policy associated with this user.

HTTP Status Code: 400

HomeRegionNotSetException

Important

The home Region is not set. Set the home Region to continue.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid. Verify the parameters and try again.

HTTP Status Code: 400

InvalidParameterValueException

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

HTTP Status Code: 400

LimitExceededException

Important

The limit of 200 configuration IDs per request has been exceeded.

HTTP Status Code: 400

OperationNotPermittedException

This operation is not permitted.

HTTP Status Code: 400

ServerInternalErrorException

The server experienced an internal error. Try again.

HTTP Status Code: 500

Examples

The following example shows the request syntax to start a deletion task for a batch of SERVER configurations, specified by the value passed to the required parameters of configurationIdsand configurationType.

Sample Request



{
    "configurationType": "SERVER",
    "configurationIds": ["d-server-029yqlktuw2udm", "d-server-03alnm4z74f77f"]
}

The following example shows the response for a successful StartBatchDeleteConfigurationTask API call.

Sample Response



{
    "taskId": "b941cc54-b0df-4cdd-90fc-70ef4293dfce"
}