

# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AssociateConfigurationItemsToApplication](API_AssociateConfigurationItemsToApplication.md) 
+  [BatchDeleteAgents](API_BatchDeleteAgents.md) 
+  [BatchDeleteImportData](API_BatchDeleteImportData.md) 
+  [CreateApplication](API_CreateApplication.md) 
+  [CreateTags](API_CreateTags.md) 
+  [DeleteApplications](API_DeleteApplications.md) 
+  [DeleteTags](API_DeleteTags.md) 
+  [DescribeAgents](API_DescribeAgents.md) 
+  [DescribeBatchDeleteConfigurationTask](API_DescribeBatchDeleteConfigurationTask.md) 
+  [DescribeConfigurations](API_DescribeConfigurations.md) 
+  [DescribeContinuousExports](API_DescribeContinuousExports.md) 
+  [DescribeExportConfigurations](API_DescribeExportConfigurations.md) 
+  [DescribeExportTasks](API_DescribeExportTasks.md) 
+  [DescribeImportTasks](API_DescribeImportTasks.md) 
+  [DescribeTags](API_DescribeTags.md) 
+  [DisassociateConfigurationItemsFromApplication](API_DisassociateConfigurationItemsFromApplication.md) 
+  [ExportConfigurations](API_ExportConfigurations.md) 
+  [GetDiscoverySummary](API_GetDiscoverySummary.md) 
+  [ListConfigurations](API_ListConfigurations.md) 
+  [ListServerNeighbors](API_ListServerNeighbors.md) 
+  [StartBatchDeleteConfigurationTask](API_StartBatchDeleteConfigurationTask.md) 
+  [StartContinuousExport](API_StartContinuousExport.md) 
+  [StartDataCollectionByAgentIds](API_StartDataCollectionByAgentIds.md) 
+  [StartExportTask](API_StartExportTask.md) 
+  [StartImportTask](API_StartImportTask.md) 
+  [StopContinuousExport](API_StopContinuousExport.md) 
+  [StopDataCollectionByAgentIds](API_StopDataCollectionByAgentIds.md) 
+  [UpdateApplication](API_UpdateApplication.md) 

# AssociateConfigurationItemsToApplication
<a name="API_AssociateConfigurationItemsToApplication"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Associates one or more configuration items with an application.

## Request Syntax
<a name="API_AssociateConfigurationItemsToApplication_RequestSyntax"></a>

```
{
   "applicationConfigurationId": "string",
   "configurationIds": [ "string" ]
}
```

