Function get

GET HTTP request

Throws

• RestApiError

Example

Send a GET request

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

const { body } = await get({
  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();
Copy

Example

Cancel a GET request

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

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