Function head

head(input): HeadOperation

HEAD HTTP request

Parameters

input: HeadInput
Input for HEAD operation

Returns HeadOperation

Operation for HEAD request

Throws

RestApiError

Example

Send a HEAD request

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

const { headers, statusCode } = await head({
  apiName,
  path,
  options: {
    headers, // Optional, A map of custom header key/values
    queryParams, // Optional, A map of query strings
  }
}),response;