update_domain_name ¶

update_domain_name(
    domain_name: String,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    domain_name_id: Optional[String] = None,
    patch_operations: Optional[ListOfPatchOperation] = None,
) -> DomainName

Changes information about the DomainName resource.

Parameters:

domain_name (String) –

The name of the DomainName resource to be changed.
domain_name_id (Optional[String], default: None ) –

The identifier for the domain name resource. Supported only for private custom domain names.
patch_operations (Optional[ListOfPatchOperation], default: None ) –

For more information about supported patch operations, see Patch Operations.

Raises:

BadRequestException –

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

The request configuration has conflicts. For details, see the accompanying error message.
LimitExceededException –

The request exceeded the rate limit. Retry after the specified time period.
NotFoundException –

The requested resource is not found. Make sure that the request URI is correct.
TooManyRequestsException –

The request has reached its throttling limit. Retry after the specified time period.
UnauthorizedException –

The request is denied because the caller has insufficient permissions.
UnknownServiceError –

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

Source code in docs_src/capo_api_gateway/_services/api_gateway.py

def update_domain_name(
    self,
    domain_name: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    domain_name_id: Optional["capo_api_gateway.types.string.String"] = None,
    patch_operations: Optional[
        "capo_api_gateway.types.list_of_patch_operation.ListOfPatchOperation"
    ] = None,
) -> "capo_api_gateway.types.domain_name.DomainName":
    """<p>Changes information about the DomainName resource.</p>

    Args:
        domain_name: <p>The name of the DomainName resource to be changed.</p>
        domain_name_id: <p> The identifier for the domain name resource. Supported only for private custom domain names. </p>
        patch_operations: <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_api_gateway.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded the rate limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.update_domain_name_request.UpdateDomainNameRequest]",
    ) -> OperationResponse["capo_api_gateway.types.domain_name.DomainName"]:
        import capo_api_gateway._operations.backplane_control_service.update_domain_name

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.update_domain_name.update_domain_name(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateDomainName")
    )
    input_: capo_api_gateway.types.update_domain_name_request.UpdateDomainNameRequest = {
        "domain_name": domain_name
    }
    if domain_name_id is not None:
        input_["domain_name_id"] = domain_name_id
    if patch_operations is not None:
        input_["patch_operations"] = patch_operations

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