Module aws_lambda_powertools.utilities.parser.models.apigw

Classes

class APIGatewayEventAuthorizer (**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 APIGatewayEventAuthorizer(BaseModel):
    claims: Optional[Dict[str, Any]] = None
    scopes: Optional[List[str]] = None

Ancestors

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

Class variables

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

var scopes : Optional[List[str]]

class APIGatewayEventIdentity (**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 APIGatewayEventIdentity(BaseModel):
    accessKey: Optional[str] = None
    accountId: Optional[str] = None
    apiKey: Optional[str] = None
    apiKeyId: Optional[str] = None
    caller: Optional[str] = None
    cognitoAuthenticationProvider: Optional[str] = None
    cognitoAuthenticationType: Optional[str] = None
    cognitoIdentityId: Optional[str] = None
    cognitoIdentityPoolId: Optional[str] = None
    principalOrgId: Optional[str] = None
    # see #1562, temp workaround until API Gateway fixes it the Test button payload
    # removing it will not be considered a regression in the future
    sourceIp: Union[IPvAnyNetwork, Literal["test-invoke-source-ip"]]
    user: Optional[str] = None
    userAgent: Optional[str] = None
    userArn: Optional[str] = None
    clientCert: Optional[ApiGatewayUserCert] = None

Ancestors

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

Class variables

var accessKey : Optional[str]

var accountId : Optional[str]

var apiKey : Optional[str]

var apiKeyId : Optional[str]

var caller : Optional[str]

var clientCert : Optional[ApiGatewayUserCert]

var cognitoAuthenticationProvider : Optional[str]

var cognitoAuthenticationType : Optional[str]

var cognitoIdentityId : Optional[str]

var cognitoIdentityPoolId : Optional[str]

var principalOrgId : Optional[str]

var sourceIp : Union[pydantic.networks.IPvAnyNetwork, Literal['test-invoke-source-ip']]

var user : Optional[str]

var userAgent : Optional[str]

var userArn : Optional[str]

class APIGatewayEventRequestContext (**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 APIGatewayEventRequestContext(BaseModel):
    accountId: str
    apiId: str
    authorizer: Optional[APIGatewayEventAuthorizer] = None
    stage: str
    protocol: str
    identity: APIGatewayEventIdentity
    requestId: str
    requestTime: str
    requestTimeEpoch: datetime
    resourceId: Optional[str] = None
    resourcePath: str
    domainName: Optional[str] = None
    domainPrefix: Optional[str] = None
    extendedRequestId: Optional[str] = None
    httpMethod: Literal["DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"]
    path: str
    connectedAt: Optional[datetime] = None
    connectionId: Optional[str] = None
    eventType: Optional[Literal["CONNECT", "MESSAGE", "DISCONNECT"]] = None
    messageDirection: Optional[str] = None
    messageId: Optional[str] = None
    routeKey: Optional[str] = None
    operationName: Optional[str] = None

    @root_validator(allow_reuse=True, skip_on_failure=True)
    def check_message_id(cls, values):
        message_id, event_type = values.get("messageId"), values.get("eventType")
        if message_id is not None and event_type != "MESSAGE":
            raise ValueError("messageId is available only when the `eventType` is `MESSAGE`")
        return values

Ancestors

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

Class variables

var accountId : str

var apiId : str

var authorizer : Optional[APIGatewayEventAuthorizer]

var connectedAt : Optional[datetime.datetime]

var connectionId : Optional[str]

var domainName : Optional[str]

var domainPrefix : Optional[str]

var eventType : Optional[Literal['CONNECT', 'MESSAGE', 'DISCONNECT']]

var extendedRequestId : Optional[str]

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

var identity : APIGatewayEventIdentity

var messageDirection : Optional[str]

var messageId : Optional[str]

var operationName : Optional[str]

var path : str

var protocol : str

var requestId : str

var requestTime : str

var requestTimeEpoch : datetime.datetime

var resourceId : Optional[str]

var resourcePath : str

var routeKey : Optional[str]

var stage : str

Static methods

def check_message_id(values)

Expand source code

@root_validator(allow_reuse=True, skip_on_failure=True)
def check_message_id(cls, values):
    message_id, event_type = values.get("messageId"), values.get("eventType")
    if message_id is not None and event_type != "MESSAGE":
        raise ValueError("messageId is available only when the `eventType` is `MESSAGE`")
    return values

class APIGatewayProxyEventModel (**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 APIGatewayProxyEventModel(BaseModel):
    version: Optional[str] = None
    resource: str
    path: str
    httpMethod: Literal["DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"]
    headers: Dict[str, str]
    multiValueHeaders: Dict[str, List[str]]
    queryStringParameters: Optional[Dict[str, str]] = None
    multiValueQueryStringParameters: Optional[Dict[str, List[str]]] = None
    requestContext: APIGatewayEventRequestContext
    pathParameters: Optional[Dict[str, str]] = None
    stageVariables: Optional[Dict[str, str]] = None
    isBase64Encoded: bool
    body: Optional[Union[str, Type[BaseModel]]] = None

Ancestors

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

Class variables

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

var headers : Dict[str, str]

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

var isBase64Encoded : bool

var multiValueHeaders : Dict[str, List[str]]

var multiValueQueryStringParameters : Optional[Dict[str, List[str]]]

var path : str

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

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

var requestContext : APIGatewayEventRequestContext

var resource : str

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

var version : Optional[str]

class ApiGatewayUserCert (**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 ApiGatewayUserCert(BaseModel):
    clientCertPem: str
    subjectDN: str
    issuerDN: str
    serialNumber: str
    validity: ApiGatewayUserCertValidity

Ancestors

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

Class variables

var clientCertPem : str

var issuerDN : str

var serialNumber : str

var subjectDN : str

var validity : ApiGatewayUserCertValidity

class ApiGatewayUserCertValidity (**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 ApiGatewayUserCertValidity(BaseModel):
    notBefore: str
    notAfter: str

Ancestors

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

Class variables

var notAfter : str

var notBefore : str