list_configurations ¶

def list_configurations(
    self,
    configuration_type: "capo_application_discovery_service.types.configuration_item_type.ConfigurationItemType",
    *,
    config_overrides: Optional[ApplicationDiscoveryServiceClientConfig] = None,
    filters: Optional[
        "capo_application_discovery_service.types.filters.Filters"
    ] = None,
    max_results: Optional[
        "capo_application_discovery_service.types.integer.Integer"
    ] = None,
    next_token: Optional[
        "capo_application_discovery_service.types.next_token.NextToken"
    ] = None,
    order_by: Optional[
        "capo_application_discovery_service.types.order_by_list.OrderByList"
    ] = None,
) -> "capo_application_discovery_service.types.list_configurations_response.ListConfigurationsResponse":
    """<p>Retrieves a list of configuration items as specified by the value passed to the required parameter <code>configurationType</code>. Optional filtering may be applied to refine search results.</p>

    Args:
        configuration_type: <p>A valid configuration identified by Application Discovery Service. </p>
        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: <p>The total number of items to return. The maximum value is 100.</p>
        next_token: <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: <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>

    Raises:
        capo_application_discovery_service.errors.authorization_error_exception.AuthorizationErrorException: <p>The user does not have permission to perform the action. Check the IAM policy associated with this user.</p>
        capo_application_discovery_service.errors.home_region_not_set_exception.HomeRegionNotSetException: <p>The home Region is not set. Set the home Region to continue.</p>
        capo_application_discovery_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid. Verify the parameters and try again.</p>
        capo_application_discovery_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.</p>
        capo_application_discovery_service.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified configuration ID was not located. Verify the configuration ID and try again.</p>
        capo_application_discovery_service.errors.server_internal_error_exception.ServerInternalErrorException: <p>The server experienced an internal error. Try again.</p>
        capo_application_discovery_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_application_discovery_service.types.list_configurations_request.ListConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_application_discovery_service.types.list_configurations_response.ListConfigurationsResponse"
    ]:
        import capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.list_configurations

        output, http_response = (
            capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.list_configurations.list_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConfigurations")
    )
    input_: capo_application_discovery_service.types.list_configurations_request.ListConfigurationsRequest = {
        "configuration_type": configuration_type
    }
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if order_by is not None:
        input_["order_by"] = order_by

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output