Skip to content

AssociateFeedRequest

Source code in docs_src/capo_elementalinference/types/associate_feed_request.py 
15
16
17
18
19
20
21
22
23
24
25
class AssociateFeedRequest(TypedDict, closed=True):
    id: "capo_elementalinference.types.feed_id.FeedId"
    """<p>The ID of the feed.</p>"""
    associated_resource_name: (
        "capo_elementalinference.types.associated_resource_name.AssociatedResourceName"
    )
    """<p>An identifier for the resource. This name must not resemble an ARN.</p> <p>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). </p>"""
    outputs: "capo_elementalinference.types.create_output_list.CreateOutputList"
    """<p>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. </p>"""
    dry_run: "bool"
    """<p>Set to true if you want to do a dry run of the associate action.</p> <p>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. </p>"""

associated_resource_name instance-attribute 

associated_resource_name: AssociatedResourceName

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

dry_run instance-attribute 

dry_run: bool

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 instance-attribute 

id: FeedId

The ID of the feed.

outputs instance-attribute 

outputs: CreateOutputList

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.