diff --git a/aws_lambda_powertools/utilities/parser/models/transfer_family.py b/aws_lambda_powertools/utilities/parser/models/transfer_family.py index 62cb49479bd..be23c29449f 100644 --- a/aws_lambda_powertools/utilities/parser/models/transfer_family.py +++ b/aws_lambda_powertools/utilities/parser/models/transfer_family.py @@ -5,8 +5,27 @@ class TransferFamilyAuthorizer(BaseModel): - username: str - password: Optional[str] = None - protocol: Literal["SFTP", "FTP", "FTPS"] - server_id: str = Field(..., alias="serverId") - source_ip: IPvAnyAddress = Field(..., alias="sourceIp") + username: str = Field( + description="The username of the user attempting to authenticate.", + examples=["bobusa", "john.doe", "sftp-user-123", "data-transfer-user"], + ) + password: Optional[str] = Field( + default=None, + description="The password for authentication.", + examples=["", "", None], + ) + protocol: Literal["SFTP", "FTP", "FTPS"] = Field( + description="The protocol used for the connection.", + examples=["SFTP", "FTPS", "FTP"], + ) + server_id: str = Field( + ..., + alias="serverId", + description="The server ID of the Transfer Family server.", + examples=["s-abcd123456", "s-1234567890abcdef0", "s-example123"], + ) + source_ip: IPvAnyAddress = Field( + ..., + alias="sourceIp", + description="The IP address of the client connecting to the Transfer Family server.", + )