You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MediaConnect

Inherits:
AWS.Service show all
Identifier:
mediaconnect
API Version:
2018-11-14
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

API for AWS Elemental MediaConnect

Sending a Request Using MediaConnect

var mediaconnect = new AWS.MediaConnect();
mediaconnect.addFlowMediaStreams(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MediaConnect object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mediaconnect = new AWS.MediaConnect({apiVersion: '2018-11-14'});

You can also set the API version globally in AWS.config.apiVersions using the mediaconnect service identifier:

AWS.config.apiVersions = {
  mediaconnect: '2018-11-14',
  // other service API versions
};

var mediaconnect = new AWS.MediaConnect();

Version:

  • 2018-11-14

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

flowActive, flowStandby, flowDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.MediaConnect(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MediaConnect object

var mediaconnect = new AWS.MediaConnect({apiVersion: '2018-11-14'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.MediaConnect.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.MediaConnect.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.MediaConnect.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addFlowMediaStreams(params = {}, callback) ⇒ AWS.Request

Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.

Service Reference:

Examples:

Calling the addFlowMediaStreams operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  MediaStreams: [ /* required */
    {
      MediaStreamId: 'NUMBER_VALUE', /* required */
      MediaStreamName: 'STRING_VALUE', /* required */
      MediaStreamType: video | audio | ancillary-data, /* required */
      Attributes: {
        Fmtp: {
          ChannelOrder: 'STRING_VALUE',
          Colorimetry: BT601 | BT709 | BT2020 | BT2100 | ST2065-1 | ST2065-3 | XYZ,
          ExactFramerate: 'STRING_VALUE',
          Par: 'STRING_VALUE',
          Range: NARROW | FULL | FULLPROTECT,
          ScanMode: progressive | interlace | progressive-segmented-frame,
          Tcs: SDR | PQ | HLG | LINEAR | BT2100LINPQ | BT2100LINHLG | ST2065-1 | ST428-1 | DENSITY
        },
        Lang: 'STRING_VALUE'
      },
      ClockRate: 'NUMBER_VALUE',
      Description: 'STRING_VALUE',
      VideoFormat: 'STRING_VALUE'
    },
    /* more items */
  ]
};
mediaconnect.addFlowMediaStreams(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The Amazon Resource Name (ARN) of the flow.
    • MediaStreams — (Array<map>) The media streams that you want to add to the flow.
      • Attributes — (map) The attributes that you want to assign to the new media stream.
        • Fmtp — (map) The settings that you want to use to define the media stream.
          • ChannelOrder — (String) The format of the audio channel.
          • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
            • "BT601"
            • "BT709"
            • "BT2020"
            • "BT2100"
            • "ST2065-1"
            • "ST2065-3"
            • "XYZ"
          • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
          • Par — (String) The pixel aspect ratio (PAR) of the video.
          • Range — (String) The encoding range of the video. Possible values include:
            • "NARROW"
            • "FULL"
            • "FULLPROTECT"
          • ScanMode — (String) The type of compression that was used to smooth the video’s appearance. Possible values include:
            • "progressive"
            • "interlace"
            • "progressive-segmented-frame"
          • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
            • "SDR"
            • "PQ"
            • "HLG"
            • "LINEAR"
            • "BT2100LINPQ"
            • "BT2100LINHLG"
            • "ST2065-1"
            • "ST428-1"
            • "DENSITY"
        • Lang — (String) The audio language, in a format that is recognized by the receiver.
      • ClockRate — (Integer) The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
      • Description — (String) A description that can help you quickly identify what your media stream is used for.
      • MediaStreamId — required — (Integer) A unique identifier for the media stream.
      • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
      • MediaStreamType — required — (String) The type of media stream. Possible values include:
        • "video"
        • "audio"
        • "ancillary-data"
      • VideoFormat — (String) The resolution of the video.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that you added media streams to.
      • MediaStreams — (Array<map>) The media streams that you added to the flow.
        • Attributes — (map) Attributes that are related to the media stream.
          • Fmtp — required — (map) A set of parameters that define the media stream.
            • ChannelOrder — (String) The format of the audio channel.
            • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
              • "BT601"
              • "BT709"
              • "BT2020"
              • "BT2100"
              • "ST2065-1"
              • "ST2065-3"
              • "XYZ"
            • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
            • Par — (String) The pixel aspect ratio (PAR) of the video.
            • Range — (String) The encoding range of the video. Possible values include:
              • "NARROW"
              • "FULL"
              • "FULLPROTECT"
            • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
              • "progressive"
              • "interlace"
              • "progressive-segmented-frame"
            • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
              • "SDR"
              • "PQ"
              • "HLG"
              • "LINEAR"
              • "BT2100LINPQ"
              • "BT2100LINHLG"
              • "ST2065-1"
              • "ST428-1"
              • "DENSITY"
          • Lang — (String) The audio language, in a format that is recognized by the receiver.
        • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
        • Description — (String) A description that can help you quickly identify what your media stream is used for.
        • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
        • MediaStreamId — required — (Integer) A unique identifier for the media stream.
        • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
        • MediaStreamType — required — (String) The type of media stream. Possible values include:
          • "video"
          • "audio"
          • "ancillary-data"
        • VideoFormat — (String) The resolution of the video.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addFlowOutputs(params = {}, callback) ⇒ AWS.Request

Adds outputs to an existing flow. You can create up to 50 outputs per flow.

Service Reference:

Examples:

Calling the addFlowOutputs operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  Outputs: [ /* required */
    {
      Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener, /* required */
      CidrAllowList: [
        'STRING_VALUE',
        /* more items */
      ],
      Description: 'STRING_VALUE',
      Destination: 'STRING_VALUE',
      Encryption: {
        RoleArn: 'STRING_VALUE', /* required */
        Algorithm: aes128 | aes192 | aes256,
        ConstantInitializationVector: 'STRING_VALUE',
        DeviceId: 'STRING_VALUE',
        KeyType: speke | static-key | srt-password,
        Region: 'STRING_VALUE',
        ResourceId: 'STRING_VALUE',
        SecretArn: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      MaxLatency: 'NUMBER_VALUE',
      MediaStreamOutputConfigurations: [
        {
          EncodingName: jxsv | raw | smpte291 | pcm, /* required */
          MediaStreamName: 'STRING_VALUE', /* required */
          DestinationConfigurations: [
            {
              DestinationIp: 'STRING_VALUE', /* required */
              DestinationPort: 'NUMBER_VALUE', /* required */
              Interface: { /* required */
                Name: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ],
          EncodingParameters: {
            CompressionFactor: 'NUMBER_VALUE', /* required */
            EncoderProfile: main | high /* required */
          }
        },
        /* more items */
      ],
      MinLatency: 'NUMBER_VALUE',
      Name: 'STRING_VALUE',
      Port: 'NUMBER_VALUE',
      RemoteId: 'STRING_VALUE',
      SmoothingLatency: 'NUMBER_VALUE',
      StreamId: 'STRING_VALUE',
      VpcInterfaceAttachment: {
        VpcInterfaceName: 'STRING_VALUE'
      }
    },
    /* more items */
  ]
};
mediaconnect.addFlowOutputs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The flow that you want to add outputs to.
    • Outputs — (Array<map>) A list of outputs that you want to add.
      • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
      • Description — (String) A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
      • Destination — (String) The IP address from which video will be sent to output destinations.
      • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
        • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
          • "speke"
          • "static-key"
          • "srt-password"
        • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
        • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
      • MediaStreamOutputConfigurations — (Array<map>) The media streams that are associated with the output, and the parameters for those associations.
        • DestinationConfigurations — (Array<map>) The transport parameters that you want to associate with the media stream.
          • DestinationIp — required — (String) The IP address where you want MediaConnect to send contents of the media stream.
          • DestinationPort — required — (Integer) The port that you want MediaConnect to use when it distributes the media stream to the output.
          • Interface — required — (map) The VPC interface that you want to use for the media stream associated with the output.
            • Name — required — (String) The name of the VPC interface.
        • EncodingName — required — (String) The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
          • "jxsv"
          • "raw"
          • "smpte291"
          • "pcm"
        • EncodingParameters — (map) A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
          • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
          • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol. Possible values include:
            • "main"
            • "high"
        • MediaStreamName — required — (String) The name of the media stream that is associated with the output.
      • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
      • Name — (String) The name of the output. This value must be unique within the current flow.
      • Port — (Integer) The port to use when content is distributed to this output.
      • Protocol — required — (String) The protocol to use for the output. Possible values include:
        • "zixi-push"
        • "rtp-fec"
        • "rtp"
        • "zixi-pull"
        • "rist"
        • "st2110-jpegxs"
        • "cdi"
        • "srt-listener"
      • RemoteId — (String) The remote ID for the Zixi-pull output stream.
      • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
      • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
        • VpcInterfaceName — (String) The name of the VPC interface to use for this output.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that these outputs were added to.
      • Outputs — (Array<map>) The details of the newly added outputs.
        • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description — (String) A description of the output.
        • Destination — (String) The address where you want to send the output.
        • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
          • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
            • "speke"
            • "static-key"
            • "srt-password"
          • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
          • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
        • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
        • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
        • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
          • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
            • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
            • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
            • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
              • Name — required — (String) The name of the VPC interface.
            • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
          • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
            • "jxsv"
            • "raw"
            • "smpte291"
            • "pcm"
          • EncodingParameters — (map) Encoding parameters
            • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
            • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
              • "main"
              • "high"
          • MediaStreamName — required — (String) The name of the media stream.
        • Name — required — (String) The name of the output. This value must be unique within the current flow.
        • OutputArn — required — (String) The ARN of the output.
        • Port — (Integer) The port to use when content is distributed to this output.
        • Transport — (map) Attributes related to the transport stream that are used in the output.
          • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
          • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
            • "zixi-pull"
            • "rist"
            • "st2110-jpegxs"
            • "cdi"
            • "srt-listener"
          • RemoteId — (String) The remote ID for the Zixi-pull stream.
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
          • VpcInterfaceName — (String) The name of the VPC interface to use for this output.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addFlowSources(params = {}, callback) ⇒ AWS.Request

Adds Sources to flow

Service Reference:

Examples:

Calling the addFlowSources operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  Sources: [ /* required */
    {
      Decryption: {
        RoleArn: 'STRING_VALUE', /* required */
        Algorithm: aes128 | aes192 | aes256,
        ConstantInitializationVector: 'STRING_VALUE',
        DeviceId: 'STRING_VALUE',
        KeyType: speke | static-key | srt-password,
        Region: 'STRING_VALUE',
        ResourceId: 'STRING_VALUE',
        SecretArn: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      Description: 'STRING_VALUE',
      EntitlementArn: 'STRING_VALUE',
      IngestPort: 'NUMBER_VALUE',
      MaxBitrate: 'NUMBER_VALUE',
      MaxLatency: 'NUMBER_VALUE',
      MaxSyncBuffer: 'NUMBER_VALUE',
      MediaStreamSourceConfigurations: [
        {
          EncodingName: jxsv | raw | smpte291 | pcm, /* required */
          MediaStreamName: 'STRING_VALUE', /* required */
          InputConfigurations: [
            {
              InputPort: 'NUMBER_VALUE', /* required */
              Interface: { /* required */
                Name: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      MinLatency: 'NUMBER_VALUE',
      Name: 'STRING_VALUE',
      Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener,
      StreamId: 'STRING_VALUE',
      VpcInterfaceName: 'STRING_VALUE',
      WhitelistCidr: 'STRING_VALUE'
    },
    /* more items */
  ]
};
mediaconnect.addFlowSources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The flow that you want to mutate.
    • Sources — (Array<map>) A list of sources that you want to add.
      • Decryption — (map) The type of encryption that is used on the content ingested from this source.
        • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
        • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
          • "speke"
          • "static-key"
          • "srt-password"
        • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
        • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
      • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
      • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
      • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
      • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
      • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
      • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
        • EncodingName — required — (String) The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
          • "jxsv"
          • "raw"
          • "smpte291"
          • "pcm"
        • InputConfigurations — (Array<map>) The transport parameters that you want to associate with the media stream.
          • InputPort — required — (Integer) The port that you want the flow to listen on for an incoming media stream.
          • Interface — required — (map) The VPC interface that you want to use for the incoming media stream.
            • Name — required — (String) The name of the VPC interface.
        • MediaStreamName — required — (String) The name of the media stream.
      • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
      • Name — (String) The name of the source.
      • Protocol — (String) The protocol that is used by the source. Possible values include:
        • "zixi-push"
        • "rtp-fec"
        • "rtp"
        • "zixi-pull"
        • "rist"
        • "st2110-jpegxs"
        • "cdi"
        • "srt-listener"
      • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceName — (String) The name of the VPC interface to use for this source.
      • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that these sources were added to.
      • Sources — (Array<map>) The details of the newly added sources.
        • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Decryption — (map) The type of encryption that is used on the content ingested from this source.
          • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
          • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
            • "speke"
            • "static-key"
            • "srt-password"
          • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
          • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
        • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
        • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
        • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
          • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
            • "jxsv"
            • "raw"
            • "smpte291"
            • "pcm"
          • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
            • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
            • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
            • Interface — required — (map) The VPC interface where the media stream comes in from.
              • Name — required — (String) The name of the VPC interface.
          • MediaStreamName — required — (String) The name of the media stream.
        • Name — required — (String) The name of the source.
        • SourceArn — required — (String) The ARN of the source.
        • Transport — (map) Attributes related to the transport stream that are used in the source.
          • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
          • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
            • "zixi-pull"
            • "rist"
            • "st2110-jpegxs"
            • "cdi"
            • "srt-listener"
          • RemoteId — (String) The remote ID for the Zixi-pull stream.
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
        • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addFlowVpcInterfaces(params = {}, callback) ⇒ AWS.Request

Adds VPC interfaces to flow

Service Reference:

Examples:

Calling the addFlowVpcInterfaces operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  VpcInterfaces: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      SecurityGroupIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      SubnetId: 'STRING_VALUE', /* required */
      NetworkInterfaceType: ena | efa
    },
    /* more items */
  ]
};
mediaconnect.addFlowVpcInterfaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The flow that you want to mutate.
    • VpcInterfaces — (Array<map>) A list of VPC interfaces that you want to add.
      • Name — required — (String) The name of the VPC Interface. This value must be unique within the current flow.
      • NetworkInterfaceType — (String) The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType. Possible values include:
        • "ena"
        • "efa"
      • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
      • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
      • SubnetId — required — (String) Subnet must be in the AZ of the Flow

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that these VPC interfaces were added to.
      • VpcInterfaces — (Array<map>) The details of the newly added VPC interfaces.
        • Name — required — (String) Immutable and has to be a unique against other VpcInterfaces in this Flow
        • NetworkInterfaceIds — required — (Array<String>) IDs of the network interfaces created in customer's account by MediaConnect.
        • NetworkInterfaceType — required — (String) The type of network interface. Possible values include:
          • "ena"
          • "efa"
        • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
        • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
        • SubnetId — required — (String) Subnet must be in the AZ of the Flow

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createFlow(params = {}, callback) ⇒ AWS.Request

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).

Service Reference:

Examples:

Calling the createFlow operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AvailabilityZone: 'STRING_VALUE',
  Entitlements: [
    {
      Subscribers: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      DataTransferSubscriberFeePercent: 'NUMBER_VALUE',
      Description: 'STRING_VALUE',
      Encryption: {
        RoleArn: 'STRING_VALUE', /* required */
        Algorithm: aes128 | aes192 | aes256,
        ConstantInitializationVector: 'STRING_VALUE',
        DeviceId: 'STRING_VALUE',
        KeyType: speke | static-key | srt-password,
        Region: 'STRING_VALUE',
        ResourceId: 'STRING_VALUE',
        SecretArn: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      EntitlementStatus: ENABLED | DISABLED,
      Name: 'STRING_VALUE'
    },
    /* more items */
  ],
  MediaStreams: [
    {
      MediaStreamId: 'NUMBER_VALUE', /* required */
      MediaStreamName: 'STRING_VALUE', /* required */
      MediaStreamType: video | audio | ancillary-data, /* required */
      Attributes: {
        Fmtp: {
          ChannelOrder: 'STRING_VALUE',
          Colorimetry: BT601 | BT709 | BT2020 | BT2100 | ST2065-1 | ST2065-3 | XYZ,
          ExactFramerate: 'STRING_VALUE',
          Par: 'STRING_VALUE',
          Range: NARROW | FULL | FULLPROTECT,
          ScanMode: progressive | interlace | progressive-segmented-frame,
          Tcs: SDR | PQ | HLG | LINEAR | BT2100LINPQ | BT2100LINHLG | ST2065-1 | ST428-1 | DENSITY
        },
        Lang: 'STRING_VALUE'
      },
      ClockRate: 'NUMBER_VALUE',
      Description: 'STRING_VALUE',
      VideoFormat: 'STRING_VALUE'
    },
    /* more items */
  ],
  Outputs: [
    {
      Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener, /* required */
      CidrAllowList: [
        'STRING_VALUE',
        /* more items */
      ],
      Description: 'STRING_VALUE',
      Destination: 'STRING_VALUE',
      Encryption: {
        RoleArn: 'STRING_VALUE', /* required */
        Algorithm: aes128 | aes192 | aes256,
        ConstantInitializationVector: 'STRING_VALUE',
        DeviceId: 'STRING_VALUE',
        KeyType: speke | static-key | srt-password,
        Region: 'STRING_VALUE',
        ResourceId: 'STRING_VALUE',
        SecretArn: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      MaxLatency: 'NUMBER_VALUE',
      MediaStreamOutputConfigurations: [
        {
          EncodingName: jxsv | raw | smpte291 | pcm, /* required */
          MediaStreamName: 'STRING_VALUE', /* required */
          DestinationConfigurations: [
            {
              DestinationIp: 'STRING_VALUE', /* required */
              DestinationPort: 'NUMBER_VALUE', /* required */
              Interface: { /* required */
                Name: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ],
          EncodingParameters: {
            CompressionFactor: 'NUMBER_VALUE', /* required */
            EncoderProfile: main | high /* required */
          }
        },
        /* more items */
      ],
      MinLatency: 'NUMBER_VALUE',
      Name: 'STRING_VALUE',
      Port: 'NUMBER_VALUE',
      RemoteId: 'STRING_VALUE',
      SmoothingLatency: 'NUMBER_VALUE',
      StreamId: 'STRING_VALUE',
      VpcInterfaceAttachment: {
        VpcInterfaceName: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  Source: {
    Decryption: {
      RoleArn: 'STRING_VALUE', /* required */
      Algorithm: aes128 | aes192 | aes256,
      ConstantInitializationVector: 'STRING_VALUE',
      DeviceId: 'STRING_VALUE',
      KeyType: speke | static-key | srt-password,
      Region: 'STRING_VALUE',
      ResourceId: 'STRING_VALUE',
      SecretArn: 'STRING_VALUE',
      Url: 'STRING_VALUE'
    },
    Description: 'STRING_VALUE',
    EntitlementArn: 'STRING_VALUE',
    IngestPort: 'NUMBER_VALUE',
    MaxBitrate: 'NUMBER_VALUE',
    MaxLatency: 'NUMBER_VALUE',
    MaxSyncBuffer: 'NUMBER_VALUE',
    MediaStreamSourceConfigurations: [
      {
        EncodingName: jxsv | raw | smpte291 | pcm, /* required */
        MediaStreamName: 'STRING_VALUE', /* required */
        InputConfigurations: [
          {
            InputPort: 'NUMBER_VALUE', /* required */
            Interface: { /* required */
              Name: 'STRING_VALUE' /* required */
            }
          },
          /* more items */
        ]
      },
      /* more items */
    ],
    MinLatency: 'NUMBER_VALUE',
    Name: 'STRING_VALUE',
    Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener,
    StreamId: 'STRING_VALUE',
    VpcInterfaceName: 'STRING_VALUE',
    WhitelistCidr: 'STRING_VALUE'
  },
  SourceFailoverConfig: {
    FailoverMode: MERGE | FAILOVER,
    RecoveryWindow: 'NUMBER_VALUE',
    SourcePriority: {
      PrimarySource: 'STRING_VALUE'
    },
    State: ENABLED | DISABLED
  },
  Sources: [
    {
      Decryption: {
        RoleArn: 'STRING_VALUE', /* required */
        Algorithm: aes128 | aes192 | aes256,
        ConstantInitializationVector: 'STRING_VALUE',
        DeviceId: 'STRING_VALUE',
        KeyType: speke | static-key | srt-password,
        Region: 'STRING_VALUE',
        ResourceId: 'STRING_VALUE',
        SecretArn: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      Description: 'STRING_VALUE',
      EntitlementArn: 'STRING_VALUE',
      IngestPort: 'NUMBER_VALUE',
      MaxBitrate: 'NUMBER_VALUE',
      MaxLatency: 'NUMBER_VALUE',
      MaxSyncBuffer: 'NUMBER_VALUE',
      MediaStreamSourceConfigurations: [
        {
          EncodingName: jxsv | raw | smpte291 | pcm, /* required */
          MediaStreamName: 'STRING_VALUE', /* required */
          InputConfigurations: [
            {
              InputPort: 'NUMBER_VALUE', /* required */
              Interface: { /* required */
                Name: 'STRING_VALUE' /* required */
              }
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      MinLatency: 'NUMBER_VALUE',
      Name: 'STRING_VALUE',
      Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener,
      StreamId: 'STRING_VALUE',
      VpcInterfaceName: 'STRING_VALUE',
      WhitelistCidr: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcInterfaces: [
    {
      Name: 'STRING_VALUE', /* required */
      RoleArn: 'STRING_VALUE', /* required */
      SecurityGroupIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      SubnetId: 'STRING_VALUE', /* required */
      NetworkInterfaceType: ena | efa
    },
    /* more items */
  ]
};
mediaconnect.createFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AvailabilityZone — (String) The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
    • Entitlements — (Array<map>) The entitlements that you want to grant on a flow.
      • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Description — (String) A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
      • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
        • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
        • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
          • "speke"
          • "static-key"
          • "srt-password"
        • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
        • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • EntitlementStatus — (String) An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED. Possible values include:
        • "ENABLED"
        • "DISABLED"
      • Name — (String) The name of the entitlement. This value must be unique within the current flow.
      • Subscribers — required — (Array<String>) The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
    • MediaStreams — (Array<map>) The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.
      • Attributes — (map) The attributes that you want to assign to the new media stream.
        • Fmtp — (map) The settings that you want to use to define the media stream.
          • ChannelOrder — (String) The format of the audio channel.
          • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
            • "BT601"
            • "BT709"
            • "BT2020"
            • "BT2100"
            • "ST2065-1"
            • "ST2065-3"
            • "XYZ"
          • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
          • Par — (String) The pixel aspect ratio (PAR) of the video.
          • Range — (String) The encoding range of the video. Possible values include:
            • "NARROW"
            • "FULL"
            • "FULLPROTECT"
          • ScanMode — (String) The type of compression that was used to smooth the video’s appearance. Possible values include:
            • "progressive"
            • "interlace"
            • "progressive-segmented-frame"
          • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
            • "SDR"
            • "PQ"
            • "HLG"
            • "LINEAR"
            • "BT2100LINPQ"
            • "BT2100LINHLG"
            • "ST2065-1"
            • "ST428-1"
            • "DENSITY"
        • Lang — (String) The audio language, in a format that is recognized by the receiver.
      • ClockRate — (Integer) The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
      • Description — (String) A description that can help you quickly identify what your media stream is used for.
      • MediaStreamId — required — (Integer) A unique identifier for the media stream.
      • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
      • MediaStreamType — required — (String) The type of media stream. Possible values include:
        • "video"
        • "audio"
        • "ancillary-data"
      • VideoFormat — (String) The resolution of the video.
    • Name — (String) The name of the flow.
    • Outputs — (Array<map>) The outputs that you want to add to this flow.
      • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
      • Description — (String) A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
      • Destination — (String) The IP address from which video will be sent to output destinations.
      • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
        • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
        • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
          • "speke"
          • "static-key"
          • "srt-password"
        • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
        • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
      • MediaStreamOutputConfigurations — (Array<map>) The media streams that are associated with the output, and the parameters for those associations.
        • DestinationConfigurations — (Array<map>) The transport parameters that you want to associate with the media stream.
          • DestinationIp — required — (String) The IP address where you want MediaConnect to send contents of the media stream.
          • DestinationPort — required — (Integer) The port that you want MediaConnect to use when it distributes the media stream to the output.
          • Interface — required — (map) The VPC interface that you want to use for the media stream associated with the output.
            • Name — required — (String) The name of the VPC interface.
        • EncodingName — required — (String) The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
          • "jxsv"
          • "raw"
          • "smpte291"
          • "pcm"
        • EncodingParameters — (map) A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
          • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
          • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol. Possible values include:
            • "main"
            • "high"
        • MediaStreamName — required — (String) The name of the media stream that is associated with the output.
      • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
      • Name — (String) The name of the output. This value must be unique within the current flow.
      • Port — (Integer) The port to use when content is distributed to this output.
      • Protocol — required — (String) The protocol to use for the output. Possible values include:
        • "zixi-push"
        • "rtp-fec"
        • "rtp"
        • "zixi-pull"
        • "rist"
        • "st2110-jpegxs"
        • "cdi"
        • "srt-listener"
      • RemoteId — (String) The remote ID for the Zixi-pull output stream.
      • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
      • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
        • VpcInterfaceName — (String) The name of the VPC interface to use for this output.
    • Source — (map) The settings for the source of the flow.
      • Decryption — (map) The type of encryption that is used on the content ingested from this source.
        • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
        • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
          • "speke"
          • "static-key"
          • "srt-password"
        • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
        • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
      • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
      • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
      • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
      • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
      • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
      • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
        • EncodingName — required — (String) The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
          • "jxsv"
          • "raw"
          • "smpte291"
          • "pcm"
        • InputConfigurations — (Array<map>) The transport parameters that you want to associate with the media stream.
          • InputPort — required — (Integer) The port that you want the flow to listen on for an incoming media stream.
          • Interface — required — (map) The VPC interface that you want to use for the incoming media stream.
            • Name — required — (String) The name of the VPC interface.
        • MediaStreamName — required — (String) The name of the media stream.
      • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
      • Name — (String) The name of the source.
      • Protocol — (String) The protocol that is used by the source. Possible values include:
        • "zixi-push"
        • "rtp-fec"
        • "rtp"
        • "zixi-pull"
        • "rist"
        • "st2110-jpegxs"
        • "cdi"
        • "srt-listener"
      • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceName — (String) The name of the VPC interface to use for this source.
      • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    • SourceFailoverConfig — (map) The settings for source failover
      • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
        • "MERGE"
        • "FAILOVER"
      • RecoveryWindow — (Integer) Search window time to look for dash-7 packets
      • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
        • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
      • State — (String) Possible values include:
        • "ENABLED"
        • "DISABLED"
    • Sources — (Array<map>)
      • Decryption — (map) The type of encryption that is used on the content ingested from this source.
        • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
        • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
          • "speke"
          • "static-key"
          • "srt-password"
        • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
        • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
      • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
      • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
      • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
      • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
      • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
      • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
        • EncodingName — required — (String) The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
          • "jxsv"
          • "raw"
          • "smpte291"
          • "pcm"
        • InputConfigurations — (Array<map>) The transport parameters that you want to associate with the media stream.
          • InputPort — required — (Integer) The port that you want the flow to listen on for an incoming media stream.
          • Interface — required — (map) The VPC interface that you want to use for the incoming media stream.
            • Name — required — (String) The name of the VPC interface.
        • MediaStreamName — required — (String) The name of the media stream.
      • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
      • Name — (String) The name of the source.
      • Protocol — (String) The protocol that is used by the source. Possible values include:
        • "zixi-push"
        • "rtp-fec"
        • "rtp"
        • "zixi-pull"
        • "rist"
        • "st2110-jpegxs"
        • "cdi"
        • "srt-listener"
      • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
      • VpcInterfaceName — (String) The name of the VPC interface to use for this source.
      • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    • VpcInterfaces — (Array<map>) The VPC interfaces you want on the flow.
      • Name — required — (String) The name of the VPC Interface. This value must be unique within the current flow.
      • NetworkInterfaceType — (String) The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType. Possible values include:
        • "ena"
        • "efa"
      • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
      • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
      • SubnetId — required — (String) Subnet must be in the AZ of the Flow

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Flow — (map) The settings for a flow, including its source, outputs, and entitlements.
        • AvailabilityZone — required — (String) The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
        • Description — (String) A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EgressIp — (String) The IP address from which video will be sent to output destinations.
        • Entitlements — required — (Array<map>) The entitlements in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the entitlement.
          • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — required — (String) The ARN of the entitlement.
          • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
            • "ENABLED"
            • "DISABLED"
          • Name — required — (String) The name of the entitlement.
          • Subscribers — required — (Array<String>) The AWS 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.
        • FlowArn — required — (String) The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
        • MediaStreams — (Array<map>) The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
          • Attributes — (map) Attributes that are related to the media stream.
            • Fmtp — required — (map) A set of parameters that define the media stream.
              • ChannelOrder — (String) The format of the audio channel.
              • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
                • "BT601"
                • "BT709"
                • "BT2020"
                • "BT2100"
                • "ST2065-1"
                • "ST2065-3"
                • "XYZ"
              • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
              • Par — (String) The pixel aspect ratio (PAR) of the video.
              • Range — (String) The encoding range of the video. Possible values include:
                • "NARROW"
                • "FULL"
                • "FULLPROTECT"
              • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
                • "progressive"
                • "interlace"
                • "progressive-segmented-frame"
              • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
                • "SDR"
                • "PQ"
                • "HLG"
                • "LINEAR"
                • "BT2100LINPQ"
                • "BT2100LINHLG"
                • "ST2065-1"
                • "ST428-1"
                • "DENSITY"
            • Lang — (String) The audio language, in a format that is recognized by the receiver.
          • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
          • Description — (String) A description that can help you quickly identify what your media stream is used for.
          • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
          • MediaStreamId — required — (Integer) A unique identifier for the media stream.
          • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
          • MediaStreamType — required — (String) The type of media stream. Possible values include:
            • "video"
            • "audio"
            • "ancillary-data"
          • VideoFormat — (String) The resolution of the video.
        • Name — required — (String) The name of the flow.
        • Outputs — required — (Array<map>) The outputs in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the output.
          • Destination — (String) The address where you want to send the output.
          • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
          • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
          • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
          • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
            • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
              • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
              • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
              • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
                • Name — required — (String) The name of the VPC interface.
              • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • EncodingParameters — (map) Encoding parameters
              • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
                • "main"
                • "high"
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the output. This value must be unique within the current flow.
          • OutputArn — required — (String) The ARN of the output.
          • Port — (Integer) The port to use when content is distributed to this output.
          • Transport — (map) Attributes related to the transport stream that are used in the output.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
            • VpcInterfaceName — (String) The name of the VPC interface to use for this output.
        • Source — required — (map) The settings for the source of the flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • SourceFailoverConfig — (map) The settings for source failover
          • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
            • "MERGE"
            • "FAILOVER"
          • RecoveryWindow — (Integer) Search window time to look for dash-7 packets
          • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
            • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
          • State — (String) Possible values include:
            • "ENABLED"
            • "DISABLED"
        • Sources — (Array<map>)
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • Status — required — (String) The current status of the flow. Possible values include:
          • "STANDBY"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "ERROR"
        • VpcInterfaces — (Array<map>) The VPC Interfaces for this flow.
          • Name — required — (String) Immutable and has to be a unique against other VpcInterfaces in this Flow
          • NetworkInterfaceIds — required — (Array<String>) IDs of the network interfaces created in customer's account by MediaConnect.
          • NetworkInterfaceType — required — (String) The type of network interface. Possible values include:
            • "ena"
            • "efa"
          • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
          • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
          • SubnetId — required — (String) Subnet must be in the AZ of the Flow

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteFlow(params = {}, callback) ⇒ AWS.Request

Deletes a flow. Before you can delete a flow, you must stop the flow.

Service Reference:

Examples:

Calling the deleteFlow operation

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.deleteFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The ARN of the flow that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that was deleted.
      • Status — (String) The status of the flow when the DeleteFlow process begins. Possible values include:
        • "STANDBY"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "STARTING"
        • "STOPPING"
        • "ERROR"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFlow(params = {}, callback) ⇒ AWS.Request

Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.

Service Reference:

Examples:

Calling the describeFlow operation

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.describeFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The ARN of the flow that you want to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Flow — (map) The settings for a flow, including its source, outputs, and entitlements.
        • AvailabilityZone — required — (String) The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
        • Description — (String) A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EgressIp — (String) The IP address from which video will be sent to output destinations.
        • Entitlements — required — (Array<map>) The entitlements in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the entitlement.
          • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — required — (String) The ARN of the entitlement.
          • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
            • "ENABLED"
            • "DISABLED"
          • Name — required — (String) The name of the entitlement.
          • Subscribers — required — (Array<String>) The AWS 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.
        • FlowArn — required — (String) The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
        • MediaStreams — (Array<map>) The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
          • Attributes — (map) Attributes that are related to the media stream.
            • Fmtp — required — (map) A set of parameters that define the media stream.
              • ChannelOrder — (String) The format of the audio channel.
              • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
                • "BT601"
                • "BT709"
                • "BT2020"
                • "BT2100"
                • "ST2065-1"
                • "ST2065-3"
                • "XYZ"
              • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
              • Par — (String) The pixel aspect ratio (PAR) of the video.
              • Range — (String) The encoding range of the video. Possible values include:
                • "NARROW"
                • "FULL"
                • "FULLPROTECT"
              • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
                • "progressive"
                • "interlace"
                • "progressive-segmented-frame"
              • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
                • "SDR"
                • "PQ"
                • "HLG"
                • "LINEAR"
                • "BT2100LINPQ"
                • "BT2100LINHLG"
                • "ST2065-1"
                • "ST428-1"
                • "DENSITY"
            • Lang — (String) The audio language, in a format that is recognized by the receiver.
          • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
          • Description — (String) A description that can help you quickly identify what your media stream is used for.
          • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
          • MediaStreamId — required — (Integer) A unique identifier for the media stream.
          • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
          • MediaStreamType — required — (String) The type of media stream. Possible values include:
            • "video"
            • "audio"
            • "ancillary-data"
          • VideoFormat — (String) The resolution of the video.
        • Name — required — (String) The name of the flow.
        • Outputs — required — (Array<map>) The outputs in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the output.
          • Destination — (String) The address where you want to send the output.
          • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
          • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
          • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
          • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
            • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
              • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
              • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
              • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
                • Name — required — (String) The name of the VPC interface.
              • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • EncodingParameters — (map) Encoding parameters
              • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
                • "main"
                • "high"
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the output. This value must be unique within the current flow.
          • OutputArn — required — (String) The ARN of the output.
          • Port — (Integer) The port to use when content is distributed to this output.
          • Transport — (map) Attributes related to the transport stream that are used in the output.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
            • VpcInterfaceName — (String) The name of the VPC interface to use for this output.
        • Source — required — (map) The settings for the source of the flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • SourceFailoverConfig — (map) The settings for source failover
          • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
            • "MERGE"
            • "FAILOVER"
          • RecoveryWindow — (Integer) Search window time to look for dash-7 packets
          • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
            • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
          • State — (String) Possible values include:
            • "ENABLED"
            • "DISABLED"
        • Sources — (Array<map>)
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • Status — required — (String) The current status of the flow. Possible values include:
          • "STANDBY"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "ERROR"
        • VpcInterfaces — (Array<map>) The VPC Interfaces for this flow.
          • Name — required — (String) Immutable and has to be a unique against other VpcInterfaces in this Flow
          • NetworkInterfaceIds — required — (Array<String>) IDs of the network interfaces created in customer's account by MediaConnect.
          • NetworkInterfaceType — required — (String) The type of network interface. Possible values include:
            • "ena"
            • "efa"
          • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
          • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
          • SubnetId — required — (String) Subnet must be in the AZ of the Flow
      • Messages — (map) Messages that provide the state of the flow.
        • Errors — required — (Array<String>) A list of errors that might have been generated from processes on this flow.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeOffering(params = {}, callback) ⇒ AWS.Request

Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the describeOffering operation

var params = {
  OfferingArn: 'STRING_VALUE' /* required */
};
mediaconnect.describeOffering(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OfferingArn — (String) The Amazon Resource Name (ARN) of the offering.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Offering — (map) A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
        • CurrencyCode — required — (String) The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
        • Duration — required — (Integer) The length of time that your reservation would be active.
        • DurationUnits — required — (String) The unit of measurement for the duration of the offering. Possible values include:
          • "MONTHS"
        • OfferingArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
        • OfferingDescription — required — (String) A description of the offering.
        • PricePerUnit — required — (String) The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
        • PriceUnits — required — (String) The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. Possible values include:
          • "HOURLY"
        • ResourceSpecification — required — (map) A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
          • ReservedBitrate — (Integer) The amount of outbound bandwidth that is discounted in the offering.
          • ResourceType — required — (String) The type of resource and the unit that is being billed for. Possible values include:
            • "Mbps_Outbound_Bandwidth"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservation(params = {}, callback) ⇒ AWS.Request

Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).

Service Reference:

Examples:

Calling the describeReservation operation

var params = {
  ReservationArn: 'STRING_VALUE' /* required */
};
mediaconnect.describeReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservationArn — (String) The Amazon Resource Name (ARN) of the reservation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Reservation — (map) A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
        • CurrencyCode — required — (String) The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
        • Duration — required — (Integer) The length of time that this reservation is active. MediaConnect defines this value in the offering.
        • DurationUnits — required — (String) The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering. Possible values include:
          • "MONTHS"
        • End — required — (String) The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
        • OfferingArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
        • OfferingDescription — required — (String) A description of the offering. MediaConnect defines this value in the offering.
        • PricePerUnit — required — (String) The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
        • PriceUnits — required — (String) The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering. Possible values include:
          • "HOURLY"
        • ReservationArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
        • ReservationName — required — (String) The name that you assigned to the reservation when you purchased the offering.
        • ReservationState — required — (String) The status of your reservation. Possible values include:
          • "ACTIVE"
          • "EXPIRED"
          • "PROCESSING"
          • "CANCELED"
        • ResourceSpecification — required — (map) A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
          • ReservedBitrate — (Integer) The amount of outbound bandwidth that is discounted in the offering.
          • ResourceType — required — (String) The type of resource and the unit that is being billed for. Possible values include:
            • "Mbps_Outbound_Bandwidth"
        • Start — required — (String) The day and time that the reservation becomes active. You set this value when you purchase the offering.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

grantFlowEntitlements(params = {}, callback) ⇒ AWS.Request

Grants entitlements to an existing flow.

Service Reference:

Examples:

Calling the grantFlowEntitlements operation

var params = {
  Entitlements: [ /* required */
    {
      Subscribers: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      DataTransferSubscriberFeePercent: 'NUMBER_VALUE',
      Description: 'STRING_VALUE',
      Encryption: {
        RoleArn: 'STRING_VALUE', /* required */
        Algorithm: aes128 | aes192 | aes256,
        ConstantInitializationVector: 'STRING_VALUE',
        DeviceId: 'STRING_VALUE',
        KeyType: speke | static-key | srt-password,
        Region: 'STRING_VALUE',
        ResourceId: 'STRING_VALUE',
        SecretArn: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      EntitlementStatus: ENABLED | DISABLED,
      Name: 'STRING_VALUE'
    },
    /* more items */
  ],
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.grantFlowEntitlements(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Entitlements — (Array<map>) The list of entitlements that you want to grant.
      • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
      • Description — (String) A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
      • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
        • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
        • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
          • "speke"
          • "static-key"
          • "srt-password"
        • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
        • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
        • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • EntitlementStatus — (String) An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED. Possible values include:
        • "ENABLED"
        • "DISABLED"
      • Name — (String) The name of the entitlement. This value must be unique within the current flow.
      • Subscribers — required — (Array<String>) The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
    • FlowArn — (String) The flow that you want to grant entitlements on.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Entitlements — (Array<map>) The entitlements that were just granted.
        • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description — (String) A description of the entitlement.
        • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
          • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
          • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
            • "speke"
            • "static-key"
            • "srt-password"
          • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
          • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • EntitlementArn — required — (String) The ARN of the entitlement.
        • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
          • "ENABLED"
          • "DISABLED"
        • Name — required — (String) The name of the entitlement.
        • Subscribers — required — (Array<String>) The AWS 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.
      • FlowArn — (String) The ARN of the flow that these entitlements were granted to.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listEntitlements(params = {}, callback) ⇒ AWS.Request

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

Service Reference:

Examples:

Calling the listEntitlements operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediaconnect.listEntitlements(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer) The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.
    • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Entitlements — (Array<map>) A list of entitlements that have been granted to you from other AWS accounts.
        • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • EntitlementArn — required — (String) The ARN of the entitlement.
        • EntitlementName — required — (String) The name of the entitlement.
      • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listFlows(params = {}, callback) ⇒ AWS.Request

Displays a list of flows that are associated with this account. This request returns a paginated result.

Service Reference:

Examples:

Calling the listFlows operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediaconnect.listFlows(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer) The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
    • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Flows — (Array<map>) A list of flow summaries.
        • AvailabilityZone — required — (String) The Availability Zone that the flow was created in.
        • Description — required — (String) A description of the flow.
        • FlowArn — required — (String) The ARN of the flow.
        • Name — required — (String) The name of the flow.
        • SourceType — required — (String) The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account). Possible values include:
          • "OWNED"
          • "ENTITLED"
        • Status — required — (String) The current status of the flow. Possible values include:
          • "STANDBY"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "ERROR"
      • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listOfferings(params = {}, callback) ⇒ AWS.Request

Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

Service Reference:

Examples:

Calling the listOfferings operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediaconnect.listOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer) The maximum number of results to return per API request. For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
    • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
      • Offerings — (Array<map>) A list of offerings that are available to this account in the current AWS Region.
        • CurrencyCode — required — (String) The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
        • Duration — required — (Integer) The length of time that your reservation would be active.
        • DurationUnits — required — (String) The unit of measurement for the duration of the offering. Possible values include:
          • "MONTHS"
        • OfferingArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
        • OfferingDescription — required — (String) A description of the offering.
        • PricePerUnit — required — (String) The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
        • PriceUnits — required — (String) The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. Possible values include:
          • "HOURLY"
        • ResourceSpecification — required — (map) A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
          • ReservedBitrate — (Integer) The amount of outbound bandwidth that is discounted in the offering.
          • ResourceType — required — (String) The type of resource and the unit that is being billed for. Possible values include:
            • "Mbps_Outbound_Bandwidth"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listReservations(params = {}, callback) ⇒ AWS.Request

Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).

Service Reference:

Examples:

Calling the listReservations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediaconnect.listReservations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer) The maximum number of results to return per API request. For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
    • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String) The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.
      • Reservations — (Array<map>) A list of all reservations that have been purchased by this account in the current AWS Region.
        • CurrencyCode — required — (String) The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
        • Duration — required — (Integer) The length of time that this reservation is active. MediaConnect defines this value in the offering.
        • DurationUnits — required — (String) The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering. Possible values include:
          • "MONTHS"
        • End — required — (String) The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
        • OfferingArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
        • OfferingDescription — required — (String) A description of the offering. MediaConnect defines this value in the offering.
        • PricePerUnit — required — (String) The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
        • PriceUnits — required — (String) The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering. Possible values include:
          • "HOURLY"
        • ReservationArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
        • ReservationName — required — (String) The name that you assigned to the reservation when you purchased the offering.
        • ReservationState — required — (String) The status of your reservation. Possible values include:
          • "ACTIVE"
          • "EXPIRED"
          • "PROCESSING"
          • "CANCELED"
        • ResourceSpecification — required — (map) A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
          • ReservedBitrate — (Integer) The amount of outbound bandwidth that is discounted in the offering.
          • ResourceType — required — (String) The type of resource and the unit that is being billed for. Possible values include:
            • "Mbps_Outbound_Bandwidth"
        • Start — required — (String) The day and time that the reservation becomes active. You set this value when you purchase the offering.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List all tags on an AWS Elemental MediaConnect resource

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mediaconnect.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String) The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>) A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

purchaseOffering(params = {}, callback) ⇒ AWS.Request

Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.

Service Reference:

Examples:

Calling the purchaseOffering operation

var params = {
  OfferingArn: 'STRING_VALUE', /* required */
  ReservationName: 'STRING_VALUE', /* required */
  Start: 'STRING_VALUE' /* required */
};
mediaconnect.purchaseOffering(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OfferingArn — (String) The Amazon Resource Name (ARN) of the offering.
    • ReservationName — (String) The name that you want to use for the reservation.
    • Start — (String) The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Reservation — (map) A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
        • CurrencyCode — required — (String) The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
        • Duration — required — (Integer) The length of time that this reservation is active. MediaConnect defines this value in the offering.
        • DurationUnits — required — (String) The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering. Possible values include:
          • "MONTHS"
        • End — required — (String) The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
        • OfferingArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
        • OfferingDescription — required — (String) A description of the offering. MediaConnect defines this value in the offering.
        • PricePerUnit — required — (String) The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
        • PriceUnits — required — (String) The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering. Possible values include:
          • "HOURLY"
        • ReservationArn — required — (String) The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
        • ReservationName — required — (String) The name that you assigned to the reservation when you purchased the offering.
        • ReservationState — required — (String) The status of your reservation. Possible values include:
          • "ACTIVE"
          • "EXPIRED"
          • "PROCESSING"
          • "CANCELED"
        • ResourceSpecification — required — (map) A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
          • ReservedBitrate — (Integer) The amount of outbound bandwidth that is discounted in the offering.
          • ResourceType — required — (String) The type of resource and the unit that is being billed for. Possible values include:
            • "Mbps_Outbound_Bandwidth"
        • Start — required — (String) The day and time that the reservation becomes active. You set this value when you purchase the offering.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeFlowMediaStream(params = {}, callback) ⇒ AWS.Request

Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.

Service Reference:

Examples:

Calling the removeFlowMediaStream operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  MediaStreamName: 'STRING_VALUE' /* required */
};
mediaconnect.removeFlowMediaStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The Amazon Resource Name (ARN) of the flow.
    • MediaStreamName — (String) The name of the media stream that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The Amazon Resource Name (ARN) of the flow.
      • MediaStreamName — (String) The name of the media stream that was removed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeFlowOutput(params = {}, callback) ⇒ AWS.Request

Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.

Service Reference:

Examples:

Calling the removeFlowOutput operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  OutputArn: 'STRING_VALUE' /* required */
};
mediaconnect.removeFlowOutput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The flow that you want to remove an output from.
    • OutputArn — (String) The ARN of the output that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that is associated with the output you removed.
      • OutputArn — (String) The ARN of the output that was removed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeFlowSource(params = {}, callback) ⇒ AWS.Request

Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.

Service Reference:

Examples:

Calling the removeFlowSource operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  SourceArn: 'STRING_VALUE' /* required */
};
mediaconnect.removeFlowSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The flow that you want to remove a source from.
    • SourceArn — (String) The ARN of the source that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that is associated with the source you removed.
      • SourceArn — (String) The ARN of the source that was removed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeFlowVpcInterface(params = {}, callback) ⇒ AWS.Request

Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.

Service Reference:

Examples:

Calling the removeFlowVpcInterface operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  VpcInterfaceName: 'STRING_VALUE' /* required */
};
mediaconnect.removeFlowVpcInterface(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The flow that you want to remove a VPC interface from.
    • VpcInterfaceName — (String) The name of the VPC interface that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that is associated with the VPC interface you removed.
      • NonDeletedNetworkInterfaceIds — (Array<String>) IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove.
      • VpcInterfaceName — (String) The name of the VPC interface that was removed.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

revokeFlowEntitlement(params = {}, callback) ⇒ AWS.Request

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.

Service Reference:

Examples:

Calling the revokeFlowEntitlement operation

var params = {
  EntitlementArn: 'STRING_VALUE', /* required */
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.revokeFlowEntitlement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EntitlementArn — (String) The ARN of the entitlement that you want to revoke.
    • FlowArn — (String) The flow that you want to revoke an entitlement from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EntitlementArn — (String) The ARN of the entitlement that was revoked.
      • FlowArn — (String) The ARN of the flow that the entitlement was revoked from.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startFlow(params = {}, callback) ⇒ AWS.Request

Starts a flow.

Service Reference:

Examples:

Calling the startFlow operation

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.startFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The ARN of the flow that you want to start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that you started.
      • Status — (String) The status of the flow when the StartFlow process begins. Possible values include:
        • "STANDBY"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "STARTING"
        • "STOPPING"
        • "ERROR"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopFlow(params = {}, callback) ⇒ AWS.Request

Stops a flow.

Service Reference:

Examples:

Calling the stopFlow operation

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.stopFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The ARN of the flow that you want to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that you stopped.
      • Status — (String) The status of the flow when the StopFlow process begins. Possible values include:
        • "STANDBY"
        • "ACTIVE"
        • "UPDATING"
        • "DELETING"
        • "STARTING"
        • "STOPPING"
        • "ERROR"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates the specified tags to a resource with the specified resourceArn. 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 deleted as well.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediaconnect.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String) The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags.
    • Tags — (map<String>) A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes specified tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mediaconnect.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String) The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.
    • TagKeys — (Array<String>) The keys of the tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateFlow(params = {}, callback) ⇒ AWS.Request

Updates flow

Service Reference:

Examples:

Calling the updateFlow operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  SourceFailoverConfig: {
    FailoverMode: MERGE | FAILOVER,
    RecoveryWindow: 'NUMBER_VALUE',
    SourcePriority: {
      PrimarySource: 'STRING_VALUE'
    },
    State: ENABLED | DISABLED
  }
};
mediaconnect.updateFlow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FlowArn — (String) The flow that you want to update.
    • SourceFailoverConfig — (map) The settings for source failover
      • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
        • "MERGE"
        • "FAILOVER"
      • RecoveryWindow — (Integer) Recovery window time to look for dash-7 packets
      • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
        • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
      • State — (String) Possible values include:
        • "ENABLED"
        • "DISABLED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Flow — (map) The settings for a flow, including its source, outputs, and entitlements.
        • AvailabilityZone — required — (String) The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
        • Description — (String) A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EgressIp — (String) The IP address from which video will be sent to output destinations.
        • Entitlements — required — (Array<map>) The entitlements in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the entitlement.
          • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — required — (String) The ARN of the entitlement.
          • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
            • "ENABLED"
            • "DISABLED"
          • Name — required — (String) The name of the entitlement.
          • Subscribers — required — (Array<String>) The AWS 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.
        • FlowArn — required — (String) The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
        • MediaStreams — (Array<map>) The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
          • Attributes — (map) Attributes that are related to the media stream.
            • Fmtp — required — (map) A set of parameters that define the media stream.
              • ChannelOrder — (String) The format of the audio channel.
              • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
                • "BT601"
                • "BT709"
                • "BT2020"
                • "BT2100"
                • "ST2065-1"
                • "ST2065-3"
                • "XYZ"
              • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
              • Par — (String) The pixel aspect ratio (PAR) of the video.
              • Range — (String) The encoding range of the video. Possible values include:
                • "NARROW"
                • "FULL"
                • "FULLPROTECT"
              • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
                • "progressive"
                • "interlace"
                • "progressive-segmented-frame"
              • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
                • "SDR"
                • "PQ"
                • "HLG"
                • "LINEAR"
                • "BT2100LINPQ"
                • "BT2100LINHLG"
                • "ST2065-1"
                • "ST428-1"
                • "DENSITY"
            • Lang — (String) The audio language, in a format that is recognized by the receiver.
          • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
          • Description — (String) A description that can help you quickly identify what your media stream is used for.
          • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
          • MediaStreamId — required — (Integer) A unique identifier for the media stream.
          • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
          • MediaStreamType — required — (String) The type of media stream. Possible values include:
            • "video"
            • "audio"
            • "ancillary-data"
          • VideoFormat — (String) The resolution of the video.
        • Name — required — (String) The name of the flow.
        • Outputs — required — (Array<map>) The outputs in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the output.
          • Destination — (String) The address where you want to send the output.
          • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
          • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
          • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
          • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
            • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
              • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
              • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
              • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
                • Name — required — (String) The name of the VPC interface.
              • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • EncodingParameters — (map) Encoding parameters
              • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
                • "main"
                • "high"
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the output. This value must be unique within the current flow.
          • OutputArn — required — (String) The ARN of the output.
          • Port — (Integer) The port to use when content is distributed to this output.
          • Transport — (map) Attributes related to the transport stream that are used in the output.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
            • VpcInterfaceName — (String) The name of the VPC interface to use for this output.
        • Source — required — (map) The settings for the source of the flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • SourceFailoverConfig — (map) The settings for source failover
          • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
            • "MERGE"
            • "FAILOVER"
          • RecoveryWindow — (Integer) Search window time to look for dash-7 packets
          • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
            • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
          • State — (String) Possible values include:
            • "ENABLED"
            • "DISABLED"
        • Sources — (Array<map>)
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • Status — required — (String) The current status of the flow. Possible values include:
          • "STANDBY"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "ERROR"
        • VpcInterfaces — (Array<map>) The VPC Interfaces for this flow.
          • Name — required — (String) Immutable and has to be a unique against other VpcInterfaces in this Flow
          • NetworkInterfaceIds — required — (Array<String>) IDs of the network interfaces created in customer's account by MediaConnect.
          • NetworkInterfaceType — required — (String) The type of network interface. Possible values include:
            • "ena"
            • "efa"
          • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
          • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
          • SubnetId — required — (String) Subnet must be in the AZ of the Flow

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateFlowEntitlement(params = {}, callback) ⇒ AWS.Request

You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.

Service Reference:

Examples:

Calling the updateFlowEntitlement operation

var params = {
  EntitlementArn: 'STRING_VALUE', /* required */
  FlowArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Encryption: {
    Algorithm: aes128 | aes192 | aes256,
    ConstantInitializationVector: 'STRING_VALUE',
    DeviceId: 'STRING_VALUE',
    KeyType: speke | static-key | srt-password,
    Region: 'STRING_VALUE',
    ResourceId: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE',
    SecretArn: 'STRING_VALUE',
    Url: 'STRING_VALUE'
  },
  EntitlementStatus: ENABLED | DISABLED,
  Subscribers: [
    'STRING_VALUE',
    /* more items */
  ]
};
mediaconnect.updateFlowEntitlement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String) A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
    • Encryption — (map) The type of encryption that will be used on the output associated with this entitlement.
      • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
      • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
        • "speke"
        • "static-key"
        • "srt-password"
      • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • RoleArn — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
      • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    • EntitlementArn — (String) The ARN of the entitlement that you want to update.
    • EntitlementStatus — (String) 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. Possible values include:
      • "ENABLED"
      • "DISABLED"
    • FlowArn — (String) The flow that is associated with the entitlement that you want to update.
    • Subscribers — (Array<String>) The AWS 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Entitlement — (map) The new configuration of the entitlement that you updated.
        • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description — (String) A description of the entitlement.
        • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
          • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
          • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
            • "speke"
            • "static-key"
            • "srt-password"
          • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
          • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • EntitlementArn — required — (String) The ARN of the entitlement.
        • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
          • "ENABLED"
          • "DISABLED"
        • Name — required — (String) The name of the entitlement.
        • Subscribers — required — (Array<String>) The AWS 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.
      • FlowArn — (String) The ARN of the flow that this entitlement was granted on.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateFlowMediaStream(params = {}, callback) ⇒ AWS.Request

Updates an existing media stream.

Service Reference:

Examples:

Calling the updateFlowMediaStream operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  MediaStreamName: 'STRING_VALUE', /* required */
  Attributes: {
    Fmtp: {
      ChannelOrder: 'STRING_VALUE',
      Colorimetry: BT601 | BT709 | BT2020 | BT2100 | ST2065-1 | ST2065-3 | XYZ,
      ExactFramerate: 'STRING_VALUE',
      Par: 'STRING_VALUE',
      Range: NARROW | FULL | FULLPROTECT,
      ScanMode: progressive | interlace | progressive-segmented-frame,
      Tcs: SDR | PQ | HLG | LINEAR | BT2100LINPQ | BT2100LINHLG | ST2065-1 | ST428-1 | DENSITY
    },
    Lang: 'STRING_VALUE'
  },
  ClockRate: 'NUMBER_VALUE',
  Description: 'STRING_VALUE',
  MediaStreamType: video | audio | ancillary-data,
  VideoFormat: 'STRING_VALUE'
};
mediaconnect.updateFlowMediaStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Attributes — (map) The attributes that you want to assign to the media stream.
      • Fmtp — (map) The settings that you want to use to define the media stream.
        • ChannelOrder — (String) The format of the audio channel.
        • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
          • "BT601"
          • "BT709"
          • "BT2020"
          • "BT2100"
          • "ST2065-1"
          • "ST2065-3"
          • "XYZ"
        • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
        • Par — (String) The pixel aspect ratio (PAR) of the video.
        • Range — (String) The encoding range of the video. Possible values include:
          • "NARROW"
          • "FULL"
          • "FULLPROTECT"
        • ScanMode — (String) The type of compression that was used to smooth the video’s appearance. Possible values include:
          • "progressive"
          • "interlace"
          • "progressive-segmented-frame"
        • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
          • "SDR"
          • "PQ"
          • "HLG"
          • "LINEAR"
          • "BT2100LINPQ"
          • "BT2100LINHLG"
          • "ST2065-1"
          • "ST428-1"
          • "DENSITY"
      • Lang — (String) The audio language, in a format that is recognized by the receiver.
    • ClockRate — (Integer) The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
    • Description — (String) Description
    • FlowArn — (String) The Amazon Resource Name (ARN) of the flow.
    • MediaStreamName — (String) The name of the media stream that you want to update.
    • MediaStreamType — (String) The type of media stream. Possible values include:
      • "video"
      • "audio"
      • "ancillary-data"
    • VideoFormat — (String) The resolution of the video.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that is associated with the media stream that you updated.
      • MediaStream — (map) The media stream that you updated.
        • Attributes — (map) Attributes that are related to the media stream.
          • Fmtp — required — (map) A set of parameters that define the media stream.
            • ChannelOrder — (String) The format of the audio channel.
            • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
              • "BT601"
              • "BT709"
              • "BT2020"
              • "BT2100"
              • "ST2065-1"
              • "ST2065-3"
              • "XYZ"
            • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
            • Par — (String) The pixel aspect ratio (PAR) of the video.
            • Range — (String) The encoding range of the video. Possible values include:
              • "NARROW"
              • "FULL"
              • "FULLPROTECT"
            • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
              • "progressive"
              • "interlace"
              • "progressive-segmented-frame"
            • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
              • "SDR"
              • "PQ"
              • "HLG"
              • "LINEAR"
              • "BT2100LINPQ"
              • "BT2100LINHLG"
              • "ST2065-1"
              • "ST428-1"
              • "DENSITY"
          • Lang — (String) The audio language, in a format that is recognized by the receiver.
        • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
        • Description — (String) A description that can help you quickly identify what your media stream is used for.
        • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
        • MediaStreamId — required — (Integer) A unique identifier for the media stream.
        • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
        • MediaStreamType — required — (String) The type of media stream. Possible values include:
          • "video"
          • "audio"
          • "ancillary-data"
        • VideoFormat — (String) The resolution of the video.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateFlowOutput(params = {}, callback) ⇒ AWS.Request

Updates an existing flow output.

Service Reference:

Examples:

Calling the updateFlowOutput operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  OutputArn: 'STRING_VALUE', /* required */
  CidrAllowList: [
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE',
  Destination: 'STRING_VALUE',
  Encryption: {
    Algorithm: aes128 | aes192 | aes256,
    ConstantInitializationVector: 'STRING_VALUE',
    DeviceId: 'STRING_VALUE',
    KeyType: speke | static-key | srt-password,
    Region: 'STRING_VALUE',
    ResourceId: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE',
    SecretArn: 'STRING_VALUE',
    Url: 'STRING_VALUE'
  },
  MaxLatency: 'NUMBER_VALUE',
  MediaStreamOutputConfigurations: [
    {
      EncodingName: jxsv | raw | smpte291 | pcm, /* required */
      MediaStreamName: 'STRING_VALUE', /* required */
      DestinationConfigurations: [
        {
          DestinationIp: 'STRING_VALUE', /* required */
          DestinationPort: 'NUMBER_VALUE', /* required */
          Interface: { /* required */
            Name: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ],
      EncodingParameters: {
        CompressionFactor: 'NUMBER_VALUE', /* required */
        EncoderProfile: main | high /* required */
      }
    },
    /* more items */
  ],
  MinLatency: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener,
  RemoteId: 'STRING_VALUE',
  SmoothingLatency: 'NUMBER_VALUE',
  StreamId: 'STRING_VALUE',
  VpcInterfaceAttachment: {
    VpcInterfaceName: 'STRING_VALUE'
  }
};
mediaconnect.updateFlowOutput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    • Description — (String) A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
    • Destination — (String) The IP address where you want to send the output.
    • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
      • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
      • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
        • "speke"
        • "static-key"
        • "srt-password"
      • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • RoleArn — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
      • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    • FlowArn — (String) The flow that is associated with the output that you want to update.
    • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
    • MediaStreamOutputConfigurations — (Array<map>) The media streams that are associated with the output, and the parameters for those associations.
      • DestinationConfigurations — (Array<map>) The transport parameters that you want to associate with the media stream.
        • DestinationIp — required — (String) The IP address where you want MediaConnect to send contents of the media stream.
        • DestinationPort — required — (Integer) The port that you want MediaConnect to use when it distributes the media stream to the output.
        • Interface — required — (map) The VPC interface that you want to use for the media stream associated with the output.
          • Name — required — (String) The name of the VPC interface.
      • EncodingName — required — (String) The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
        • "jxsv"
        • "raw"
        • "smpte291"
        • "pcm"
      • EncodingParameters — (map) A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
        • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
        • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol. Possible values include:
          • "main"
          • "high"
      • MediaStreamName — required — (String) The name of the media stream that is associated with the output.
    • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
    • OutputArn — (String) The ARN of the output that you want to update.
    • Port — (Integer) The port to use when content is distributed to this output.
    • Protocol — (String) The protocol to use for the output. Possible values include:
      • "zixi-push"
      • "rtp-fec"
      • "rtp"
      • "zixi-pull"
      • "rist"
      • "st2110-jpegxs"
      • "cdi"
      • "srt-listener"
    • RemoteId — (String) The remote ID for the Zixi-pull stream.
    • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
    • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
      • VpcInterfaceName — (String) The name of the VPC interface to use for this output.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that is associated with the updated output.
      • Output — (map) The new settings of the output that you updated.
        • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Description — (String) A description of the output.
        • Destination — (String) The address where you want to send the output.
        • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
          • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
          • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
            • "speke"
            • "static-key"
            • "srt-password"
          • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
          • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
        • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
        • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
        • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
          • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
            • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
            • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
            • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
              • Name — required — (String) The name of the VPC interface.
            • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
          • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
            • "jxsv"
            • "raw"
            • "smpte291"
            • "pcm"
          • EncodingParameters — (map) Encoding parameters
            • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
            • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
              • "main"
              • "high"
          • MediaStreamName — required — (String) The name of the media stream.
        • Name — required — (String) The name of the output. This value must be unique within the current flow.
        • OutputArn — required — (String) The ARN of the output.
        • Port — (Integer) The port to use when content is distributed to this output.
        • Transport — (map) Attributes related to the transport stream that are used in the output.
          • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
          • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
            • "zixi-pull"
            • "rist"
            • "st2110-jpegxs"
            • "cdi"
            • "srt-listener"
          • RemoteId — (String) The remote ID for the Zixi-pull stream.
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
          • VpcInterfaceName — (String) The name of the VPC interface to use for this output.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateFlowSource(params = {}, callback) ⇒ AWS.Request

Updates the source of a flow.

Service Reference:

Examples:

Calling the updateFlowSource operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  SourceArn: 'STRING_VALUE', /* required */
  Decryption: {
    Algorithm: aes128 | aes192 | aes256,
    ConstantInitializationVector: 'STRING_VALUE',
    DeviceId: 'STRING_VALUE',
    KeyType: speke | static-key | srt-password,
    Region: 'STRING_VALUE',
    ResourceId: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE',
    SecretArn: 'STRING_VALUE',
    Url: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  EntitlementArn: 'STRING_VALUE',
  IngestPort: 'NUMBER_VALUE',
  MaxBitrate: 'NUMBER_VALUE',
  MaxLatency: 'NUMBER_VALUE',
  MaxSyncBuffer: 'NUMBER_VALUE',
  MediaStreamSourceConfigurations: [
    {
      EncodingName: jxsv | raw | smpte291 | pcm, /* required */
      MediaStreamName: 'STRING_VALUE', /* required */
      InputConfigurations: [
        {
          InputPort: 'NUMBER_VALUE', /* required */
          Interface: { /* required */
            Name: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  MinLatency: 'NUMBER_VALUE',
  Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener,
  StreamId: 'STRING_VALUE',
  VpcInterfaceName: 'STRING_VALUE',
  WhitelistCidr: 'STRING_VALUE'
};
mediaconnect.updateFlowSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Decryption — (map) The type of encryption used on the content ingested from this source.
      • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
      • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
        • "speke"
        • "static-key"
        • "srt-password"
      • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
      • RoleArn — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
      • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
      • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
    • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
    • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
    • FlowArn — (String) The flow that is associated with the source that you want to update.
    • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
    • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
    • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
    • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
    • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
      • EncodingName — required — (String) The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
        • "jxsv"
        • "raw"
        • "smpte291"
        • "pcm"
      • InputConfigurations — (Array<map>) The transport parameters that you want to associate with the media stream.
        • InputPort — required — (Integer) The port that you want the flow to listen on for an incoming media stream.
        • Interface — required — (map) The VPC interface that you want to use for the incoming media stream.
          • Name — required — (String) The name of the VPC interface.
      • MediaStreamName — required — (String) The name of the media stream.
    • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
    • Protocol — (String) The protocol that is used by the source. Possible values include:
      • "zixi-push"
      • "rtp-fec"
      • "rtp"
      • "zixi-pull"
      • "rist"
      • "st2110-jpegxs"
      • "cdi"
      • "srt-listener"
    • SourceArn — (String) The ARN of the source that you want to update.
    • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • VpcInterfaceName — (String) The name of the VPC interface to use for this source.
    • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FlowArn — (String) The ARN of the flow that you want to update.
      • Source — (map) The settings for the source of the flow.
        • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
        • Decryption — (map) The type of encryption that is used on the content ingested from this source.
          • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
          • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
            • "speke"
            • "static-key"
            • "srt-password"
          • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
          • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
          • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
        • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
        • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
        • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
        • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
          • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
            • "jxsv"
            • "raw"
            • "smpte291"
            • "pcm"
          • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
            • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
            • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
            • Interface — required — (map) The VPC interface where the media stream comes in from.
              • Name — required — (String) The name of the VPC interface.
          • MediaStreamName — required — (String) The name of the media stream.
        • Name — required — (String) The name of the source.
        • SourceArn — required — (String) The ARN of the source.
        • Transport — (map) Attributes related to the transport stream that are used in the source.
          • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
          • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
          • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
          • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
            • "zixi-pull"
            • "rist"
            • "st2110-jpegxs"
            • "cdi"
            • "srt-listener"
          • RemoteId — (String) The remote ID for the Zixi-pull stream.
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
        • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
        • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given MediaConnect resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the flowActive state

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.waitFor('flowActive', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

mediaconnect.waitFor('flowActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the flowActive state by periodically calling the underlying MediaConnect.describeFlow() operation every 3 seconds (at most 40 times).

Examples:

Waiting for the flowActive state

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.waitFor('flowActive', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • FlowArn — (String) The ARN of the flow that you want to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Flow — (map) The settings for a flow, including its source, outputs, and entitlements.
        • AvailabilityZone — required — (String) The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
        • Description — (String) A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EgressIp — (String) The IP address from which video will be sent to output destinations.
        • Entitlements — required — (Array<map>) The entitlements in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the entitlement.
          • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — required — (String) The ARN of the entitlement.
          • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
            • "ENABLED"
            • "DISABLED"
          • Name — required — (String) The name of the entitlement.
          • Subscribers — required — (Array<String>) The AWS 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.
        • FlowArn — required — (String) The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
        • MediaStreams — (Array<map>) The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
          • Attributes — (map) Attributes that are related to the media stream.
            • Fmtp — required — (map) A set of parameters that define the media stream.
              • ChannelOrder — (String) The format of the audio channel.
              • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
                • "BT601"
                • "BT709"
                • "BT2020"
                • "BT2100"
                • "ST2065-1"
                • "ST2065-3"
                • "XYZ"
              • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
              • Par — (String) The pixel aspect ratio (PAR) of the video.
              • Range — (String) The encoding range of the video. Possible values include:
                • "NARROW"
                • "FULL"
                • "FULLPROTECT"
              • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
                • "progressive"
                • "interlace"
                • "progressive-segmented-frame"
              • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
                • "SDR"
                • "PQ"
                • "HLG"
                • "LINEAR"
                • "BT2100LINPQ"
                • "BT2100LINHLG"
                • "ST2065-1"
                • "ST428-1"
                • "DENSITY"
            • Lang — (String) The audio language, in a format that is recognized by the receiver.
          • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
          • Description — (String) A description that can help you quickly identify what your media stream is used for.
          • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
          • MediaStreamId — required — (Integer) A unique identifier for the media stream.
          • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
          • MediaStreamType — required — (String) The type of media stream. Possible values include:
            • "video"
            • "audio"
            • "ancillary-data"
          • VideoFormat — (String) The resolution of the video.
        • Name — required — (String) The name of the flow.
        • Outputs — required — (Array<map>) The outputs in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the output.
          • Destination — (String) The address where you want to send the output.
          • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
          • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
          • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
          • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
            • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
              • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
              • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
              • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
                • Name — required — (String) The name of the VPC interface.
              • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • EncodingParameters — (map) Encoding parameters
              • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
                • "main"
                • "high"
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the output. This value must be unique within the current flow.
          • OutputArn — required — (String) The ARN of the output.
          • Port — (Integer) The port to use when content is distributed to this output.
          • Transport — (map) Attributes related to the transport stream that are used in the output.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
            • VpcInterfaceName — (String) The name of the VPC interface to use for this output.
        • Source — required — (map) The settings for the source of the flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • SourceFailoverConfig — (map) The settings for source failover
          • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
            • "MERGE"
            • "FAILOVER"
          • RecoveryWindow — (Integer) Search window time to look for dash-7 packets
          • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
            • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
          • State — (String) Possible values include:
            • "ENABLED"
            • "DISABLED"
        • Sources — (Array<map>)
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • Status — required — (String) The current status of the flow. Possible values include:
          • "STANDBY"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "ERROR"
        • VpcInterfaces — (Array<map>) The VPC Interfaces for this flow.
          • Name — required — (String) Immutable and has to be a unique against other VpcInterfaces in this Flow
          • NetworkInterfaceIds — required — (Array<String>) IDs of the network interfaces created in customer's account by MediaConnect.
          • NetworkInterfaceType — required — (String) The type of network interface. Possible values include:
            • "ena"
            • "efa"
          • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
          • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
          • SubnetId — required — (String) Subnet must be in the AZ of the Flow
      • Messages — (map) Messages that provide the state of the flow.
        • Errors — required — (Array<String>) A list of errors that might have been generated from processes on this flow.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

mediaconnect.waitFor('flowStandby', params = {}, [callback]) ⇒ AWS.Request

Waits for the flowStandby state by periodically calling the underlying MediaConnect.describeFlow() operation every 3 seconds (at most 40 times).

Examples:

Waiting for the flowStandby state

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.waitFor('flowStandby', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • FlowArn — (String) The ARN of the flow that you want to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Flow — (map) The settings for a flow, including its source, outputs, and entitlements.
        • AvailabilityZone — required — (String) The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
        • Description — (String) A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EgressIp — (String) The IP address from which video will be sent to output destinations.
        • Entitlements — required — (Array<map>) The entitlements in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the entitlement.
          • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — required — (String) The ARN of the entitlement.
          • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
            • "ENABLED"
            • "DISABLED"
          • Name — required — (String) The name of the entitlement.
          • Subscribers — required — (Array<String>) The AWS 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.
        • FlowArn — required — (String) The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
        • MediaStreams — (Array<map>) The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
          • Attributes — (map) Attributes that are related to the media stream.
            • Fmtp — required — (map) A set of parameters that define the media stream.
              • ChannelOrder — (String) The format of the audio channel.
              • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
                • "BT601"
                • "BT709"
                • "BT2020"
                • "BT2100"
                • "ST2065-1"
                • "ST2065-3"
                • "XYZ"
              • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
              • Par — (String) The pixel aspect ratio (PAR) of the video.
              • Range — (String) The encoding range of the video. Possible values include:
                • "NARROW"
                • "FULL"
                • "FULLPROTECT"
              • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
                • "progressive"
                • "interlace"
                • "progressive-segmented-frame"
              • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
                • "SDR"
                • "PQ"
                • "HLG"
                • "LINEAR"
                • "BT2100LINPQ"
                • "BT2100LINHLG"
                • "ST2065-1"
                • "ST428-1"
                • "DENSITY"
            • Lang — (String) The audio language, in a format that is recognized by the receiver.
          • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
          • Description — (String) A description that can help you quickly identify what your media stream is used for.
          • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
          • MediaStreamId — required — (Integer) A unique identifier for the media stream.
          • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
          • MediaStreamType — required — (String) The type of media stream. Possible values include:
            • "video"
            • "audio"
            • "ancillary-data"
          • VideoFormat — (String) The resolution of the video.
        • Name — required — (String) The name of the flow.
        • Outputs — required — (Array<map>) The outputs in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the output.
          • Destination — (String) The address where you want to send the output.
          • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
          • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
          • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
          • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
            • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
              • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
              • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
              • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
                • Name — required — (String) The name of the VPC interface.
              • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • EncodingParameters — (map) Encoding parameters
              • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
                • "main"
                • "high"
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the output. This value must be unique within the current flow.
          • OutputArn — required — (String) The ARN of the output.
          • Port — (Integer) The port to use when content is distributed to this output.
          • Transport — (map) Attributes related to the transport stream that are used in the output.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
            • VpcInterfaceName — (String) The name of the VPC interface to use for this output.
        • Source — required — (map) The settings for the source of the flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • SourceFailoverConfig — (map) The settings for source failover
          • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
            • "MERGE"
            • "FAILOVER"
          • RecoveryWindow — (Integer) Search window time to look for dash-7 packets
          • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
            • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
          • State — (String) Possible values include:
            • "ENABLED"
            • "DISABLED"
        • Sources — (Array<map>)
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • Status — required — (String) The current status of the flow. Possible values include:
          • "STANDBY"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "ERROR"
        • VpcInterfaces — (Array<map>) The VPC Interfaces for this flow.
          • Name — required — (String) Immutable and has to be a unique against other VpcInterfaces in this Flow
          • NetworkInterfaceIds — required — (Array<String>) IDs of the network interfaces created in customer's account by MediaConnect.
          • NetworkInterfaceType — required — (String) The type of network interface. Possible values include:
            • "ena"
            • "efa"
          • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
          • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
          • SubnetId — required — (String) Subnet must be in the AZ of the Flow
      • Messages — (map) Messages that provide the state of the flow.
        • Errors — required — (Array<String>) A list of errors that might have been generated from processes on this flow.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

mediaconnect.waitFor('flowDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the flowDeleted state by periodically calling the underlying MediaConnect.describeFlow() operation every 3 seconds (at most 40 times).

Examples:

Waiting for the flowDeleted state

var params = {
  FlowArn: 'STRING_VALUE' /* required */
};
mediaconnect.waitFor('flowDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • FlowArn — (String) The ARN of the flow that you want to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Flow — (map) The settings for a flow, including its source, outputs, and entitlements.
        • AvailabilityZone — required — (String) The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
        • Description — (String) A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
        • EgressIp — (String) The IP address from which video will be sent to output destinations.
        • Entitlements — required — (Array<map>) The entitlements in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the entitlement.
          • Encryption — (map) The type of encryption that will be used on the output that is associated with this entitlement.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — required — (String) The ARN of the entitlement.
          • EntitlementStatus — (String) An indication of whether the entitlement is enabled. Possible values include:
            • "ENABLED"
            • "DISABLED"
          • Name — required — (String) The name of the entitlement.
          • Subscribers — required — (Array<String>) The AWS 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.
        • FlowArn — required — (String) The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
        • MediaStreams — (Array<map>) The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
          • Attributes — (map) Attributes that are related to the media stream.
            • Fmtp — required — (map) A set of parameters that define the media stream.
              • ChannelOrder — (String) The format of the audio channel.
              • Colorimetry — (String) The format that is used for the representation of color. Possible values include:
                • "BT601"
                • "BT709"
                • "BT2020"
                • "BT2100"
                • "ST2065-1"
                • "ST2065-3"
                • "XYZ"
              • ExactFramerate — (String) The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
              • Par — (String) The pixel aspect ratio (PAR) of the video.
              • Range — (String) The encoding range of the video. Possible values include:
                • "NARROW"
                • "FULL"
                • "FULLPROTECT"
              • ScanMode — (String) The type of compression that was used to smooth the video’s appearance Possible values include:
                • "progressive"
                • "interlace"
                • "progressive-segmented-frame"
              • Tcs — (String) The transfer characteristic system (TCS) that is used in the video. Possible values include:
                • "SDR"
                • "PQ"
                • "HLG"
                • "LINEAR"
                • "BT2100LINPQ"
                • "BT2100LINHLG"
                • "ST2065-1"
                • "ST428-1"
                • "DENSITY"
            • Lang — (String) The audio language, in a format that is recognized by the receiver.
          • ClockRate — (Integer) The sample rate for the stream. This value is measured in Hz.
          • Description — (String) A description that can help you quickly identify what your media stream is used for.
          • Fmt — required — (Integer) The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
          • MediaStreamId — required — (Integer) A unique identifier for the media stream.
          • MediaStreamName — required — (String) A name that helps you distinguish one media stream from another.
          • MediaStreamType — required — (String) The type of media stream. Possible values include:
            • "video"
            • "audio"
            • "ancillary-data"
          • VideoFormat — (String) The resolution of the video.
        • Name — required — (String) The name of the flow.
        • Outputs — required — (Array<map>) The outputs in this flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Description — (String) A description of the output.
          • Destination — (String) The address where you want to send the output.
          • Encryption — (map) The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
          • ListenerAddress — (String) The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
          • MediaLiveInputArn — (String) The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
          • MediaStreamOutputConfigurations — (Array<map>) The configuration for each media stream that is associated with the output.
            • DestinationConfigurations — (Array<map>) The transport parameters that are associated with each outbound media stream.
              • DestinationIp — required — (String) The IP address where contents of the media stream will be sent.
              • DestinationPort — required — (Integer) The port to use when the content of the media stream is distributed to the output.
              • Interface — required — (map) The VPC interface that is used for the media stream associated with the output.
                • Name — required — (String) The name of the VPC interface.
              • OutboundIp — required — (String) The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • EncodingParameters — (map) Encoding parameters
              • CompressionFactor — required — (Float) A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
              • EncoderProfile — required — (String) A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Possible values include:
                • "main"
                • "high"
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the output. This value must be unique within the current flow.
          • OutputArn — required — (String) The ARN of the output.
          • Port — (Integer) The port to use when content is distributed to this output.
          • Transport — (map) Attributes related to the transport stream that are used in the output.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this output.
            • VpcInterfaceName — (String) The name of the VPC interface to use for this output.
        • Source — required — (map) The settings for the source of the flow.
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • SourceFailoverConfig — (map) The settings for source failover
          • FailoverMode — (String) The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams. Possible values include:
            • "MERGE"
            • "FAILOVER"
          • RecoveryWindow — (Integer) Search window time to look for dash-7 packets
          • SourcePriority — (map) The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
            • PrimarySource — (String) The name of the source you choose as the primary source for this flow.
          • State — (String) Possible values include:
            • "ENABLED"
            • "DISABLED"
        • Sources — (Array<map>)
          • DataTransferSubscriberFeePercent — (Integer) Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
          • Decryption — (map) The type of encryption that is used on the content ingested from this source.
            • Algorithm — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
              • "aes128"
              • "aes192"
              • "aes256"
            • ConstantInitializationVector — (String) A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
            • DeviceId — (String) The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • KeyType — (String) The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Possible values include:
              • "speke"
              • "static-key"
              • "srt-password"
            • Region — (String) The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • ResourceId — (String) An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
            • RoleArn — required — (String) The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
            • SecretArn — (String) The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
            • Url — (String) The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
          • Description — (String) A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
          • EntitlementArn — (String) The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
          • IngestIp — (String) The IP address that the flow will be listening on for incoming content.
          • IngestPort — (Integer) The port that the flow will be listening on for incoming content.
          • MediaStreamSourceConfigurations — (Array<map>) The media streams that are associated with the source, and the parameters for those associations.
            • EncodingName — required — (String) The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv. Possible values include:
              • "jxsv"
              • "raw"
              • "smpte291"
              • "pcm"
            • InputConfigurations — (Array<map>) The transport parameters that are associated with an incoming media stream.
              • InputIp — required — (String) The IP address that the flow listens on for incoming content for a media stream.
              • InputPort — required — (Integer) The port that the flow listens on for an incoming media stream.
              • Interface — required — (map) The VPC interface where the media stream comes in from.
                • Name — required — (String) The name of the VPC interface.
            • MediaStreamName — required — (String) The name of the media stream.
          • Name — required — (String) The name of the source.
          • SourceArn — required — (String) The ARN of the source.
          • Transport — (map) Attributes related to the transport stream that are used in the source.
            • CidrAllowList — (Array<String>) The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
            • MaxBitrate — (Integer) The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.
            • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
            • MaxSyncBuffer — (Integer) The size of the buffer (in milliseconds) to use to sync incoming source data.
            • MinLatency — (Integer) The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
            • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
              • "zixi-push"
              • "rtp-fec"
              • "rtp"
              • "zixi-pull"
              • "rist"
              • "st2110-jpegxs"
              • "cdi"
              • "srt-listener"
            • RemoteId — (String) The remote ID for the Zixi-pull stream.
            • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
            • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
          • VpcInterfaceName — (String) The name of the VPC interface that is used for this source.
          • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
        • Status — required — (String) The current status of the flow. Possible values include:
          • "STANDBY"
          • "ACTIVE"
          • "UPDATING"
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "ERROR"
        • VpcInterfaces — (Array<map>) The VPC Interfaces for this flow.
          • Name — required — (String) Immutable and has to be a unique against other VpcInterfaces in this Flow
          • NetworkInterfaceIds — required — (Array<String>) IDs of the network interfaces created in customer's account by MediaConnect.
          • NetworkInterfaceType — required — (String) The type of network interface. Possible values include:
            • "ena"
            • "efa"
          • RoleArn — required — (String) Role Arn MediaConnect can assumes to create ENIs in customer's account
          • SecurityGroupIds — required — (Array<String>) Security Group IDs to be used on ENI.
          • SubnetId — required — (String) Subnet must be in the AZ of the Flow
      • Messages — (map) Messages that provide the state of the flow.
        • Errors — required — (Array<String>) A list of errors that might have been generated from processes on this flow.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: