AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . discovery ]

describe-batch-delete-configuration-task

Description

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

See also: AWS API Documentation

Synopsis

  describe-batch-delete-configuration-task
--task-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--task-id (string)

The ID of the task to delete.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

task -> (structure)

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 -> (timestamp)

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

endTime -> (timestamp)

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.

(structure)

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.

(structure)

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.