The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

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.addBridgeOutputs(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'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

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

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

Adds outputs to an existing bridge.

Service Reference:

Examples:

Calling the addBridgeOutputs operation

var params = {
  BridgeArn: 'STRING_VALUE', /* required */
  Outputs: [ /* required */
    {
      NetworkOutput: {
        IpAddress: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        NetworkName: 'STRING_VALUE', /* required */
        Port: 'NUMBER_VALUE', /* required */
        Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | srt-caller | fujitsu-qos | udp, /* required */
        Ttl: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ]
};
mediaconnect.addBridgeOutputs(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: {}) —
    • BridgeArn — (String) The ARN of the bridge that you want to update.
    • Outputs — (Array<map>) The outputs that you want to add to this bridge.
      • NetworkOutput — (map) Add a network output to an existing bridge.
        • IpAddress — required — (String) The network output IP Address.
        • Name — required — (String) The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
        • NetworkName — required — (String) The network output's gateway network name.
        • Port — required — (Integer) The network output port.
        • Protocol — required — (String) The network output protocol. Possible values include:
          • "zixi-push"
          • "rtp-fec"
          • "rtp"
          • "zixi-pull"
          • "rist"
          • "st2110-jpegxs"
          • "cdi"
          • "srt-listener"
          • "srt-caller"
          • "fujitsu-qos"
          • "udp"
        • Ttl — required — (Integer) The network output TTL.

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:

      • BridgeArn — (String) The Amazon Resource Number (ARN) of the bridge.
      • Outputs — (Array<map>) The outputs that you added to this bridge.
        • FlowOutput — (map) The output of the bridge. A flow output is delivered to the AWS cloud.
          • FlowArn — required — (String) The Amazon Resource Number (ARN) of the cloud flow.
          • FlowSourceArn — required — (String) The Amazon Resource Number (ARN) of the flow source.
          • Name — required — (String) The name of the bridge's output.
        • NetworkOutput — (map) The output of the bridge. A network output is delivered to your premises.
          • IpAddress — required — (String) The network output IP Address.
          • Name — required — (String) The network output name.
          • NetworkName — required — (String) The network output's gateway network name.
          • Port — required — (Integer) The network output port.
          • Protocol — required — (String) The network output protocol. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
            • "zixi-pull"
            • "rist"
            • "st2110-jpegxs"
            • "cdi"
            • "srt-listener"
            • "srt-caller"
            • "fujitsu-qos"
            • "udp"
          • Ttl — required — (Integer) The network output TTL.

Returns:

  • (AWS.Request) —

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

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

Adds sources to an existing bridge.

Service Reference:

Examples:

Calling the addBridgeSources operation

var params = {
  BridgeArn: 'STRING_VALUE', /* required */
  Sources: [ /* required */
    {
      FlowSource: {
        FlowArn: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        FlowVpcInterfaceAttachment: {
          VpcInterfaceName: 'STRING_VALUE'
        }
      },
      NetworkSource: {
        MulticastIp: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        NetworkName: 'STRING_VALUE', /* required */
        Port: 'NUMBER_VALUE', /* required */
        Protocol: zixi-push | rtp-fec | rtp | zixi-pull | rist | st2110-jpegxs | cdi | srt-listener | srt-caller | fujitsu-qos | udp /* required */
      }
    },
    /* more items */
  ]
};
mediaconnect.addBridgeSources(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: {}) —
    • BridgeArn — (String) The ARN of the bridge that you want to update.
    • Sources — (Array<map>) The sources that you want to add to this bridge.
      • FlowSource — (map) Add a flow source to an existing bridge.
        • FlowArn — required — (String) The Amazon Resource Number (ARN) of the cloud flow to use as a source of this bridge.
        • FlowVpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this source.
          • VpcInterfaceName — (String) The name of the VPC interface to use for this resource.
        • Name — required — (String) The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
      • NetworkSource — (map) Add a network source to an existing bridge.
        • MulticastIp — required — (String) The network source multicast IP.
        • Name — required — (String) The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
        • NetworkName — required — (String) The network source's gateway network name.
        • Port — required — (Integer) The network source port.
        • Protocol — required — (String) The network source protocol. Possible values include:
          • "zixi-push"
          • "rtp-fec"
          • "rtp"
          • "zixi-pull"
          • "rist"
          • "st2110-jpegxs"
          • "cdi"
          • "srt-listener"
          • "srt-caller"
          • "fujitsu-qos"
          • "udp"

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:

      • BridgeArn — (String) The Amazon Resource Number (ARN) of the bridge.
      • Sources — (Array<map>) The sources that you added to this bridge.
        • FlowSource — (map) The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
          • FlowArn — required — (String) The ARN of the cloud flow used as a source of this bridge.
          • FlowVpcInterfaceAttachment — (map) The name of the VPC interface attachment to use for this source.
            • VpcInterfaceName — (String) The name of the VPC interface to use for this resource.
          • Name — required — (String) The name of the flow source.
          • OutputArn — (String) The Amazon Resource Number (ARN) of the output.
        • NetworkSource — (map) The source of the bridge. A network source originates at your premises.
          • MulticastIp — required — (String) The network source multicast IP.
          • Name — required — (String) The name of the network source.
          • NetworkName — required — (String) The network source's gateway network name.
          • Port — required — (Integer) The network source port.
          • Protocol — required — (String) The network source protocol. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
            • "zixi-pull"
            • "rist"
            • "st2110-jpegxs"
            • "cdi"
            • "srt-listener"
            • "srt-caller"
            • "fujitsu-qos"
            • "udp"

Returns:

  • (AWS.Request) —

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

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 | srt-caller | fujitsu-qos | udp, /* 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',
      OutputStatus: ENABLED | DISABLED,
      Port: 'NUMBER_VALUE',
      RemoteId: 'STRING_VALUE',
      SenderControlPort: 'NUMBER_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). Allowable encryption types: 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. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-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"
        • "srt-caller"
        • "fujitsu-qos"
        • "udp"
      • RemoteId — (String) The remote ID for the Zixi-pull output stream.
      • SenderControlPort — (Integer) The port that the flow uses to send outbound requests to initiate connection with the sender.
      • 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 and SRT caller-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 resource.
      • OutputStatus — (String) An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED. 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:

      • 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 (in bps) for RIST, RTP, and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-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"
            • "srt-caller"
            • "fujitsu-qos"
            • "udp"
          • RemoteId — (String) The remote ID for the Zixi-pull stream.
          • SenderControlPort — (Integer) The port that the flow uses to send outbound requests to initiate connection with the sender.
          • SenderIpAddress — (String) The IP address that the flow communicates with to initiate connection with the sender.
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
          • SourceListenerAddress — (String) Source IP or domain name for SRT-caller protocol.
          • SourceListenerPort — (Integer) Source port for SRT-caller protocol.
          • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-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 resource.
        • BridgeArn — (String) The ARN of the bridge that added this output.
        • BridgePorts — (Array<Integer>) The bridge output ports currently in use.
        • OutputStatus — (String) An indication of whether the output is transmitting data or not. Possible values include:
          • "ENABLED"
          • "DISABLED"

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',
      GatewayBridgeSource: {
        BridgeArn: 'STRING_VALUE', /* required */
        VpcInterfaceAttachment: {
          VpcInterfaceName: '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 | srt-caller | fujitsu-qos | udp,
      SenderControlPort: 'NUMBER_VALUE',
      SenderIpAddress: 'STRING_VALUE',
      SourceListenerAddress: 'STRING_VALUE',
      SourceListenerPort: 'NUMBER_VALUE',
      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. Allowable encryption types: 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.
      • 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 (in bps) for RIST, RTP, and RTP-FEC streams.
      • MaxLatency — (Integer) The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-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"
        • "srt-caller"
        • "fujitsu-qos"
        • "udp"
      • SenderControlPort — (Integer) The port that the flow uses to send outbound requests to initiate connection with the sender.
      • SenderIpAddress — (String) The IP address that the flow communicates with to initiate connection with the sender.
      • SourceListenerAddress — (String) Source IP or domain name for SRT-caller protocol.
      • SourceListenerPort — (