Class: AWS.MediaConnect

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.MediaConnect

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.addFlowOutputs(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

Constructor Summary

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

  Constructs a service object.

Property Summary

• endpoint ⇒ AWS.Endpoint readwrite

  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

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

  Adds outputs to an existing flow.

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

  Creates a new flow.

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

  Deletes a flow.

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

  Displays the details of a flow.

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

  Grants entitlements to an existing flow.

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

  Displays a list of all entitlements that have been granted to this account.

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

  Displays a list of flows that are associated with this account.

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

  List all tags on an AWS Elemental MediaConnect resource.

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

  Removes an output from an existing flow.

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

  Revokes an entitlement from a flow.

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

  Starts a flow.

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

  Stops a flow.

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

  Associates the specified tags to a resource with the specified resourceArn.

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

  Deletes specified tags from a resource.

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

  You can change an entitlement's description, subscribers, and encryption.

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

  Updates an existing flow output.

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

  Updates the source of a flow.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, 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) —

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

• 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.

• 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
• 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) —

  whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

• 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.

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

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

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

Service Reference:

• AddFlowOutputs

Examples:

Calling the addFlowOutputs operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  Outputs: [ /* required */
    {
      Destination: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE', /* required */
      Protocol: zixi-push | rtp-fec | rtp, /* required */
      Description: 'STRING_VALUE',
      Encryption: {
        Algorithm: aes128 | aes192 | aes256, /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SecretArn: 'STRING_VALUE', /* required */
        KeyType: static-key
      },
      MaxLatency: 'NUMBER_VALUE',
      Name: 'STRING_VALUE',
      SmoothingLatency: 'NUMBER_VALUE',
      StreamId: '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.
    • 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 — required — (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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • 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:
        • "static-key"
      • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
    • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
    • Name — (String) The name of the output. This value must be unique within the current flow.
    • Port — required — (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"
    • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.

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.
      • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • 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:
          • "static-key"
        • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
      • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
      • 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.
      • 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.
        • MaxBitrate — (Integer) The smoothing max bitrate for RTP and RTP-FEC streams.
        • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
        • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
          • "zixi-push"
          • "rtp-fec"
          • "rtp"
        • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.

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 20) and entitlements (up to 50).

Service Reference:

• CreateFlow

Examples:

Calling the createFlow operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Source: { /* required */
    Decryption: {
      Algorithm: aes128 | aes192 | aes256, /* required */
      RoleArn: 'STRING_VALUE', /* required */
      SecretArn: 'STRING_VALUE', /* required */
      KeyType: static-key
    },
    Description: 'STRING_VALUE',
    EntitlementArn: 'STRING_VALUE',
    IngestPort: 'NUMBER_VALUE',
    MaxBitrate: 'NUMBER_VALUE',
    MaxLatency: 'NUMBER_VALUE',
    Name: 'STRING_VALUE',
    Protocol: zixi-push | rtp-fec | rtp,
    StreamId: 'STRING_VALUE',
    WhitelistCidr: 'STRING_VALUE'
  },
  AvailabilityZone: 'STRING_VALUE',
  Entitlements: [
    {
      Subscribers: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Description: 'STRING_VALUE',
      Encryption: {
        Algorithm: aes128 | aes192 | aes256, /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SecretArn: 'STRING_VALUE', /* required */
        KeyType: static-key
      },
      Name: 'STRING_VALUE'
    },
    /* more items */
  ],
  Outputs: [
    {
      Destination: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE', /* required */
      Protocol: zixi-push | rtp-fec | rtp, /* required */
      Description: 'STRING_VALUE',
      Encryption: {
        Algorithm: aes128 | aes192 | aes256, /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SecretArn: 'STRING_VALUE', /* required */
        KeyType: static-key
      },
      MaxLatency: 'NUMBER_VALUE',
      Name: 'STRING_VALUE',
      SmoothingLatency: 'NUMBER_VALUE',
      StreamId: 'STRING_VALUE'
    },
    /* 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.
    • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • 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:
        • "static-key"
      • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
    • 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.
  • Name — (String) The name of the flow.
  • Outputs — (Array<map>) The outputs that you want to add to this flow.
    • 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 — required — (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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • 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:
        • "static-key"
      • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
    • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
    • Name — (String) The name of the output. This value must be unique within the current flow.
    • Port — required — (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"
    • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.
  • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • 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:
        • "static-key"
      • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
    • 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 RTP and RTP-FEC streams.
    • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
    • 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"
    • StreamId — (String) The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
    • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should 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:

    • 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.
        • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • 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:
            • "static-key"
          • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
        • EntitlementArn — required — (String) The ARN of the entitlement.
        • 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.
      • Name — required — (String) The name of the flow.
      • Outputs — required — (Array<map>) The outputs in this flow.
        • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • 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:
            • "static-key"
          • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
        • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
        • 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.
        • 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.
          • MaxBitrate — (Integer) The smoothing max bitrate for RTP and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.
      • Source — required — (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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • 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:
            • "static-key"
          • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
        • 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.
        • 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.
          • MaxBitrate — (Integer) The smoothing max bitrate for RTP and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.
        • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should 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"

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:

• DeleteFlow

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:

• DescribeFlow

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.
        • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • 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:
            • "static-key"
          • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
        • EntitlementArn — required — (String) The ARN of the entitlement.
        • 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.
      • Name — required — (String) The name of the flow.
      • Outputs — required — (Array<map>) The outputs in this flow.
        • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • 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:
            • "static-key"
          • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
        • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
        • 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.
        • 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.
          • MaxBitrate — (Integer) The smoothing max bitrate for RTP and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.
      • Source — required — (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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
            • "aes128"
            • "aes192"
            • "aes256"
          • 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:
            • "static-key"
          • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
        • 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.
        • 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.
          • MaxBitrate — (Integer) The smoothing max bitrate for RTP and RTP-FEC streams.
          • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
          • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
            • "zixi-push"
            • "rtp-fec"
            • "rtp"
          • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.
        • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should 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"
    • 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.

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

Grants entitlements to an existing flow.

Service Reference:

• GrantFlowEntitlements

Examples:

Calling the grantFlowEntitlements operation

var params = {
  Entitlements: [ /* required */
    {
      Subscribers: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Description: 'STRING_VALUE',
      Encryption: {
        Algorithm: aes128 | aes192 | aes256, /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SecretArn: 'STRING_VALUE', /* required */
        KeyType: static-key
      },
      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.
    • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
        • "aes128"
        • "aes192"
        • "aes256"
      • 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:
        • "static-key"
      • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
    • 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.
      • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • 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:
          • "static-key"
        • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
      • EntitlementArn — required — (String) The ARN of the entitlement.
      • 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:

• ListEntitlements

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.
      • 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:

• ListFlows

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.

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

List all tags on an AWS Elemental MediaConnect resource

Service Reference:

• ListTagsForResource

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.

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:

• RemoveFlowOutput

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.

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:

• RevokeFlowEntitlement

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:

• StartFlow

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:

• StopFlow

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:

• TagResource

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:

• UntagResource

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.

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:

• UpdateFlowEntitlement

Examples:

Calling the updateFlowEntitlement operation

var params = {
  EntitlementArn: 'STRING_VALUE', /* required */
  FlowArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Encryption: {
    Algorithm: aes128 | aes192 | aes256,
    KeyType: static-key,
    RoleArn: 'STRING_VALUE',
    SecretArn: 'STRING_VALUE'
  },
  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"
    • 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:
      • "static-key"
    • 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 that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
  • EntitlementArn — (String) The ARN of the entitlement that you want to update.
  • 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 settings for a flow entitlement.
      • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • 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:
          • "static-key"
        • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
      • EntitlementArn — required — (String) The ARN of the entitlement.
      • 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.

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

Updates an existing flow output.

Service Reference:

• UpdateFlowOutput

Examples:

Calling the updateFlowOutput operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  OutputArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Destination: 'STRING_VALUE',
  Encryption: {
    Algorithm: aes128 | aes192 | aes256,
    KeyType: static-key,
    RoleArn: 'STRING_VALUE',
    SecretArn: 'STRING_VALUE'
  },
  MaxLatency: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  Protocol: zixi-push | rtp-fec | rtp,
  SmoothingLatency: 'NUMBER_VALUE',
  StreamId: '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: {}) —
  • 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"
    • 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:
      • "static-key"
    • 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 that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
  • 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.
  • 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"
  • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.

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 settings for an output.
      • 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 — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • 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:
          • "static-key"
        • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
      • EntitlementArn — (String) The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
      • 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.
      • 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.
        • MaxBitrate — (Integer) The smoothing max bitrate for RTP and RTP-FEC streams.
        • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
        • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
          • "zixi-push"
          • "rtp-fec"
          • "rtp"
        • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.

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:

• UpdateFlowSource

Examples:

Calling the updateFlowSource operation

var params = {
  FlowArn: 'STRING_VALUE', /* required */
  SourceArn: 'STRING_VALUE', /* required */
  Decryption: {
    Algorithm: aes128 | aes192 | aes256,
    KeyType: static-key,
    RoleArn: 'STRING_VALUE',
    SecretArn: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  EntitlementArn: 'STRING_VALUE',
  IngestPort: 'NUMBER_VALUE',
  MaxBitrate: 'NUMBER_VALUE',
  MaxLatency: 'NUMBER_VALUE',
  Protocol: zixi-push | rtp-fec | rtp,
  StreamId: '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"
    • 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:
      • "static-key"
    • 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 that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
  • 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 RTP and RTP-FEC streams.
  • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
  • Protocol — (String) The protocol that is used by the source. Possible values include:
    • "zixi-push"
    • "rtp-fec"
    • "rtp"
  • 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.
  • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should 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.
      • Decryption — (map) The type of encryption that is used on the content ingested from this source.
        • Algorithm — required — (String) The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256). Possible values include:
          • "aes128"
          • "aes192"
          • "aes256"
        • 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:
          • "static-key"
        • 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 — required — (String) The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
      • 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.
      • 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.
        • MaxBitrate — (Integer) The smoothing max bitrate for RTP and RTP-FEC streams.
        • MaxLatency — (Integer) The maximum latency in milliseconds for Zixi-based streams.
        • Protocol — required — (String) The protocol that is used by the source or output. Possible values include:
          • "zixi-push"
          • "rtp-fec"
          • "rtp"
        • SmoothingLatency — (Integer) The smoothing latency in milliseconds for 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.
      • WhitelistCidr — (String) The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should 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.