SDK for PHP V3

Client: Aws\ElementalInference\ElementalInferenceClient
Service ID: elementalinference
Version: 2018-11-14

This page describes the parameters and results for the operations of the AWS Elemental Inference (2018-11-14), and shows how to use the Aws\ElementalInference\ElementalInferenceClient object to call the described operations. This documentation is specific to the 2018-11-14 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateFeed ( array $params = [] )
Associates a resource with the feed.
CreateDictionary ( array $params = [] )
Creates a custom dictionary for improving transcription accuracy.
CreateFeed ( array $params = [] )
Creates a feed.
DeleteDictionary ( array $params = [] )
Deletes the specified dictionary.
DeleteFeed ( array $params = [] )
Deletes the specified feed.
DisassociateFeed ( array $params = [] )
Releases the resource (the source media) that is associated with this feed.
ExportDictionaryEntries ( array $params = [] )
Exports the entries from the specified dictionary.
GetDictionary ( array $params = [] )
Retrieves information about the specified dictionary.
GetFeed ( array $params = [] )
Retrieves information about the specified feed.
ListDictionaries ( array $params = [] )
Lists the dictionaries in your account.
ListFeeds ( array $params = [] )
Displays a list of feeds that belong to this AWS account.
ListTagsForResource ( array $params = [] )
List all tags that are on an Elemental Inference resource in the current region.
TagResource ( array $params = [] )
Associates the specified tags to the resource identified by the specified resourceArn in the current region.
UntagResource ( array $params = [] )
Deletes specified tags from the specified resource in the current region.
UpdateDictionary ( array $params = [] )
Updates the specified dictionary.
UpdateFeed ( array $params = [] )
Updates the name and/or outputs in a feed.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDictionaries
ListFeeds

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
FeedDeleted GetFeed 3 40

Operations

AssociateFeed

$result = $client->associateFeed([/* ... */]);
$promise = $client->associateFeedAsync([/* ... */]);

Associates a resource with the feed. The resource provides the input that Elemental Inference 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. With an association, a specific source media is claiming ownership of the feed.

AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation.

Specifically:

  • You can add more outputs to the existing outputs. New outputs will be appended.

  • You can't modify an existing output (for example to change its name). Instead, use UpdateFeed.

  • You can't delete an existing output. Instead, use UpdateFeed.

Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.

Parameter Syntax

