Class: Aws::ElementalInference::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ElementalInference::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb
Overview
An API client for ElementalInference. To construct a client, you need to configure a :region and :credentials.
client = Aws::ElementalInference::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_feed(params = {}) ⇒ Types::AssociateFeedResponse
Associates a resource with the feed.
-
#create_dictionary(params = {}) ⇒ Types::CreateDictionaryResponse
Creates a custom dictionary for improving transcription accuracy.
-
#create_feed(params = {}) ⇒ Types::CreateFeedResponse
Creates a feed.
-
#create_function(params = {}) ⇒ Types::CreateFunctionResponse
Creates a function.
-
#create_question_set(params = {}) ⇒ Types::CreateQuestionSetResponse
Creates a question set.
-
#create_question_set_version(params = {}) ⇒ Types::CreateQuestionSetVersionResponse
Publishes the DRAFT version of the specified question set as a new version.
-
#create_schedule_action(params = {}) ⇒ Types::CreateScheduleActionResponse
Creates a schedule action on a feed.
-
#delete_dictionary(params = {}) ⇒ Types::DeleteDictionaryResponse
Deletes the specified dictionary.
-
#delete_feed(params = {}) ⇒ Types::DeleteFeedResponse
Deletes the specified feed.
-
#delete_feed_policy(params = {}) ⇒ Struct
Deletes the resource-based policy attached to the specified feed.
-
#delete_function(params = {}) ⇒ Types::DeleteFunctionResponse
Deletes a function.
-
#delete_question_set(params = {}) ⇒ Types::DeleteQuestionSetResponse
Deletes the specified question set, including its DRAFT version and all its published versions.
-
#delete_question_set_version(params = {}) ⇒ Struct
Deletes a published version of the specified question set.
-
#delete_schedule_action(params = {}) ⇒ Types::DeleteScheduleActionResponse
Deletes a schedule action from a feed.
-
#disassociate_feed(params = {}) ⇒ Types::DisassociateFeedResponse
Releases the resource (the source media) that is associated with this feed.
-
#export_dictionary_entries(params = {}) ⇒ Types::ExportDictionaryEntriesResponse
Exports the entries from the specified dictionary.
-
#get_dictionary(params = {}) ⇒ Types::GetDictionaryResponse
Retrieves information about the specified dictionary.
-
#get_feed(params = {}) ⇒ Types::GetFeedResponse
Retrieves information about the specified feed.
-
#get_feed_policy(params = {}) ⇒ Types::GetFeedPolicyResponse
Retrieves the resource-based policy attached to the specified feed.
-
#get_fixture(params = {}) ⇒ Types::GetFixtureResponse
Retrieves information about the specified fixture (a sports event, such as a specific basketball game).
-
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Retrieves the details of a function, including its expressions, the media context that Elemental Inference derived from the request expression, and the feeds that currently reference it.
-
#get_question_set(params = {}) ⇒ Types::GetQuestionSetResponse
Retrieves information about the specified question set at one version.
-
#list_dictionaries(params = {}) ⇒ Types::ListDictionariesResponse
Lists the dictionaries in your account.
-
#list_feeds(params = {}) ⇒ Types::ListFeedsResponse
Displays a list of feeds that belong to this AWS account.
-
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
Lists the functions in this account, in this Region.
-
#list_question_set_versions(params = {}) ⇒ Types::ListQuestionSetVersionsResponse
Lists the versions of the specified question set.
-
#list_question_sets(params = {}) ⇒ Types::ListQuestionSetsResponse
Lists the question sets in your account.
-
#list_schedule_actions(params = {}) ⇒ Types::ListScheduleActionsResponse
Displays 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.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags that are on an Elemental Inference resource in the current region.
-
#put_feed_policy(params = {}) ⇒ Struct
Attaches or replaces a resource-based policy on the specified feed.
-
#search_fixtures(params = {}) ⇒ Types::SearchFixturesResponse
Searches for the fixtures (sports events, such as a specific basketball game) that are available for a sport in a date window.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to the resource identified by the specified resourceArn in the current region.
-
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from the specified resource in the current region.
-
#update_dictionary(params = {}) ⇒ Types::UpdateDictionaryResponse
Updates the specified dictionary.
-
#update_feed(params = {}) ⇒ Types::UpdateFeedResponse
Updates the name and/or outputs in a feed.
-
#update_function(params = {}) ⇒ Types::UpdateFunctionResponse
Updates a function.
-
#update_question_set(params = {}) ⇒ Types::UpdateQuestionSetResponse
Updates the DRAFT version of the specified question set.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
479 480 481 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#associate_feed(params = {}) ⇒ Types::AssociateFeedResponse
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.
638 639 640 641 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 638 def associate_feed(params = {}, = {}) req = build_request(:associate_feed, params) req.send_request() end |
#create_dictionary(params = {}) ⇒ Types::CreateDictionaryResponse
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.
701 702 703 704 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 701 def create_dictionary(params = {}, = {}) req = build_request(:create_dictionary, params) req.send_request() end |
#create_feed(params = {}) ⇒ Types::CreateFeedResponse
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.
883 884 885 886 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 883 def create_feed(params = {}, = {}) req = build_request(:create_feed, params) req.send_request() end |
#create_function(params = {}) ⇒ Types::CreateFunctionResponse
Creates a function. A function analyzes a feed by building a request from the feed's media and metadata, optionally sending that request to an Amazon Bedrock model in your account, and publishing the result to the feed's metadata timeline.
A function runs only after you attach it to a feed as a function output. For more information, see Using functions in the AWS Elemental Inference User Guide.
1020 1021 1022 1023 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1020 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_question_set(params = {}) ⇒ Types::CreateQuestionSetResponse
Creates a question set. Use a question set to get answers about content that's specific to your business, in addition to the built-in contextual metadata classifications. A question set contains your own questions. You ask Elemental Inference these questions about each shot or scene of the media in a contextual metadata output, and Elemental Inference answers each question with scores. To use a question set, reference it in the customQuestions property of the contextual metadata configuration of a feed output.
CreateQuestionSet creates the question set with a DRAFT version that contains the questions in the request. To change DRAFT, use UpdateQuestionSet. To publish DRAFT as a numbered version, use CreateQuestionSetVersion. You can't change a published version.
A question set can contain the following types of questions. You must specify at least one question.
yesNo – Elemental Inference answers yes or no.
yesNoPerOption – Elemental Inference answers yes or no for each option.
chooseOne – Elemental Inference chooses one of the options.
A version can contain up to 100 scored items, where each yesNo question, each option of a yesNoPerOption question, and each chooseOne question counts as one item. The name of each question must be unique across all three types.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1164 def create_question_set(params = {}, = {}) req = build_request(:create_question_set, params) req.send_request() end |
#create_question_set_version(params = {}) ⇒ Types::CreateQuestionSetVersionResponse
Publishes the DRAFT version of the specified question set as a new version. The new version has the same name and questions as DRAFT, and you can't change it. DRAFT doesn't change, so you can continue to update it.
Version numbers start at 1, and each new version has the next number. Elemental Inference never reuses a version number, even after you delete that version.
If DRAFT hasn't changed since the latest published version, Elemental Inference doesn't create a version. Instead, it returns the latest version. A change to the name of the question set counts as a change to DRAFT.
A question set can have a limited number of versions. If the question set already has the maximum number of versions, Elemental Inference returns ServiceQuotaExceededException. To free space for a new version, delete a version that you no longer need, or create a new question set.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1268 def create_question_set_version(params = {}, = {}) req = build_request(:create_question_set_version, params) req.send_request() end |
#create_schedule_action(params = {}) ⇒ Types::CreateScheduleActionResponse
Creates 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 request.
Elemental Inference validates the targets of the action when you create it.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1352 def create_schedule_action(params = {}, = {}) req = build_request(:create_schedule_action, params) req.send_request() end |
#delete_dictionary(params = {}) ⇒ Types::DeleteDictionaryResponse
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.
1386 1387 1388 1389 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1386 def delete_dictionary(params = {}, = {}) req = build_request(:delete_dictionary, params) req.send_request() end |
#delete_feed(params = {}) ⇒ Types::DeleteFeedResponse
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.
1422 1423 1424 1425 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1422 def delete_feed(params = {}, = {}) req = build_request(:delete_feed, params) req.send_request() end |
#delete_feed_policy(params = {}) ⇒ Struct
Deletes the resource-based policy attached to the specified feed. After you delete the policy, the operation revokes the cross-account access that the policy granted.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1446 def delete_feed_policy(params = {}, = {}) req = build_request(:delete_feed_policy, params) req.send_request() end |
#delete_function(params = {}) ⇒ Types::DeleteFunctionResponse
Deletes a function. If any feed still references the function, the operation returns a ConflictException. A disabled function output still references the function. Use GetFunction to find those feeds, then remove the function output from each one with UpdateFeed, or delete the feed, before retrying.
Deleting a function doesn't delete the metadata that it has already produced.
1485 1486 1487 1488 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1485 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_question_set(params = {}) ⇒ Types::DeleteQuestionSetResponse
Deletes the specified question set, including its DRAFT version and all its published versions. You can't delete a question set while any feed references any of its versions, including an archived feed. You must first remove the question set from the customQuestions configuration of each feed output that references it, or delete those feeds.
1520 1521 1522 1523 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1520 def delete_question_set(params = {}, = {}) req = build_request(:delete_question_set, params) req.send_request() end |
#delete_question_set_version(params = {}) ⇒ Struct
Deletes a published version of the specified question set. You can't delete a version while a feed references it, including an archived feed. You can't restore a deleted version, and Elemental Inference doesn't reuse its number.
You can't delete the DRAFT version on its own. To delete DRAFT, delete the question set by using DeleteQuestionSet.
Deleting a version doesn't change the latestVersion of the question set, even if you delete the highest version.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1556 def delete_question_set_version(params = {}, = {}) req = build_request(:delete_question_set_version, params) req.send_request() end |
#delete_schedule_action(params = {}) ⇒ Types::DeleteScheduleActionResponse
Deletes 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 changes that the action already made to the feed. When you delete or archive a feed, Elemental Inference deletes all the schedule actions on that feed.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1593 def delete_schedule_action(params = {}, = {}) req = build_request(:delete_schedule_action, params) req.send_request() end |
#disassociate_feed(params = {}) ⇒ Types::DisassociateFeedResponse
Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.
1640 1641 1642 1643 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1640 def disassociate_feed(params = {}, = {}) req = build_request(:disassociate_feed, params) req.send_request() end |
#export_dictionary_entries(params = {}) ⇒ Types::ExportDictionaryEntriesResponse
Exports the entries from the specified dictionary.
1668 1669 1670 1671 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1668 def export_dictionary_entries(params = {}, = {}) req = build_request(:export_dictionary_entries, params) req.send_request() end |
#get_dictionary(params = {}) ⇒ Types::GetDictionaryResponse
Retrieves information about the specified dictionary.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1710 def get_dictionary(params = {}, = {}) req = build_request(:get_dictionary, params) req.send_request() end |
#get_feed(params = {}) ⇒ Types::GetFeedResponse
Retrieves information about the specified feed.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- feed_deleted
1791 1792 1793 1794 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1791 def get_feed(params = {}, = {}) req = build_request(:get_feed, params) req.send_request() end |
#get_feed_policy(params = {}) ⇒ Types::GetFeedPolicyResponse
Retrieves the resource-based policy attached to the specified feed.
1819 1820 1821 1822 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1819 def get_feed_policy(params = {}, = {}) req = build_request(:get_feed_policy, params) req.send_request() end |
#get_fixture(params = {}) ⇒ Types::GetFixtureResponse
Retrieves information about the specified fixture (a sports event, such as a specific basketball game). You obtain a fixtureId from SearchFixtures, or from the clipping output of a feed.
1861 1862 1863 1864 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1861 def get_fixture(params = {}, = {}) req = build_request(:get_fixture, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResponse
Retrieves the details of a function, including its expressions, the media context that Elemental Inference derived from the request expression, and the feeds that currently reference it.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1917 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_question_set(params = {}) ⇒ Types::GetQuestionSetResponse
Retrieves information about the specified question set at one version. By default, GetQuestionSet returns the DRAFT version. To retrieve a published version, specify questionSetVersion.
1989 1990 1991 1992 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 1989 def get_question_set(params = {}, = {}) req = build_request(:get_question_set, params) req.send_request() end |
#list_dictionaries(params = {}) ⇒ Types::ListDictionariesResponse
Lists the dictionaries in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2031 2032 2033 2034 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2031 def list_dictionaries(params = {}, = {}) req = build_request(:list_dictionaries, params) req.send_request() end |
#list_feeds(params = {}) ⇒ Types::ListFeedsResponse
Displays a list of feeds that belong to this AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2088 2089 2090 2091 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2088 def list_feeds(params = {}, = {}) req = build_request(:list_feeds, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::ListFunctionsResponse
Lists the functions in this account, in this Region. Each entry is a summary. To get the expressions of a function, use GetFunction.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2136 2137 2138 2139 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2136 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_question_set_versions(params = {}) ⇒ Types::ListQuestionSetVersionsResponse
Lists the versions of the specified question set. The list starts with the DRAFT version, followed by the published versions from the highest version number to the lowest. The list doesn't include deleted versions.
The response doesn't include the questions in each version. To retrieve them, use GetQuestionSet and specify questionSetVersion.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2187 2188 2189 2190 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2187 def list_question_set_versions(params = {}, = {}) req = build_request(:list_question_set_versions, params) req.send_request() end |
#list_question_sets(params = {}) ⇒ Types::ListQuestionSetsResponse
Lists the question sets in your account. The response doesn't include the questions in each question set. To retrieve them, use GetQuestionSet.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2230 2231 2232 2233 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2230 def list_question_sets(params = {}, = {}) req = build_request(:list_question_sets, params) req.send_request() end |
#list_schedule_actions(params = {}) ⇒ Types::ListScheduleActionsResponse
Displays 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 Inference keeps an action whose status is COMPLETED or FAILED for about 48 hours after its scheduled time, and then deletes it automatically.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2291 2292 2293 2294 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2291 def list_schedule_actions(params = {}, = {}) req = build_request(:list_schedule_actions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags that are on an Elemental Inference resource in the current region.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2321 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_feed_policy(params = {}) ⇒ Struct
Attaches or replaces a resource-based policy on the specified feed. A resource-based policy grants cross-account access to the feed.
2348 2349 2350 2351 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2348 def put_feed_policy(params = {}, = {}) req = build_request(:put_feed_policy, params) req.send_request() end |
#search_fixtures(params = {}) ⇒ Types::SearchFixturesResponse
Searches 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 includes a fixtureId that you specify in the clipping output of a feed, so that Elemental Inference maps the event data for that fixture onto the clipping metadata. This operation is paginated: if there are more fixtures than fit in one page, the response includes a nextToken that you pass in a subsequent request.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2447 2448 2449 2450 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2447 def search_fixtures(params = {}, = {}) req = build_request(:search_fixtures, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
2479 2480 2481 2482 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2479 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from the specified resource in the current region.
2506 2507 2508 2509 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2506 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_dictionary(params = {}) ⇒ Types::UpdateDictionaryResponse
Updates the specified dictionary.
2562 2563 2564 2565 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2562 def update_dictionary(params = {}, = {}) req = build_request(:update_dictionary, params) req.send_request() end |
#update_feed(params = {}) ⇒ Types::UpdateFeedResponse
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.
2744 2745 2746 2747 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2744 def update_feed(params = {}, = {}) req = build_request(:update_feed, params) req.send_request() end |
#update_function(params = {}) ⇒ Types::UpdateFunctionResponse
Updates a function. Include only the parameters that you want to change; parameters that you don't include aren't affected. Elemental Inference validates the updated expressions in the same way as CreateFunction.
While a feed references the function, you can change only its expressions and its description, and you can set eventBridgeDelivery to DISABLED but not to ENABLED. The request expression must keep referencing the same media context, as reported in contextTypes. Changing an expression changes the behavior of every feed that references the function.
2851 2852 2853 2854 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2851 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_question_set(params = {}) ⇒ Types::UpdateQuestionSetResponse
Updates the DRAFT version of the specified question set. UpdateQuestionSet doesn't create a version and doesn't change published versions. To publish the updated DRAFT as a new version, use CreateQuestionSetVersion.
UpdateQuestionSet replaces questions one type at a time. For each of yesNo, yesNoPerOption, and chooseOne: if you omit the array, DRAFT keeps its questions of that type. If you include the array, it replaces all the questions of that type in DRAFT. If you include an empty array, DRAFT no longer has questions of that type. The updated DRAFT must follow the same rules as in CreateQuestionSet, and Elemental Inference applies those rules to the questions that DRAFT keeps as well as to the questions in the request.
Feeds that reference the DRAFT version use the updated questions. To make sure that the questions for a feed don't change, reference a published version instead.
2986 2987 2988 2989 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 2986 def update_question_set(params = {}, = {}) req = build_request(:update_question_set, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.
| waiter_name | params | :delay | :max_attempts |
|---|---|---|---|
| feed_deleted | #get_feed | 3 | 40 |
3101 3102 3103 3104 3105 |
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/client.rb', line 3101 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |