Module aws_lambda_powertools.utilities.parser.models.apigwv2

Classes

class APIGatewayProxyEventV2Model (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class APIGatewayProxyEventV2Model(BaseModel):
    version: str
    routeKey: str
    rawPath: str
    rawQueryString: str
    cookies: Optional[List[str]]
    headers: Dict[str, str]
    queryStringParameters: Optional[Dict[str, str]]
    pathParameters: Optional[Dict[str, str]]
    stageVariables: Optional[Dict[str, str]]
    requestContext: RequestContextV2
    body: Optional[Union[str, Type[BaseModel]]]
    isBase64Encoded: bool

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Subclasses

• LambdaFunctionUrlModel

Class variables

var body : Union[str, Type[pydantic.main.BaseModel], ForwardRef(None)]

var cookies : Optional[List[str]]

var headers : Dict[str, str]

var isBase64Encoded : bool

var pathParameters : Optional[Dict[str, str]]

var queryStringParameters : Optional[Dict[str, str]]

var rawPath : str

var rawQueryString : str

var requestContext : RequestContextV2

var routeKey : str

var stageVariables : Optional[Dict[str, str]]

var version : str

class RequestContextV2 (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class RequestContextV2(BaseModel):
    accountId: str
    apiId: str
    authorizer: Optional[RequestContextV2Authorizer]
    domainName: str
    domainPrefix: str
    requestId: str
    routeKey: str
    stage: str
    time: str
    timeEpoch: datetime
    http: RequestContextV2Http

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var accountId : str

var apiId : str

var authorizer : Optional[RequestContextV2Authorizer]

var domainName : str

var domainPrefix : str

var http : RequestContextV2Http

var requestId : str

var routeKey : str

var stage : str

var time : str

var timeEpoch : datetime.datetime

class RequestContextV2Authorizer (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class RequestContextV2Authorizer(BaseModel):
    jwt: Optional[RequestContextV2AuthorizerJwt]
    iam: Optional[RequestContextV2AuthorizerIam]
    lambda_value: Optional[Dict[str, Any]] = Field(None, alias="lambda")

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var iam : Optional[RequestContextV2AuthorizerIam]

var jwt : Optional[RequestContextV2AuthorizerJwt]

var lambda_value : Optional[Dict[str, Any]]

class RequestContextV2AuthorizerIam (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class RequestContextV2AuthorizerIam(BaseModel):
    accessKey: Optional[str]
    accountId: Optional[str]
    callerId: Optional[str]
    principalOrgId: Optional[str]
    userArn: Optional[str]
    userId: Optional[str]
    cognitoIdentity: Optional[RequestContextV2AuthorizerIamCognito]

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var accessKey : Optional[str]

var accountId : Optional[str]

var callerId : Optional[str]

var cognitoIdentity : Optional[RequestContextV2AuthorizerIamCognito]

var principalOrgId : Optional[str]

var userArn : Optional[str]

var userId : Optional[str]

class RequestContextV2AuthorizerIamCognito (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class RequestContextV2AuthorizerIamCognito(BaseModel):
    amr: List[str]
    identityId: str
    identityPoolId: str

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var amr : List[str]

var identityId : str

var identityPoolId : str

class RequestContextV2AuthorizerJwt (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class RequestContextV2AuthorizerJwt(BaseModel):
    claims: Dict[str, Any]
    scopes: List[str]

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var claims : Dict[str, Any]

var scopes : List[str]

class RequestContextV2Http (**data: Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Expand source code

class RequestContextV2Http(BaseModel):
    method: Literal["DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"]
    path: str
    protocol: str
    sourceIp: IPvAnyNetwork
    userAgent: str

Ancestors

• pydantic.main.BaseModel
• pydantic.utils.Representation

Class variables

var method : Literal['DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', 'PUT']

var path : str

var protocol : str

var sourceIp : pydantic.networks.IPvAnyNetwork

var userAgent : str