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

DescribeConfigurations

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 in the AWS Application Discovery Service User Guide.

Request Syntax


{
   "configurationIds": [ "string" ]
}

Request Parameters

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

The request accepts the following data in JSON format.

configurationIds

One or more configuration IDs.

Type: Array of strings

Length Constraints: Maximum length of 200.

Pattern: \S*

Required: Yes

Response Syntax


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

Response Elements

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

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

configurations

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

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

AuthorizationErrorException

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

HTTP Status Code: 400

HomeRegionNotSetException

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

HTTP Status Code: 400

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

Describe configurations

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



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

Sample Response



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