ApplicationDiscoveryService / Client / describe_batch_delete_configuration_task

describe_batch_delete_configuration_task

ApplicationDiscoveryService.Client.describe_batch_delete_configuration_task(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_batch_delete_configuration_task(
    taskId='string'
)

Parameters:

taskId (string) –

[REQUIRED]

The ID of the task to delete.

Return type:

dict

Returns:

Response Syntax

{
    'task': {
        'taskId': 'string',
        'status': 'INITIALIZING'|'VALIDATING'|'DELETING'|'COMPLETED'|'FAILED',
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'configurationType': 'SERVER',
        'requestedConfigurations': [
            'string',
        ],
        'deletedConfigurations': [
            'string',
        ],
        'failedConfigurations': [
            {
                'configurationId': 'string',
                'errorStatusCode': 123,
                'errorMessage': 'string'
            },
        ],
        'deletionWarnings': [
            {
                'configurationId': 'string',
                'warningCode': 123,
                'warningText': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • task (dict) –

    The BatchDeleteConfigurationTask that represents the deletion task being executed.

    • taskId (string) –

      The deletion task’s unique identifier.

    • status (string) –

      The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED.

    • startTime (datetime) –

      An epoch seconds timestamp (UTC) of when the deletion task was started.

    • endTime (datetime) –

      An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.

    • configurationType (string) –

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

    • requestedConfigurations (list) –

      The list of configuration IDs that were originally requested to be deleted by the deletion task.

      • (string) –

    • deletedConfigurations (list) –

      The list of configuration IDs that were successfully deleted by the deletion task.

      • (string) –

    • failedConfigurations (list) –

      A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.

      • (dict) –

        A configuration ID paired with an error message.

        • configurationId (string) –

          The unique identifier of the configuration the failed to delete.

        • errorStatusCode (integer) –

          The integer error code associated with the error message.

        • errorMessage (string) –

          A descriptive message indicating why the associated configuration failed to delete.

    • deletionWarnings (list) –

      A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.

      • (dict) –

        A configuration ID paired with a warning message.

        • configurationId (string) –

          The unique identifier of the configuration that produced a warning.

        • warningCode (integer) –

          The integer warning code associated with the warning message.

        • warningText (string) –

          A descriptive message of the warning the associated configuration ID produced.

Exceptions

• ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException

• ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException

• ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException

• ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException