Interface InternalAPIRequestParams

The parameters needed to invoke an internal API request.

Deprecated

don't run a Lambda from another Lambda (bad practice).

interface InternalAPIRequestParams {
    body?: any;
    eventBridge?: {
        bus?: string;
        target?: string;
    };
    httpMethod: string;
    lambda?: string;
    pathParams?: {
        [index: string]: string | number;
    };
    queryParams?: {
        [index: string]: string | number;
    };
    resource: string;
    stage?: string;
}

Properties

body? eventBridge? httpMethod lambda? pathParams? queryParams? resource stage?

Properties

Optionalbody

body?: any

The body of the request.

OptionaleventBridge

eventBridge?: {
    bus?: string;
    target?: string;
}

The EventBridge destination of the request. If the bus name or ARN isn't specified, the default one is used. The target maps into the DetailType of the event. Note: the invocation is always asyncronous. Either this attribute or lambda must be set.

httpMethod

httpMethod: string

The http method to use.

Optionallambda

lambda?: string

The name of the Lambda function receiving the request; e.g. project_memberships. Note: the invocation is always syncronous. Either this attribute or eventBus must be set.

OptionalpathParams

pathParams?: {
    [index: string]: string | number;
}

The parameters to substitute in the path.

OptionalqueryParams

queryParams?: {
    [index: string]: string | number;
}

The parameters to substitute in the path.

resource

resource: string

The path (in the internal API) to the resource we need; e.g. teams/{teamId}/memberships/{userId}.

Optionalstage

stage?: string

The alias of the lambda function to invoke. Default: the value of the current API stage.

Settings

Member Visibility

On This Page

Properties