Skip to content

update_domain_name async

update_domain_name(
    domain_name: __string,
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    domain_name_configurations: Optional[DomainNameConfigurations] = None,
    mutual_tls_authentication: Optional[MutualTlsAuthenticationInput] = None,
    routing_mode: Optional[RoutingMode] = None,
) -> UpdateDomainNameResponse

Updates a domain name.

Parameters:

Raises:

  • BadRequestException –

    The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

  • ConflictException –

    The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

  • NotFoundException –

    The resource specified in the request was not found. See the message field for more information.

  • TooManyRequestsException –

    A limit has been exceeded. See the accompanying error message for details.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_apigatewayv2/_services/async_api_gateway_v2.py
async def update_domain_name(
    self,
    domain_name: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[AsyncApiGatewayV2ClientConfig] = None,
    domain_name_configurations: Optional[
        "capo_apigatewayv2.types.domain_name_configurations.DomainNameConfigurations"
    ] = None,
    mutual_tls_authentication: Optional[
        "capo_apigatewayv2.types.mutual_tls_authentication_input.MutualTlsAuthenticationInput"
    ] = None,
    routing_mode: Optional[
        "capo_apigatewayv2.types.routing_mode.RoutingMode"
    ] = None,
) -> "capo_apigatewayv2.types.update_domain_name_response.UpdateDomainNameResponse":
    """<p>Updates a domain name.</p>

    Args:
        domain_name: <p>The domain name.</p>
        domain_name_configurations: <p>The domain name configurations.</p>
        mutual_tls_authentication: <p>The mutual TLS authentication configuration for a custom domain name.</p>
        routing_mode: <p>The routing mode.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_apigatewayv2.types.update_domain_name_request.UpdateDomainNameRequest]",
    ) -> AsyncOperationResponse[
        "capo_apigatewayv2.types.update_domain_name_response.UpdateDomainNameResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.update_domain_name

        (
            output,
            http_response,
        ) = await capo_apigatewayv2._operations.api_gateway_v2.update_domain_name.async_update_domain_name(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDomainName")
    )
    input_: capo_apigatewayv2.types.update_domain_name_request.UpdateDomainNameRequest = {
        "domain_name": domain_name
    }
    if domain_name_configurations is not None:
        input_["domain_name_configurations"] = domain_name_configurations
    if mutual_tls_authentication is not None:
        input_["mutual_tls_authentication"] = mutual_tls_authentication
    if routing_mode is not None:
        input_["routing_mode"] = routing_mode

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