update_rest_api `async` ¶

update_rest_api(
    rest_api_id: String,
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    patch_operations: Optional[ListOfPatchOperation] = None,
) -> RestApi

Changes information about the specified API.

Parameters:

rest_api_id (String) –

The string identifier of the associated RestApi.
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/async_api_gateway.py

async def update_rest_api(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    *,
    config_overrides: Optional[AsyncAPIGatewayClientConfig] = None,
    patch_operations: Optional[
        "capo_api_gateway.types.list_of_patch_operation.ListOfPatchOperation"
    ] = None,
) -> "capo_api_gateway.types.rest_api.RestApi":
    """<p>Changes information about the specified API.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_api_gateway.types.update_rest_api_request.UpdateRestApiRequest]",
    ) -> AsyncOperationResponse["capo_api_gateway.types.rest_api.RestApi"]:
        import capo_api_gateway._operations.backplane_control_service.update_rest_api

        (
            output,
            http_response,
        ) = await capo_api_gateway._operations.backplane_control_service.update_rest_api.async_update_rest_api(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateRestApi")
    )
    input_: capo_api_gateway.types.update_rest_api_request.UpdateRestApiRequest = {
        "rest_api_id": rest_api_id
    }
    if patch_operations is not None:
        input_["patch_operations"] = patch_operations

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

update_rest_api async ¶

update_rest_api `async` ¶