Skip to content

update_configuration

update_configuration(
    configuration_id: __string,
    *,
    config_overrides: Optional[mqClientConfig] = None,
    data: Optional[__string] = None,
    description: Optional[__string] = None,
) -> UpdateConfigurationResponse

Updates the specified configuration.

Parameters:

  • configuration_id (__string) –

    The unique ID that Amazon MQ generates for the configuration.

  • data (Optional[__string], default: None ) –

    Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.

  • description (Optional[__string], default: None ) –

    The description of the configuration.

Raises:

Source code in docs_src/capo_mq/_services/mq.py
def update_configuration(
    self,
    configuration_id: "capo_mq.types.__string.__string",
    *,
    config_overrides: Optional[mqClientConfig] = None,
    data: Optional["capo_mq.types.__string.__string"] = None,
    description: Optional["capo_mq.types.__string.__string"] = None,
) -> "capo_mq.types.update_configuration_response.UpdateConfigurationResponse":
    """<p>Updates the specified configuration.</p>

    Args:
        configuration_id: <p>The unique ID that Amazon MQ generates for the configuration.</p>
        data: <p>Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.</p>
        description: <p>The description of the configuration.</p>

    Raises:
        capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_mq.errors.conflict_exception.ConflictException: <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.update_configuration_request.UpdateConfigurationRequest]",
    ) -> OperationResponse[
        "capo_mq.types.update_configuration_response.UpdateConfigurationResponse"
    ]:
        import capo_mq._operations.mq.update_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConfiguration")
    )
    input_: capo_mq.types.update_configuration_request.UpdateConfigurationRequest = {
        "configuration_id": configuration_id
    }
    if data is not None:
        input_["data"] = data
    if description is not None:
        input_["description"] = description

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