Skip to content

describe_configuration

describe_configuration(
    configuration_id: __string, *, config_overrides: Optional[mqClientConfig] = None
) -> DescribeConfigurationResponse

Returns information about the specified configuration.

Parameters:

  • configuration_id (__string) –

    The unique ID that Amazon MQ generates for the configuration.

Raises:

Source code in docs_src/capo_mq/_services/mq.py
def describe_configuration(
    self,
    configuration_id: "capo_mq.types.__string.__string",
    *,
    config_overrides: Optional[mqClientConfig] = None,
) -> "capo_mq.types.describe_configuration_response.DescribeConfigurationResponse":
    """<p>Returns information about the specified configuration.</p>

    Args:
        configuration_id: <p>The unique ID that Amazon MQ generates for the configuration.</p>

    Raises:
        capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_mq.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_mq.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_mq.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
        capo_mq.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mq.types.describe_configuration_request.DescribeConfigurationRequest]",
    ) -> OperationResponse[
        "capo_mq.types.describe_configuration_response.DescribeConfigurationResponse"
    ]:
        import capo_mq._operations.mq.describe_configuration

        output, http_response = (
            capo_mq._operations.mq.describe_configuration.describe_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConfiguration")
    )
    input_: capo_mq.types.describe_configuration_request.DescribeConfigurationRequest = {
        "configuration_id": configuration_id
    }

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