Api-Elementalinference-2018-11-14

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.
CreateFeed ( array $params = [] ): Creates a feed.
DeleteFeed ( array $params = [] ): Deletes the specified feed.
DisassociateFeed ( array $params = [] ): Releases the resource (for example, an MediaLive channel) that is associated with this feed.
GetFeed ( array $params = [] ): Retrieves information about the specified feed.
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.
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:

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

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' => [
                ],
            ],
            'status' => 'ENABLED|DISABLED', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

associatedResourceName

: Required: Yes
: Type: string

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.

dryRun

: Type: boolean

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

id

: Required: Yes
: Type: string

The ID of the feed.

outputs

: Required: Yes
: Type: Array of CreateOutput structures

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.

Result Syntax

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

Result Details

Members

arn

: Required: Yes
: Type: string

The AWS ARN for this association.

id

: Required: Yes
: Type: string

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

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.

CreateFeed

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

Creates a feed. The feed is the target for live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed.

Parameter Syntax

$result = $client->createFeed([
    'name' => '<string>', // REQUIRED
    'outputs' => [ // REQUIRED
        [
            'description' => '<string>',
            'name' => '<string>', // REQUIRED
            'outputConfig' => [ // REQUIRED
                'clipping' => [
                    'callbackMetadata' => '<string>',
                ],
                'cropping' => [
                ],
            ],
            'status' => 'ENABLED|DISABLED', // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

name

: Required: Yes
: Type: string

A 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, an output might represent the crop feature.

tags

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

If you want to include tags, add them now. You won't be able to add them later.

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' => [
                ],
            ],
            '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.

dataEndpoints

: Required: Yes
: Type: Array of strings

A unique ARN that Elemental Inference assigns to the feed.

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.

outputs

: Required: Yes
: Type: Array of GetOutput structures

Data endpoints that Elemental Inference assigns to the feed.

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.

DeleteFeed

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

Deletes the specified feed. The feed can be deleted at any time.

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 (for example, an MediaLive channel) 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.

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 ID of the feed where you deleted the associated resource.

id

: Required: Yes
: Type: string

The ARN of the resource that you 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.

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' => [
                ],
            ],
            '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, if any, associated with the feed being queried.

dataEndpoints

: Required: Yes
: Type: Array of strings

The dataEndpoints of the feed being queried.

id

: Required: Yes
: Type: string

The ID of the feed being queried.

name

: Required: Yes
: Type: string

The name of the feed being queried.

outputs

: Required: Yes
: Type: Array of GetOutput structures

An array of the outputs in the feed being queried.

status

: Required: Yes
: Type: string

The status of the feed being queried.

tags

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

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

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.

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 ListBridges 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 ListBridges 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 feed summaries.

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.

UpdateFeed

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

Updates the name and/or outputs in a feed.

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' => [
                ],
            ],
            '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' => [
                ],
            ],
            '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

True means that the output was originally created in the feed by the AssociateFeed operation. False means it was created using CreateFeed or UpdateFeed. You will need this value if you use the UpdateFeed operation to modify the list of outputs in the feed.

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 output.

tags

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

The name of the resource currently associated with the feed, if any.

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

ClippingConfig

Description

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

Members

callbackMetadata

: Type: string

The metadata that is the result of the clip request to Elemental Inference.

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 is used in the CreateFeed and AssociateFeed actions. 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

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 action.

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 action.

Members

description

: Type: string

The description of the output.

fromAssociation

: Type: boolean

name

: Required: Yes
: Type: string

The ARN of the output.

outputConfig

: Required: Yes
: Type: OutputConfig structure

A typed property for an output in a feed. It is used in the GetFeed action. 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.

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

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

This property is set by the service when you add the output to the feed, and indicates how you added the output. True means that you used the AssociateFeed operation. False means that you used the CreateFeed or UpdateFeed operation. Use GetFeed to obtain the value. If the value is True, include this field here with a value of True. If the value is False, omit the field here.

name

: Required: Yes
: Type: string

The name start here

outputConfig

: Required: Yes
: Type: OutputConfig structure

A typed property for an output in a feed. It is used in the UpdateFeed action. 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

AWS Elemental Inference 2018-11-14

Operation Summary

Paginators

Waiters

Operations

AssociateFeed

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFeed

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteFeed

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateFeed

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetFeed

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListFeeds

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

TagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

UntagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

UpdateFeed

Parameter Syntax

Parameter Details

Members

Result Syntax