1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. mediapackagev2
  5. getChannel

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi

aws-native.mediapackagev2.getChannel

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi

    Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.

    Using getChannel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getChannel(args: GetChannelArgs, opts?: InvokeOptions): Promise<GetChannelResult>
    function getChannelOutput(args: GetChannelOutputArgs, opts?: InvokeOptions): Output<GetChannelResult>
    def get_channel(arn: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetChannelResult
    def get_channel_output(arn: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetChannelResult]
    func LookupChannel(ctx *Context, args *LookupChannelArgs, opts ...InvokeOption) (*LookupChannelResult, error)
    func LookupChannelOutput(ctx *Context, args *LookupChannelOutputArgs, opts ...InvokeOption) LookupChannelResultOutput

    > Note: This function is named LookupChannel in the Go SDK.

    public static class GetChannel 
    {
        public static Task<GetChannelResult> InvokeAsync(GetChannelArgs args, InvokeOptions? opts = null)
        public static Output<GetChannelResult> Invoke(GetChannelInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
    public static Output<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:mediapackagev2:getChannel
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string
    Arn string
    arn String
    arn string
    arn str
    arn String

    getChannel Result

    The following output properties are available:

    Arn string
    CreatedAt string
    Description string
    IngestEndpointUrls List<string>
    The ingest domain URL where the source stream should be sent.
    IngestEndpoints List<Pulumi.AwsNative.MediaPackageV2.Outputs.ChannelIngestEndpoint>
    InputSwitchConfiguration Pulumi.AwsNative.MediaPackageV2.Outputs.ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    ModifiedAt string
    OutputHeaderConfiguration Pulumi.AwsNative.MediaPackageV2.Outputs.ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Arn string
    CreatedAt string
    Description string
    IngestEndpointUrls []string
    The ingest domain URL where the source stream should be sent.
    IngestEndpoints []ChannelIngestEndpoint
    InputSwitchConfiguration ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    ModifiedAt string
    OutputHeaderConfiguration ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    Tags Tag
    arn String
    createdAt String
    description String
    ingestEndpointUrls List<String>
    The ingest domain URL where the source stream should be sent.
    ingestEndpoints List<ChannelIngestEndpoint>
    inputSwitchConfiguration ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    modifiedAt String
    outputHeaderConfiguration ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags List<Tag>
    arn string
    createdAt string
    description string
    ingestEndpointUrls string[]
    The ingest domain URL where the source stream should be sent.
    ingestEndpoints ChannelIngestEndpoint[]
    inputSwitchConfiguration ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    modifiedAt string
    outputHeaderConfiguration ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags Tag[]
    arn str
    created_at str
    description str
    ingest_endpoint_urls Sequence[str]
    The ingest domain URL where the source stream should be sent.
    ingest_endpoints Sequence[ChannelIngestEndpoint]
    input_switch_configuration ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    modified_at str
    output_header_configuration ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags Sequence[root_Tag]
    arn String
    createdAt String
    description String
    ingestEndpointUrls List<String>
    The ingest domain URL where the source stream should be sent.
    ingestEndpoints List<Property Map>
    inputSwitchConfiguration Property Map
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    modifiedAt String
    outputHeaderConfiguration Property Map
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags List<Property Map>

    Supporting Types

    ChannelIngestEndpoint

    Id string
    Url string
    Id string
    Url string
    id String
    url String
    id string
    url string
    id str
    url str
    id String
    url String

    ChannelInputSwitchConfiguration

    MqcsInputSwitching bool
    PreferredInput int
    For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.
    MqcsInputSwitching bool
    PreferredInput int
    For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.
    mqcsInputSwitching Boolean
    preferredInput Integer
    For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.
    mqcsInputSwitching boolean
    preferredInput number
    For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.
    mqcs_input_switching bool
    preferred_input int
    For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.
    mqcsInputSwitching Boolean
    preferredInput Number
    For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select 1 to prefer the first ingest endpoint, or 2 to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal.

    ChannelOutputHeaderConfiguration

    publishMqcs Boolean
    publishMqcs boolean
    publishMqcs Boolean

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi