Skip to content

delete_api_cache async

delete_api_cache(
    api_id: String, *, config_overrides: Optional[AsyncAppSyncClientConfig] = None
) -> DeleteApiCacheResponse

Deletes an ApiCache object.

Parameters:

  • api_id (String) –

    The API ID.

Raises:

  • BadRequestException –

    The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

  • ConcurrentModificationException –

    Another modification is in progress at this time and it must complete before you can make your change.

  • InternalFailureException –

    An internal AppSync error occurred. Try your request again.

  • NotFoundException –

    The resource specified in the request was not found. Check the resource, and then try again.

  • UnauthorizedException –

    You aren't authorized to perform this operation.

  • UnknownServiceError –

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

Source code in docs_src/capo_appsync/_services/async_app_sync.py
async def delete_api_cache(
    self,
    api_id: "capo_appsync.types.string.String",
    *,
    config_overrides: Optional[AsyncAppSyncClientConfig] = None,
) -> "capo_appsync.types.delete_api_cache_response.DeleteApiCacheResponse":
    """<p>Deletes an <code>ApiCache</code> object.</p>

    Args:
        api_id: <p>The API ID.</p>

    Raises:
        capo_appsync.errors.bad_request_exception.BadRequestException: <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.</p>
        capo_appsync.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Another modification is in progress at this time and it must complete before you can make your change.</p>
        capo_appsync.errors.internal_failure_exception.InternalFailureException: <p>An internal AppSync error occurred. Try your request again.</p>
        capo_appsync.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
        capo_appsync.errors.unauthorized_exception.UnauthorizedException: <p>You aren't authorized to perform this operation.</p>
        capo_appsync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appsync.types.delete_api_cache_request.DeleteApiCacheRequest]",
    ) -> AsyncOperationResponse[
        "capo_appsync.types.delete_api_cache_response.DeleteApiCacheResponse"
    ]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.delete_api_cache

        (
            output,
            http_response,
        ) = await capo_appsync._operations.aws_deepdish_control_plane_service.delete_api_cache.async_delete_api_cache(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteApiCache")
    )
    input_: capo_appsync.types.delete_api_cache_request.DeleteApiCacheRequest = {
        "api_id": api_id
    }

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