Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociateFeed

Associates a resource with the feed. The resource provides the input that Elemental Inference needs needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed.

Request Syntax


POST /v1/feed/id/associate HTTP/1.1
Content-type: application/json

{
   "associatedResourceName": "string",
   "dryRun": boolean,
   "outputs": [ 
      { 
         "description": "string",
         "name": "string",
         "outputConfig": { ... },
         "status": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

id

The ID of the feed.

Pattern: [a-z0-9]{19}

Required: Yes

Request Body

The request accepts the following data in JSON format.

associatedResourceName

An identifier for the resource. If the resource is from an AWS service, this identifier must be the full ARN of that resource. Otherwise, the identifier is a name that you assign and that is appropriate for the application that owns the resource. This name must not resemble an ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [\w \-\.',@:;/]*

Required: Yes

dryRun

Set to true if you want to do a dry run of the associate action.

Type: Boolean

Required: No

outputs

The outputs to add to this feed. You must specify at least one output. You can later use the UpdateFeed action to change the list of outputs.

Type: Array of CreateOutput objects

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The AWS ARN for this association.

Type: String

id

An ID for this response. It is unique in Elemental Inference for this AWS account.

Type: String

Pattern: [a-z0-9]{19}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict.

HTTP Status Code: 409

InternalServerErrorException

An internal server error occurred. This is a temporary condition and the request can be retried. If the problem persists, contact AWS Support.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the action doesn't exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request was rejected because it would exceed one or more service quotas for your account. Review your service quotas and either delete unused resources or request a quota increase.

HTTP Status Code: 402

TooManyRequestException

The request was denied due to request throttling. Too many requests have been made within a given time period. Reduce the frequency of requests and use exponential backoff when retrying.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service. Check the error message for details about which parameter or field is invalid and correct the request before retrying.

HTTP Status Code: 400