Amplify JS API Documentation
    Preparing search index...

    Function post

    • post(ctx: AmplifyContext, input: PostInput): PostOperation

      Parameters

      Returns PostOperation

    • post(input: PostInput): PostOperation

      POST HTTP request

      Parameters

      • input: PostInput

        Input for POST operation

      Returns PostOperation

      Operation for POST request

      • RestApiError

      Send a POST request

      import { post, isCancelError } from '@aws-amplify/api';

      const { body } = await post({
      apiName,
      path,
      options: {
      headers, // Optional, A map of custom header key/values
      body, // Optional, JSON object or FormData
      queryParams, // Optional, A map of query strings
      }
      }).response;
      const data = await body.json();

      Cancel a POST request

      import { post, isCancelError } from '@aws-amplify/api';

      const { response, cancel } = post({apiName, path, options});
      cancel(message);
      try {
      await response;
      } catch (e) {
      if (isCancelError(e)) {
      // handle request cancellation
      }
      //...
      }