AWSAPIGatewayRequest Class Reference

Inherits from NSObject
Declared in AWSAPIGatewayModel.h
AWSAPIGatewayModel.m

Overview

The request object for invoking an AWS API Gateway API.

– initWithHTTPMethod:URLString:queryParameters:headerParameters:HTTPBody:

Creates an instance of AWSAPIGatewayRequest which is required to invoke an API using the invoke method.

- (instancetype)initWithHTTPMethod:(NSString *)HTTPMethod URLString:(NSString *_Nullable)URLString queryParameters:(NSDictionary *_Nullable)queryParameters headerParameters:(NSDictionary *_Nullable)headerParameters HTTPBody:(id _Nullable)HTTPBody

Parameters

HTTPMethod

The HTTP method to be invoked(E.g. : GET, PUT, POST, PATCH, UPDATE, DELETE, HEAD)

URLString

The path to be invoked(E.g. : /cars)

queryParameters

The query string parameters for the invocation request

headerParameters

The header parameters for the request

HTTPBody

The Http body for the request (Could be of type NSString, NSData, NSInputStream)

Return Value

An instance of AWSAPIGateway

Declared In

AWSAPIGatewayModel.h