Skip to content

describe_configurations async

describe_configurations(
    configuration_ids: ConfigurationIdList,
    *,
    config_overrides: Optional[AsyncApplicationDiscoveryServiceClientConfig] = None,
) -> DescribeConfigurationsResponse

Retrieves attributes for a list of configuration item IDs.

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

Parameters:

Raises:

Source code in docs_src/capo_application_discovery_service/_services/async_application_discovery_service.py
async def describe_configurations(
    self,
    configuration_ids: "capo_application_discovery_service.types.configuration_id_list.ConfigurationIdList",
    *,
    config_overrides: Optional[AsyncApplicationDiscoveryServiceClientConfig] = None,
) -> "capo_application_discovery_service.types.describe_configurations_response.DescribeConfigurationsResponse":
    """<p>Retrieves attributes for a list of configuration item IDs.</p> <note> <p>All of the supplied IDs must be for the same asset type from one of the following:</p> <ul> <li> <p>server</p> </li> <li> <p>application</p> </li> <li> <p>process</p> </li> <li> <p>connection</p> </li> </ul> <p>Output fields are specific to the asset type specified. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.</p> <p>For a complete list of outputs for each asset type, see <a href="https://docs.aws.amazon.com/application-discovery/latest/userguide/discovery-api-queries.html#DescribeConfigurations">Using the DescribeConfigurations Action</a> in the <i>Amazon Web Services Application Discovery Service User Guide</i>.</p> </note>

    Args:
        configuration_ids: <p>One or more configuration IDs.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_application_discovery_service.types.describe_configurations_request.DescribeConfigurationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_application_discovery_service.types.describe_configurations_response.DescribeConfigurationsResponse"
    ]:
        import capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.describe_configurations

        (
            output,
            http_response,
        ) = await capo_application_discovery_service._operations.aws_poseidon_service_v2015_11_01.describe_configurations.async_describe_configurations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConfigurations")
    )
    input_: capo_application_discovery_service.types.describe_configurations_request.DescribeConfigurationsRequest = {
        "configuration_ids": configuration_ids
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output