Amazon Web Services, Inc.

AWS Elemental Inference

This is the AWS Elemental Inference REST API Reference. It provides information on the URL, request contents, and response contents of each AWS Elemental…

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the AWS Elemental Inference REST API Reference. It provides information on the URL, request contents, and response contents of each AWS Elemental Inference REST operation. We assume that you have the IAM permissions that you need to use AWS Elemental Inference via the REST API. We also assume that you are familiar with the features and operations of AWS Elemental Inference as described in AWS Elemental Inference User Guide .

Endpoints 24

Feed

  • POSTAssociate feed/v1/feed/:id/associateAssociates a resource with the feed. The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such…
  • POSTCreate feed/v1/feedCreates a feed. The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS…
  • GETList schedule actions/v1/feed/:id/schedule-actions?maxResults=0&nextToken=stringDisplays a list of the schedule actions on a feed, including the status of each action and, for a failed action, information about why it failed. Elemental…
  • POSTCreate schedule action/v1/feed/:id/schedule-actionsCreates a schedule action on a feed. A schedule action applies configuration changes to the feed at a time that you specify, in the same way as an UpdateFeed…
  • DELETEDelete schedule action/v1/feed/:id/schedule-actions?actionName=stringDeletes a schedule action from a feed. A deleted action never runs. You can delete only an action whose status is PENDING. Deleting an action doesn't reverse…
  • GETGet feed/v1/feed/:idRetrieves information about the specified feed.
  • PUTUpdate feed/v1/feed/:idUpdates the name and/or outputs in a feed. UpdateFeed is a PUT operation, which means that the payload that you specify completely overwrites the existing…
  • DELETEDelete feed/v1/feed/:idDeletes the specified feed. You can delete the feed at any time. Elemental Inference doesn't block you from deleting a feed when the calling application is…
  • GETGet feed policy/v1/feed/:id/policyRetrieves the resource-based policy attached to the specified feed.
  • PUTPut feed policy/v1/feed/:id/policyAttaches or replaces a resource-based policy on the specified feed. A resource-based policy grants cross-account access to the feed.
  • DELETEDelete feed policy/v1/feed/:id/policyDeletes the resource-based policy attached to the specified feed. After you delete the policy, the operation revokes the cross-account access that the policy…
  • POSTDisassociate feed/v1/feed/:id/disassociateReleases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.
  • GETList feeds/v1/feeds?maxResults=0&nextToken=stringDisplays a list of feeds that belong to this AWS account.

Dictionary

  • POSTCreate dictionary/v1/dictionaryCreates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such…
  • GETGet dictionary/v1/dictionary/:idRetrieves information about the specified dictionary.
  • DELETEDelete dictionary/v1/dictionary/:idDeletes the specified dictionary. You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's…
  • PATCHUpdate dictionary/v1/dictionary/:idUpdates the specified dictionary.
  • GETExport dictionary entries/v1/dictionary/:id/entries/exportExports the entries from the specified dictionary.
  • GETList dictionaries/v1/dictionaries?maxResults=0&nextToken=stringLists the dictionaries in your account.
  • GETGet fixture/v1/fixtures/:fixtureIdRetrieves information about the specified fixture (a sports event, such as a specific basketball game). You obtain a fixtureId from SearchFixtures, or from…
  • GETList tags for resource/v1/tags/:resourceArnList all tags that are on an Elemental Inference resource in the current region.
  • POSTTag resource/v1/tags/:resourceArnAssociates the specified tags to the resource identified by the specified resourceArn in the current region. If existing tags on a resource are not specified…
  • DELETEUntag resource/v1/tags/:resourceArn?tagKeys=Deletes specified tags from the specified resource in the current region.
  • POSTSearch fixtures/v1/fixturesSearches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window. Each fixture in the response…

API details

Base URL
https://elemental-inference.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
24 operations on 14 pathsGET 9POST 7DELETE 5PUT 2PATCH 1
Main resources
Feed 13Dictionary 6
Description format
AWS Smithy model, API version 2018-11-14

How to test the AWS Elemental Inference in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Elemental Inference collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate feed” (POST /v1/feed/:id/associate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Elemental Inference?

This is the AWS Elemental Inference REST API Reference. It provides information on the URL, request contents, and response contents of each AWS Elemental… It is listed under AI & machine learning and has 24 endpoints.

Who publishes the AWS Elemental Inference?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Elemental Inference?

Requests go to https://elemental-inference.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Elemental Inference?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Elemental Inference have?

24 operations on 14 paths (9 GET, 7 POST, 5 DELETE, 2 PUT, 1 PATCH). The largest groups are Feed, Dictionary.

Is forking the AWS Elemental Inference free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.