openapi-directory/api/amazonaws.com/personalize-events.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2018-03-22","x-release":"v4","title":"Amazon Personalize Events","description":"Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use it for model training either alone or combined with historical data. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html\">Recording Events</a>.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"personalize-events","x-aws-signingName":"personalize","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/personalize-events-2018-03-22.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/personalize-events/"},"servers":[{"url":"http://personalize-events.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Personalize Events multi-region endpoint"},{"url":"https://personalize-events.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon Personalize Events multi-region endpoint"},{"url":"http://personalize-events.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Personalize Events endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://personalize-events.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon Personalize Events endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/events":{"post":{"operationId":"PutEvents","description":"Records user interaction event data. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html\">Recording Events</a>.","responses":{"200":{"description":"Success"},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["trackingId","sessionId","eventList"],"properties":{"trackingId":{"description":"The tracking ID for the event. The ID is generated by a call to the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html\">CreateEventTracker</a> API.","type":"string","minLength":1,"maxLength":256},"userId":{"description":"The user associated with the event.","type":"string","minLength":1,"maxLength":256,"format":"password"},"sessionId":{"description":"The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html\">Recording Events</a>.","type":"string","minLength":1,"maxLength":256},"eventList":{"description":"A list of event data from the session.","type":"array","items":{"$ref":"#/components/schemas/Event"},"minItems":1,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/items":{"post":{"operationId":"PutItems","description":"Adds one or more items to an Items dataset. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html\">Importing Items Incrementally</a>. ","responses":{"200":{"description":"Success"},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ResourceInUseException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInUseException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["datasetArn","items"],"properties":{"datasetArn":{"description":"The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.","type":"string","pattern":"arn:([a-z\\d-]+):personalize:.*:.*:.+","maxLength":256},"items":{"description":"A list of item data.","type":"array","items":{"$ref":"#/components/schemas/Item"},"minItems":1,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/users":{"post":{"operationId":"PutUsers","description":"Adds one or more users to a Users dataset. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html\">Importing Users Incrementally</a>.","responses":{"200":{"description":"Success"},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ResourceInUseException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceInUseException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["datasetArn","users"],"properties":{"datasetArn":{"description":"The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.","type":"string","pattern":"arn:([a-z\\d-]+):personalize:.*:.*:.+","maxLength":256},"users":{"description":"A list of user data.","type":"array","items":{"$ref":"#/components/schemas/User"},"minItems":1,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"Event":{"type":"object","required":["eventType","sentAt"],"properties":{"eventId":{"allOf":[{"$ref":"#/components/schemas/StringType"},{"description":"An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training."}]},"eventType":{"allOf":[{"$ref":"#/components/schemas/StringType"},{"description":"The type of event, such as click or download. This property corresponds to the <code>EVENT_TYPE</code> field of your Interactions schema and depends on the types of events you are tracking."}]},"eventValue":{"allOf":[{"$ref":"#/components/schemas/FloatType"},{"description":"The event value that corresponds to the <code>EVENT_VALUE</code> field of the Interactions schema."}]},"itemId":{"allOf":[{"$ref":"#/components/schemas/ItemId"},{"description":"The item ID key that corresponds to the <code>ITEM_ID</code> field of the Interactions schema."}]},"properties":{"description":"<p>A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (<code>itemId</code>) and rating (<code>eventValue</code>) , you might also send the number of movie ratings made by the user.</p> <p>Each item in the map consists of a key-value pair. For example,</p> <p> <code>{\"numberOfRatings\": \"12\"}</code> </p> <p>The keys use camel case names that match the fields in the Interactions schema. In the above example, the <code>numberOfRatings</code> would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.</p>"},"sentAt":{"allOf":[{"$ref":"#/components/schemas/Date"},{"description":"The timestamp (in Unix time) on the client side when the event occurred."}]},"recommendationId":{"allOf":[{"$ref":"#/components/schemas/RecommendationId"},{"description":"<p>The ID of the list of recommendations that contains the item the user interacted with. Provide a <code>recommendationId</code> to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a <code>recommendationId</code> if you use a metric attribution to measure the impact of recommendations. </p> <p> For more information on recording impressions data, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data\">Recording impressions data</a>. For more information on creating a metric attribution see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html\">Measuring impact of recommendations</a>. </p>"}]},"impression":{"allOf":[{"$ref":"#/components/schemas/Impression"},{"description":"A list of item IDs that represents the sequence of items you have shown the user. For example, <code>[\"itemId1\", \"itemId2\", \"itemId3\"]</code>. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data\">Recording impressions data</a>. "}]},"metricAttribution":{"allOf":[{"$ref":"#/components/schemas/MetricAttribution"},{"description":"Contains information about the metric attribution associated with an event. For more information about metric attributions, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html\">Measuring impact of recommendations</a>."}]}},"description":"Represents user interaction event information sent using the <code>PutEvents</code> API."},"InvalidInputException":{},"Item":{"type":"object","required":["itemId"],"properties":{"itemId":{"allOf":[{"$ref":"#/components/schemas/StringType"},{"description":"The ID associated with the item."}]},"properties":{"description":"<p>A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, <code>{\"numberOfRatings\": \"12\"}</code>.</p> <p>The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the <code>numberOfRatings</code> matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (<code>|</code>). For example, <code>\\\"Horror|Action\\\"</code>.</p>"}},"description":"Represents item metadata added to an Items dataset using the <code>PutItems</code> API. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html\">Importing Items Incrementally</a>. "},"ResourceNotFoundException":{},"ResourceInUseException":{},"User":{"type":"object","required":["userId"],"properties":{"userId":{"allOf":[{"$ref":"#/components/schemas/StringType"},{"description":"The ID associated with the user."}]},"properties":{"description":"<p>A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, <code>{\"numberOfVideosWatched\": \"45\"}</code>.</p> <p>The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the <code>numberOfVideosWatched</code> matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (<code>|</code>). For example, <code>\\\"Member|Frequent shopper\\\"</code>.</p>"}},"description":"Represents user metadata added to a Users dataset using the <code>PutUsers</code> API. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html\">Importing Users Incrementally</a>."},"Arn":{"type":"string","pattern":"arn:([a-z\\d-]+):personalize:.*:.*:.+","maxLength":256},"Date":{"type":"string","format":"date-time"},"StringType":{"type":"string","minLength":1,"maxLength":256},"FloatType":{"type":"number","format":"float"},"ItemId":{"type":"string","minLength":1,"maxLength":256,"format":"password"},"RecommendationId":{"type":"string","minLength":1,"maxLength":40},"Impression":{"type":"array","items":{"$ref":"#/components/schemas/ItemId"},"minItems":1,"maxItems":25},"MetricAttribution":{"type":"object","required":["eventAttributionSource"],"properties":{"eventAttributionSource":{"allOf":[{"$ref":"#/components/schemas/EventAttributionSource"},{"description":"The source of the event, such as a third party."}]}},"description":"Contains information about a metric attribution associated with an event. For more information about metric attributions, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html\">Measuring impact of recommendations</a>."},"EventAttributionSource":{"type":"string","pattern":"^[\\x20-\\x7E]*[\\x21-\\x7E]+[\\x20-\\x7E]*$","maxLength":1024},"EventList":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"minItems":1,"maxItems":10},"EventPropertiesJSON":{"type":"string","minLength":1,"maxLength":1024,"format":"password"},"ItemList":{"type":"array","items":{"$ref":"#/components/schemas/Item"},"minItems":1,"maxItems":10},"ItemProperties":{"type":"string","minLength":1,"maxLength":24262,"format":"password"},"UserId":{"type":"string","minLength":1,"maxLength":256,"format":"password"},"PutEventsRequest":{"type":"object","required":["trackingId","sessionId","eventList"],"title":"PutEventsRequest","properties":{"trackingId":{"allOf":[{"$ref":"#/components/schemas/StringType"},{"description":"The tracking ID for the event. The ID is generated by a call to the <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/API_CreateEventTracker.html\">CreateEventTracker</a> API."}]},"userId":{"allOf":[{"$ref":"#/components/schemas/UserId"},{"description":"The user associated with the event."}]},"sessionId":{"allOf":[{"$ref":"#/components/schemas/StringType"},{"description":"The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html\">Recording Events</a>."}]},"eventList":{"allOf":[{"$ref":"#/components/schemas/EventList"},{"description":"A list of event data from the session."}]}}},"PutItemsRequest":{"type":"object","required":["datasetArn","items"],"title":"PutItemsRequest","properties":{"datasetArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to."}]},"items":{"allOf":[{"$ref":"#/components/schemas/ItemList"},{"description":"A list of item data."}]}}},"UserList":{"type":"array","items":{"$ref":"#/components/schemas/User"},"minItems":1,"maxItems":10},"PutUsersRequest":{"type":"object","required":["datasetArn","users"],"title":"PutUsersRequest","properties":{"datasetArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to."}]},"users":{"allOf":[{"$ref":"#/components/schemas/UserList"},{"description":"A list of user data."}]}}},"UserProperties":{"type":"string","minLength":1,"maxLength":4096,"format":"password"}}},"security":[{"hmac":[]}]}