## Request Parameters
<a name="API_AssociateConfigurationItemsToApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [applicationConfigurationId](#API_AssociateConfigurationItemsToApplication_RequestSyntax) **   <a name="DiscServ-AssociateConfigurationItemsToApplication-request-applicationConfigurationId"></a>
The configuration ID of an application with which items are to be associated.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S+`   
Required: Yes

 ** [configurationIds](#API_AssociateConfigurationItemsToApplication_RequestSyntax) **   <a name="DiscServ-AssociateConfigurationItemsToApplication-request-configurationIds"></a>
The ID of each configuration item to be associated with an application.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: Yes

## Response Elements
<a name="API_AssociateConfigurationItemsToApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateConfigurationItemsToApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_AssociateConfigurationItemsToApplication_Examples"></a>

### Associate configuration items to an application
<a name="API_AssociateConfigurationItemsToApplication_Example_1"></a>

The following example associates two Application Discovery Service discovered resources specified by their configuration ids to the application identified by the value passed to the parameter `applicationConfigurationId` in the request.

#### Sample Request
<a name="API_AssociateConfigurationItemsToApplication_Example_1_Request"></a>

```
{
    "applicationConfigurationId":"d-application-0039038d504694533",
    "configurationIds": [
	      "d-server-0025db43a885966c8",
	      "d-server-0f0a32a0db4217bd6"
    ]
}
```

## See Also
<a name="API_AssociateConfigurationItemsToApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/AssociateConfigurationItemsToApplication) 

# BatchDeleteAgents
<a name="API_BatchDeleteAgents"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

 Deletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete the previously discovered data. To delete the data collected, use `StartBatchDeleteConfigurationTask`. 

## Request Syntax
<a name="API_BatchDeleteAgents_RequestSyntax"></a>

```
{
   "deleteAgents": [ 
      { 
         "agentId": "string",
         "force": boolean
      }
   ]
}
```

## Request Parameters
<a name="API_BatchDeleteAgents_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deleteAgents](#API_BatchDeleteAgents_RequestSyntax) **   <a name="DiscServ-BatchDeleteAgents-request-deleteAgents"></a>
 The list of agents to delete.   
Type: Array of [DeleteAgent](API_DeleteAgent.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_BatchDeleteAgents_ResponseSyntax"></a>

```
{
   "errors": [ 
      { 
         "agentId": "string",
         "errorCode": "string",
         "errorMessage": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDeleteAgents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_BatchDeleteAgents_ResponseSyntax) **   <a name="DiscServ-BatchDeleteAgents-response-errors"></a>
 A list of agent IDs that failed to delete during the deletion task, each paired with an error message.   
Type: Array of [BatchDeleteAgentError](API_BatchDeleteAgentError.md) objects

## Errors
<a name="API_BatchDeleteAgents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_BatchDeleteAgents_Examples"></a>

### 
<a name="API_BatchDeleteAgents_Example_1"></a>

The following example shows the request syntax for a `BatchDeleteAgents` API call that deletes an agent from the account provided by the `agentId`.

#### Sample Request
<a name="API_BatchDeleteAgents_Example_1_Request"></a>

```
{
  "deleteAgents": [{
        "agentId": "o-3i7dc2x5a020kaq4s",
        "force": true
    }]
}
```

### 
<a name="API_BatchDeleteAgents_Example_2"></a>

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

#### Sample Response
<a name="API_BatchDeleteAgents_Example_2_Response"></a>

```
{
  "errors": [] 
}
```

## See Also
<a name="API_BatchDeleteAgents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/BatchDeleteAgents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/BatchDeleteAgents) 

# BatchDeleteImportData
<a name="API_BatchDeleteImportData"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications. 

 AWS Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.

## Request Syntax
<a name="API_BatchDeleteImportData_RequestSyntax"></a>

```
{
   "deleteHistory": boolean,
   "importTaskIds": [ "string" ]
}
```

## Request Parameters
<a name="API_BatchDeleteImportData_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deleteHistory](#API_BatchDeleteImportData_RequestSyntax) **   <a name="DiscServ-BatchDeleteImportData-request-deleteHistory"></a>
 Set to `true` to remove the deleted import task from [DescribeImportTasks](API_DescribeImportTasks.md).   
Type: Boolean  
Required: No

 ** [importTaskIds](#API_BatchDeleteImportData_RequestSyntax) **   <a name="DiscServ-BatchDeleteImportData-request-importTaskIds"></a>
The IDs for the import tasks that you want to delete.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Length Constraints: Maximum length of 200.  
Pattern: `^import-task-[a-fA-F0-9]{32}$`   
Required: Yes

## Response Syntax
<a name="API_BatchDeleteImportData_ResponseSyntax"></a>

```
{
   "errors": [ 
      { 
         "errorCode": "string",
         "errorDescription": "string",
         "importTaskId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDeleteImportData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_BatchDeleteImportData_ResponseSyntax) **   <a name="DiscServ-BatchDeleteImportData-response-errors"></a>
Error messages returned for each import task that you deleted as a response for this command.  
Type: Array of [BatchDeleteImportDataError](API_BatchDeleteImportDataError.md) objects

## Errors
<a name="API_BatchDeleteImportData_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## See Also
<a name="API_BatchDeleteImportData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/BatchDeleteImportData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/BatchDeleteImportData) 

# CreateApplication
<a name="API_CreateApplication"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Creates an application with the given name and description.

## Request Syntax
<a name="API_CreateApplication_RequestSyntax"></a>

```
{
   "description": "string",
   "name": "string",
   "wave": "string"
}
```

## Request Parameters
<a name="API_CreateApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [description](#API_CreateApplication_RequestSyntax) **   <a name="DiscServ-CreateApplication-request-description"></a>
The description of the application to be created.  
Type: String  
Length Constraints: Maximum length of 1000.  
Pattern: `(^$|[\s\S]*\S[\s\S]*)`   
Required: No

 ** [name](#API_CreateApplication_RequestSyntax) **   <a name="DiscServ-CreateApplication-request-name"></a>
The name of the application to be created.  
Type: String  
Length Constraints: Maximum length of 127.  
Pattern: `[\s\S]*\S[\s\S]*`   
Required: Yes

 ** [wave](#API_CreateApplication_RequestSyntax) **   <a name="DiscServ-CreateApplication-request-wave"></a>
The name of the migration wave of the application to be created.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^($|[^\s\x00]( *[^\s\x00])*$)`   
Required: No

## Response Syntax
<a name="API_CreateApplication_ResponseSyntax"></a>

```
{
   "configurationId": "string"
}
```

## Response Elements
<a name="API_CreateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurationId](#API_CreateApplication_ResponseSyntax) **   <a name="DiscServ-CreateApplication-response-configurationId"></a>
The configuration ID of an application to be created.  
Type: String  
Length Constraints: Maximum length of 10000.  
Pattern: `[\s\S]*` 

## Errors
<a name="API_CreateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_CreateApplication_Examples"></a>

### Create an application
<a name="API_CreateApplication_Example_1"></a>

The following example creates an application specified by value passed the required parameter of `name` as well as a description passed to the optional parameter `description` in the request.

#### Sample Request
<a name="API_CreateApplication_Example_1_Request"></a>

```
{
    "name":"PeopleSoft_phase1",
	  "description":"components related to payroll app to be migrated"
}
```

#### Sample Response
<a name="API_CreateApplication_Example_1_Response"></a>

```
{
    "configurationId": "d-application-0282ccd1ba7c211ca"
}
```

## See Also
<a name="API_CreateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/CreateApplication) 

# CreateTags
<a name="API_CreateTags"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

**Important**  
Do not store sensitive information (like personal data) in tags.

## Request Syntax
<a name="API_CreateTags_RequestSyntax"></a>

```
{
   "configurationIds": [ "string" ],
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateTags_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationIds](#API_CreateTags_RequestSyntax) **   <a name="DiscServ-CreateTags-request-configurationIds"></a>
A list of configuration items that you want to tag.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: Yes

 ** [tags](#API_CreateTags_RequestSyntax) **   <a name="DiscServ-CreateTags-request-tags"></a>
Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a *key*-*value* format. For example:  
 `{"key": "serverType", "value": "webServer"}`   
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

## Response Elements
<a name="API_CreateTags_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CreateTags_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ResourceNotFoundException **   
The specified configuration ID was not located. Verify the configuration ID and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_CreateTags_Examples"></a>

### Create tags for configuration items
<a name="API_CreateTags_Example_1"></a>

The following example creates two tags, each with a key/value pair, and associates both tags to two Application Discovery Service discovered resources specified by the values passed to the parameter `configurationIds` in the request.

#### Sample Request
<a name="API_CreateTags_Example_1_Request"></a>

```
{
    "configurationIds": [
	      "d-server-08a4bce106f63340e",
	      "d-server-04dadef51d0a728f3"
    ],
    "tags": [ 
        { 
            "key": "ServerLocation",
            "value": "Warehouse"
        },
        { 
            "key": "MigrationPhase",
            "value": "PH1"
        }
    ]
}
```

## See Also
<a name="API_CreateTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/CreateTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/CreateTags) 

# DeleteApplications
<a name="API_DeleteApplications"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Deletes a list of applications and their associations with configuration items.

## Request Syntax
<a name="API_DeleteApplications_RequestSyntax"></a>

```
{
   "configurationIds": [ "string" ]
}
```

## Request Parameters
<a name="API_DeleteApplications_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationIds](#API_DeleteApplications_RequestSyntax) **   <a name="DiscServ-DeleteApplications-request-configurationIds"></a>
Configuration ID of an application to be deleted.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S+`   
Required: Yes

## Response Elements
<a name="API_DeleteApplications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DeleteApplications_Examples"></a>

### Delete applications
<a name="API_DeleteApplications_Example_1"></a>

The following example deletes two applications as specified by the values passed to the parameter `configurationIds` in the request.

#### Sample Request
<a name="API_DeleteApplications_Example_1_Request"></a>

```
{
    "configurationIds": [
	      "d-application-022b024aa42685464",
	      "d-application-0ce38f881a50d2ac1" 
	  ]
}
```

## See Also
<a name="API_DeleteApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DeleteApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DeleteApplications) 

# DeleteTags
<a name="API_DeleteTags"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

## Request Syntax
<a name="API_DeleteTags_RequestSyntax"></a>

```
{
   "configurationIds": [ "string" ],
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_DeleteTags_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationIds](#API_DeleteTags_RequestSyntax) **   <a name="DiscServ-DeleteTags-request-configurationIds"></a>
A list of configuration items with tags that you want to delete.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: Yes

 ** [tags](#API_DeleteTags_RequestSyntax) **   <a name="DiscServ-DeleteTags-request-tags"></a>
Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a *key*-*value* format. For example:  
 `{"key": "serverType", "value": "webServer"}`   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Elements
<a name="API_DeleteTags_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTags_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ResourceNotFoundException **   
The specified configuration ID was not located. Verify the configuration ID and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DeleteTags_Examples"></a>

### Delete tags
<a name="API_DeleteTags_Example_1"></a>

The following example deletes a tag, identified by its key/value pair in the `tags` parameter, from the server specified by the value passed to the `configurationIds` parameter in the request.

#### Sample Request
<a name="API_DeleteTags_Example_1_Request"></a>

```
{
"configurationIds": [
	"d-server-08a4bce106f63340e"
   ],
   "tags": [ 
      { 
         "key": "ServerHostType",
         "value": "OracleProdDB"
      }
   ]
}
```

## See Also
<a name="API_DeleteTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DeleteTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DeleteTags) 

# DescribeAgents
<a name="API_DescribeAgents"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Lists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call `DescribeAgents` as is without passing any parameters.

## Request Syntax
<a name="API_DescribeAgents_RequestSyntax"></a>

```
{
   "agentIds": [ "string" ],
   "filters": [ 
      { 
         "condition": "string",
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeAgents_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [agentIds](#API_DescribeAgents_RequestSyntax) **   <a name="DiscServ-DescribeAgents-request-agentIds"></a>
The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.  
Type: Array of strings  
Length Constraints: Minimum length of 10. Maximum length of 20.  
Pattern: `\S+`   
Required: No

 ** [filters](#API_DescribeAgents_RequestSyntax) **   <a name="DiscServ-DescribeAgents-request-filters"></a>
You can filter the request using various logical operators and a *key*-*value* format. For example:   
 `{"key": "collectionStatus", "value": "STARTED"}`   
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** [maxResults](#API_DescribeAgents_RequestSyntax) **   <a name="DiscServ-DescribeAgents-request-maxResults"></a>
The total number of agents/collectors to return in a single page of output. The maximum value is 100.  
Type: Integer  
Required: No

 ** [nextToken](#API_DescribeAgents_RequestSyntax) **   <a name="DiscServ-DescribeAgents-request-nextToken"></a>
Token to retrieve the next set of results. For example, if you previously specified 100 IDs for `DescribeAgentsRequest$agentIds` but set `DescribeAgentsRequest$maxResults` to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeAgents_ResponseSyntax"></a>

```
{
   "agentsInfo": [ 
      { 
         "agentId": "string",
         "agentNetworkInfoList": [ 
            { 
               "ipAddress": "string",
               "macAddress": "string"
            }
         ],
         "agentType": "string",
         "collectionStatus": "string",
         "connectorId": "string",
         "health": "string",
         "hostName": "string",
         "lastHealthPingTime": "string",
         "registeredTime": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_DescribeAgents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentsInfo](#API_DescribeAgents_ResponseSyntax) **   <a name="DiscServ-DescribeAgents-response-agentsInfo"></a>
Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.  
Type: Array of [AgentInfo](API_AgentInfo.md) objects

 ** [nextToken](#API_DescribeAgents_ResponseSyntax) **   <a name="DiscServ-DescribeAgents-response-nextToken"></a>
Token to retrieve the next set of results. For example, if you specified 100 IDs for `DescribeAgentsRequest$agentIds` but set `DescribeAgentsRequest$maxResults` to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.  
Type: String

## Errors
<a name="API_DescribeAgents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeAgents_Examples"></a>

### Describe agents that are running
<a name="API_DescribeAgents_Example_1"></a>

The following example describes all agents that are currently running by passing object array values to the parameter `filters` where `condition` is "EQUALS", `name` is "health", and `value` is "RUNNING". This results in a descriptive response that lists all agents running in your account.

#### Sample Request
<a name="API_DescribeAgents_Example_1_Request"></a>

```
{
"filters": [ 
      { 
         "condition": "EQUALS",
         "name": "health",
         "values": [ "RUNNING" ]
      }
   ]
}
```

#### Sample Response
<a name="API_DescribeAgents_Example_1_Response"></a>

```
{
    "agentsInfo": [
        {
            "agentId": "o-55vu6xeo8zs27b905",
            "hostName": "ip-172-31-24-158.us-west-2.compute.internal",
            "agentNetworkInfoList": [
                {
                    "ipAddress": "172.31.24.158",
                    "macAddress": "02:7C:B6:F7:82:C4"
                }
            ],
            "version": "2.0.1008.0",
            "health": "RUNNING",
            "lastHealthPingTime": "2018-03-19T22:48:25Z",
            "collectionStatus": "STARTED",
            "agentType": "ONPREMISES",
            "registeredTime": "2018-01-30T18:54:19Z"
        },
        {
            "agentId": "o-5i6fq7z1fhgokgreg",
            "hostName": "win-gv9i8gpt9t1",
            "agentNetworkInfoList": [
                {
                    "ipAddress": "192.168.204.1",
                    "macAddress": "00:50:56:C0:00:01"
                },
                {
                    "ipAddress": "192.168.64.1",
                    "macAddress": "00:50:56:C0:00:08"
                },
                {
                    "ipAddress": "172.31.12.174",
                    "macAddress": "0A:84:BB:BF:88:8E"
                }
            ],
            "version": "2.0.1008.0",
            "health": "RUNNING",
            "lastHealthPingTime": "2018-03-19T22:29:33Z",
            "collectionStatus": "STARTED",
            "agentType": "ONPREMISES",
            "registeredTime": "2018-03-16T23:54:19Z"
        }
    ]
}
```

## See Also
<a name="API_DescribeAgents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeAgents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeAgents) 

# DescribeBatchDeleteConfigurationTask
<a name="API_DescribeBatchDeleteConfigurationTask"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

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

## Request Syntax
<a name="API_DescribeBatchDeleteConfigurationTask_RequestSyntax"></a>

```
{
   "taskId": "string"
}
```

## Request Parameters
<a name="API_DescribeBatchDeleteConfigurationTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [taskId](#API_DescribeBatchDeleteConfigurationTask_RequestSyntax) **   <a name="DiscServ-DescribeBatchDeleteConfigurationTask-request-taskId"></a>
 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
<a name="API_DescribeBatchDeleteConfigurationTask_ResponseSyntax"></a>

```
{
   "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
<a name="API_DescribeBatchDeleteConfigurationTask_ResponseElements"></a>

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](#API_DescribeBatchDeleteConfigurationTask_ResponseSyntax) **   <a name="DiscServ-DescribeBatchDeleteConfigurationTask-response-task"></a>
 The `BatchDeleteConfigurationTask` that represents the deletion task being executed.   
Type: [BatchDeleteConfigurationTask](API_BatchDeleteConfigurationTask.md) object

## Errors
<a name="API_DescribeBatchDeleteConfigurationTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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
<a name="API_DescribeBatchDeleteConfigurationTask_Examples"></a>

### 
<a name="API_DescribeBatchDeleteConfigurationTask_Example_1"></a>

The following example shows the request syntax for a deletion task that was previously started using [StartBatchDeleteConfigurationTask](API_StartBatchDeleteConfigurationTask.md) specified by the value passed to the required `taskId` parameter.

#### Sample Request
<a name="API_DescribeBatchDeleteConfigurationTask_Example_1_Request"></a>

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

### 
<a name="API_DescribeBatchDeleteConfigurationTask_Example_2"></a>

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

#### Sample Response
<a name="API_DescribeBatchDeleteConfigurationTask_Example_2_Response"></a>

```
{
      "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"
    }
}
```

## See Also
<a name="API_DescribeBatchDeleteConfigurationTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeBatchDeleteConfigurationTask) 

# DescribeConfigurations
<a name="API_DescribeConfigurations"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Retrieves attributes for a list of configuration item IDs.

**Note**  
All of the supplied IDs must be for the same asset type from one of the following:  
server
application
process
connection
Output fields are specific to the asset type specified. For example, the output for a *server* configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.  
For a complete list of outputs for each asset type, see [Using the DescribeConfigurations Action](https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#DescribeConfigurations) in the * AWS Application Discovery Service User Guide*.

## Request Syntax
<a name="API_DescribeConfigurations_RequestSyntax"></a>

```
{
   "configurationIds": [ "string" ]
}
```

## Request Parameters
<a name="API_DescribeConfigurations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationIds](#API_DescribeConfigurations_RequestSyntax) **   <a name="DiscServ-DescribeConfigurations-request-configurationIds"></a>
One or more configuration IDs.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: Yes

## Response Syntax
<a name="API_DescribeConfigurations_ResponseSyntax"></a>

```
{
   "configurations": [ 
      { 
         "string" : "string" 
      }
   ]
}
```

## Response Elements
<a name="API_DescribeConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurations](#API_DescribeConfigurations_ResponseSyntax) **   <a name="DiscServ-DescribeConfigurations-response-configurations"></a>
A key in the response map. The value is an array of data.  
Type: Array of string to string maps  
Key Length Constraints: Maximum length of 10000.  
Key Pattern: `[\s\S]*`   
Value Length Constraints: Maximum length of 10000.  
Value Pattern: `[\s\S]*` 

## Errors
<a name="API_DescribeConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeConfigurations_Examples"></a>

### Describe configurations
<a name="API_DescribeConfigurations_Example_1"></a>

The following example queries configuration descriptions of two applications as specified by the values passed to the parameter `configurationIds` in the request. Note that the configuration ID's passed meet the requirement that they represent the same asset type, in this example, *application*.

#### Sample Request
<a name="API_DescribeConfigurations_Example_1_Request"></a>

```
{
    "configurationIds": [
	      "d-application-0282ccd1ba7c211ca",
	      "d-application-034219054305e4a34" 
	  ]
}
```

#### Sample Response
<a name="API_DescribeConfigurations_Example_1_Response"></a>

```
{
    "configurations": [
        {
            "application.configurationId": "d-application-0282ccd1ba7c211ca",
            "application.description": "ads CreateApplication",
            "application.lastModifiedTime": "2018-02-27 00:48:16.0",
            "application.name": "adsdp2",
            "application.serverCount": "2",
            "application.timeOfCreation": "2018-02-27 00:48:16.0"
        },
        {
            "application.configurationId": "d-application-034219054305e4a34",
            "application.description": "ads CreateApplication place holder app",
            "application.lastModifiedTime": "2018-02-27 23:33:32.0",
            "application.name": "adsdp2_ph1",
            "application.serverCount": "0",
            "application.timeOfCreation": "2018-02-27 23:33:32.0"
        }
    ]    
}
```

## See Also
<a name="API_DescribeConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeConfigurations) 

# DescribeContinuousExports
<a name="API_DescribeContinuousExports"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Lists exports as specified by ID. All continuous exports associated with your user can be listed if you call `DescribeContinuousExports` as is without passing any parameters.

## Request Syntax
<a name="API_DescribeContinuousExports_RequestSyntax"></a>

```
{
   "exportIds": [ "string" ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeContinuousExports_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [exportIds](#API_DescribeContinuousExports_RequestSyntax) **   <a name="DiscServ-DescribeContinuousExports-request-exportIds"></a>
The unique IDs assigned to the exports.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: No

 ** [maxResults](#API_DescribeContinuousExports_RequestSyntax) **   <a name="DiscServ-DescribeContinuousExports-request-maxResults"></a>
A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_DescribeContinuousExports_RequestSyntax) **   <a name="DiscServ-DescribeContinuousExports-request-nextToken"></a>
The token from the previous call to `DescribeExportTasks`.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeContinuousExports_ResponseSyntax"></a>

```
{
   "descriptions": [ 
      { 
         "dataSource": "string",
         "exportId": "string",
         "s3Bucket": "string",
         "schemaStorageConfig": { 
            "string" : "string" 
         },
         "startTime": number,
         "status": "string",
         "statusDetail": "string",
         "stopTime": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_DescribeContinuousExports_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [descriptions](#API_DescribeContinuousExports_ResponseSyntax) **   <a name="DiscServ-DescribeContinuousExports-response-descriptions"></a>
A list of continuous export descriptions.  
Type: Array of [ContinuousExportDescription](API_ContinuousExportDescription.md) objects

 ** [nextToken](#API_DescribeContinuousExports_ResponseSyntax) **   <a name="DiscServ-DescribeContinuousExports-response-nextToken"></a>
The token from the previous call to `DescribeExportTasks`.  
Type: String

## Errors
<a name="API_DescribeContinuousExports_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** OperationNotPermittedException **   
This operation is not permitted.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified configuration ID was not located. Verify the configuration ID and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeContinuousExports_Examples"></a>

### Describe a continuous export
<a name="API_DescribeContinuousExports_Example_1"></a>

The following example shows the request and response of describing a particular continuous export specified by passing in a value to `exportId` as well as other filtering parameters.

#### Sample Request
<a name="API_DescribeContinuousExports_Example_1_Request"></a>

```
{
    "maxResults": 10,
    "nextToken": "rLH9RloHsWvY1sljKfLwlmHioorNIJJ1TC9MDO6HolpInQgsQKfk30Zu5n9YP59JZ5k5NzAqs6YerZWY",
    "exportIds": [
        "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59"
    ]
}
```

#### Sample Response
<a name="API_DescribeContinuousExports_Example_1_Response"></a>

```
{
    "descriptions": [
        {
            "exportId": "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59",
            "status": "ACTIVE"
        },
        {
            "schemaStorageConfig": {
                "databaseName": "application_discovery_service_database"
            },
            "startTime": 1531248144.117,
            "exportId": "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59",
            "s3Bucket": "aws-application-discovery-service-92costafer5c9vn0qjane94mi",
            "status": "STOP_IN_PROGRESS",
            "stopTime": 1531248232.085,
            "statusDetail": "",
            "dataSource": "AGENT"
        }
    ]
}
```

## See Also
<a name="API_DescribeContinuousExports_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeContinuousExports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeContinuousExports) 

# DescribeExportConfigurations
<a name="API_DescribeExportConfigurations"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

 `DescribeExportConfigurations` is deprecated. Use [DescribeExportTasks](https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_DescribeExportTasks.html), instead.

## Request Syntax
<a name="API_DescribeExportConfigurations_RequestSyntax"></a>

```
{
   "exportIds": [ "string" ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeExportConfigurations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [exportIds](#API_DescribeExportConfigurations_RequestSyntax) **   <a name="DiscServ-DescribeExportConfigurations-request-exportIds"></a>
A list of continuous export IDs to search for.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: No

 ** [maxResults](#API_DescribeExportConfigurations_RequestSyntax) **   <a name="DiscServ-DescribeExportConfigurations-request-maxResults"></a>
A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.  
Type: Integer  
Required: No

 ** [nextToken](#API_DescribeExportConfigurations_RequestSyntax) **   <a name="DiscServ-DescribeExportConfigurations-request-nextToken"></a>
The token from the previous call to describe-export-tasks.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeExportConfigurations_ResponseSyntax"></a>

```
{
   "exportsInfo": [ 
      { 
         "configurationsDownloadUrl": "string",
         "exportId": "string",
         "exportRequestTime": number,
         "exportStatus": "string",
         "isTruncated": boolean,
         "requestedEndTime": number,
         "requestedStartTime": number,
         "statusMessage": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_DescribeExportConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [exportsInfo](#API_DescribeExportConfigurations_ResponseSyntax) **   <a name="DiscServ-DescribeExportConfigurations-response-exportsInfo"></a>
  
Type: Array of [ExportInfo](API_ExportInfo.md) objects

 ** [nextToken](#API_DescribeExportConfigurations_ResponseSyntax) **   <a name="DiscServ-DescribeExportConfigurations-response-nextToken"></a>
The token from the previous call to describe-export-tasks.  
Type: String

## Errors
<a name="API_DescribeExportConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ResourceNotFoundException **   
The specified configuration ID was not located. Verify the configuration ID and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## See Also
<a name="API_DescribeExportConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeExportConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeExportConfigurations) 

# DescribeExportTasks
<a name="API_DescribeExportTasks"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

## Request Syntax
<a name="API_DescribeExportTasks_RequestSyntax"></a>

```
{
   "exportIds": [ "string" ],
   "filters": [ 
      { 
         "condition": "string",
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeExportTasks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [exportIds](#API_DescribeExportTasks_RequestSyntax) **   <a name="DiscServ-DescribeExportTasks-request-exportIds"></a>
One or more unique identifiers used to query the status of an export request.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: No

 ** [filters](#API_DescribeExportTasks_RequestSyntax) **   <a name="DiscServ-DescribeExportTasks-request-filters"></a>
One or more filters.  
+  `AgentId` - ID of the agent whose collected data will be exported
Type: Array of [ExportFilter](API_ExportFilter.md) objects  
Required: No

 ** [maxResults](#API_DescribeExportTasks_RequestSyntax) **   <a name="DiscServ-DescribeExportTasks-request-maxResults"></a>
The maximum number of volume results returned by `DescribeExportTasks` in paginated output. When this parameter is used, `DescribeExportTasks` only returns `maxResults` results in a single page along with a `nextToken` response element.  
Type: Integer  
Required: No

 ** [nextToken](#API_DescribeExportTasks_RequestSyntax) **   <a name="DiscServ-DescribeExportTasks-request-nextToken"></a>
The `nextToken` value returned from a previous paginated `DescribeExportTasks` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value. This value is null when there are no more results to return.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeExportTasks_ResponseSyntax"></a>

```
{
   "exportsInfo": [ 
      { 
         "configurationsDownloadUrl": "string",
         "exportId": "string",
         "exportRequestTime": number,
         "exportStatus": "string",
         "isTruncated": boolean,
         "requestedEndTime": number,
         "requestedStartTime": number,
         "statusMessage": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_DescribeExportTasks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [exportsInfo](#API_DescribeExportTasks_ResponseSyntax) **   <a name="DiscServ-DescribeExportTasks-response-exportsInfo"></a>
Contains one or more sets of export request details. When the status of a request is `SUCCEEDED`, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.  
Type: Array of [ExportInfo](API_ExportInfo.md) objects

 ** [nextToken](#API_DescribeExportTasks_ResponseSyntax) **   <a name="DiscServ-DescribeExportTasks-response-nextToken"></a>
The `nextToken` value to include in a future `DescribeExportTasks` request. When the results of a `DescribeExportTasks` request exceed `maxResults`, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.  
Type: String

## Errors
<a name="API_DescribeExportTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeExportTasks_Examples"></a>

In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the * AWS General Reference*.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

### Retrieve status of two specified export tasks
<a name="API_DescribeExportTasks_Example_1"></a>

This example illustrates one usage of DescribeExportTasks.

#### Sample Request
<a name="API_DescribeExportTasks_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: discovery.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 109
X-Amz-Target: AWSPoseidonService_V2015_11_01.DescribeExportTasks
X-Amz-Date: 20170308T232123Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS

{
   "exportIds":[
      "export-123a4b56-7c89-01d2-3ef4-example5678f",
      "export-654a3b21-7c89-01d2-3ef4-example8765f"
   ]
}
```

#### Sample Response
<a name="API_DescribeExportTasks_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
Content-Type: application/x-amz-json-1.1
Content-Length: 1140
Date: Wed, 08 Mar 2017 23:21:25 GMT

{
   "exportsInfo":[
      {
         "configurationsDownloadUrl":"[URL]",
         "exportId":"export-123a4b56-7c89-01d2-3ef4-example5678f",
         "exportRequestTime":1.489001254713E9,
         "exportStatus":"SUCCEEDED",
         "statusMessage":"Data export ran successfully and is accessible from the download URL. The URL will expire in 24 hours. The export data expires in 10 days."
      },
      {
         "configurationsDownloadUrl":"[URL]",
         "exportId":"export-654a3b21-7c89-01d2-3ef4-example8765f",
         "exportRequestTime":1.488920016713E9,
         "exportStatus":"SUCCEEDED",
         "statusMessage":"Data export ran successfully and is accessible from the download URL. The URL will expire in 24 hours. The export data expires in 10 days."
      }
   ],
   "nextToken":""
}
```

## See Also
<a name="API_DescribeExportTasks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeExportTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeExportTasks) 

# DescribeImportTasks
<a name="API_DescribeImportTasks"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

## Request Syntax
<a name="API_DescribeImportTasks_RequestSyntax"></a>

```
{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeImportTasks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filters](#API_DescribeImportTasks_RequestSyntax) **   <a name="DiscServ-DescribeImportTasks-request-filters"></a>
An array of name-value pairs that you provide to filter the results for the `DescribeImportTask` request to a specific subset of results. Currently, wildcard values aren't supported for filters.  
Type: Array of [ImportTaskFilter](API_ImportTaskFilter.md) objects  
Required: No

 ** [maxResults](#API_DescribeImportTasks_RequestSyntax) **   <a name="DiscServ-DescribeImportTasks-request-maxResults"></a>
The maximum number of results that you want this request to return, up to 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_DescribeImportTasks_RequestSyntax) **   <a name="DiscServ-DescribeImportTasks-request-nextToken"></a>
The token to request a specific page of results.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeImportTasks_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "tasks": [ 
      { 
         "applicationImportFailure": number,
         "applicationImportSuccess": number,
         "clientRequestToken": "string",
         "errorsAndFailedEntriesZip": "string",
         "fileClassification": "string",
         "importCompletionTime": number,
         "importDeletedTime": number,
         "importRequestTime": number,
         "importTaskId": "string",
         "importUrl": "string",
         "name": "string",
         "serverImportFailure": number,
         "serverImportSuccess": number,
         "status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeImportTasks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_DescribeImportTasks_ResponseSyntax) **   <a name="DiscServ-DescribeImportTasks-response-nextToken"></a>
The token to request the next page of results.  
Type: String

 ** [tasks](#API_DescribeImportTasks_ResponseSyntax) **   <a name="DiscServ-DescribeImportTasks-response-tasks"></a>
A returned array of import tasks that match any applied filters, up to the specified number of maximum results.  
Type: Array of [ImportTask](API_ImportTask.md) objects

## Errors
<a name="API_DescribeImportTasks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## See Also
<a name="API_DescribeImportTasks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeImportTasks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeImportTasks) 

# DescribeTags
<a name="API_DescribeTags"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter `filters`.

There are three valid tag filter names:
+ tagKey
+ tagValue
+ configurationId

Also, all configuration items associated with your user that have tags can be listed if you call `DescribeTags` as is without passing any parameters.

## Request Syntax
<a name="API_DescribeTags_RequestSyntax"></a>

```
{
   "filters": [ 
      { 
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_DescribeTags_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [filters](#API_DescribeTags_RequestSyntax) **   <a name="DiscServ-DescribeTags-request-filters"></a>
You can filter the list using a *key*-*value* format. You can separate these items by using logical operators. Allowed filters include `tagKey`, `tagValue`, and `configurationId`.   
Type: Array of [TagFilter](API_TagFilter.md) objects  
Required: No

 ** [maxResults](#API_DescribeTags_RequestSyntax) **   <a name="DiscServ-DescribeTags-request-maxResults"></a>
The total number of items to return in a single page of output. The maximum value is 100.  
Type: Integer  
Required: No

 ** [nextToken](#API_DescribeTags_RequestSyntax) **   <a name="DiscServ-DescribeTags-request-nextToken"></a>
A token to start the list. Use this token to get the next set of results.  
Type: String  
Required: No

## Response Syntax
<a name="API_DescribeTags_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "tags": [ 
      { 
         "configurationId": "string",
         "configurationType": "string",
         "key": "string",
         "timeOfCreation": number,
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeTags_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_DescribeTags_ResponseSyntax) **   <a name="DiscServ-DescribeTags-response-nextToken"></a>
The call returns a token. Use this token to get the next set of results.  
Type: String

 ** [tags](#API_DescribeTags_ResponseSyntax) **   <a name="DiscServ-DescribeTags-response-tags"></a>
Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.  
Type: Array of [ConfigurationTag](API_ConfigurationTag.md) objects

## Errors
<a name="API_DescribeTags_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ResourceNotFoundException **   
The specified configuration ID was not located. Verify the configuration ID and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DescribeTags_Examples"></a>

### Describe tags that have a particular value
<a name="API_DescribeTags_Example_1"></a>

The following example lists configuration items associated with an agent installed on a linux server. This is done by passing object array values to the parameter `filters` where `name` is "tagValue" and `value` is "agent on linux server". This results in a descriptive response that lists configuration item details where the tag value is equal to the value specified in the request.

#### Sample Request
<a name="API_DescribeTags_Example_1_Request"></a>

```
{
"filters": [ 
       { 
         "name": "tagValue",
         "values": [ "agent on linux server" ]
      }
   ]
}
```

#### Sample Response
<a name="API_DescribeTags_Example_1_Response"></a>

```
{
    "tags": [
        {
            "configurationType": "SERVER",
            "configurationId": "d-server-0c269e353e6d1fb4c",
            "key": "dp2",
            "value": "agent on linux server",
            "timeOfCreation": 1519674610.0
        }
    ],
    "nextToken": "0039038d504694533"
}
```

## See Also
<a name="API_DescribeTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DescribeTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DescribeTags) 

# DisassociateConfigurationItemsFromApplication
<a name="API_DisassociateConfigurationItemsFromApplication"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Disassociates one or more configuration items from an application.

## Request Syntax
<a name="API_DisassociateConfigurationItemsFromApplication_RequestSyntax"></a>

```
{
   "applicationConfigurationId": "string",
   "configurationIds": [ "string" ]
}
```

## Request Parameters
<a name="API_DisassociateConfigurationItemsFromApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [applicationConfigurationId](#API_DisassociateConfigurationItemsFromApplication_RequestSyntax) **   <a name="DiscServ-DisassociateConfigurationItemsFromApplication-request-applicationConfigurationId"></a>
Configuration ID of an application from which each item is disassociated.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S+`   
Required: Yes

 ** [configurationIds](#API_DisassociateConfigurationItemsFromApplication_RequestSyntax) **   <a name="DiscServ-DisassociateConfigurationItemsFromApplication-request-configurationIds"></a>
Configuration ID of each item to be disassociated from an application.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: Yes

## Response Elements
<a name="API_DisassociateConfigurationItemsFromApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateConfigurationItemsFromApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_DisassociateConfigurationItemsFromApplication_Examples"></a>

### Disassociate configuration items from an application
<a name="API_DisassociateConfigurationItemsFromApplication_Example_1"></a>

The following example disassociates two Application Discovery Service discovered resources specified by their configuration ids from the application identified by the value passed to the required parameter `applicationConfigurationId` in the request.

#### Sample Request
<a name="API_DisassociateConfigurationItemsFromApplication_Example_1_Request"></a>

```
{
    "applicationConfigurationId":"d-application-0039038d504694533",
    "configurationIds": [
	      "d-server-0025db43a885966c8",
	      "d-server-0f0a32a0db4217bd6"
    ]
}
```

## See Also
<a name="API_DisassociateConfigurationItemsFromApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/DisassociateConfigurationItemsFromApplication) 

# ExportConfigurations
<a name="API_ExportConfigurations"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Deprecated. Use `StartExportTask` instead.

Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the *DescribeExportConfigurations* API. The system imposes a limit of two configuration exports in six hours.

## Response Syntax
<a name="API_ExportConfigurations_ResponseSyntax"></a>

```
{
   "exportId": "string"
}
```

## Response Elements
<a name="API_ExportConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [exportId](#API_ExportConfigurations_ResponseSyntax) **   <a name="DiscServ-ExportConfigurations-response-exportId"></a>
A unique identifier that you can use to query the export status.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S*` 

## Errors
<a name="API_ExportConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** OperationNotPermittedException **   
This operation is not permitted.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## See Also
<a name="API_ExportConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/ExportConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/ExportConfigurations) 

# GetDiscoverySummary
<a name="API_GetDiscoverySummary"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Retrieves a short summary of discovered assets.

This API operation takes no request parameters and is called as is at the command prompt as shown in the example.

## Response Syntax
<a name="API_GetDiscoverySummary_ResponseSyntax"></a>

```
{
   "agentlessCollectorSummary": { 
      "activeAgentlessCollectors": number,
      "denyListedAgentlessCollectors": number,
      "healthyAgentlessCollectors": number,
      "shutdownAgentlessCollectors": number,
      "totalAgentlessCollectors": number,
      "unhealthyAgentlessCollectors": number,
      "unknownAgentlessCollectors": number
   },
   "agentSummary": { 
      "activeAgents": number,
      "blackListedAgents": number,
      "healthyAgents": number,
      "shutdownAgents": number,
      "totalAgents": number,
      "unhealthyAgents": number,
      "unknownAgents": number
   },
   "applications": number,
   "connectorSummary": { 
      "activeConnectors": number,
      "blackListedConnectors": number,
      "healthyConnectors": number,
      "shutdownConnectors": number,
      "totalConnectors": number,
      "unhealthyConnectors": number,
      "unknownConnectors": number
   },
   "meCollectorSummary": { 
      "activeMeCollectors": number,
      "denyListedMeCollectors": number,
      "healthyMeCollectors": number,
      "shutdownMeCollectors": number,
      "totalMeCollectors": number,
      "unhealthyMeCollectors": number,
      "unknownMeCollectors": number
   },
   "servers": number,
   "serversMappedToApplications": number,
   "serversMappedtoTags": number
}
```

## Response Elements
<a name="API_GetDiscoverySummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentlessCollectorSummary](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-agentlessCollectorSummary"></a>
 Details about Agentless Collector collectors, including status.   
Type: [CustomerAgentlessCollectorInfo](API_CustomerAgentlessCollectorInfo.md) object

 ** [agentSummary](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-agentSummary"></a>
Details about discovered agents, including agent status and health.  
Type: [CustomerAgentInfo](API_CustomerAgentInfo.md) object

 ** [applications](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-applications"></a>
The number of applications discovered.  
Type: Long

 ** [connectorSummary](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-connectorSummary"></a>
Details about discovered connectors, including connector status and health.  
Type: [CustomerConnectorInfo](API_CustomerConnectorInfo.md) object

 ** [meCollectorSummary](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-meCollectorSummary"></a>
 Details about Migration Evaluator collectors, including collector status and health.   
Type: [CustomerMeCollectorInfo](API_CustomerMeCollectorInfo.md) object

 ** [servers](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-servers"></a>
The number of servers discovered.  
Type: Long

 ** [serversMappedToApplications](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-serversMappedToApplications"></a>
The number of servers mapped to applications.  
Type: Long

 ** [serversMappedtoTags](#API_GetDiscoverySummary_ResponseSyntax) **   <a name="DiscServ-GetDiscoverySummary-response-serversMappedtoTags"></a>
The number of servers mapped to tags.  
Type: Long

## Errors
<a name="API_GetDiscoverySummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_GetDiscoverySummary_Examples"></a>

### Get discovery summary of discovered assets
<a name="API_GetDiscoverySummary_Example_1"></a>

In the following example `GetDiscoverySummary` is called as is, without any request parameters, directly from the AWS CLI and returns a summary of all discovered assets associated with your account.

#### Sample Request
<a name="API_GetDiscoverySummary_Example_1_Request"></a>

```
$ aws discovery get-discovery-summary
```

#### Sample Response
<a name="API_GetDiscoverySummary_Example_1_Response"></a>

```
{
    "servers": 1370,
    "applications": 125,
    "serversMappedToApplications": 212,
    "serversMappedtoTags": 213,
    "agentlessCollectorSummary": { 
        "activeAgentlessCollectors": 3,
        "denyListedAgentlessCollectors": 0,
        "healthyAgentlessCollectors": 3,
        "shutdownAgentlessCollectors": 0,
        "totalAgentlessCollectors": 15,
        "unhealthyAgentlessCollectors": 0,
        "unknownAgentlessCollectors": 12
    },
    "agentSummary": {
        "activeAgents": 3,
        "healthyAgents": 3,
        "blackListedAgents": 0,
        "shutdownAgents": 0,
        "unhealthyAgents": 0,
        "totalAgents": 16,
        "unknownAgents": 13
    },
    "connectorSummary": {
        "activeConnectors": 1,
        "healthyConnectors": 1,
        "blackListedConnectors": 0,
        "shutdownConnectors": 0,
        "unhealthyConnectors": 1,
        "totalConnectors": 2,
        "unknownConnectors": 0
    },
    "meCollectorSummary": {
        "activeMeCollectors": 1,
        "denyListedMeCollectors": 0,
        "healthyMeCollectors": 1,
        "shutdownMeCollectors": 0,
        "totalMeCollectors": 2,
        "unhealthyMeCollectors": 1,
        "unknownMeCollectors": 0
    }
}
```

## See Also
<a name="API_GetDiscoverySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/GetDiscoverySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/GetDiscoverySummary) 

# ListConfigurations
<a name="API_ListConfigurations"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Retrieves a list of configuration items as specified by the value passed to the required parameter `configurationType`. Optional filtering may be applied to refine search results.

## Request Syntax
<a name="API_ListConfigurations_RequestSyntax"></a>

```
{
   "configurationType": "string",
   "filters": [ 
      { 
         "condition": "string",
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "orderBy": [ 
      { 
         "fieldName": "string",
         "sortOrder": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_ListConfigurations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationType](#API_ListConfigurations_RequestSyntax) **   <a name="DiscServ-ListConfigurations-request-configurationType"></a>
A valid configuration identified by Application Discovery Service.   
Type: String  
Valid Values: `SERVER | PROCESS | CONNECTION | APPLICATION`   
Required: Yes

 ** [filters](#API_ListConfigurations_RequestSyntax) **   <a name="DiscServ-ListConfigurations-request-filters"></a>
You can filter the request using various logical operators and a *key*-*value* format. For example:   
 `{"key": "serverType", "value": "webServer"}`   
For a complete list of filter options and guidance about using them with this action, see [Using the ListConfigurations Action](https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) in the * AWS Application Discovery Service User Guide*.  
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 ** [maxResults](#API_ListConfigurations_RequestSyntax) **   <a name="DiscServ-ListConfigurations-request-maxResults"></a>
The total number of items to return. The maximum value is 100.  
Type: Integer  
Required: No

 ** [nextToken](#API_ListConfigurations_RequestSyntax) **   <a name="DiscServ-ListConfigurations-request-nextToken"></a>
Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set `ListConfigurationsRequest$maxResults` to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.  
Type: String  
Required: No

 ** [orderBy](#API_ListConfigurations_RequestSyntax) **   <a name="DiscServ-ListConfigurations-request-orderBy"></a>
Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see [Using the ListConfigurations Action](https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations) in the * AWS Application Discovery Service User Guide*.  
Type: Array of [OrderByElement](API_OrderByElement.md) objects  
Required: No

## Response Syntax
<a name="API_ListConfigurations_ResponseSyntax"></a>

```
{
   "configurations": [ 
      { 
         "string" : "string" 
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurations](#API_ListConfigurations_ResponseSyntax) **   <a name="DiscServ-ListConfigurations-response-configurations"></a>
Returns configuration details, including the configuration ID, attribute names, and attribute values.  
Type: Array of string to string maps  
Key Length Constraints: Maximum length of 10000.  
Key Pattern: `[\s\S]*`   
Value Length Constraints: Maximum length of 10000.  
Value Pattern: `[\s\S]*` 

 ** [nextToken](#API_ListConfigurations_ResponseSyntax) **   <a name="DiscServ-ListConfigurations-response-nextToken"></a>
Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set `ListConfigurationsRequest$maxResults` to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.  
Type: String

## Errors
<a name="API_ListConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ResourceNotFoundException **   
The specified configuration ID was not located. Verify the configuration ID and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_ListConfigurations_Examples"></a>

### List configurations based on server type
<a name="API_ListConfigurations_Example_1"></a>

The following example lists server configurations where the server type is an EC2 instance. This is done by passing the value "SERVER" to the required parameter `configurationType`. Then, to limit the results to just EC2 servers, object array values are passed to the parameter `filters` where `condition` is "EQUALS, `name` is "server.type", and `values` is "EC2". A sorting refinement is also used in this example by passing values to the parameter `orderBy` that sorts the results by the server's OS name in reverse alphabetical order.

#### Sample Request
<a name="API_ListConfigurations_Example_1_Request"></a>

```
{
   "configurationType": "SERVER",
   "filters": [ 
      { 
         "condition": "EQUALS",
         "name": "server.type",
         "values": [ "EC2" ]
      }
   ],
   "orderBy": [ 
      { 
         "fieldName": "server.osName",
         "sortOrder": "DESC"
      }
   ]
}
```

#### Sample Response
<a name="API_ListConfigurations_Example_1_Response"></a>

```
{
    "configurations": [
        {
            "server.agentId": "i-0adf772ed9f61445a",
            "server.configurationId": "d-server-062d1f42166d190a4",
            "server.hostName": "WIN-7O92JH2AKNB",
            "server.osName": "WindowsOS - Windows Server 2012 R2 x64",
            "server.osVersion": "6.2.9200",
            "server.source": "Agent",
            "server.timeOfCreation": "2017-10-09 20:42:25.0",
            "server.type": "EC2"
        },
        {
            "server.agentId": "i-0243426187d59c9c3",
            "server.configurationId": "d-server-0fc7f9126ed1c2be7",
            "server.hostName": "ip-10-0-0-22.us-west-2.compute.internal",
            "server.osName": "Linux - Red Hat Enterprise Linux Server release 7.3 (Maipo)",
            "server.osVersion": "3.10.0-514.el7.x86_64",
            "server.source": "Agent",
            "server.timeOfCreation": "2017-04-06 19:58:15.0",
            "server.type": "EC2"
        }
}
```

## See Also
<a name="API_ListConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/ListConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/ListConfigurations) 

# ListServerNeighbors
<a name="API_ListServerNeighbors"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Retrieves a list of servers that are one network hop away from a specified server.

## Request Syntax
<a name="API_ListServerNeighbors_RequestSyntax"></a>

```
{
   "configurationId": "string",
   "maxResults": number,
   "neighborConfigurationIds": [ "string" ],
   "nextToken": "string",
   "portInformationNeeded": boolean
}
```

## Request Parameters
<a name="API_ListServerNeighbors_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationId](#API_ListServerNeighbors_RequestSyntax) **   <a name="DiscServ-ListServerNeighbors-request-configurationId"></a>
Configuration ID of the server for which neighbors are being listed.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: Yes

 ** [maxResults](#API_ListServerNeighbors_RequestSyntax) **   <a name="DiscServ-ListServerNeighbors-request-maxResults"></a>
Maximum number of results to return in a single page of output.  
Type: Integer  
Required: No

 ** [neighborConfigurationIds](#API_ListServerNeighbors_RequestSyntax) **   <a name="DiscServ-ListServerNeighbors-request-neighborConfigurationIds"></a>
List of configuration IDs to test for one-hop-away.  
Type: Array of strings  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: No

 ** [nextToken](#API_ListServerNeighbors_RequestSyntax) **   <a name="DiscServ-ListServerNeighbors-request-nextToken"></a>
Token to retrieve the next set of results. For example, if you previously specified 100 IDs for `ListServerNeighborsRequest$neighborConfigurationIds` but set `ListServerNeighborsRequest$maxResults` to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.  
Type: String  
Length Constraints: Maximum length of 10000.  
Pattern: `[\s\S]*`   
Required: No

 ** [portInformationNeeded](#API_ListServerNeighbors_RequestSyntax) **   <a name="DiscServ-ListServerNeighbors-request-portInformationNeeded"></a>
Flag to indicate if port and protocol information is needed as part of the response.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_ListServerNeighbors_ResponseSyntax"></a>

```
{
   "knownDependencyCount": number,
   "neighbors": [ 
      { 
         "connectionsCount": number,
         "destinationPort": number,
         "destinationServerId": "string",
         "sourceServerId": "string",
         "transportProtocol": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListServerNeighbors_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [knownDependencyCount](#API_ListServerNeighbors_ResponseSyntax) **   <a name="DiscServ-ListServerNeighbors-response-knownDependencyCount"></a>
Count of distinct servers that are one hop away from the given server.  
Type: Long

 ** [neighbors](#API_ListServerNeighbors_ResponseSyntax) **   <a name="DiscServ-ListServerNeighbors-response-neighbors"></a>
List of distinct servers that are one hop away from the given server.  
Type: Array of [NeighborConnectionDetail](API_NeighborConnectionDetail.md) objects

 ** [nextToken](#API_ListServerNeighbors_ResponseSyntax) **   <a name="DiscServ-ListServerNeighbors-response-nextToken"></a>
Token to retrieve the next set of results. For example, if you specified 100 IDs for `ListServerNeighborsRequest$neighborConfigurationIds` but set `ListServerNeighborsRequest$maxResults` to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.  
Type: String  
Length Constraints: Maximum length of 10000.  
Pattern: `[\s\S]*` 

## Errors
<a name="API_ListServerNeighbors_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_ListServerNeighbors_Examples"></a>

### List server neighbors
<a name="API_ListServerNeighbors_Example_1"></a>

The following example requests to find out if there are any server neighbors that are one network hop away from the server specified in the required parameter `configurationId`. Port information is also requested by passing "true" to the boolean parameter `portInformationNeeded` (note that boolean parameters must be passed as all lowercase without any quotes). It this particular example, no server neighbors are found that are one network hop away.

#### Sample Request
<a name="API_ListServerNeighbors_Example_1_Request"></a>

```
{
   "configurationId": "d-server-0974b967a76335589",
   "neighborConfigurationIds": [ "d-server-0c269e353e6d1fb4c","d-server-01440c9c5df26ae50" ],
   "portInformationNeeded": true
}
```

#### Sample Response
<a name="API_ListServerNeighbors_Example_1_Response"></a>

```
{
    "neighbors": [],
    "knownDependencyCount": 0
}
```

## See Also
<a name="API_ListServerNeighbors_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/ListServerNeighbors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/ListServerNeighbors) 

# StartBatchDeleteConfigurationTask
<a name="API_StartBatchDeleteConfigurationTask"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

 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
<a name="API_StartBatchDeleteConfigurationTask_RequestSyntax"></a>

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

## Request Parameters
<a name="API_StartBatchDeleteConfigurationTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationIds](#API_StartBatchDeleteConfigurationTask_RequestSyntax) **   <a name="DiscServ-StartBatchDeleteConfigurationTask-request-configurationIds"></a>
 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](#API_StartBatchDeleteConfigurationTask_RequestSyntax) **   <a name="DiscServ-StartBatchDeleteConfigurationTask-request-configurationType"></a>
 The type of configuration item to delete. Supported types are: SERVER.   
Type: String  
Valid Values: `SERVER`   
Required: Yes

## Response Syntax
<a name="API_StartBatchDeleteConfigurationTask_ResponseSyntax"></a>

```
{
   "taskId": "string"
}
```

## Response Elements
<a name="API_StartBatchDeleteConfigurationTask_ResponseElements"></a>

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](#API_StartBatchDeleteConfigurationTask_ResponseSyntax) **   <a name="DiscServ-StartBatchDeleteConfigurationTask-response-taskId"></a>
 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
<a name="API_StartBatchDeleteConfigurationTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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 **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
 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
<a name="API_StartBatchDeleteConfigurationTask_Examples"></a>

### 
<a name="API_StartBatchDeleteConfigurationTask_Example_1"></a>

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 `configurationIds`and `configurationType`.

#### Sample Request
<a name="API_StartBatchDeleteConfigurationTask_Example_1_Request"></a>

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

### 
<a name="API_StartBatchDeleteConfigurationTask_Example_2"></a>

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

#### Sample Response
<a name="API_StartBatchDeleteConfigurationTask_Example_2_Response"></a>

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

## See Also
<a name="API_StartBatchDeleteConfigurationTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/StartBatchDeleteConfigurationTask) 

# StartContinuousExport
<a name="API_StartContinuousExport"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Start the continuous flow of agent's discovered data into Amazon Athena.

## Response Syntax
<a name="API_StartContinuousExport_ResponseSyntax"></a>

```
{
   "dataSource": "string",
   "exportId": "string",
   "s3Bucket": "string",
   "schemaStorageConfig": { 
      "string" : "string" 
   },
   "startTime": number
}
```

## Response Elements
<a name="API_StartContinuousExport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dataSource](#API_StartContinuousExport_ResponseSyntax) **   <a name="DiscServ-StartContinuousExport-response-dataSource"></a>
The type of data collector used to gather this data (currently only offered for AGENT).  
Type: String  
Valid Values: `AGENT` 

 ** [exportId](#API_StartContinuousExport_ResponseSyntax) **   <a name="DiscServ-StartContinuousExport-response-exportId"></a>
The unique ID assigned to this export.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S*` 

 ** [s3Bucket](#API_StartContinuousExport_ResponseSyntax) **   <a name="DiscServ-StartContinuousExport-response-s3Bucket"></a>
The name of the s3 bucket where the export data parquet files are stored.  
Type: String

 ** [schemaStorageConfig](#API_StartContinuousExport_ResponseSyntax) **   <a name="DiscServ-StartContinuousExport-response-schemaStorageConfig"></a>
A dictionary which describes how the data is stored.  
+  `databaseName` - the name of the Glue database used to store the schema.
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 252.  
Value Length Constraints: Maximum length of 10000.  
Value Pattern: `[\s\S]*` 

 ** [startTime](#API_StartContinuousExport_ResponseSyntax) **   <a name="DiscServ-StartContinuousExport-response-startTime"></a>
The timestamp representing when the continuous export was started.  
Type: Timestamp

## Errors
<a name="API_StartContinuousExport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** ConflictErrorException **   
Conflict error.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** OperationNotPermittedException **   
This operation is not permitted.  
HTTP Status Code: 400

 ** ResourceInUseException **   
This issue occurs when the same `clientRequestToken` is used with the `StartImportTask` action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different `clientRequestToken`, and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_StartContinuousExport_Examples"></a>

### Start a continuous export
<a name="API_StartContinuousExport_Example_1"></a>

The following example shows the response of starting a continuous export.

#### Sample Response
<a name="API_StartContinuousExport_Example_1_Response"></a>

```
{
    "startTime": 1531247730.19,
    "dataSource": "AGENT",
    "schemaStorageConfig": {
        "databaseName": "application_discovery_service_database"
    },
    "exportId": "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59",
    "s3Bucket": "aws-application-discovery-service-92costafer5c9vn0qjane94mi"
}
```

## See Also
<a name="API_StartContinuousExport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/StartContinuousExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/StartContinuousExport) 

# StartDataCollectionByAgentIds
<a name="API_StartDataCollectionByAgentIds"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Instructs the specified agents to start collecting data.

## Request Syntax
<a name="API_StartDataCollectionByAgentIds_RequestSyntax"></a>

```
{
   "agentIds": [ "string" ]
}
```

## Request Parameters
<a name="API_StartDataCollectionByAgentIds_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [agentIds](#API_StartDataCollectionByAgentIds_RequestSyntax) **   <a name="DiscServ-StartDataCollectionByAgentIds-request-agentIds"></a>
The IDs of the agents from which to start collecting data. If you send a request to an agent ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the *Description* field. If you send a request to multiple agents and you do not have permission to contact some of those agents, the system does not throw an exception. Instead, the system shows `Failed` in the *Description* field.  
Type: Array of strings  
Length Constraints: Minimum length of 10. Maximum length of 20.  
Pattern: `\S+`   
Required: Yes

## Response Syntax
<a name="API_StartDataCollectionByAgentIds_ResponseSyntax"></a>

```
{
   "agentsConfigurationStatus": [ 
      { 
         "agentId": "string",
         "description": "string",
         "operationSucceeded": boolean
      }
   ]
}
```

## Response Elements
<a name="API_StartDataCollectionByAgentIds_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentsConfigurationStatus](#API_StartDataCollectionByAgentIds_ResponseSyntax) **   <a name="DiscServ-StartDataCollectionByAgentIds-response-agentsConfigurationStatus"></a>
Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation performed, and whether the agent configuration was updated.  
Type: Array of [AgentConfigurationStatus](API_AgentConfigurationStatus.md) objects

## Errors
<a name="API_StartDataCollectionByAgentIds_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_StartDataCollectionByAgentIds_Examples"></a>

### Start data collection by agent ids for one agent
<a name="API_StartDataCollectionByAgentIds_Example_1"></a>

In the following example, multiple agent ids are passed to the required parameter `agentIds` to start one agent. In the response, the first agent id returned is reported as started successfully, in the second agent id returned, the description reads "Redundant", which means that a request was sent to start an agent that was already running.

#### Sample Request
<a name="API_StartDataCollectionByAgentIds_Example_1_Request"></a>

```
{
   "agentIds": [ "c-a07gapohc6spvdl65","i-0afec73de85777dd0" ]
}
```

#### Sample Response
<a name="API_StartDataCollectionByAgentIds_Example_1_Response"></a>

```
{
    "agentsConfigurationStatus": [
        {
            "agentId": "c-a07gapohc6spvdl65",
            "operationSucceeded": true,
            "description": "Succeeded"
        },
        {
            "agentId": "i-0afec73de85777dd0",
            "operationSucceeded": false,
            "description": "Redundant"
        }
    ]
}
```

## See Also
<a name="API_StartDataCollectionByAgentIds_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/StartDataCollectionByAgentIds) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/StartDataCollectionByAgentIds) 

# StartExportTask
<a name="API_StartExportTask"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Begins the export of a discovered data report to an Amazon S3 bucket managed by AWS.

**Note**  
Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of AWS services, which might vary from the estimates provided in this report.

If you do not specify `preferences` or `agentIds` in the filter, a summary of all servers, applications, tags, and performance is generated. This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping and applying tags.

If you specify `agentIds` in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using `startTime` and `endTime`. Export of detailed agent data is limited to five concurrently running exports. Export of detailed agent data is limited to two exports per day.

If you enable `ec2RecommendationsPreferences` in `preferences` [ExportPreferences](API_ExportPreferences.md), an Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. Changing the attributes of the `ec2RecommendationsPreferences` changes the criteria of the recommendation.

## Request Syntax
<a name="API_StartExportTask_RequestSyntax"></a>

```
{
   "endTime": number,
   "exportDataFormat": [ "string" ],
   "filters": [ 
      { 
         "condition": "string",
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "preferences": { ... },
   "startTime": number
}
```

## Request Parameters
<a name="API_StartExportTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [endTime](#API_StartExportTask_RequestSyntax) **   <a name="DiscServ-StartExportTask-request-endTime"></a>
The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.  
Type: Timestamp  
Required: No

 ** [exportDataFormat](#API_StartExportTask_RequestSyntax) **   <a name="DiscServ-StartExportTask-request-exportDataFormat"></a>
The file format for the returned export data. Default value is `CSV`. **Note:** *The* `GRAPHML` *option has been deprecated.*   
Type: Array of strings  
Valid Values: `CSV`   
Required: No

 ** [filters](#API_StartExportTask_RequestSyntax) **   <a name="DiscServ-StartExportTask-request-filters"></a>
If a filter is present, it selects the single `agentId` of the Application Discovery Agent for which data is exported. The `agentId` can be found in the results of the `DescribeAgents` API or CLI. If no filter is present, `startTime` and `endTime` are ignored and exported data includes both AWS Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents.   
Type: Array of [ExportFilter](API_ExportFilter.md) objects  
Required: No

 ** [preferences](#API_StartExportTask_RequestSyntax) **   <a name="DiscServ-StartExportTask-request-preferences"></a>
 Indicates the type of data that needs to be exported. Only one [ExportPreferences](https://docs.aws.amazon.com/application-discovery/latest/APIReference/API_ExportPreferences.html) can be enabled at any time.   
Type: [ExportPreferences](API_ExportPreferences.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [startTime](#API_StartExportTask_RequestSyntax) **   <a name="DiscServ-StartExportTask-request-startTime"></a>
The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_StartExportTask_ResponseSyntax"></a>

```
{
   "exportId": "string"
}
```

## Response Elements
<a name="API_StartExportTask_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [exportId](#API_StartExportTask_ResponseSyntax) **   <a name="DiscServ-StartExportTask-response-exportId"></a>
A unique identifier used to query the status of an export request.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S*` 

## Errors
<a name="API_StartExportTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** OperationNotPermittedException **   
This operation is not permitted.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_StartExportTask_Examples"></a>

In the following example or examples, the Authorization header contents (`AUTHPARAMS`) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the * AWS General Reference*.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

### Specify export preferences
<a name="API_StartExportTask_Example_1"></a>

This example illustrates one usage of StartExportTask.

#### Sample Request
<a name="API_StartExportTask_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: discovery.us-west-2.amazonaws.com
Accept-Encoding: gzip, deflate
X-Amz-Target: AWSPoseidonService_V2015_11_01.StartExportTask
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS

{
    "preferences": {
        "ec2RecommendationsPreferences": {
            "enabled": true,
            "cpuPerformanceMetricBasis": {
                "name": "AVG",
                "percentageAdjust": 3.14159
            },
            "ramPerformanceMetricBasis": {
                "name": "MAX",
                "percentageAdjust": 3.14159
            },
            "tenancy": "DEDICATED",
            "excludedInstanceTypes": ["m5.4xlarge", "r3.large", "t3"],
            "preferredRegion": "us-west-2",
            "reservedInstanceOptions": {
                "purchasingOption": "ALL_UPFRONT",
                "offeringClass": "STANDARD",
                "termLength": "ONE_YEAR"
            }
        }
    }
}
```

#### Sample Response
<a name="API_StartExportTask_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
Content-Type: application/x-amz-json-1.1
Content-Length: 58
Date: Tue, 13 Jun 2023 00:44:54 GMT
          
{
   "exportId":"export-123a4b56-7c89-01d2-3ef4-example5678f"
}
```

## See Also
<a name="API_StartExportTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/StartExportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/StartExportTask) 

# StartImportTask
<a name="API_StartImportTask"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Starts an import task, which allows you to import details of your on-premises environment directly into AWS Migration Hub without having to use the AWS Application Discovery Service (Application Discovery Service) tools such as the AWS Application Discovery Service Agentless Collector or Application Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.

To start an import request, do this:

1. Download the specially formatted comma separated value (CSV) import template, which you can find here: [https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import\$1template.csv](https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv).

1. Fill out the template with your server and application data.

1. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.

1. Use the console or the `StartImportTask` command with the AWS CLI or one of the AWS SDKs to import the records from your file.

For more information, including step-by-step procedures, see [Migration Hub Import](https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-import.html) in the * AWS Application Discovery Service User Guide*.

**Note**  
There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see [AWS Application Discovery Service Limits](https://docs.aws.amazon.com/application-discovery/latest/userguide/ads_service_limits.html) in the * AWS Application Discovery Service User Guide*.

## Request Syntax
<a name="API_StartImportTask_RequestSyntax"></a>

```
{
   "clientRequestToken": "string",
   "importUrl": "string",
   "name": "string"
}
```

## Request Parameters
<a name="API_StartImportTask_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_StartImportTask_RequestSyntax) **   <a name="DiscServ-StartImportTask-request-clientRequestToken"></a>
Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.  
Sending more than one `StartImportTask` request with the same client request token will return information about the original import task with that client request token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [importUrl](#API_StartImportTask_RequestSyntax) **   <a name="DiscServ-StartImportTask-request-importUrl"></a>
The URL for your import file that you've uploaded to Amazon S3.  
If you're using the AWS CLI, this URL is structured as follows: `s3://BucketName/ImportFileName.CSV` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4000.  
Pattern: `\S+://\S+/[\s\S]*\S[\s\S]*`   
Required: Yes

 ** [name](#API_StartImportTask_RequestSyntax) **   <a name="DiscServ-StartImportTask-request-name"></a>
A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[\s\S]*\S[\s\S]*`   
Required: Yes

## Response Syntax
<a name="API_StartImportTask_ResponseSyntax"></a>

```
{
   "task": { 
      "applicationImportFailure": number,
      "applicationImportSuccess": number,
      "clientRequestToken": "string",
      "errorsAndFailedEntriesZip": "string",
      "fileClassification": "string",
      "importCompletionTime": number,
      "importDeletedTime": number,
      "importRequestTime": number,
      "importTaskId": "string",
      "importUrl": "string",
      "name": "string",
      "serverImportFailure": number,
      "serverImportSuccess": number,
      "status": "string"
   }
}
```

## Response Elements
<a name="API_StartImportTask_ResponseElements"></a>

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](#API_StartImportTask_ResponseSyntax) **   <a name="DiscServ-StartImportTask-response-task"></a>
An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.   
Type: [ImportTask](API_ImportTask.md) object

## Errors
<a name="API_StartImportTask_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ResourceInUseException **   
This issue occurs when the same `clientRequestToken` is used with the `StartImportTask` action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different `clientRequestToken`, and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## See Also
<a name="API_StartImportTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/StartImportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/StartImportTask) 

# StopContinuousExport
<a name="API_StopContinuousExport"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Stop the continuous flow of agent's discovered data into Amazon Athena.

## Request Syntax
<a name="API_StopContinuousExport_RequestSyntax"></a>

```
{
   "exportId": "string"
}
```

## Request Parameters
<a name="API_StopContinuousExport_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [exportId](#API_StopContinuousExport_RequestSyntax) **   <a name="DiscServ-StopContinuousExport-request-exportId"></a>
The unique ID assigned to this export.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S*`   
Required: Yes

## Response Syntax
<a name="API_StopContinuousExport_ResponseSyntax"></a>

```
{
   "startTime": number,
   "stopTime": number
}
```

## Response Elements
<a name="API_StopContinuousExport_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [startTime](#API_StopContinuousExport_ResponseSyntax) **   <a name="DiscServ-StopContinuousExport-response-startTime"></a>
Timestamp that represents when this continuous export started collecting data.  
Type: Timestamp

 ** [stopTime](#API_StopContinuousExport_ResponseSyntax) **   <a name="DiscServ-StopContinuousExport-response-stopTime"></a>
Timestamp that represents when this continuous export was stopped.  
Type: Timestamp

## Errors
<a name="API_StopContinuousExport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** OperationNotPermittedException **   
This operation is not permitted.  
HTTP Status Code: 400

 ** ResourceInUseException **   
This issue occurs when the same `clientRequestToken` is used with the `StartImportTask` action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different `clientRequestToken`, and try again.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified configuration ID was not located. Verify the configuration ID and try again.  
HTTP Status Code: 400

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_StopContinuousExport_Examples"></a>

### Stop a continuous export.
<a name="API_StopContinuousExport_Example_1"></a>

The following example shows the request and response of stopping a particular continuous export specified by passing in a value to `exportId`.

#### Sample Request
<a name="API_StopContinuousExport_Example_1_Request"></a>

```
{
    "exportId": "continuous-export-181b77c3-7jf3-4610-924e-7acafe5bbc59"
}
```

#### Sample Response
<a name="API_StopContinuousExport_Example_1_Response"></a>

```
{
    "ApplicationStatus": "IN_PROGRESS", 
    "LastUpdatedTime": 1493405005.639
}
```

## See Also
<a name="API_StopContinuousExport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/StopContinuousExport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/StopContinuousExport) 

# StopDataCollectionByAgentIds
<a name="API_StopDataCollectionByAgentIds"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Instructs the specified agents to stop collecting data.

## Request Syntax
<a name="API_StopDataCollectionByAgentIds_RequestSyntax"></a>

```
{
   "agentIds": [ "string" ]
}
```

## Request Parameters
<a name="API_StopDataCollectionByAgentIds_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [agentIds](#API_StopDataCollectionByAgentIds_RequestSyntax) **   <a name="DiscServ-StopDataCollectionByAgentIds-request-agentIds"></a>
The IDs of the agents from which to stop collecting data.  
Type: Array of strings  
Length Constraints: Minimum length of 10. Maximum length of 20.  
Pattern: `\S+`   
Required: Yes

## Response Syntax
<a name="API_StopDataCollectionByAgentIds_ResponseSyntax"></a>

```
{
   "agentsConfigurationStatus": [ 
      { 
         "agentId": "string",
         "description": "string",
         "operationSucceeded": boolean
      }
   ]
}
```

## Response Elements
<a name="API_StopDataCollectionByAgentIds_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [agentsConfigurationStatus](#API_StopDataCollectionByAgentIds_ResponseSyntax) **   <a name="DiscServ-StopDataCollectionByAgentIds-response-agentsConfigurationStatus"></a>
Information about the agents that were instructed to stop collecting data. Information includes the agent ID, a description of the operation performed, and whether the agent configuration was updated.  
Type: Array of [AgentConfigurationStatus](API_AgentConfigurationStatus.md) objects

## Errors
<a name="API_StopDataCollectionByAgentIds_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_StopDataCollectionByAgentIds_Examples"></a>

### Stop data collection by agent ids for two agents
<a name="API_StopDataCollectionByAgentIds_Example_1"></a>

In the following example, multiple agent ids are passed to the required parameter `agentIds` to stop two agents. In the response, it is reported that both agents were stopped successfully.

#### Sample Request
<a name="API_StopDataCollectionByAgentIds_Example_1_Request"></a>

```
{
   "agentIds": [ "i-0afec73de85777dd0","i-0b30b932b328cbd73" ]
}
```

#### Sample Response
<a name="API_StopDataCollectionByAgentIds_Example_1_Response"></a>

```
{
    "agentsConfigurationStatus": [
        {
            "agentId": "i-0afec73de85777dd0",
            "operationSucceeded": true,
            "description": "Succeeded"
        },
        {
            "agentId": "i-0b30b932b328cbd73",
            "operationSucceeded": true,
            "description": "Succeeded"
        }
    ]
}
```

## See Also
<a name="API_StopDataCollectionByAgentIds_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/StopDataCollectionByAgentIds) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/StopDataCollectionByAgentIds) 

# UpdateApplication
<a name="API_UpdateApplication"></a>

**Important**  
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 

Updates metadata about an application.

## Request Syntax
<a name="API_UpdateApplication_RequestSyntax"></a>

```
{
   "configurationId": "string",
   "description": "string",
   "name": "string",
   "wave": "string"
}
```

## Request Parameters
<a name="API_UpdateApplication_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [configurationId](#API_UpdateApplication_RequestSyntax) **   <a name="DiscServ-UpdateApplication-request-configurationId"></a>
Configuration ID of the application to be updated.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `\S+`   
Required: Yes

 ** [description](#API_UpdateApplication_RequestSyntax) **   <a name="DiscServ-UpdateApplication-request-description"></a>
New description of the application to be updated.  
Type: String  
Length Constraints: Maximum length of 1000.  
Pattern: `(^$|[\s\S]*\S[\s\S]*)`   
Required: No

 ** [name](#API_UpdateApplication_RequestSyntax) **   <a name="DiscServ-UpdateApplication-request-name"></a>
New name of the application to be updated.  
Type: String  
Length Constraints: Maximum length of 127.  
Pattern: `[\s\S]*\S[\s\S]*`   
Required: No

 ** [wave](#API_UpdateApplication_RequestSyntax) **   <a name="DiscServ-UpdateApplication-request-wave"></a>
The new migration wave of the application that you want to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^($|[^\s\x00]( *[^\s\x00])*$)`   
Required: No

## Response Elements
<a name="API_UpdateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AuthorizationErrorException **   
The user does not have permission to perform the action. Check the IAM policy associated with this user.  
HTTP Status Code: 400

 ** HomeRegionNotSetException **   
 AWS Application Discovery Service is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [AWS Application Discovery Service availability change](https://docs.aws.amazon.com/application-discovery/latest/userguide/application-discovery-service-availability-change.html). 
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

 ** ServerInternalErrorException **   
The server experienced an internal error. Try again.  
HTTP Status Code: 500

## Examples
<a name="API_UpdateApplication_Examples"></a>

### Update application name and description
<a name="API_UpdateApplication_Example_1"></a>

In the following example, both the name and the description are changed (updated) of an existing application. The application is identified by passing the application id to the required parameter `configurationId`.

#### Sample Request
<a name="API_UpdateApplication_Example_1_Request"></a>

```
{
   "configurationId": "d-application-03767f7bddd6c0531",
   "description": "PSoft financials db migration",
   "name": "payroll_db_migration"
}
```

## See Also
<a name="API_UpdateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/discovery-2015-11-01/UpdateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/discovery-2015-11-01/UpdateApplication) 