Module apigw

AWS Lambda event definitions for apigw.

Structs

ApiGatewayCustomAuthorizerContext

ApiGatewayCustomAuthorizerContext represents the expected format of an API Gateway custom authorizer response. Deprecated. Code should be updated to use the Authorizer map from APIGatewayRequestIdentity. Ex: Authorizer[“principalId”]

ApiGatewayCustomAuthorizerPolicy

ApiGatewayCustomAuthorizerPolicy represents an IAM policy

ApiGatewayCustomAuthorizerRequest

ApiGatewayCustomAuthorizerRequest contains data coming in to a custom API Gateway authorizer function.

ApiGatewayCustomAuthorizerRequestTypeRequest

ApiGatewayCustomAuthorizerRequestTypeRequest contains data coming in to a custom API Gateway authorizer function.

ApiGatewayCustomAuthorizerRequestTypeRequestContext

ApiGatewayCustomAuthorizerRequestTypeRequestContext represents the expected format of an API Gateway custom authorizer response.

ApiGatewayCustomAuthorizerRequestTypeRequestIdentity

ApiGatewayCustomAuthorizerRequestTypeRequestIdentity contains identity information for the request caller including certificate information if using mTLS.

ApiGatewayCustomAuthorizerRequestTypeRequestIdentityClientCert

ApiGatewayCustomAuthorizerRequestTypeRequestIdentityClientCert contains certificate information for the request caller if using mTLS.

ApiGatewayCustomAuthorizerRequestTypeRequestIdentityClientCertValidity

ApiGatewayCustomAuthorizerRequestTypeRequestIdentityClientCertValidity contains certificate validity information for the request caller if using mTLS.

ApiGatewayCustomAuthorizerResponse

ApiGatewayCustomAuthorizerResponse represents the expected format of an API Gateway authorization response.

ApiGatewayProxyRequest

ApiGatewayProxyRequest contains data coming from the API Gateway proxy

ApiGatewayProxyRequestContext

ApiGatewayProxyRequestContext contains the information to identify the AWS account and resources invoking the Lambda function. It also includes Cognito identity information for the caller.

ApiGatewayProxyResponse

ApiGatewayProxyResponse configures the response to be returned by API Gateway for the request

ApiGatewayRequestAuthorizer

ApiGatewayRequestAuthorizer contains authorizer information for the request context.

ApiGatewayRequestAuthorizerCognitoIdentity

ApiGatewayRequestAuthorizerCognitoIdentity contains Cognito identity information for the request context.

ApiGatewayRequestAuthorizerIamDescription

ApiGatewayRequestAuthorizerIamDescription contains IAM information for the request context.

ApiGatewayRequestAuthorizerJwtDescription

ApiGatewayRequestAuthorizerJwtDescription contains JWT authorizer information for the request context.

ApiGatewayRequestIdentity

ApiGatewayRequestIdentity contains identity information for the request caller.

ApiGatewayV2CustomAuthorizerIamPolicyResponse

ApiGatewayV2CustomAuthorizerSimpleResponse

ApiGatewayV2CustomAuthorizerSimpleResponse represents the simple format of an API Gateway V2 authorization response.

ApiGatewayV2CustomAuthorizerV1Request

ApiGatewayV2CustomAuthorizerV1RequestTypeRequestContext

ApiGatewayV2CustomAuthorizerV2Request

ApiGatewayV2httpRequest

ApiGatewayV2httpRequest contains data coming from the new HTTP API Gateway

ApiGatewayV2httpRequestContext

ApiGatewayV2httpRequestContext contains the information to identify the AWS account and resources invoking the Lambda function.

ApiGatewayV2httpRequestContextAuthentication

ApiGatewayV2httpRequestContextAuthentication contains authentication context information for the request caller including client certificate information if using mTLS.

ApiGatewayV2httpRequestContextAuthenticationClientCert

ApiGatewayV2httpRequestContextAuthenticationClientCert contains client certificate information for the request caller if using mTLS.

ApiGatewayV2httpRequestContextAuthenticationClientCertValidity

ApiGatewayV2httpRequestContextAuthenticationClientCertValidity contains client certificate validity information for the request caller if using mTLS.

ApiGatewayV2httpRequestContextHttpDescription

ApiGatewayV2httpRequestContextHttpDescription contains HTTP information for the request context.

ApiGatewayV2httpResponse

ApiGatewayV2httpResponse configures the response to be returned by API Gateway V2 for the request

ApiGatewayWebsocketProxyRequest

ApiGatewayWebsocketProxyRequest contains data coming from the API Gateway proxy

ApiGatewayWebsocketProxyRequestContext

ApiGatewayWebsocketProxyRequestContext contains the information to identify the AWS account and resources invoking the Lambda function. It also includes Cognito identity information for the caller.

Functions

serialize_authorizer_fields

Type Aliases

ApiGatewayV2httpRequestContextAuthorizerCognitoIdentityDeprecated

ApiGatewayV2httpRequestContextAuthorizerDescriptionDeprecated

ApiGatewayV2httpRequestContextAuthorizerIamDescriptionDeprecated

ApiGatewayV2httpRequestContextAuthorizerJwtDescriptionDeprecated