add context variables

cloutierMat · cloutierMat · commit bb60eaaae8be · 2024-06-27T11:40:57.000-06:00
diff --git a/localstack-core/localstack/services/apigateway/next_gen/execute_api/context.py b/localstack-core/localstack/services/apigateway/next_gen/execute_api/context.py
@@ -33,6 +33,57 @@ class InvocationRequest(TypedDict, total=False):
     """Body content of the request"""
 
 
+class AuthorizerContext(TypedDict, total=False):
+    # https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
+    claims: Optional[dict[str, str]]
+    """Claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated"""
+    principal_id: Optional[str]
+    """The principal user identification associated with the token sent by the client and returned from an API Gateway Lambda authorizer"""
+    context: Optional[dict[str, str]]
+    """The stringified value of the specified key-value pair of the context map returned from an API Gateway Lambda authorizer function"""
+
+
+class IdentityContext(TypedDict, total=False):
+    # https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
+    accountId: Optional[str]
+    """The AWS account ID associated with the request."""
+    apiKey: Optional[str]
+    """For API methods that require an API key, this variable is the API key associated with the method request."""
+    apiKeyId: Optional[str]
+    """The API key ID associated with an API request that requires an API key."""
+    caller: Optional[str]
+    """The principal identifier of the caller that signed the request. Supported for resources that use IAM authorization."""
+    cognitoAuthenticationProvider: Optional[str]
+    """A comma-separated list of the Amazon Cognito authentication providers used by the caller making the request"""
+    cognitoAuthenticationType: Optional[str]
+    """The Amazon Cognito authentication type of the caller making the request"""
+    cognitoIdentityId: Optional[str]
+    """The Amazon Cognito identity ID of the caller making the request"""
+    cognitoIdentityPoolId: Optional[str]
+    """The Amazon Cognito identity pool ID of the caller making the request"""
+    principalOrgId: Optional[str]
+    """The AWS organization ID."""
+    sourceIp: Optional[str]
+    """The source IP address of the immediate TCP connection making the request to the API Gateway endpoint"""
+    clientCert: Optional[dict[str, str]]
+    """Certificate that a client presents. Present only in access logs if mutual TLS authentication fails."""
+    vpcId: Optional[str]
+    """The VPC ID of the VPC making the request to the API Gateway endpoint."""
+    vpceId: Optional[str]
+    """The VPC endpoint ID of the VPC endpoint making the request to the API Gateway endpoint."""
+    user: Optional[str]
+    """The principal identifier of the user that will be authorized against resource access for resources that use IAM authorization."""
+    userAgent: Optional[str]
+    """The User-Agent header of the API caller."""
+    userArn: Optional[str]
+    """The Amazon Resource Name (ARN) of the effective user identified after authentication."""
+
+
+class ContextVariables(TypedDict, total=False):
+    authorizer: AuthorizerContext
+    identity: IdentityContext
+
+
 class RestApiInvocationContext(RequestContext):
     """
     This context is going to be used to pass relevant information across an API Gateway invocation.
@@ -54,6 +105,8 @@ class RestApiInvocationContext(RequestContext):
     """The resource the invocation matched"""  # TODO: verify if needed through the invocation
     resource_method: Optional[Method]
     """The method of the resource the invocation matched"""
+    context_variables: Optional[ContextVariables]
+    """Variables can be used in data models, authorizers, mapping templates, and CloudWatch access logging."""
 
     def __init__(self, request: Request):
         super().__init__(request)
@@ -65,3 +118,4 @@ def __init__(self, request: Request):
         self.invocation_request = None
         self.resource = None
         self.resource_method = None
+        self.context_variables = None
