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

ListConfigurations

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


{
   "configurationType": "string",
   "filters": [ 
      { 
         "condition": "string",
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "maxResults": number,
   "nextToken": "string",
   "orderBy": [ 
      { 
         "fieldName": "string",
         "sortOrder": "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.

configurationType

A valid configuration identified by Application Discovery Service.

Type: String

Valid Values: SERVER | PROCESS | CONNECTION | APPLICATION

Required: Yes

filters

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

Type: Array of Filter objects

Required: No

maxResults

The total number of items to return. The maximum value is 100.

Type: Integer

Required: No

nextToken

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

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

Type: Array of OrderByElement objects

Required: No

Response Syntax


{
   "configurations": [ 
      { 
         "string" : "string" 
      }
   ],
   "nextToken": "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

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

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

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

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

List configurations based on server type

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



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

Sample Response



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