AWSAPIGatewayRequest

@interface AWSAPIGatewayRequest : NSObject

The request object for invoking an AWS API Gateway API.

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

    Declaration

    Objective-C

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

    Swift

    init(httpMethod HTTPMethod: String, urlString URLString: String?, queryParameters: [AnyHashable : Any]?, headerParameters: [AnyHashable : Any]?, httpBody HTTPBody: Any?)

    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