Skip to content

Function

Source code in docs_src/capo_mediatailor/types/function.py
class Function(TypedDict, closed=True):
    function_id: "capo_mediatailor.types.__string.__string"
    """<p>The identifier of the function.</p>"""
    function_type: "capo_mediatailor.types.function_type.FunctionType"
    """<p>The type of the function.</p>"""
    description: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>A description of the function.</p>"""
    http_request_configuration: NotRequired[
        "capo_mediatailor.types.http_request_configuration.HttpRequestConfiguration"
    ]
    """<p>The configuration for an <code>HTTP_REQUEST</code> function.</p>"""
    aws_service_request_configuration: NotRequired[
        "capo_mediatailor.types.aws_service_request_configuration.AwsServiceRequestConfiguration"
    ]
    """<p>The configuration for an <code>AWS_SERVICE_REQUEST</code> function. Specifies the target service, target Region, and request parameters.</p>"""
    custom_output_configuration: NotRequired[
        "capo_mediatailor.types.custom_output_configuration.CustomOutputConfiguration"
    ]
    """<p>The configuration for a <code>CUSTOM_OUTPUT</code> function.</p>"""
    concurrent_executor_configuration: NotRequired[
        "capo_mediatailor.types.concurrent_executor_configuration.ConcurrentExecutorConfiguration"
    ]
    """<p>The configuration for a <code>CONCURRENT_EXECUTOR</code> function.</p>"""
    sequential_executor_configuration: NotRequired[
        "capo_mediatailor.types.sequential_executor_configuration.SequentialExecutorConfiguration"
    ]
    """<p>The configuration for a <code>SEQUENTIAL_EXECUTOR</code> function.</p>"""
    vast_request_configuration: NotRequired[
        "capo_mediatailor.types.vast_request_configuration.VastRequestConfiguration"
    ]
    """<p>The configuration for a <code>VAST_REQUEST</code> function.</p>"""
    tags: NotRequired["capo_mediatailor.types.__map_of__string.__mapOf__string"]
    """<p>The tags assigned to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>"""
    arn: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the function.</p>"""

arn instance-attribute

arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the function.

aws_service_request_configuration instance-attribute

aws_service_request_configuration: NotRequired[AwsServiceRequestConfiguration]

The configuration for an AWS_SERVICE_REQUEST function. Specifies the target service, target Region, and request parameters.

concurrent_executor_configuration instance-attribute

concurrent_executor_configuration: NotRequired[ConcurrentExecutorConfiguration]

The configuration for a CONCURRENT_EXECUTOR function.

custom_output_configuration instance-attribute

custom_output_configuration: NotRequired[CustomOutputConfiguration]

The configuration for a CUSTOM_OUTPUT function.

description instance-attribute

description: NotRequired[__string]

A description of the function.

function_id instance-attribute

function_id: __string

The identifier of the function.

function_type instance-attribute

function_type: FunctionType

The type of the function.

http_request_configuration instance-attribute

http_request_configuration: NotRequired[HttpRequestConfiguration]

The configuration for an HTTP_REQUEST function.

sequential_executor_configuration instance-attribute

sequential_executor_configuration: NotRequired[SequentialExecutorConfiguration]

The configuration for a SEQUENTIAL_EXECUTOR function.

tags instance-attribute

tags: NotRequired[__mapOf__string]

The tags assigned to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

vast_request_configuration instance-attribute

vast_request_configuration: NotRequired[VastRequestConfiguration]

The configuration for a VAST_REQUEST function.