Skip to content

UpdateFlowEntitlementRequest

Source code in docs_src/capo_mediaconnect/types/update_flow_entitlement_request.py
class UpdateFlowEntitlementRequest(TypedDict, closed=True):
    description: NotRequired["str"]
    """<p> A description of the entitlement. This description appears only on the MediaConnect console and will not be seen by the subscriber or end user.</p>"""
    encryption: NotRequired[
        "capo_mediaconnect.types.update_encryption.UpdateEncryption"
    ]
    """<p> The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.</p>"""
    entitlement_arn: "str"
    """<p> The Amazon Resource Name (ARN) of the entitlement that you want to update.</p>"""
    entitlement_status: NotRequired[
        "capo_mediaconnect.types.entitlement_status.EntitlementStatus"
    ]
    """<p> An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the <code>entitlementStatus</code> field in your request, MediaConnect leaves the value unchanged.</p>"""
    flow_arn: "capo_mediaconnect.types.flow_arn.FlowArn"
    """<p> The ARN of the flow that is associated with the entitlement that you want to update.</p>"""
    subscribers: NotRequired["capo_mediaconnect.types.__list_of_string.__listOfString"]
    """<p> The Amazon Web Services account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.</p>"""

description instance-attribute

description: NotRequired[str]

A description of the entitlement. This description appears only on the MediaConnect console and will not be seen by the subscriber or end user.

encryption instance-attribute

encryption: NotRequired[UpdateEncryption]

The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.

entitlement_arn instance-attribute

entitlement_arn: str

The Amazon Resource Name (ARN) of the entitlement that you want to update.

entitlement_status instance-attribute

entitlement_status: NotRequired[EntitlementStatus]

An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.

flow_arn instance-attribute

flow_arn: FlowArn

The ARN of the flow that is associated with the entitlement that you want to update.

subscribers instance-attribute

subscribers: NotRequired[__listOfString]

The Amazon Web Services account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.