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

DescribeBatchDeleteConfigurationTask

Takes a unique deletion task identifier as input and returns metadata about a configuration deletion task.

Request Syntax


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

taskId

The ID of the task to delete.

Type: String

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

Required: Yes

Response Syntax


{
   "task": { 
      "configurationType": "string",
      "deletedConfigurations": [ "string" ],
      "deletionWarnings": [ 
         { 
            "configurationId": "string",
            "warningCode": number,
            "warningText": "string"
         }
      ],
      "endTime": number,
      "failedConfigurations": [ 
         { 
            "configurationId": "string",
            "errorMessage": "string",
            "errorStatusCode": number
         }
      ],
      "requestedConfigurations": [ "string" ],
      "startTime": number,
      "status": "string",
      "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.

task

The BatchDeleteConfigurationTask that represents the deletion task being executed.

Type: BatchDeleteConfigurationTask object

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

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

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

ServerInternalErrorException

The server experienced an internal error. Try again.

HTTP Status Code: 500

Examples

The following example shows the request syntax for a deletion task that was previously started using StartBatchDeleteConfigurationTask specified by the value passed to the required taskId parameter.

Sample Request



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

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

Sample Response



{
      "task": {
        "configurationType": "SERVER",
        "deletedConfigurations": ["d-server-029yqlktuw2udm", "d-server-03alnm4z74f77f"],
        "deletionWarnings": [],
        "endTime": 1695765672.384,
        "failedConfigurations": [],
        "requestedConfigurations": ["d-server-029yqlktuw2udm", "d-server-03alnm4z74f77f"],
        "startTime": 1695755672.129,
        "status": "COMPLETED",
        "taskId": "b941cc54-b0df-4cdd-90fc-70ef4293dfce"
    }
}