@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Personalize Runtime
@version 2018-05-22
@auth AWS SigV4
@endpoints 3
@toc action-recommendations(1), personalize-ranking(1), recommendations(1)

@group action-recommendations
@endpoint POST /action-recommendations
@optional {campaignArn: str, userId: str, numResults: int, filterArn: str, filterValues: map<str,str>}
@returns(200) {actionList: [PredictedAction]?, recommendationId: str?}

@endgroup

@group personalize-ranking
@endpoint POST /personalize-ranking
@required {campaignArn: str, inputList: [str], userId: str}
@optional {context: map<str,str>, filterArn: str, filterValues: map<str,str>, metadataColumns: map<str,[str]>}
@returns(200) {personalizedRanking: [PredictedItem]?, recommendationId: str?}

@endgroup

@group recommendations
@endpoint POST /recommendations
@optional {campaignArn: str, itemId: str, userId: str, numResults: int, context: map<str,str>, filterArn: str, filterValues: map<str,str>, recommenderArn: str, promotions: [Promotion], metadataColumns: map<str,[str]>}
@returns(200) {itemList: [PredictedItem]?, recommendationId: str?}

@endgroup

@end