$result = $client->associateFeed([
    'associatedResourceName' => '<string>', // REQUIRED
    'dryRun' => true || false,
    'id' => '<string>', // REQUIRED
    'outputs' => [ // REQUIRED
        [
            'description' => '<string>',
            'name' => '<string>', // REQUIRED
            'outputConfig' => [ // REQUIRED
                'clipping' => [
                    'callbackMetadata' => '<string>',
                ],
                'cropping' => [
                ],
                'subtitling' => [
                    'aspectRatio' => [
                        'height' => <integer>, // REQUIRED
                        'width' => <integer>, // REQUIRED
                    ],
                    'dictionary' => '<string>',
                    'language' => 'eng|eng-au|eng-gb|eng-us|fra|ita|deu|spa|por', // REQUIRED
                    'profanityFilter' => 'DISABLED|CENSOR|DROP',
                ],
            ],
            'status' => 'ENABLED|DISABLED', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
associatedResourceName
Required: Yes
Type: string

An identifier for the resource. This name must not resemble an ARN.

The resource is the source media that the feed will process. The name you assign should help you to later identify the source media that belongs to the feed. In this way, you will know which source media to push to the feed (using PutMedia).

dryRun
Type: boolean

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

Elemental Inference will validate that the real request would succeed without actually making any changes. A dry run catches errors such as missing IAM permissions, quota limits exceeded, conflicting outputs, and so on. If the dry run fails, the action returns a 4xx error code. After you've fixed the errors, resubmit the request.

id
Required: Yes
Type: string

The ID of the feed.

outputs
Required: Yes
Type: Array of CreateOutput structures

An array of one or more outputs that you want to add to this feed now, to supplement any outputs that you specified when you created or updated the feed.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the feed.

id
Required: Yes
Type: string

The ID of the feed.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

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.

CreateDictionary

$result = $client->createDictionary([/* ... */]);
$promise = $client->createDictionaryAsync([/* ... */]);

Creates a custom dictionary for improving transcription accuracy. A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.

Parameter Syntax

$result = $client->createDictionary([
    'entries' => '<string>',
    'language' => 'eng|fra|ita|deu|spa|por', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
entries
Type: string

The dictionary entries payload. Contains the custom words and phrases for the dictionary. Maximum size is 40,960 characters.

language
Required: Yes
Type: string

The language of the dictionary entries. Specify the language using an ISO 639-2/T three-letter code. Supported values: eng, fra, ita, deu, spa, por.

name
Required: Yes
Type: string

A user-friendly name for this dictionary.

tags
Type: Associative array of custom strings keys (TagKey) to strings

Optional tags to associate with the dictionary.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'language' => 'eng|fra|ita|deu|spa|por',
    'name' => '<string>',
    'references' => ['<string>', ...],
    'status' => 'CREATING|AVAILABLE|REFERENCED|DELETING|DELETED',
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the dictionary.

id
Required: Yes
Type: string

A unique ID that Elemental Inference assigns to the dictionary.

language
Required: Yes
Type: string

The language of the dictionary.

name
Required: Yes
Type: string

The name that you specified in the request.

references
Type: Array of strings

A list of feed IDs that reference this dictionary.

status
Required: Yes
Type: string

The current status of the dictionary. After creation succeeds, the status will be AVAILABLE.

tags
Type: Associative array of custom strings keys (TagKey) to strings

Any tags that you included when you created the dictionary.

Errors

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.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

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.

CreateFeed

$result = $client->createFeed([/* ... */]);
$promise = $client->createFeedAsync([/* ... */]);

Creates 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 Elemental MediaLive.

The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs.

Parameter Syntax

$result = $client->createFeed([
    'name' => '<string>', // REQUIRED
    'outputs' => [ // REQUIRED
        [
            'description' => '<string>',
            'name' => '<string>', // REQUIRED
            'outputConfig' => [ // REQUIRED
                'clipping' => [
                    'callbackMetadata' => '<string>',
                ],
                'cropping' => [
                ],
                'subtitling' => [
                    'aspectRatio' => [
                        'height' => <integer>, // REQUIRED
                        'width' => <integer>, // REQUIRED
                    ],
                    'dictionary' => '<string>',
                    'language' => 'eng|eng-au|eng-gb|eng-us|fra|ita|deu|spa|por', // REQUIRED
                    'profanityFilter' => 'DISABLED|CENSOR|DROP',
                ],
            ],
            'status' => 'ENABLED|DISABLED', // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
name
Required: Yes
Type: string

A user-friendly name for this feed.

outputs
Required: Yes
Type: Array of CreateOutput structures

An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, there is one output type for the smart crop feature. You must specify at least one output, but you can later add outputs using AssociateFeed, or add, modify, and delete outputs using UpdateFeed.

tags
Type: Associative array of custom strings keys (TagKey) to strings

Optional tags. You can also add tags later, using TagResource.

Result Syntax

[
    'arn' => '<string>',
    'association' => [
        'associatedResourceName' => '<string>',
    ],
    'dataEndpoints' => ['<string>', ...],
    'id' => '<string>',
    'name' => '<string>',
    'outputs' => [
        [
            'description' => '<string>',
            'fromAssociation' => true || false,
            'name' => '<string>',
            'outputConfig' => [
                'clipping' => [
                    'callbackMetadata' => '<string>',
                ],
                'cropping' => [
                ],
                'subtitling' => [
                    'aspectRatio' => [
                        'height' => <integer>,
                        'width' => <integer>,
                    ],
                    'dictionary' => '<string>',
                    'language' => 'eng|eng-au|eng-gb|eng-us|fra|ita|deu|spa|por',
                    'profanityFilter' => 'DISABLED|CENSOR|DROP',
                ],
            ],
            'status' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
    'status' => 'CREATING|AVAILABLE|ACTIVE|UPDATING|DELETING|DELETED|ARCHIVED',
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

A unique ARN that Elemental Inference assigns to the feed.

association
Type: FeedAssociation structure

The association for this feed. When you create the feed, this property is empty. You must associate a resource with the feed using AssociateFeed or UpdateFeed.

dataEndpoints
Required: Yes
Type: Array of strings

An array of endpoints for the feed. Typically, there is only one endpoint. The feed receives source media at this endpoint (when the calling application calls PutMedia) and returns the resulting metadata to this endpoint (when the calling application calls GetMetadata).

id
Required: Yes
Type: string

A unique ID that Elemental Inference assigns to the feed.

name
Required: Yes
Type: string

The name that you specified in the request.

outputs
Required: Yes
Type: Array of GetOutput structures

Repeats the outputs that you specified in the request.

status
Required: Yes
Type: string

The current status of the feed. After creation of the feed has succeeded, the status will be AVAILABLE.

tags
Type: Associative array of custom strings keys (TagKey) to strings

Any tags that you included when you created the feed.

Errors

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.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

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.

DeleteDictionary

$result = $client->deleteDictionary([/* ... */]);
$promise = $client->deleteDictionaryAsync([/* ... */]);

Deletes 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 subtitling configuration.

Parameter Syntax

$result = $client->deleteDictionary([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the dictionary to delete.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'status' => 'CREATING|AVAILABLE|REFERENCED|DELETING|DELETED',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the deleted dictionary.

id
Required: Yes
Type: string

The ID of the deleted dictionary.

status
Required: Yes
Type: string

The status of the dictionary after deletion.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

DeleteFeed

$result = $client->deleteFeed([/* ... */]);
$promise = $client->deleteFeedAsync([/* ... */]);

Deletes 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 calling PutMedia or GetMetadata on that feed, although both these calls will start to fail. For more information about managing inactive feeds, see the Elemental Inference User Guide.

Parameter Syntax

$result = $client->deleteFeed([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the feed.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'status' => 'CREATING|AVAILABLE|ACTIVE|UPDATING|DELETING|DELETED|ARCHIVED',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the deleted feed.

id
Required: Yes
Type: string

The ID of the deleted feed.

status
Required: Yes
Type: string

The current status of the feed. When deletion of the feed has succeeded, the status will be DELETED.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

DisassociateFeed

$result = $client->disassociateFeed([/* ... */]);
$promise = $client->disassociateFeedAsync([/* ... */]);

Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.

Parameter Syntax

$result = $client->disassociateFeed([
    'associatedResourceName' => '<string>', // REQUIRED
    'dryRun' => true || false,
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
associatedResourceName
Required: Yes
Type: string

The name of the resource currently associated with the feed.

dryRun
Type: boolean

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

Elemental Inference will validate that the real request would succeed without actually making any changes. A dry run catches errors such as missing IAM permissions. If the dry run fails, the action returns a 4xx error code.

id
Required: Yes
Type: string

The ID of the feed where you want to release the resource.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the feed.

id
Required: Yes
Type: string

The ID of the feed.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

ExportDictionaryEntries

$result = $client->exportDictionaryEntries([/* ... */]);
$promise = $client->exportDictionaryEntriesAsync([/* ... */]);

Exports the entries from the specified dictionary.

Parameter Syntax

$result = $client->exportDictionaryEntries([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the dictionary whose entries you want to export.

Result Syntax

[
    'entries' => '<string>',
]

Result Details

Members
entries
Type: string

The dictionary entries payload.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

GetDictionary

$result = $client->getDictionary([/* ... */]);
$promise = $client->getDictionaryAsync([/* ... */]);

Retrieves information about the specified dictionary.

Parameter Syntax

$result = $client->getDictionary([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the dictionary to retrieve.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'language' => 'eng|fra|ita|deu|spa|por',
    'name' => '<string>',
    'references' => ['<string>', ...],
    'status' => 'CREATING|AVAILABLE|REFERENCED|DELETING|DELETED',
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the dictionary.

id
Required: Yes
Type: string

The ID of the dictionary.

language
Required: Yes
Type: string

The language of the dictionary.

name
Required: Yes
Type: string

The name of the dictionary.

references
Type: Array of strings

A list of feed IDs that reference this dictionary.

status
Required: Yes
Type: string

The current status of the dictionary.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags associated with the dictionary.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

GetFeed

$result = $client->getFeed([/* ... */]);
$promise = $client->getFeedAsync([/* ... */]);

Retrieves information about the specified feed.

Parameter Syntax

$result = $client->getFeed([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the feed to query.

Result Syntax

[
    'arn' => '<string>',
    'association' => [
        'associatedResourceName' => '<string>',
    ],
    'dataEndpoints' => ['<string>', ...],
    'id' => '<string>',
    'name' => '<string>',
    'outputs' => [
        [
            'description' => '<string>',
            'fromAssociation' => true || false,
            'name' => '<string>',
            'outputConfig' => [
                'clipping' => [
                    'callbackMetadata' => '<string>',
                ],
                'cropping' => [
                ],
                'subtitling' => [
                    'aspectRatio' => [
                        'height' => <integer>,
                        'width' => <integer>,
                    ],
                    'dictionary' => '<string>',
                    'language' => 'eng|eng-au|eng-gb|eng-us|fra|ita|deu|spa|por',
                    'profanityFilter' => 'DISABLED|CENSOR|DROP',
                ],
            ],
            'status' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
    'status' => 'CREATING|AVAILABLE|ACTIVE|UPDATING|DELETING|DELETED|ARCHIVED',
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the feed.

association
Type: FeedAssociation structure

Information about the resource that is associated with the feed. It's possible that there is no associated resource. This is not an error.

dataEndpoints
Required: Yes
Type: Array of strings

The dataEndpoints of the feed.

id
Required: Yes
Type: string

The ID of the feed.

name
Required: Yes
Type: string

The name of the feed.

outputs
Required: Yes
Type: Array of GetOutput structures

An array of the outputs in the feed.

status
Required: Yes
Type: string

The status of the feed.

tags
Type: Associative array of custom strings keys (TagKey) to strings

A list of the tags, if any, for the feed.

Errors

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ListDictionaries

$result = $client->listDictionaries([/* ... */]);
$promise = $client->listDictionariesAsync([/* ... */]);

Lists the dictionaries in your account.

Parameter Syntax

$result = $client->listDictionaries([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return per API request. Valid range: 1 to 100.

nextToken
Type: string

The token that identifies the next batch of results to return.

Result Syntax

[
    'dictionaries' => [
        [
            'arn' => '<string>',
            'id' => '<string>',
            'language' => 'eng|fra|ita|deu|spa|por',
            'name' => '<string>',
            'status' => 'CREATING|AVAILABLE|REFERENCED|DELETING|DELETED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
dictionaries
Required: Yes
Type: Array of DictionarySummary structures

A list of DictionarySummary objects.

nextToken
Type: string

The token to use to retrieve the next batch of results.

Errors

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.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ListFeeds

$result = $client->listFeeds([/* ... */]);
$promise = $client->listFeedsAsync([/* ... */]);

Displays a list of feeds that belong to this AWS account.

Parameter Syntax

$result = $client->listFeeds([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return per API request.

For example, you submit a list request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)

The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken
Type: string

The token that identifies the batch of results that you want to see.

For example, you submit a ListFeeds request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFeeds request a second time and specify the NextToken value.

Result Syntax

[
    'feeds' => [
        [
            'arn' => '<string>',
            'association' => [
                'associatedResourceName' => '<string>',
            ],
            'id' => '<string>',
            'name' => '<string>',
            'status' => 'CREATING|AVAILABLE|ACTIVE|UPDATING|DELETING|DELETED|ARCHIVED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
feeds
Required: Yes
Type: Array of FeedSummary structures

A list of FeedSummary objects.

nextToken
Type: string

The token that identifies the batch of results that you want to see. For example, you submit a list request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the list request a second time and specify the NextToken value.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List all tags that are on an Elemental Inference resource in the current region.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource whose tags you want to query.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

A list of the tags that belong to this resource.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates the specified tags to the resource identified by the specified resourceArn in the current region. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource where you want to add tags.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes specified tags from the specified resource in the current region.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The ARN of the resource where you want to delete one or more tags.

tagKeys
Required: Yes
Type: Array of strings

The keys of the tags to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

UpdateDictionary

$result = $client->updateDictionary([/* ... */]);
$promise = $client->updateDictionaryAsync([/* ... */]);

Updates the specified dictionary.

Parameter Syntax

$result = $client->updateDictionary([
    'entries' => '<string>',
    'id' => '<string>', // REQUIRED
    'language' => 'eng|fra|ita|deu|spa|por',
    'name' => '<string>',
]);

Parameter Details

Members
entries
Type: string

New dictionary entries. If not specified, the entries are not changed.

id
Required: Yes
Type: string

The ID of the dictionary to update.

language
Type: string

A new language for the dictionary. If not specified, the language is not changed.

name
Type: string

A new name for the dictionary. If not specified, the name is not changed.

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
    'language' => 'eng|fra|ita|deu|spa|por',
    'name' => '<string>',
    'references' => ['<string>', ...],
    'status' => 'CREATING|AVAILABLE|REFERENCED|DELETING|DELETED',
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the dictionary.

id
Required: Yes
Type: string

The ID of the dictionary.

language
Required: Yes
Type: string

The updated or original language of the dictionary.

name
Required: Yes
Type: string

The updated or original name of the dictionary.

references
Type: Array of strings

A list of feed IDs that reference this dictionary.

status
Required: Yes
Type: string

The current status of the dictionary.

tags
Type: Associative array of custom strings keys (TagKey) to strings

Any tags associated with the dictionary.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

UpdateFeed

$result = $client->updateFeed([/* ... */]);
$promise = $client->updateFeedAsync([/* ... */]);

Updates 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 payload.

This means that if you want to touch the array of outputs, you must pass in the full new list. So you must omit outputs you want to delete, and include outputs you want to add or modify.

If you want to patch the array of outputs to make selective additions, use AssociateFeed.

Parameter Syntax

$result = $client->updateFeed([
    'id' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'outputs' => [ // REQUIRED
        [
            'description' => '<string>',
            'fromAssociation' => true || false,
            'name' => '<string>', // REQUIRED
            'outputConfig' => [ // REQUIRED
                'clipping' => [
                    'callbackMetadata' => '<string>',
                ],
                'cropping' => [
                ],
                'subtitling' => [
                    'aspectRatio' => [
                        'height' => <integer>, // REQUIRED
                        'width' => <integer>, // REQUIRED
                    ],
                    'dictionary' => '<string>',
                    'language' => 'eng|eng-au|eng-gb|eng-us|fra|ita|deu|spa|por', // REQUIRED
                    'profanityFilter' => 'DISABLED|CENSOR|DROP',
                ],
            ],
            'status' => 'ENABLED|DISABLED', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the feed to update.

name
Required: Yes
Type: string

Required. You can specify the existing name (to leave it unchanged) or a new name.

outputs
Required: Yes
Type: Array of UpdateOutput structures

Required. You can specify the existing array of outputs (to leave outputs unchanged) or you can specify a new array.

Result Syntax

[
    'arn' => '<string>',
    'association' => [
        'associatedResourceName' => '<string>',
    ],
    'dataEndpoints' => ['<string>', ...],
    'id' => '<string>',
    'name' => '<string>',
    'outputs' => [
        [
            'description' => '<string>',
            'fromAssociation' => true || false,
            'name' => '<string>',
            'outputConfig' => [
                'clipping' => [
                    'callbackMetadata' => '<string>',
                ],
                'cropping' => [
                ],
                'subtitling' => [
                    'aspectRatio' => [
                        'height' => <integer>,
                        'width' => <integer>,
                    ],
                    'dictionary' => '<string>',
                    'language' => 'eng|eng-au|eng-gb|eng-us|fra|ita|deu|spa|por',
                    'profanityFilter' => 'DISABLED|CENSOR|DROP',
                ],
            ],
            'status' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
    'status' => 'CREATING|AVAILABLE|ACTIVE|UPDATING|DELETING|DELETED|ARCHIVED',
    'tags' => ['<string>', ...],
]

Result Details

Members
arn
Required: Yes
Type: string

The ARN of the feed.

association
Type: FeedAssociation structure

Information about the resource that is associated with the feed, if any.

dataEndpoints
Required: Yes
Type: Array of strings

The data endpoints of the feed.

id
Required: Yes
Type: string

The ID of the feed.

name
Required: Yes
Type: string

The updated or original name of the feed.

outputs
Required: Yes
Type: Array of GetOutput structures

The array of outputs in the feed. You might have left this array unchanged, or you might have changed it.

status
Required: Yes
Type: string

The status of the feed.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags associated with the feed.

Errors

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.

ResourceNotFoundException:

The resource specified in the action doesn't exist.

InternalServerErrorException:

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

AccessDeniedException:

You do not have sufficient access to perform this action.

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.

ConflictException:

The request could not be completed due to a conflict.

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.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
message
Required: Yes
Type: string

AspectRatio

Description

The width and height of the output video. Used in SubtitlingConfig to determine subtitle layout.

Members
height
Required: Yes
Type: int

The height component of the aspect ratio (for example, 9 in a 16:9 ratio).

width
Required: Yes
Type: int

The width component of the aspect ratio (for example, 16 in a 16:9 ratio).

ClippingConfig

Description

A type of OutputConfig, used when the output in a feed is for the clip feature.

Members
callbackMetadata
Type: string

A string that you want Elemental Inference to always include in the event clipping metadata for this output. The string might identify the sports event in the source media, for example.

ConflictException

Description

The request could not be completed due to a conflict.

Members
message
Required: Yes
Type: string

CreateOutput

Description

Contains configuration information about one output in a feed. It is used in the AssociateFeed and the CreateFeed actions.

Members
description
Type: string

A description for the output.

name
Required: Yes
Type: string

A name for the output.

outputConfig
Required: Yes
Type: OutputConfig structure

A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.

status
Required: Yes
Type: string

The status to assign to the output.

CroppingConfig

Description

A type of OutputConfig, used when the output in a feed is for the crop feature.

Members

DictionarySummary

Description

Contains summary information about a dictionary. Used in the ListDictionaries response.

Members
arn
Required: Yes
Type: string

The ARN of the dictionary.

id
Required: Yes
Type: string

The ID of the dictionary.

language
Required: Yes
Type: string

The language of the dictionary.

name
Required: Yes
Type: string

The name of the dictionary.

status
Required: Yes
Type: string

The status of the dictionary.

FeedAssociation

Description

Contains information about the resource that is associated with a feed. It is used in the FeedSummary that is used in the response of a ListFeeds action.

Members
associatedResourceName
Required: Yes
Type: string

The name of the associated resource.

FeedSummary

Description

Contains configuration information about a feed. It is used in the ListFeeds response.

Members
arn
Required: Yes
Type: string

The ARN of the feed.

association
Type: FeedAssociation structure

The resource, if any, associated with the feed.

id
Required: Yes
Type: string

The ID of the feed.

name
Required: Yes
Type: string

The name of the feed

status
Required: Yes
Type: string

The status of the feed.

GetOutput

Description

Contains configuration information about one output in a feed. It is used in the GetFeed response.

Members
description
Type: string

The description of the output.

fromAssociation
Type: boolean

True means that the output was originally created in the feed using AssociateFeed. False means it was created using CreateFeed or UpdateFeed.

You will need this value if you use UpdateFeed to modify the list of outputs in the feed.

name
Required: Yes
Type: string

The name of the output.

outputConfig
Required: Yes
Type: OutputConfig structure

A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.

status
Required: Yes
Type: string

The status of the output.

InternalServerErrorException

Description

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

Members
message
Required: Yes
Type: string

OutputConfig

Description

Contains one typed output. It is used in the CreateOutput, GetOutput, and Update Output structures.

Members
clipping
Type: ClippingConfig structure

The output config type that applies to the clipping feature.

cropping
Type: CroppingConfig structure

The output config type that applies to the cropping feature.

subtitling
Type: SubtitlingConfig structure

The output config type that applies to the smart subtitling feature.

ResourceNotFoundException

Description

The resource specified in the action doesn't exist.

Members
message
Required: Yes
Type: string

ServiceQuotaExceededException

Description

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.

Members
message
Required: Yes
Type: string

SubtitlingConfig

Description

A type of OutputConfig, used when the output in a feed is for the smart subtitling feature. smart subtitling uses automatic speech recognition (ASR) to generate live TTML subtitles from the audio in your source media.

Members
aspectRatio
Type: AspectRatio structure

The aspect ratio of the output video, specified as width and height integer values. Elemental Inference uses the aspect ratio to determine subtitle layout and line lengths.

dictionary
Type: string

The ID of a custom dictionary to improve transcription accuracy for domain-specific terminology. Use the CreateDictionary operation to create a dictionary.

language
Required: Yes
Type: string

The language of the audio in the source media. Elemental Inference uses this setting to optimize transcription accuracy. Specify the language using an ISO 639-2/T three-letter code, optionally with a region subtag. Supported values: eng, eng-au, eng-gb, eng-us, fra, ita, deu, spa, por.

profanityFilter
Type: string

Controls how profanity is handled in the generated subtitles. Valid values: DISABLED (no filtering, default), CENSOR (replace profanity with asterisks), DROP (remove profanity from the transcript).

TooManyRequestException

Description

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.

Members
message
Required: Yes
Type: string

UpdateOutput

Description

Contains configuration information about one output in a feed. It is used in the UpdateFeed action.

Members
description
Type: string

A description of the output.

fromAssociation
Type: boolean

Elemental Inference originally sets this parameter to True if this output was created by AssociateFeed or to False if this output was created by CreateFeed or UpdateFeed.

You must not change this value. Therefore, use GetFeed to determine the current value. Then in the UpdateFeed request, if the current value is True, include this parameter with a value of True. If it's False, omit the parameter.

name
Required: Yes
Type: string

The name of the output.

outputConfig
Required: Yes
Type: OutputConfig structure

A typed property for an output in a feed. It identifies the action for Elemental Inference to perform. It also provides a repository for the results of that action. For example, CroppingConfig output will contain the metadata for the crop feature.

status
Required: Yes
Type: string

The status of the output.

ValidationException

Description

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.

Members
message
Required: Yes
Type: string