Skip to content

ListConfigurationsRequest

Source code in docs_src/capo_application_discovery_service/types/list_configurations_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class ListConfigurationsRequest(TypedDict, closed=True):
    configuration_type: "capo_application_discovery_service.types.configuration_item_type.ConfigurationItemType"
    """<p>A valid configuration identified by Application Discovery Service. </p>"""
    filters: NotRequired["capo_application_discovery_service.types.filters.Filters"]
    """<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{"key": "serverType", "value": "webServer"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href="https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations">Using the ListConfigurations Action</a> in the <i>Amazon Web Services Application Discovery Service User Guide</i>.</p>"""
    max_results: "capo_application_discovery_service.types.integer.Integer"
    """<p>The total number of items to return. The maximum value is 100.</p>"""
    next_token: NotRequired[
        "capo_application_discovery_service.types.next_token.NextToken"
    ]
    """<p>Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set <code>ListConfigurationsRequest$maxResults</code> 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.</p>"""
    order_by: NotRequired[
        "capo_application_discovery_service.types.order_by_list.OrderByList"
    ]
    """<p>Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see <a href="https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#ListConfigurations">Using the ListConfigurations Action</a> in the <i>Amazon Web Services Application Discovery Service User Guide</i>.</p>"""

configuration_type instance-attribute 

configuration_type: ConfigurationItemType

A valid configuration identified by Application Discovery Service.

filters instance-attribute 

filters: NotRequired[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 Amazon Web Services Application Discovery Service User Guide.

max_results instance-attribute 

max_results: Integer

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

next_token instance-attribute 

next_token: NotRequired[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.

order_by instance-attribute 

order_by: NotRequired[OrderByList]

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 Amazon Web Services Application Discovery Service User Guide.