Add a network output to an existing bridge.
* @public */ export interface AddBridgeNetworkOutputRequest { /** *The network output IP Address.
* @public */ IpAddress: string | undefined; /** *The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
* @public */ Name: string | undefined; /** *The network output's gateway network name.
* @public */ NetworkName: string | undefined; /** *The network output port.
* @public */ Port: number | undefined; /** *The network output protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The network output TTL.
* @public */ Ttl: number | undefined; } /** *Add outputs to the specified bridge.
* @public */ export interface AddBridgeOutputRequest { /** *The network output of the bridge. A network output is delivered to your premises.
* @public */ NetworkOutput?: AddBridgeNetworkOutputRequest | undefined; } /** *The settings for attaching a VPC interface to an resource.
* @public */ export interface VpcInterfaceAttachment { /** *The name of the VPC interface to use for this resource.
* @public */ VpcInterfaceName?: string | undefined; } /** *Add a flow source to an existing bridge.
* @public */ export interface AddBridgeFlowSourceRequest { /** *The Amazon Resource Number (ARN) of the flow to use as a source of this bridge.
* @public */ FlowArn: string | undefined; /** *The name of the VPC interface attachment to use for this source.
* @public */ FlowVpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; /** *The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
* @public */ Name: string | undefined; } /** *The settings related to the multicast source.
* @public */ export interface MulticastSourceSettings { /** *The IP address of the source for source-specific multicast (SSM).
* @public */ MulticastSourceIp?: string | undefined; } /** *Add a network source to an existing bridge.
* @public */ export interface AddBridgeNetworkSourceRequest { /** *The network source multicast IP.
* @public */ MulticastIp: string | undefined; /** *The settings related to the multicast source.
* @public */ MulticastSourceSettings?: MulticastSourceSettings | undefined; /** *The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
* @public */ Name: string | undefined; /** *The network source's gateway network name.
* @public */ NetworkName: string | undefined; /** *The network source port.
* @public */ Port: number | undefined; /** *The network source protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
Add an output to a bridge.
* @public */ export interface AddBridgeSourceRequest { /** *The source of the flow.
* @public */ FlowSource?: AddBridgeFlowSourceRequest | undefined; /** *The source of the network.
* @public */ NetworkSource?: AddBridgeNetworkSourceRequest | undefined; } /** *The settings that you want to use to define the media stream.
* @public */ export interface FmtpRequest { /** *The format of the audio channel.
* @public */ ChannelOrder?: string | undefined; /** *The format that is used for the representation of color.
* @public */ Colorimetry?: Colorimetry | undefined; /** * 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.
The pixel aspect ratio (PAR) of the video.
* @public */ Par?: string | undefined; /** *The encoding range of the video.
* @public */ Range?: Range | undefined; /** *The type of compression that was used to smooth the video’s appearance.
* @public */ ScanMode?: ScanMode | undefined; /** *The transfer characteristic system (TCS) that is used in the video.
* @public */ Tcs?: Tcs | undefined; } /** *Attributes that are related to the media stream.
* @public */ export interface MediaStreamAttributesRequest { /** *The settings that you want to use to define the media stream.
* @public */ Fmtp?: FmtpRequest | undefined; /** *The audio language, in a format that is recognized by the receiver.
* @public */ Lang?: string | undefined; } /** *The media stream that you want to add to the flow.
* @public */ export interface AddMediaStreamRequest { /** *The attributes that you want to assign to the new media stream.
* @public */ Attributes?: MediaStreamAttributesRequest | undefined; /** *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.
* @public */ ClockRate?: number | undefined; /** *A description that can help you quickly identify what your media stream is used for.
* @public */ Description?: string | undefined; /** *A unique identifier for the media stream.
* @public */ MediaStreamId: number | undefined; /** *A name that helps you distinguish one media stream from another.
* @public */ MediaStreamName: string | undefined; /** *The type of media stream.
* @public */ MediaStreamType: MediaStreamType | undefined; /** *The resolution of the video.
* @public */ VideoFormat?: string | undefined; /** *The key-value pairs that can be used to tag and organize the media stream.
* @public */ MediaStreamTags?: RecordEncryption information.
* @public */ export interface Encryption { /** *The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
* @public */ Algorithm?: Algorithm | undefined; /** *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.
* @public */ ConstantInitializationVector?: string | undefined; /** *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.
* @public */ DeviceId?: string | undefined; /** *The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
* @public */ KeyType?: KeyType | undefined; /** *The Amazon Web Services 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.
* @public */ Region?: string | undefined; /** *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.
* @public */ ResourceId?: string | undefined; /** *The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
* @public */ RoleArn: string | undefined; /** *The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
* @public */ SecretArn?: string | undefined; /** *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.
* @public */ Url?: string | undefined; } /** *The VPC interface that you want to designate where the media stream is coming from or going to.
* @public */ export interface InterfaceRequest { /** *The name of the VPC interface.
* @public */ Name: string | undefined; } /** *The definition of a media stream that you want to associate with the output.
* @public */ export interface DestinationConfigurationRequest { /** *The IP address where you want MediaConnect to send contents of the media stream.
* @public */ DestinationIp: string | undefined; /** *The port that you want MediaConnect to use when it distributes the media stream to the output.
* @public */ DestinationPort: number | undefined; /** *The VPC interface that you want to use for the media stream associated with the output.
* @public */ Interface: InterfaceRequest | undefined; } /** *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.
* @public */ export interface EncodingParametersRequest { /** *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.
* @public */ CompressionFactor: number | undefined; /** *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.
* @public */ EncoderProfile: EncoderProfile | undefined; } /** *The media stream that you want to associate with the output, and the parameters for that association.
* @public */ export interface MediaStreamOutputConfigurationRequest { /** *The media streams that you want to associate with the output.
* @public */ DestinationConfigurations?: DestinationConfigurationRequest[] | undefined; /** *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.
* @public */ EncodingName: EncodingName | undefined; /** *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.
* @public */ EncodingParameters?: EncodingParametersRequest | undefined; /** *The name of the media stream that is associated with the output.
* @public */ MediaStreamName: string | undefined; } /** *Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
* @public */ export interface AutomaticEncryptionKeyConfiguration { } /** *The configuration settings for transit encryption using Secrets Manager, including the secret ARN and role ARN.
* @public */ export interface SecretsManagerEncryptionKeyConfiguration { /** *The ARN of the Secrets Manager secret used for transit encryption.
* @public */ SecretArn: string | undefined; /** *The ARN of the IAM role assumed by MediaConnect to access the Secrets Manager secret.
* @public */ RoleArn: string | undefined; } /** *Configuration settings for flow transit encryption keys.
* @public */ export type FlowTransitEncryptionKeyConfiguration = FlowTransitEncryptionKeyConfiguration.AutomaticMember | FlowTransitEncryptionKeyConfiguration.SecretsManagerMember | FlowTransitEncryptionKeyConfiguration.$UnknownMember; /** * @public */ export declare namespace FlowTransitEncryptionKeyConfiguration { /** *The configuration settings for transit encryption using Secrets Manager, including the secret ARN and role ARN.
* @public */ interface SecretsManagerMember { SecretsManager: SecretsManagerEncryptionKeyConfiguration; Automatic?: never; $unknown?: never; } /** *Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
* @public */ interface AutomaticMember { SecretsManager?: never; Automatic: AutomaticEncryptionKeyConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { SecretsManager?: never; Automatic?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
* @public */ export interface FlowTransitEncryption { /** *The type of encryption key to use for flow transit encryption.
* @public */ EncryptionKeyType?: FlowTransitEncryptionKeyType | undefined; /** *The configuration details for the encryption key.
* @public */ EncryptionKeyConfiguration: FlowTransitEncryptionKeyConfiguration | undefined; } /** *A request to add an output to a flow.
* @public */ export interface AddOutputRequest { /** *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.
* @public */ CidrAllowList?: string[] | undefined; /** *A description of the output. This description appears only on the Audit Manager console and will not be seen by the end user.
* @public */ Description?: string | undefined; /** *The IP address from which video will be sent to output destinations.
* @public */ Destination?: string | undefined; /** *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.
* @public */ Encryption?: Encryption | undefined; /** *The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
* @public */ MaxLatency?: number | undefined; /** *The media streams that are associated with the output, and the parameters for those associations.
* @public */ MediaStreamOutputConfigurations?: MediaStreamOutputConfigurationRequest[] | undefined; /** *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.
* @public */ MinLatency?: number | undefined; /** *The name of the output. This value must be unique within the current flow.
* @public */ Name?: string | undefined; /** *The port to use when content is distributed to this output.
* @public */ Port?: number | undefined; /** *The protocol to use for the output.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The remote ID for the Zixi-pull output stream.
* @public */ RemoteId?: string | undefined; /** *The port that the flow uses to send outbound requests to initiate connection with the sender.
* @public */ SenderControlPort?: number | undefined; /** *The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
* @public */ SmoothingLatency?: number | undefined; /** *The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
* @public */ StreamId?: string | undefined; /** *The name of the VPC interface attachment to use for this output.
* @public */ VpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; /** *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.
* @public */ OutputStatus?: OutputStatus | undefined; /** *A quality setting for the NDI Speed HQ encoder.
* @public */ NdiSpeedHqQuality?: number | undefined; /** *A suffix for the name of the NDI® sender that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
* @public */ NdiProgramName?: string | undefined; /** *The key-value pairs that can be used to tag and organize the output.
* @public */ OutputTags?: RecordIndicates whether to enable or disable router integration when creating a new flow output.
* @public */ RouterIntegrationState?: State | undefined; /** *The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
* @public */ RouterIntegrationTransitEncryption?: FlowTransitEncryption | undefined; } /** *Configures settings for the SilentAudio metric.
Indicates whether the SilentAudio metric is enabled or disabled.
Specifies the number of consecutive seconds of silence that triggers an event or alert.
* @public */ ThresholdSeconds?: number | undefined; } /** *Specifies the configuration for audio stream metrics monitoring.
* @public */ export interface AudioMonitoringSetting { /** *Detects periods of silence.
* @public */ SilentAudio?: SilentAudio | undefined; } /** *The output of the bridge. A flow output is delivered to the Amazon Web Services cloud.
* @public */ export interface BridgeFlowOutput { /** *The Amazon Resource Number (ARN) of the cloud flow.
* @public */ FlowArn: string | undefined; /** *The Amazon Resource Number (ARN) of the flow source.
* @public */ FlowSourceArn: string | undefined; /** *The name of the bridge's output.
* @public */ Name: string | undefined; } /** *The output of the bridge. A network output is delivered to your premises.
* @public */ export interface BridgeNetworkOutput { /** *The network output IP address.
* @public */ IpAddress: string | undefined; /** *The network output name.
* @public */ Name: string | undefined; /** *The network output's gateway network name.
* @public */ NetworkName: string | undefined; /** *The network output's port.
* @public */ Port: number | undefined; /** *The network output protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The network output TTL.
* @public */ Ttl: number | undefined; } /** *The output of the bridge.
* @public */ export interface BridgeOutput { /** *The output of the associated flow.
* @public */ FlowOutput?: BridgeFlowOutput | undefined; /** *The network output for the bridge.
* @public */ NetworkOutput?: BridgeNetworkOutput | undefined; } /** *The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
* @public */ export interface BridgeFlowSource { /** *The ARN of the cloud flow used as a source of this bridge.
* @public */ FlowArn: string | undefined; /** *The name of the VPC interface attachment to use for this source.
* @public */ FlowVpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; /** *The name of the flow source.
* @public */ Name: string | undefined; /** *The Amazon Resource Number (ARN) of the output.
* @public */ OutputArn?: string | undefined; } /** *The source of the bridge. A network source originates at your premises.
* @public */ export interface BridgeNetworkSource { /** *The network source multicast IP.
* @public */ MulticastIp: string | undefined; /** *The settings related to the multicast source.
* @public */ MulticastSourceSettings?: MulticastSourceSettings | undefined; /** *The name of the network source.
* @public */ Name: string | undefined; /** *The network source's gateway network name.
* @public */ NetworkName: string | undefined; /** *The network source port.
* @public */ Port: number | undefined; /** *The network source protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The bridge's source.
* @public */ export interface BridgeSource { /** *The source of the associated flow.
* @public */ FlowSource?: BridgeFlowSource | undefined; /** *The network source for the bridge.
* @public */ NetworkSource?: BridgeNetworkSource | undefined; } /** *The VPC interface that is used for the media stream associated with the source or output.
* @public */ export interface Interface { /** *The name of the VPC interface.
* @public */ Name: string | undefined; } /** *The transport parameters that you want to associate with an outbound media stream.
* @public */ export interface DestinationConfiguration { /** *The IP address where you want MediaConnect to send contents of the media stream.
* @public */ DestinationIp: string | undefined; /** *The port that you want MediaConnect to use when it distributes the media stream to the output.
* @public */ DestinationPort: number | undefined; /** *The VPC interface that you want to use for the media stream associated with the output.
* @public */ Interface: Interface | undefined; /** *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 or protocol.
* @public */ OutboundIp: string | undefined; } /** *The settings for a flow entitlement.
* @public */ export interface Entitlement { /** *Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
* @public */ DataTransferSubscriberFeePercent?: number | undefined; /** *A description of the entitlement.
* @public */ Description?: string | undefined; /** *The type of encryption that will be used on the output that is associated with this entitlement.
* @public */ Encryption?: Encryption | undefined; /** *The ARN of the entitlement.
* @public */ EntitlementArn: string | undefined; /** *An indication of whether the entitlement is enabled.
* @public */ EntitlementStatus?: EntitlementStatus | undefined; /** *The name of the entitlement.
* @public */ Name: string | undefined; /** *The Amazon Web Services 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.
* @public */ Subscribers: string[] | undefined; } /** *The network settings for a gateway.
* @public */ export interface GatewayNetwork { /** *A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
* @public */ CidrBlock: string | undefined; /** *The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
* @public */ Name: string | undefined; } /** *The entitlements that you want to grant on a flow.
* @public */ export interface GrantEntitlementRequest { /** *Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
* @public */ DataTransferSubscriberFeePercent?: number | undefined; /** *A description of the entitlement. This description appears only on the MediaConnect console and will not be seen by the subscriber or end user.
* @public */ Description?: string | undefined; /** *The type of encryption that will be used on the output that is associated with this entitlement. Allowable encryption types: static-key, speke.
* @public */ Encryption?: Encryption | undefined; /** *An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
* @public */ EntitlementStatus?: EntitlementStatus | undefined; /** *The name of the entitlement. This value must be unique within the current flow.
* @public */ Name?: string | undefined; /** *The Amazon Web Services 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.
* @public */ Subscribers: string[] | undefined; /** *The key-value pairs that can be used to tag and organize the entitlement.
* @public */ EntitlementTags?: RecordThe transport parameters that are associated with an incoming media stream.
* @public */ export interface InputConfiguration { /** *The IP address that the flow listens on for incoming content for a media stream.
* @public */ InputIp: string | undefined; /** *The port that the flow listens on for an incoming media stream.
* @public */ InputPort: number | undefined; /** *The VPC interface where the media stream comes in from.
* @public */ Interface: Interface | undefined; } /** *The transport parameters that you want to associate with an incoming media stream.
* @public */ export interface InputConfigurationRequest { /** *The port that you want the flow to listen on for an incoming media stream.
* @public */ InputPort: number | undefined; /** *The VPC interface that you want to use for the incoming media stream.
* @public */ Interface: InterfaceRequest | undefined; } /** *Displays details of the selected bridge.
* @public */ export interface ListedBridge { /** *The ARN of the bridge.
* @public */ BridgeArn: string | undefined; /** *The state of the bridge.
* @public */ BridgeState: BridgeState | undefined; /** *The type of the bridge.
* @public */ BridgeType: string | undefined; /** *The name of the bridge.
* @public */ Name: string | undefined; /** *The ARN of the gateway associated with the bridge.
* @public */ PlacementArn: string | undefined; } /** *An entitlement that has been granted to you from other Amazon Web Services accounts.
* @public */ export interface ListedEntitlement { /** *Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
* @public */ DataTransferSubscriberFeePercent?: number | undefined; /** *The ARN of the entitlement.
* @public */ EntitlementArn: string | undefined; /** *The name of the entitlement.
* @public */ EntitlementName: string | undefined; } /** *The maintenance setting of a flow.
* @public */ export interface Maintenance { /** *A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
* @public */ MaintenanceDay?: MaintenanceDay | undefined; /** *The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
* @public */ MaintenanceDeadline?: string | undefined; /** *A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
* @public */ MaintenanceScheduledDate?: string | undefined; /** *UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
* @public */ MaintenanceStartHour?: string | undefined; } /** *A summary of a flow, including its ARN, Availability Zone, and source type.
* @public */ export interface ListedFlow { /** *The Availability Zone that the flow was created in.
* @public */ AvailabilityZone: string | undefined; /** *A description of the flow.
* @public */ Description: string | undefined; /** *The ARN of the flow.
* @public */ FlowArn: string | undefined; /** *The name of the flow.
* @public */ Name: string | undefined; /** *The type of source. This value is either owned (originated somewhere other than an MediaConnect flow owned by another Amazon Web Services account) or entitled (originated at a MediaConnect flow owned by another Amazon Web Services account).
* @public */ SourceType: SourceType | undefined; /** *The current status of the flow.
* @public */ Status: Status | undefined; /** *The maintenance settings for the flow.
* @public */ Maintenance?: Maintenance | undefined; } /** *A summary of a gateway, including its name, ARN, and status.
* @public */ export interface ListedGateway { /** *The Amazon Resource Name (ARN) of the gateway.
* @public */ GatewayArn: string | undefined; /** *The status of the gateway.
* @public */ GatewayState: GatewayState | undefined; /** *The name of the gateway.
* @public */ Name: string | undefined; } /** *A summary of an instance.
* @public */ export interface ListedGatewayInstance { /** *The Amazon Resource Name (ARN) of the gateway.
* @public */ GatewayArn: string | undefined; /** *The Amazon Resource Name (ARN) of the instance.
* @public */ GatewayInstanceArn: string | undefined; /** *The managed instance ID generated by the SSM install. This will begin with "mi-".
* @public */ InstanceId: string | undefined; /** *The status of the instance.
* @public */ InstanceState?: InstanceState | undefined; } /** *A set of parameters that define the media stream.
* @public */ export interface Fmtp { /** *The format of the audio channel.
* @public */ ChannelOrder?: string | undefined; /** *The format used for the representation of color.
* @public */ Colorimetry?: Colorimetry | undefined; /** *The frame rate for the video stream, in frames/second. For example: 60000/1001.
* @public */ ExactFramerate?: string | undefined; /** *The pixel aspect ratio (PAR) of the video.
* @public */ Par?: string | undefined; /** *The encoding range of the video.
* @public */ Range?: Range | undefined; /** *The type of compression that was used to smooth the video’s appearance.
* @public */ ScanMode?: ScanMode | undefined; /** *The transfer characteristic system (TCS) that is used in the video.
* @public */ Tcs?: Tcs | undefined; } /** *Attributes that are related to the media stream.
* @public */ export interface MediaStreamAttributes { /** *The settings that you want to use to define the media stream.
* @public */ Fmtp: Fmtp | undefined; /** *The audio language, in a format that is recognized by the receiver.
* @public */ Lang?: string | undefined; } /** *A media stream represents one component of your content, such as video, audio, or ancillary data. After you add a media stream to your flow, you can associate it with sources and outputs that use the ST 2110 JPEG XS or CDI protocol.
* @public */ export interface MediaStream { /** *Attributes that are related to the media stream.
* @public */ Attributes?: MediaStreamAttributes | undefined; /** *The sample rate for the stream. This value is measured in Hz.
* @public */ ClockRate?: number | undefined; /** *A description that can help you quickly identify what your media stream is used for.
* @public */ Description?: string | undefined; /** *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.
* @public */ Fmt: number | undefined; /** *A unique identifier for the media stream.
* @public */ MediaStreamId: number | undefined; /** *A name that helps you distinguish one media stream from another.
* @public */ MediaStreamName: string | undefined; /** *The type of media stream.
* @public */ MediaStreamType: MediaStreamType | undefined; /** *The resolution of the video.
* @public */ VideoFormat?: string | undefined; } /** *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.
* @public */ export interface EncodingParameters { /** *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.
* @public */ CompressionFactor: number | undefined; /** *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.
* @public */ EncoderProfile: EncoderProfile | undefined; } /** *The media stream that is associated with the output, and the parameters for that association.
* @public */ export interface MediaStreamOutputConfiguration { /** *The transport parameters that are associated with each outbound media stream.
* @public */ DestinationConfigurations?: DestinationConfiguration[] | undefined; /** *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.
* @public */ EncodingName: EncodingName | undefined; /** *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.
* @public */ EncodingParameters?: EncodingParameters | undefined; /** *The name of the media stream.
* @public */ MediaStreamName: string | undefined; } /** *The media stream that is associated with the source, and the parameters for that association.
* @public */ export interface MediaStreamSourceConfiguration { /** *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.
* @public */ EncodingName: EncodingName | undefined; /** *The media streams that you want to associate with the source.
* @public */ InputConfigurations?: InputConfiguration[] | undefined; /** *A name that helps you distinguish one media stream from another.
* @public */ MediaStreamName: string | undefined; } /** *The media stream that you want to associate with the source, and the parameters for that association.
* @public */ export interface MediaStreamSourceConfigurationRequest { /** *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.
* @public */ EncodingName: EncodingName | undefined; /** *The media streams that you want to associate with the source.
* @public */ InputConfigurations?: InputConfigurationRequest[] | undefined; /** *The name of the media stream.
* @public */ MediaStreamName: string | undefined; } /** *The details of an error message.
* @public */ export interface MessageDetail { /** *The error code.
* @public */ Code: string | undefined; /** *The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
* @public */ Message: string | undefined; /** *The name of the resource.
* @public */ ResourceName?: string | undefined; } /** *Specifies the configuration settings for individual NDI® discovery servers. A maximum of 3 servers is allowed.
* @public */ export interface NdiDiscoveryServerConfig { /** *The unique network address of the NDI discovery server.
* @public */ DiscoveryServerAddress: string | undefined; /** *The port for the NDI discovery server. Defaults to 5959 if a custom port isn't specified.
* @public */ DiscoveryServerPort?: number | undefined; /** *The identifier for the Virtual Private Cloud (VPC) network interface used by the flow.
* @public */ VpcInterfaceAdapter: string | undefined; } /** *The frame resolution used by the video stream.
* @public */ export interface FrameResolution { /** *The number of pixels in the height of the video frame.
* @public */ FrameHeight: number | undefined; /** *The number of pixels in the width of the video frame.
* @public */ FrameWidth: number | undefined; } /** *Detailed information about a single media stream that is part of an NDI® source. This includes details about the stream type, codec, resolution, frame rate, audio channels, and sample rate.
* @public */ export interface NdiMediaStreamInfo { /** * The type of media stream (for example, Video or Audio).
The codec used for the media stream. For NDI sources, use speed-hq.
A unique identifier for the media stream.
* @public */ StreamId: number | undefined; /** * The method used to display video frames. Used when the streamType is Video.
The width and height dimensions of the video frame in pixels. Used when the streamType is Video.
The number of video frames displayed per second. Used when the streamType is Video.
The number of audio channels in the stream. Used when the streamType is Audio.
The number of audio samples captured per second, measured in kilohertz (kHz). Used when the streamType is Audio.
Information about a single NDI® sender, including its name.
* @public */ export interface NdiSourceInfo { /** *The name of the upstream NDI sender.
* @public */ SourceName: string | undefined; } /** *A definition of what is being billed for, including the type and amount.
* @public */ export interface ResourceSpecification { /** *The amount of outbound bandwidth that is discounted in the offering.
* @public */ ReservedBitrate?: number | undefined; /** *The type of resource and the unit that is being billed for.
* @public */ ResourceType: ResourceType | undefined; } /** *A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
* @public */ export interface Offering { /** *The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
* @public */ CurrencyCode: string | undefined; /** *The length of time that your reservation would be active.
* @public */ Duration: number | undefined; /** *The unit of measurement for the duration of the offering.
* @public */ DurationUnits: DurationUnits | undefined; /** *The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
* @public */ OfferingArn: string | undefined; /** *A description of the offering.
* @public */ OfferingDescription: string | undefined; /** *The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
* @public */ PricePerUnit: string | undefined; /** *The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
* @public */ PriceUnits: PriceUnits | undefined; /** *A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
* @public */ ResourceSpecification: ResourceSpecification | undefined; } /** *The settings for the NDI® source. This includes the exact name of the upstream NDI sender that you want to connect to your source.
* @public */ export interface NdiSourceSettings { /** * The exact name of an existing NDI sender that's registered with your discovery server. If included, the format of this name must be MACHINENAME (ProgramName).
Attributes related to the transport stream that are used in a source or output.
* @public */ export interface Transport { /** *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
* @public */ CidrAllowList?: string[] | undefined; /** *The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
* @public */ MaxBitrate?: number | undefined; /** *The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
* @public */ MaxLatency?: number | undefined; /** *The size of the buffer (in milliseconds) to use to sync incoming source data.
* @public */ MaxSyncBuffer?: number | undefined; /** *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.
* @public */ MinLatency?: number | undefined; /** *The protocol that is used by the source or output.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The remote ID for the Zixi-pull stream.
* @public */ RemoteId?: string | undefined; /** *The port that the flow uses to send outbound requests to initiate connection with the sender.
* @public */ SenderControlPort?: number | undefined; /** *The IP address that the flow communicates with to initiate connection with the sender.
* @public */ SenderIpAddress?: string | undefined; /** *The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
* @public */ SmoothingLatency?: number | undefined; /** *Source IP or domain name for SRT-caller protocol.
* @public */ SourceListenerAddress?: string | undefined; /** *Source port for SRT-caller protocol.
* @public */ SourceListenerPort?: number | undefined; /** *The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
* @public */ StreamId?: string | undefined; /** *A quality setting for the NDI Speed HQ encoder.
* @public */ NdiSpeedHqQuality?: number | undefined; /** *A suffix for the name of the NDI® sender that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
* @public */ NdiProgramName?: string | undefined; /** *The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source.
* @public */ NdiSourceSettings?: NdiSourceSettings | undefined; } /** *The settings for an output.
* @public */ export interface Output { /** *Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
* @public */ DataTransferSubscriberFeePercent?: number | undefined; /** *A description of the output.
* @public */ Description?: string | undefined; /** *The address where you want to send the output.
* @public */ Destination?: string | undefined; /** *The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
* @public */ Encryption?: Encryption | undefined; /** *The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
* @public */ EntitlementArn?: string | undefined; /** *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.
* @public */ ListenerAddress?: string | undefined; /** *The input ARN of the MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
* @public */ MediaLiveInputArn?: string | undefined; /** *The configuration for each media stream that is associated with the output.
* @public */ MediaStreamOutputConfigurations?: MediaStreamOutputConfiguration[] | undefined; /** *The name of the output. This value must be unique within the current flow.
* @public */ Name: string | undefined; /** *The ARN of the output.
* @public */ OutputArn: string | undefined; /** *The port to use when content is distributed to this output.
* @public */ Port?: number | undefined; /** *Attributes related to the transport stream that are used in the output.
* @public */ Transport?: Transport | undefined; /** *The name of the VPC interface attachment to use for this output.
* @public */ VpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; /** *The ARN of the bridge added to this output.
* @public */ BridgeArn?: string | undefined; /** *The bridge output ports currently in use.
* @public */ BridgePorts?: number[] | undefined; /** *An indication of whether the output is transmitting data or not.
* @public */ OutputStatus?: OutputStatus | undefined; /** *The IP address of the device that is currently receiving content from this output.
For outputs that use protocols where you specify the destination (such as SRT Caller or Zixi Push), this value matches the configured destination address.
For outputs that use listener protocols (such as SRT Listener), this value shows the address of the connected receiver.
Peer IP addresses aren't available for entitlements, managed MediaLive outputs, NDI® sources and outputs, and CDI/ST2110 outputs.
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
Indicates if router integration is enabled or disabled on the flow output.
* @public */ RouterIntegrationState?: State | undefined; /** *The encryption configuration for the output when router integration is enabled.
* @public */ RouterIntegrationTransitEncryption?: FlowTransitEncryption | undefined; /** *The ARN of the router input that's connected to this flow output.
* @public */ ConnectedRouterInputArn?: string | undefined; } /** *A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
* @public */ export interface Reservation { /** *The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
* @public */ CurrencyCode: string | undefined; /** *The length of time that this reservation is active. MediaConnect defines this value in the offering.
* @public */ Duration: number | undefined; /** *The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
* @public */ DurationUnits: DurationUnits | undefined; /** *The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
* @public */ End: string | undefined; /** *The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
* @public */ OfferingArn: string | undefined; /** *A description of the offering. MediaConnect defines this value in the offering.
* @public */ OfferingDescription: string | undefined; /** *The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
* @public */ PricePerUnit: string | undefined; /** *The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
* @public */ PriceUnits: PriceUnits | undefined; /** *The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
* @public */ ReservationArn: string | undefined; /** *The name that you assigned to the reservation when you purchased the offering.
* @public */ ReservationName: string | undefined; /** *The status of your reservation.
* @public */ ReservationState: ReservationState | undefined; /** *A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
* @public */ ResourceSpecification: ResourceSpecification | undefined; /** *The day and time that the reservation becomes active. You set this value when you purchase the offering.
* @public */ Start: string | undefined; } /** *The source configuration for cloud flows receiving a stream from a bridge.
* @public */ export interface SetGatewayBridgeSourceRequest { /** *The ARN of the bridge feeding this flow.
* @public */ BridgeArn: string | undefined; /** *The name of the VPC interface attachment to use for this bridge source.
* @public */ VpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; } /** *The settings for the source of the flow.
* @public */ export interface SetSourceRequest { /** *The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
* @public */ Decryption?: Encryption | undefined; /** *A description for the source. This value is not used or seen outside of the current MediaConnect account.
* @public */ Description?: string | undefined; /** *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.
* @public */ EntitlementArn?: string | undefined; /** *The port that the flow will be listening on for incoming content.
* @public */ IngestPort?: number | undefined; /** *The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
* @public */ MaxBitrate?: number | undefined; /** *The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
* @public */ MaxLatency?: number | undefined; /** *The size of the buffer (in milliseconds) to use to sync incoming source data.
* @public */ MaxSyncBuffer?: number | undefined; /** *The media streams that are associated with the source, and the parameters for those associations.
* @public */ MediaStreamSourceConfigurations?: MediaStreamSourceConfigurationRequest[] | undefined; /** *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.
* @public */ MinLatency?: number | undefined; /** *The name of the source.
* @public */ Name?: string | undefined; /** *The protocol that is used by the source.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The port that the flow uses to send outbound requests to initiate connection with the sender.
* @public */ SenderControlPort?: number | undefined; /** *The IP address that the flow communicates with to initiate connection with the sender.
* @public */ SenderIpAddress?: string | undefined; /** *Source IP or domain name for SRT-caller protocol.
* @public */ SourceListenerAddress?: string | undefined; /** *Source port for SRT-caller protocol.
* @public */ SourceListenerPort?: number | undefined; /** *The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
* @public */ StreamId?: string | undefined; /** *The name of the VPC interface to use for this source.
* @public */ VpcInterfaceName?: string | undefined; /** *The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
* @public */ WhitelistCidr?: string | undefined; /** *The source configuration for cloud flows receiving a stream from a bridge.
* @public */ GatewayBridgeSource?: SetGatewayBridgeSourceRequest | undefined; /** *The settings for the NDI® source. This includes the exact name of the upstream NDI sender that you want to connect to your source.
* @public */ NdiSourceSettings?: NdiSourceSettings | undefined; /** *The key-value pairs that can be used to tag and organize the source.
* @public */ SourceTags?: RecordIndicates whether to enable or disable router integration when setting a flow source.
* @public */ RouterIntegrationState?: State | undefined; /** *The decryption configuration for the flow source when router integration is enabled. Specifies how the source content should be decrypted when router integration is used.
* @public */ RouterIntegrationTransitDecryption?: FlowTransitEncryption | undefined; } /** *The source configuration for cloud flows receiving a stream from a bridge.
* @public */ export interface GatewayBridgeSource { /** *The ARN of the bridge feeding this flow.
* @public */ BridgeArn: string | undefined; /** *The name of the VPC interface attachment to use for this bridge source.
* @public */ VpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; } /** *The settings for the source of the flow.
* @public */ export interface Source { /** *Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
* @public */ DataTransferSubscriberFeePercent?: number | undefined; /** *The type of encryption that is used on the content ingested from this source.
* @public */ Decryption?: Encryption | undefined; /** *A description for the source. This value is not used or seen outside of the current MediaConnect account.
* @public */ Description?: string | undefined; /** *The ARN of the entitlement that allows you to subscribe to content that comes from another Amazon Web Services account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
* @public */ EntitlementArn?: string | undefined; /** *The IP address that the flow will be listening on for incoming content.
* @public */ IngestIp?: string | undefined; /** *The port that the flow will be listening on for incoming content.
* @public */ IngestPort?: number | undefined; /** *The media streams that are associated with the source, and the parameters for those associations.
* @public */ MediaStreamSourceConfigurations?: MediaStreamSourceConfiguration[] | undefined; /** *The name of the source.
* @public */ Name: string | undefined; /** *The IP address that the flow communicates with to initiate connection with the sender.
* @public */ SenderControlPort?: number | undefined; /** *The port that the flow uses to send outbound requests to initiate connection with the sender.
* @public */ SenderIpAddress?: string | undefined; /** *The ARN of the source.
* @public */ SourceArn: string | undefined; /** *Attributes related to the transport stream that are used in the source.
* @public */ Transport?: Transport | undefined; /** *The name of the VPC interface that is used for this source.
* @public */ VpcInterfaceName?: string | undefined; /** *The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
* @public */ WhitelistCidr?: string | undefined; /** *The source configuration for cloud flows receiving a stream from a bridge.
* @public */ GatewayBridgeSource?: GatewayBridgeSource | undefined; /** *The IP address of the device that is currently sending content to this source.
For sources that use protocols where you specify the origin (such as SRT Caller), this value matches the configured origin address.
For sources that use listener protocols (such as SRT Listener or RTP), this value shows the address of the connected sender.
Peer IP addresses aren't available for entitlements and CDI/ST2110 sources.
The peer IP address might not be visible for flows that haven't been started yet, or flows that were started before May 2025. In these cases, restart your flow to see the peer IP address.
Indicates if router integration is enabled or disabled on the flow source.
* @public */ RouterIntegrationState?: State | undefined; /** *The decryption configuration for the flow source when router integration is enabled.
* @public */ RouterIntegrationTransitDecryption?: FlowTransitEncryption | undefined; /** *The ARN of the router output that's currently connected to this source.
* @public */ ConnectedRouterOutputArn?: string | undefined; } /** *The metadata of an elementary transport stream.
* @public */ export interface TransportStream { /** *The number of channels in the audio stream.
* @public */ Channels?: number | undefined; /** *The codec used by the stream.
* @public */ Codec?: string | undefined; /** *The frame rate used by the video stream.
* @public */ FrameRate?: string | undefined; /** *The frame resolution used by the video stream.
* @public */ FrameResolution?: FrameResolution | undefined; /** *The Packet ID (PID) as it is reported in the Program Map Table.
* @public */ Pid: number | undefined; /** *The sample rate used by the audio stream.
* @public */ SampleRate?: number | undefined; /** *The sample bit size used by the audio stream.
* @public */ SampleSize?: number | undefined; /** *The Stream Type as it is reported in the Program Map Table.
* @public */ StreamType: string | undefined; } /** *The metadata of a single transport stream program.
* @public */ export interface TransportStreamProgram { /** *The Program Clock Reference (PCR) Packet ID (PID) as it is reported in the Program Association Table.
* @public */ PcrPid: number | undefined; /** *The program name as it is reported in the Program Association Table.
* @public */ ProgramName?: string | undefined; /** *The program number as it is reported in the Program Association Table.
* @public */ ProgramNumber: number | undefined; /** *The program Packet ID (PID) as it is reported in the Program Association Table.
* @public */ ProgramPid: number | undefined; /** *The list of elementary transport streams in the program. The list includes video, audio, and data streams.
* @public */ Streams: TransportStream[] | undefined; } /** * Configures settings for the BlackFrames metric.
Indicates whether the BlackFrames metric is enabled or disabled..
Specifies the number of consecutive seconds of black frames that triggers an event or alert.
* @public */ ThresholdSeconds?: number | undefined; } /** * Configures settings for the FrozenFrames metric.
Indicates whether the FrozenFrames metric is enabled or disabled.
Specifies the number of consecutive seconds of a static image that triggers an event or alert.
* @public */ ThresholdSeconds?: number | undefined; } /** *Specifies the configuration for video stream metrics monitoring.
* @public */ export interface VideoMonitoringSetting { /** *Detects video frames that are black.
* @public */ BlackFrames?: BlackFrames | undefined; /** *Detects video frames that have not changed.
* @public */ FrozenFrames?: FrozenFrames | undefined; } /** *The settings for a VPC source.
* @public */ export interface VpcInterface { /** *Immutable and has to be a unique against other VpcInterfaces in this Flow.
* @public */ Name: string | undefined; /** *IDs of the network interfaces created in customer's account by MediaConnect.
* @public */ NetworkInterfaceIds: string[] | undefined; /** *The type of network interface.
* @public */ NetworkInterfaceType: NetworkInterfaceType | undefined; /** *A role Arn MediaConnect can assume to create ENIs in your account.
* @public */ RoleArn: string | undefined; /** *Security Group IDs to be used on ENI.
* @public */ SecurityGroupIds: string[] | undefined; /** *Subnet must be in the AZ of the Flow.
* @public */ SubnetId: string | undefined; } /** *The details of the VPC interfaces that you want to add to the flow.
* @public */ export interface VpcInterfaceRequest { /** *The name for the VPC interface. This name must be unique within the flow.
* @public */ Name: string | undefined; /** *The type of network interface.
* @public */ NetworkInterfaceType?: NetworkInterfaceType | undefined; /** *The Amazon Resource Name (ARN) of the role that you created when you set up MediaConnect as a trusted service.
* @public */ RoleArn: string | undefined; /** *A virtual firewall to control inbound and outbound traffic.
* @public */ SecurityGroupIds: string[] | undefined; /** *The subnet IDs that you want to use for your VPC interface. A range of IP addresses in your VPC. When you create your VPC, you specify a range of IPv4 addresses for the VPC in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16. This is the primary CIDR block for your VPC. When you create a subnet for your VPC, you specify the CIDR block for the subnet, which is a subset of the VPC CIDR block. The subnets that you use across all VPC interfaces on the flow must be in the same Availability Zone as the flow.
* @public */ SubnetId: string | undefined; /** *The key-value pairs that can be used to tag and organize the VPC network interface.
* @public */ VpcInterfaceTags?: RecordThe Amazon Resource Name (ARN) of the bridge that you want to update.
* @public */ BridgeArn: string | undefined; /** *The outputs that you want to add to this bridge.
* @public */ Outputs: AddBridgeOutputRequest[] | undefined; } /** * @public */ export interface AddBridgeOutputsResponse { /** *The ARN of the bridge that you added outputs to.
* @public */ BridgeArn?: string | undefined; /** *The outputs that you added to this bridge.
* @public */ Outputs?: BridgeOutput[] | undefined; } /** * @public */ export interface AddBridgeSourcesRequest { /** *The Amazon Resource Name (ARN) of the bridge that you want to update.
* @public */ BridgeArn: string | undefined; /** *The sources that you want to add to this bridge.
* @public */ Sources: AddBridgeSourceRequest[] | undefined; } /** * @public */ export interface AddBridgeSourcesResponse { /** *The ARN of the bridge that you added sources to.
* @public */ BridgeArn?: string | undefined; /** *The sources that you added to this bridge.
* @public */ Sources?: BridgeSource[] | undefined; } /** *Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
* @public */ export interface AddEgressGatewayBridgeRequest { /** *The maximum expected bitrate (in bps) of the egress bridge.
* @public */ MaxBitrate: number | undefined; } /** * @public */ export interface AddFlowMediaStreamsRequest { /** *The Amazon Resource Name (ARN) of the flow.
* @public */ FlowArn: string | undefined; /** *The media streams that you want to add to the flow.
* @public */ MediaStreams: AddMediaStreamRequest[] | undefined; } /** * @public */ export interface AddFlowMediaStreamsResponse { /** *The ARN of the flow that you added media streams to.
* @public */ FlowArn?: string | undefined; /** *The media streams that you added to the flow.
* @public */ MediaStreams?: MediaStream[] | undefined; } /** * @public */ export interface AddFlowOutputsRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to add outputs to.
* @public */ FlowArn: string | undefined; /** *A list of outputs that you want to add to the flow.
* @public */ Outputs: AddOutputRequest[] | undefined; } /** * @public */ export interface AddFlowOutputsResponse { /** *The ARN of the flow that these outputs were added to.
* @public */ FlowArn?: string | undefined; /** *The details of the newly added outputs.
* @public */ Outputs?: Output[] | undefined; } /** * @public */ export interface AddFlowSourcesRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to update.
* @public */ FlowArn: string | undefined; /** *A list of sources that you want to add to the flow.
* @public */ Sources: SetSourceRequest[] | undefined; } /** * @public */ export interface AddFlowSourcesResponse { /** *The ARN of the flow that these sources were added to.
* @public */ FlowArn?: string | undefined; /** *The details of the newly added sources.
* @public */ Sources?: Source[] | undefined; } /** * @public */ export interface AddFlowVpcInterfacesRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to update.
* @public */ FlowArn: string | undefined; /** *A list of VPC interfaces that you want to add to the flow.
* @public */ VpcInterfaces: VpcInterfaceRequest[] | undefined; } /** * @public */ export interface AddFlowVpcInterfacesResponse { /** *The ARN of the flow that these VPC interfaces were added to.
* @public */ FlowArn?: string | undefined; /** *The details of the newly added VPC interfaces.
* @public */ VpcInterfaces?: VpcInterface[] | undefined; } /** *Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
* @public */ export interface AddIngressGatewayBridgeRequest { /** *The maximum expected bitrate (in bps) of the ingress bridge.
* @public */ MaxBitrate: number | undefined; /** *The maximum number of expected outputs on the ingress bridge.
* @public */ MaxOutputs: number | undefined; } /** *Create a maintenance setting for a flow.
* @public */ export interface AddMaintenance { /** *A day of a week when the maintenance will happen.
* @public */ MaintenanceDay: MaintenanceDay | undefined; /** *UTC time when the maintenance will happen.
Use 24-hour HH:MM format.
Minutes must be 00.
Example: 13:00.
The default value is 02:00.
* @public */ MaintenanceStartHour: string | undefined; } /** * @public */ export interface BatchGetRouterInputRequest { /** *The Amazon Resource Names (ARNs) of the router inputs you want to retrieve information about.
* @public */ Arns: string[] | undefined; } /** *An error that occurred when retrieving multiple router inputs in the BatchGetRouterInput operation, including the ARN, error code, and error message.
* @public */ export interface BatchGetRouterInputError { /** *The Amazon Resource Name (ARN) of the router input for which the error occurred.
* @public */ Arn: string | undefined; /** *The error code associated with the error.
* @public */ Code: string | undefined; /** *A message describing the error.
* @public */ Message: string | undefined; } /** *The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
* @public */ export interface RistRouterInputConfiguration { /** *The port number used for the RIST protocol in the router input configuration.
* @public */ Port: number | undefined; /** *The recovery latency in milliseconds for the RIST protocol in the router input configuration.
* @public */ RecoveryLatencyMilliseconds: number | undefined; } /** *The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
* @public */ export interface RtpRouterInputConfiguration { /** *The port number used for the RTP protocol in the router input configuration.
* @public */ Port: number | undefined; /** *The state of forward error correction for the RTP protocol in the router input configuration.
* @public */ ForwardErrorCorrection?: ForwardErrorCorrectionState | undefined; } /** *Contains the configuration settings for decrypting SRT streams, including the encryption key details and decryption parameters.
* @public */ export interface SrtDecryptionConfiguration { /** *Specifies the encryption key configuration used for decrypting SRT streams, including the key source and associated credentials.
* @public */ EncryptionKey: SecretsManagerEncryptionKeyConfiguration | undefined; } /** *The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
* @public */ export interface SrtCallerRouterInputConfiguration { /** *The source IP address for the SRT protocol in caller mode.
* @public */ SourceAddress: string | undefined; /** *The source port number for the SRT protocol in caller mode.
* @public */ SourcePort: number | undefined; /** *The minimum latency in milliseconds for the SRT protocol in caller mode.
* @public */ MinimumLatencyMilliseconds: number | undefined; /** *The stream ID for the SRT protocol in caller mode.
* @public */ StreamId?: string | undefined; /** *Specifies the decryption settings for an SRT caller input, including the encryption key configuration and associated parameters.
* @public */ DecryptionConfiguration?: SrtDecryptionConfiguration | undefined; } /** *The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
* @public */ export interface SrtListenerRouterInputConfiguration { /** *The port number for the SRT protocol in listener mode.
* @public */ Port: number | undefined; /** *The minimum latency in milliseconds for the SRT protocol in listener mode.
* @public */ MinimumLatencyMilliseconds: number | undefined; /** *Specifies the decryption settings for an SRT listener input, including the encryption key configuration and associated parameters.
* @public */ DecryptionConfiguration?: SrtDecryptionConfiguration | undefined; } /** *Protocol configuration settings for failover router inputs.
* @public */ export type FailoverRouterInputProtocolConfiguration = FailoverRouterInputProtocolConfiguration.RistMember | FailoverRouterInputProtocolConfiguration.RtpMember | FailoverRouterInputProtocolConfiguration.SrtCallerMember | FailoverRouterInputProtocolConfiguration.SrtListenerMember | FailoverRouterInputProtocolConfiguration.$UnknownMember; /** * @public */ export declare namespace FailoverRouterInputProtocolConfiguration { /** *The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
* @public */ interface RistMember { Rist: RistRouterInputConfiguration; SrtListener?: never; SrtCaller?: never; Rtp?: never; $unknown?: never; } /** *The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
* @public */ interface SrtListenerMember { Rist?: never; SrtListener: SrtListenerRouterInputConfiguration; SrtCaller?: never; Rtp?: never; $unknown?: never; } /** *The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
* @public */ interface SrtCallerMember { Rist?: never; SrtListener?: never; SrtCaller: SrtCallerRouterInputConfiguration; Rtp?: never; $unknown?: never; } /** *The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
* @public */ interface RtpMember { Rist?: never; SrtListener?: never; SrtCaller?: never; Rtp: RtpRouterInputConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { Rist?: never; SrtListener?: never; SrtCaller?: never; Rtp?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorConfiguration settings for a failover router input that allows switching between two input sources.
* @public */ export interface FailoverRouterInputConfiguration { /** *The ARN of the network interface to use for this failover router input.
* @public */ NetworkInterfaceArn: string | undefined; /** *A list of exactly two protocol configurations for the failover input sources. Both must use the same protocol type.
* @public */ ProtocolConfigurations: FailoverRouterInputProtocolConfiguration[] | undefined; /** *The mode for determining source priority in failover configurations.
* @public */ SourcePriorityMode: FailoverInputSourcePriorityMode | undefined; /** *The index (0 or 1) that specifies which source in the protocol configurations list is currently active. Used to control which of the two failover sources is currently selected. This field is ignored when sourcePriorityMode is set to NO_PRIORITY
* @public */ PrimarySourceIndex?: number | undefined; } /** *Configuration settings for connecting a router input to a flow output.
* @public */ export interface MediaConnectFlowRouterInputConfiguration { /** *The ARN of the flow to connect to.
* @public */ FlowArn?: string | undefined; /** *The ARN of the flow output to connect to this router input.
* @public */ FlowOutputArn?: string | undefined; /** *The decryption configuration for the flow source when connected to this router input.
* @public */ SourceTransitDecryption: FlowTransitEncryption | undefined; } /** *Configuration settings for the MediaLive transit encryption key.
* @public */ export type MediaLiveTransitEncryptionKeyConfiguration = MediaLiveTransitEncryptionKeyConfiguration.AutomaticMember | MediaLiveTransitEncryptionKeyConfiguration.SecretsManagerMember | MediaLiveTransitEncryptionKeyConfiguration.$UnknownMember; /** * @public */ export declare namespace MediaLiveTransitEncryptionKeyConfiguration { /** *The configuration settings for transit encryption using Secrets Manager, including the secret ARN and role ARN.
* @public */ interface SecretsManagerMember { SecretsManager: SecretsManagerEncryptionKeyConfiguration; Automatic?: never; $unknown?: never; } /** *Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
* @public */ interface AutomaticMember { SecretsManager?: never; Automatic: AutomaticEncryptionKeyConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { SecretsManager?: never; Automatic?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
* @public */ export interface MediaLiveTransitEncryption { /** *The type of encryption key to use for MediaLive transit encryption.
* @public */ EncryptionKeyType?: MediaLiveTransitEncryptionKeyType | undefined; /** *The configuration details for the MediaLive encryption key.
* @public */ EncryptionKeyConfiguration: MediaLiveTransitEncryptionKeyConfiguration | undefined; } /** *Configuration settings for connecting a router input to a MediaLive channel output.
* @public */ export interface MediaLiveChannelRouterInputConfiguration { /** *The ARN of the MediaLive channel to connect to this router input.
* @public */ MediaLiveChannelArn?: string | undefined; /** *The index of the MediaLive pipeline to connect to this router input.
* @public */ MediaLivePipelineId?: MediaLiveChannelPipelineId | undefined; /** *The name of the MediaLive channel output to connect to this router input.
* @public */ MediaLiveChannelOutputName?: string | undefined; /** *The encryption configuration that defines how content is encrypted during transit between MediaConnect Router and MediaLive. This configuration determines whether encryption keys are automatically managed by the service or manually managed through Secrets Manager.
* @public */ SourceTransitDecryption: MediaLiveTransitEncryption | undefined; } /** *Protocol configuration settings for merge router inputs.
* @public */ export type MergeRouterInputProtocolConfiguration = MergeRouterInputProtocolConfiguration.RistMember | MergeRouterInputProtocolConfiguration.RtpMember | MergeRouterInputProtocolConfiguration.$UnknownMember; /** * @public */ export declare namespace MergeRouterInputProtocolConfiguration { /** *The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
* @public */ interface RtpMember { Rtp: RtpRouterInputConfiguration; Rist?: never; $unknown?: never; } /** *The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
* @public */ interface RistMember { Rtp?: never; Rist: RistRouterInputConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { Rtp?: never; Rist?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorConfiguration settings for a merge router input that combines two input sources.
* @public */ export interface MergeRouterInputConfiguration { /** *The ARN of the network interface to use for this merge router input.
* @public */ NetworkInterfaceArn: string | undefined; /** *A list of exactly two protocol configurations for the merge input sources. Both must use the same protocol type.
* @public */ ProtocolConfigurations: MergeRouterInputProtocolConfiguration[] | undefined; /** *The time window in milliseconds for merging the two input sources.
* @public */ MergeRecoveryWindowMilliseconds: number | undefined; } /** *The protocol configuration settings for a router input.
* @public */ export type RouterInputProtocolConfiguration = RouterInputProtocolConfiguration.RistMember | RouterInputProtocolConfiguration.RtpMember | RouterInputProtocolConfiguration.SrtCallerMember | RouterInputProtocolConfiguration.SrtListenerMember | RouterInputProtocolConfiguration.$UnknownMember; /** * @public */ export declare namespace RouterInputProtocolConfiguration { /** *The configuration settings for a router input using the RIST (Reliable Internet Stream Transport) protocol, including the port and recovery latency.
* @public */ interface RistMember { Rist: RistRouterInputConfiguration; SrtListener?: never; SrtCaller?: never; Rtp?: never; $unknown?: never; } /** *The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and decryption key configuration.
* @public */ interface SrtListenerMember { Rist?: never; SrtListener: SrtListenerRouterInputConfiguration; SrtCaller?: never; Rtp?: never; $unknown?: never; } /** *The configuration settings for a router input using the SRT (Secure Reliable Transport) protocol in caller mode, including the source address and port, minimum latency, stream ID, and decryption key configuration.
* @public */ interface SrtCallerMember { Rist?: never; SrtListener?: never; SrtCaller: SrtCallerRouterInputConfiguration; Rtp?: never; $unknown?: never; } /** *The configuration settings for a Router Input using the RTP (Real-Time Transport Protocol) protocol, including the port and forward error correction state.
* @public */ interface RtpMember { Rist?: never; SrtListener?: never; SrtCaller?: never; Rtp: RtpRouterInputConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { Rist?: never; SrtListener?: never; SrtCaller?: never; Rtp?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
* @public */ export interface StandardRouterInputConfiguration { /** *The Amazon Resource Name (ARN) of the network interface associated with the standard router input.
* @public */ NetworkInterfaceArn: string | undefined; /** *The configuration settings for the protocol used by the standard router input.
* @public */ ProtocolConfiguration: RouterInputProtocolConfiguration | undefined; /** *The protocol used by the standard router input.
* @public */ Protocol?: RouterInputProtocol | undefined; } /** *The configuration settings for a router input.
* @public */ export type RouterInputConfiguration = RouterInputConfiguration.FailoverMember | RouterInputConfiguration.MediaConnectFlowMember | RouterInputConfiguration.MediaLiveChannelMember | RouterInputConfiguration.MergeMember | RouterInputConfiguration.StandardMember | RouterInputConfiguration.$UnknownMember; /** * @public */ export declare namespace RouterInputConfiguration { /** *The configuration settings for a standard router input, including the protocol, protocol-specific configuration, network interface, and availability zone.
* @public */ interface StandardMember { Standard: StandardRouterInputConfiguration; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow?: never; Merge?: never; $unknown?: never; } /** *Configuration settings for connecting a router input to a MediaLive channel output.
* @public */ interface MediaLiveChannelMember { Standard?: never; MediaLiveChannel: MediaLiveChannelRouterInputConfiguration; Failover?: never; MediaConnectFlow?: never; Merge?: never; $unknown?: never; } /** *Configuration settings for a failover router input that allows switching between two input sources.
* @public */ interface FailoverMember { Standard?: never; MediaLiveChannel?: never; Failover: FailoverRouterInputConfiguration; MediaConnectFlow?: never; Merge?: never; $unknown?: never; } /** *Configuration settings for connecting a router input to a flow output.
* @public */ interface MediaConnectFlowMember { Standard?: never; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow: MediaConnectFlowRouterInputConfiguration; Merge?: never; $unknown?: never; } /** *Configuration settings for a merge router input that combines two input sources.
* @public */ interface MergeMember { Standard?: never; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow?: never; Merge: MergeRouterInputConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { Standard?: never; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow?: never; Merge?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorConfiguration settings for default maintenance scheduling.
* @public */ export interface DefaultMaintenanceConfiguration { } /** *Configuration for preferred day and time maintenance settings.
* @public */ export interface PreferredDayTimeMaintenanceConfiguration { /** *The preferred day for maintenance operations.
* @public */ Day: Day | undefined; /** *The preferred time for maintenance operations.
* @public */ Time: string | undefined; } /** *The configuration settings for maintenance operations, including preferred maintenance windows and schedules.
* @public */ export type MaintenanceConfiguration = MaintenanceConfiguration.DefaultMember | MaintenanceConfiguration.PreferredDayTimeMember | MaintenanceConfiguration.$UnknownMember; /** * @public */ export declare namespace MaintenanceConfiguration { /** *Preferred day and time maintenance configuration settings.
* @public */ interface PreferredDayTimeMember { PreferredDayTime: PreferredDayTimeMaintenanceConfiguration; Default?: never; $unknown?: never; } /** *Default maintenance configuration settings.
* @public */ interface DefaultMember { PreferredDayTime?: never; Default: DefaultMaintenanceConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { PreferredDayTime?: never; Default?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorDefines a specific time window for maintenance operations.
* @public */ export interface WindowMaintenanceSchedule { /** *The start time of the maintenance window.
* @public */ Start: Date | undefined; /** *The end time of the maintenance window.
* @public */ End: Date | undefined; /** *The date and time when the maintenance window is scheduled to occur.
* @public */ ScheduledTime: Date | undefined; } /** *The details of the maintenance schedule.
* @public */ export type MaintenanceSchedule = MaintenanceSchedule.WindowMember | MaintenanceSchedule.$UnknownMember; /** * @public */ export declare namespace MaintenanceSchedule { /** *Defines a specific time window for maintenance operations.
* @public */ interface WindowMember { Window: WindowMaintenanceSchedule; $unknown?: never; } /** * @public */ interface $UnknownMember { Window?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorA message associated with a router input, including a code and a message.
* @public */ export interface RouterInputMessage { /** *The code associated with the router input message.
* @public */ Code: string | undefined; /** *The message text associated with the router input message.
* @public */ Message: string | undefined; } /** *Configuration details for an indexed stream in a failover router input setup.
* @public */ export interface FailoverRouterInputIndexedStreamDetails { /** *The index number (0 or 1) assigned to this source in the failover configuration.
* @public */ SourceIndex: number | undefined; /** *The IP address of the source for this indexed stream.
* @public */ SourceIpAddress?: string | undefined; } /** *Configuration details for a failover router input that can automatically switch between two sources.
* @public */ export interface FailoverRouterInputStreamDetails { /** *Configuration details for the primary source (index 0) in the failover setup.
* @public */ SourceIndexZeroStreamDetails: FailoverRouterInputIndexedStreamDetails | undefined; /** *Configuration details for the secondary source (index 1) in the failover setup.
* @public */ SourceIndexOneStreamDetails: FailoverRouterInputIndexedStreamDetails | undefined; } /** *Configuration details for a MediaConnect flow when used as a router input source.
* @public */ export interface MediaConnectFlowRouterInputStreamDetails { } /** *Configuration details for a MediaLive channel when used as a router input source.
* @public */ export interface MediaLiveChannelRouterInputStreamDetails { } /** *Configuration details for an indexed stream in a merge router input setup.
* @public */ export interface MergeRouterInputIndexedStreamDetails { /** *The index number (0 or 1) assigned to this source in the merge configuration.
* @public */ SourceIndex: number | undefined; /** *The IP address of the source for this indexed stream in the merge setup.
* @public */ SourceIpAddress?: string | undefined; } /** *Configuration details for a merge router input that combines two input sources.
* @public */ export interface MergeRouterInputStreamDetails { /** *Configuration details for the first source (index 0) in the merge setup.
* @public */ SourceIndexZeroStreamDetails: MergeRouterInputIndexedStreamDetails | undefined; /** *Configuration details for the second source (index 1) in the merge setup.
* @public */ SourceIndexOneStreamDetails: MergeRouterInputIndexedStreamDetails | undefined; } /** *Configuration details for a standard router input stream type.
* @public */ export interface StandardRouterInputStreamDetails { /** *The source IP address for the standard router input stream.
* @public */ SourceIpAddress?: string | undefined; } /** *Configuration details for the router input stream.
* @public */ export type RouterInputStreamDetails = RouterInputStreamDetails.FailoverMember | RouterInputStreamDetails.MediaConnectFlowMember | RouterInputStreamDetails.MediaLiveChannelMember | RouterInputStreamDetails.MergeMember | RouterInputStreamDetails.StandardMember | RouterInputStreamDetails.$UnknownMember; /** * @public */ export declare namespace RouterInputStreamDetails { /** *Configuration details for a standard router input stream type.
* @public */ interface StandardMember { Standard: StandardRouterInputStreamDetails; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow?: never; Merge?: never; $unknown?: never; } /** *Configuration details for a MediaLive channel when used as a router input source.
* @public */ interface MediaLiveChannelMember { Standard?: never; MediaLiveChannel: MediaLiveChannelRouterInputStreamDetails; Failover?: never; MediaConnectFlow?: never; Merge?: never; $unknown?: never; } /** *Configuration details for a failover router input that can automatically switch between two sources.
* @public */ interface FailoverMember { Standard?: never; MediaLiveChannel?: never; Failover: FailoverRouterInputStreamDetails; MediaConnectFlow?: never; Merge?: never; $unknown?: never; } /** *Configuration details for a MediaConnect flow when used as a router input source.
* @public */ interface MediaConnectFlowMember { Standard?: never; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow: MediaConnectFlowRouterInputStreamDetails; Merge?: never; $unknown?: never; } /** *Configuration details for a merge router input that combines two input sources.
* @public */ interface MergeMember { Standard?: never; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow?: never; Merge: MergeRouterInputStreamDetails; $unknown?: never; } /** * @public */ interface $UnknownMember { Standard?: never; MediaLiveChannel?: never; Failover?: never; MediaConnectFlow?: never; Merge?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorDefines the configuration settings for transit encryption keys.
* @public */ export type RouterInputTransitEncryptionKeyConfiguration = RouterInputTransitEncryptionKeyConfiguration.AutomaticMember | RouterInputTransitEncryptionKeyConfiguration.SecretsManagerMember | RouterInputTransitEncryptionKeyConfiguration.$UnknownMember; /** * @public */ export declare namespace RouterInputTransitEncryptionKeyConfiguration { /** *The configuration settings for transit encryption using Secrets Manager, including the secret ARN and role ARN.
* @public */ interface SecretsManagerMember { SecretsManager: SecretsManagerEncryptionKeyConfiguration; Automatic?: never; $unknown?: never; } /** *Configuration settings for automatic encryption key management, where MediaConnect handles key creation and rotation.
* @public */ interface AutomaticMember { SecretsManager?: never; Automatic: AutomaticEncryptionKeyConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { SecretsManager?: never; Automatic?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe transit encryption settings for a router input.
* @public */ export interface RouterInputTransitEncryption { /** *Specifies the type of encryption key to use for transit encryption.
* @public */ EncryptionKeyType?: RouterInputTransitEncryptionKeyType | undefined; /** *Contains the configuration details for the encryption key used in transit encryption, including the key source and associated parameters.
* @public */ EncryptionKeyConfiguration: RouterInputTransitEncryptionKeyConfiguration | undefined; } /** *A router input in AWS Elemental MediaConnect. A router input is a source of media content that can be routed to one or more router outputs.
* @public */ export interface RouterInput { /** *The name of the router input.
* @public */ Name: string | undefined; /** *The Amazon Resource Name (ARN) of the router input.
* @public */ Arn: string | undefined; /** *The unique identifier of the router input.
* @public */ Id: string | undefined; /** *The current state of the router input.
* @public */ State: RouterInputState | undefined; /** *The type of the router input.
* @public */ InputType: RouterInputType | undefined; /** *The configuration settings for a router input.
* @public */ Configuration: RouterInputConfiguration | undefined; /** *The number of router outputs associated with the router input.
* @public */ RoutedOutputs: number | undefined; /** *The maximum number of outputs that can be simultaneously routed to this input.
* @public */ MaximumRoutedOutputs?: number | undefined; /** *The Amazon Web Services Region where the router input is located.
* @public */ RegionName: string | undefined; /** *The Availability Zone of the router input.
* @public */ AvailabilityZone: string | undefined; /** *The maximum bitrate for the router input.
* @public */ MaximumBitrate: number | undefined; /** *The tier level of the router input.
* @public */ Tier: RouterInputTier | undefined; /** *Indicates whether the router input is configured for Regional or global routing.
* @public */ RoutingScope: RoutingScope | undefined; /** *The timestamp when the router input was created.
* @public */ CreatedAt: Date | undefined; /** *The timestamp when the router input was last updated.
* @public */ UpdatedAt: Date | undefined; /** *The messages associated with the router input.
* @public */ Messages: RouterInputMessage[] | undefined; /** *The transit encryption settings for a router input.
* @public */ TransitEncryption: RouterInputTransitEncryption | undefined; /** *Key-value pairs that can be used to tag and organize this router input.
* @public */ Tags: RecordConfiguration details for the router input stream.
* @public */ StreamDetails: RouterInputStreamDetails | undefined; /** *The IP address of the router input.
* @public */ IpAddress?: string | undefined; /** *The type of maintenance configuration applied to this router input.
* @public */ MaintenanceType: MaintenanceType | undefined; /** *The maintenance configuration settings applied to this router input.
* @public */ MaintenanceConfiguration: MaintenanceConfiguration | undefined; /** *The type of maintenance schedule currently in effect for this router input.
* @public */ MaintenanceScheduleType?: MaintenanceScheduleType | undefined; /** *The current maintenance schedule details for this router input.
* @public */ MaintenanceSchedule?: MaintenanceSchedule | undefined; } /** * @public */ export interface BatchGetRouterInputResponse { /** *An array of router inputs that were successfully retrieved.
* @public */ RouterInputs: RouterInput[] | undefined; /** *An array of errors that occurred when retrieving the requested router inputs.
* @public */ Errors: BatchGetRouterInputError[] | undefined; } /** * @public */ export interface BatchGetRouterNetworkInterfaceRequest { /** *The Amazon Resource Names (ARNs) of the router network interfaces you want to retrieve information about.
* @public */ Arns: string[] | undefined; } /** *An error that occurred when retrieving multiple router network interfaces in the BatchGetRouterNetworkInterface operation, including the ARN, error code, and error message.
* @public */ export interface BatchGetRouterNetworkInterfaceError { /** *The Amazon Resource Name (ARN) of the router network interface for which the error occurred.
* @public */ Arn: string | undefined; /** *The error code associated with the error.
* @public */ Code: string | undefined; /** *A message describing the error.
* @public */ Message: string | undefined; } /** *A rule that allows a specific CIDR block to access the public router network interface.
* @public */ export interface PublicRouterNetworkInterfaceRule { /** *The CIDR block that is allowed to access the public router network interface.
* @public */ Cidr: string | undefined; } /** *The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
* @public */ export interface PublicRouterNetworkInterfaceConfiguration { /** *The list of allowed CIDR blocks for the public router network interface.
* @public */ AllowRules: PublicRouterNetworkInterfaceRule[] | undefined; } /** *The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
* @public */ export interface VpcRouterNetworkInterfaceConfiguration { /** *The IDs of the security groups to associate with the router network interface within the VPC.
* @public */ SecurityGroupIds: string[] | undefined; /** *The ID of the subnet within the VPC to associate the router network interface with.
* @public */ SubnetId: string | undefined; } /** *The configuration settings for a router network interface.
* @public */ export type RouterNetworkInterfaceConfiguration = RouterNetworkInterfaceConfiguration.PublicMember | RouterNetworkInterfaceConfiguration.VpcMember | RouterNetworkInterfaceConfiguration.$UnknownMember; /** * @public */ export declare namespace RouterNetworkInterfaceConfiguration { /** *The configuration settings for a public router network interface, including the list of allowed CIDR blocks.
* @public */ interface PublicMember { Public: PublicRouterNetworkInterfaceConfiguration; Vpc?: never; $unknown?: never; } /** *The configuration settings for a router network interface within a VPC, including the security group IDs and subnet ID.
* @public */ interface VpcMember { Public?: never; Vpc: VpcRouterNetworkInterfaceConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { Public?: never; Vpc?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorA router network interface in AWS Elemental MediaConnect. A router network interface is a network interface that can be associated with one or more router inputs and outputs.
* @public */ export interface RouterNetworkInterface { /** *The name of the router network interface.
* @public */ Name: string | undefined; /** *The Amazon Resource Name (ARN) of the router network interface.
* @public */ Arn: string | undefined; /** *The unique identifier of the router network interface.
* @public */ Id: string | undefined; /** *The current state of the router network interface.
* @public */ State: RouterNetworkInterfaceState | undefined; /** *The type of the router network interface.
* @public */ NetworkInterfaceType: RouterNetworkInterfaceType | undefined; /** *The configuration settings for a router network interface.
* @public */ Configuration: RouterNetworkInterfaceConfiguration | undefined; /** *The number of router outputs associated with the network interface.
* @public */ AssociatedOutputCount: number | undefined; /** *The number of router inputs associated with the network interface.
* @public */ AssociatedInputCount: number | undefined; /** *The Amazon Web Services Region where the router network interface is located.
* @public */ RegionName: string | undefined; /** *The timestamp when the router network interface was created.
* @public */ CreatedAt: Date | undefined; /** *The timestamp when the router network interface was last updated.
* @public */ UpdatedAt: Date | undefined; /** *Key-value pairs that can be used to tag and organize this router network interface.
* @public */ Tags: RecordAn array of router network interfaces that were successfully retrieved.
* @public */ RouterNetworkInterfaces: RouterNetworkInterface[] | undefined; /** *An array of errors that occurred when retrieving the requested router network interfaces.
* @public */ Errors: BatchGetRouterNetworkInterfaceError[] | undefined; } /** * @public */ export interface BatchGetRouterOutputRequest { /** *The Amazon Resource Names (ARNs) of the router outputs you want to retrieve information about.
* @public */ Arns: string[] | undefined; } /** *An error that occurred when retrieving multiple router outputs in the BatchGetRouterOutput operation, including the ARN, error code, and error message.
* @public */ export interface BatchGetRouterOutputError { /** *The Amazon Resource Name (ARN) of the router output for which the error occurred.
* @public */ Arn: string | undefined; /** *The error code associated with the error.
* @public */ Code: string | undefined; /** *A message describing the error.
* @public */ Message: string | undefined; } /** *Configuration settings for connecting a router output to a MediaConnect flow source.
* @public */ export interface MediaConnectFlowRouterOutputConfiguration { /** *The ARN of the flow to connect to this router output.
* @public */ FlowArn?: string | undefined; /** *The ARN of the flow source to connect to this router output.
* @public */ FlowSourceArn?: string | undefined; /** *The encryption configuration for the flow destination when connected to this router output.
* @public */ DestinationTransitEncryption: FlowTransitEncryption | undefined; } /** *Configuration settings for connecting a router output to a MediaLive input.
* @public */ export interface MediaLiveInputRouterOutputConfiguration { /** *The ARN of the MediaLive input to connect to this router output.
* @public */ MediaLiveInputArn?: string | undefined; /** *The index of the MediaLive pipeline to connect to this router output.
* @public */ MediaLivePipelineId?: MediaLiveInputPipelineId | undefined; /** *The encryption configuration for the MediaLive input when connected to this router output.
* @public */ DestinationTransitEncryption: MediaLiveTransitEncryption | undefined; } /** *The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
* @public */ export interface RistRouterOutputConfiguration { /** *The destination IP address for the RIST protocol in the router output configuration.
* @public */ DestinationAddress: string | undefined; /** *The destination port number for the RIST protocol in the router output configuration.
* @public */ DestinationPort: number | undefined; } /** *The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
* @public */ export interface RtpRouterOutputConfiguration { /** *The destination IP address for the RTP protocol in the router output configuration.
* @public */ DestinationAddress: string | undefined; /** *The destination port number for the RTP protocol in the router output configuration.
* @public */ DestinationPort: number | undefined; /** *The state of forward error correction for the RTP protocol in the router output configuration.
* @public */ ForwardErrorCorrection?: ForwardErrorCorrectionState | undefined; } /** *Contains the configuration settings for encrypting SRT streams, including the encryption key details and encryption parameters.
* @public */ export interface SrtEncryptionConfiguration { /** *Specifies the encryption key configuration used for encrypting SRT streams, including the key source and associated credentials.
* @public */ EncryptionKey: SecretsManagerEncryptionKeyConfiguration | undefined; } /** *The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
* @public */ export interface SrtCallerRouterOutputConfiguration { /** *The destination IP address for the SRT protocol in caller mode.
* @public */ DestinationAddress: string | undefined; /** *The destination port number for the SRT protocol in caller mode.
* @public */ DestinationPort: number | undefined; /** *The minimum latency in milliseconds for the SRT protocol in caller mode.
* @public */ MinimumLatencyMilliseconds: number | undefined; /** *The stream ID for the SRT protocol in caller mode.
* @public */ StreamId?: string | undefined; /** *Defines the encryption settings for an SRT caller output, including the encryption key configuration and associated parameters.
* @public */ EncryptionConfiguration?: SrtEncryptionConfiguration | undefined; } /** *The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
* @public */ export interface SrtListenerRouterOutputConfiguration { /** *The port number for the SRT protocol in listener mode.
* @public */ Port: number | undefined; /** *The minimum latency in milliseconds for the SRT protocol in listener mode.
* @public */ MinimumLatencyMilliseconds: number | undefined; /** *Defines the encryption settings for an SRT listener output, including the encryption key configuration and associated parameters.
* @public */ EncryptionConfiguration?: SrtEncryptionConfiguration | undefined; } /** *The protocol configuration settings for a router output.
* @public */ export type RouterOutputProtocolConfiguration = RouterOutputProtocolConfiguration.RistMember | RouterOutputProtocolConfiguration.RtpMember | RouterOutputProtocolConfiguration.SrtCallerMember | RouterOutputProtocolConfiguration.SrtListenerMember | RouterOutputProtocolConfiguration.$UnknownMember; /** * @public */ export declare namespace RouterOutputProtocolConfiguration { /** *The configuration settings for a router output using the RIST (Reliable Internet Stream Transport) protocol, including the destination address and port.
* @public */ interface RistMember { Rist: RistRouterOutputConfiguration; SrtListener?: never; SrtCaller?: never; Rtp?: never; $unknown?: never; } /** *The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in listener mode, including the port, minimum latency, and encryption key configuration.
* @public */ interface SrtListenerMember { Rist?: never; SrtListener: SrtListenerRouterOutputConfiguration; SrtCaller?: never; Rtp?: never; $unknown?: never; } /** *The configuration settings for a router output using the SRT (Secure Reliable Transport) protocol in caller mode, including the destination address and port, minimum latency, stream ID, and encryption key configuration.
* @public */ interface SrtCallerMember { Rist?: never; SrtListener?: never; SrtCaller: SrtCallerRouterOutputConfiguration; Rtp?: never; $unknown?: never; } /** *The configuration settings for a router output using the RTP (Real-Time Transport Protocol) protocol, including the destination address and port, and forward error correction state.
* @public */ interface RtpMember { Rist?: never; SrtListener?: never; SrtCaller?: never; Rtp: RtpRouterOutputConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { Rist?: never; SrtListener?: never; SrtCaller?: never; Rtp?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
* @public */ export interface StandardRouterOutputConfiguration { /** *The Amazon Resource Name (ARN) of the network interface associated with the standard router output.
* @public */ NetworkInterfaceArn: string | undefined; /** *The configuration settings for the protocol used by the standard router output.
* @public */ ProtocolConfiguration: RouterOutputProtocolConfiguration | undefined; /** *The protocol used by the standard router output.
* @public */ Protocol?: RouterOutputProtocol | undefined; } /** *The configuration settings for a router output.
* @public */ export type RouterOutputConfiguration = RouterOutputConfiguration.MediaConnectFlowMember | RouterOutputConfiguration.MediaLiveInputMember | RouterOutputConfiguration.StandardMember | RouterOutputConfiguration.$UnknownMember; /** * @public */ export declare namespace RouterOutputConfiguration { /** *The configuration settings for a standard router output, including the protocol, protocol-specific configuration, network interface, and availability zone.
* @public */ interface StandardMember { Standard: StandardRouterOutputConfiguration; MediaConnectFlow?: never; MediaLiveInput?: never; $unknown?: never; } /** *Configuration settings for connecting a router output to a MediaConnect flow source.
* @public */ interface MediaConnectFlowMember { Standard?: never; MediaConnectFlow: MediaConnectFlowRouterOutputConfiguration; MediaLiveInput?: never; $unknown?: never; } /** *Configuration settings for connecting a router output to a MediaLive input.
* @public */ interface MediaLiveInputMember { Standard?: never; MediaConnectFlow?: never; MediaLiveInput: MediaLiveInputRouterOutputConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { Standard?: never; MediaConnectFlow?: never; MediaLiveInput?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorA message associated with a router output.
* @public */ export interface RouterOutputMessage { /** *The code associated with the router output message.
* @public */ Code: string | undefined; /** *The message text associated with the router output message.
* @public */ Message: string | undefined; } /** *Configuration details for a MediaConnect flow when used as a router output destination.
* @public */ export interface MediaConnectFlowRouterOutputStreamDetails { } /** *Configuration details for a MediaLive input when used as a router output destination.
* @public */ export interface MediaLiveInputRouterOutputStreamDetails { } /** *Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
* @public */ export interface StandardRouterOutputStreamDetails { /** *The IP address where the output stream will be sent. This is the destination address that will receive the routed media content.
* @public */ DestinationIpAddress?: string | undefined; } /** *Information about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
* @public */ export type RouterOutputStreamDetails = RouterOutputStreamDetails.MediaConnectFlowMember | RouterOutputStreamDetails.MediaLiveInputMember | RouterOutputStreamDetails.StandardMember | RouterOutputStreamDetails.$UnknownMember; /** * @public */ export declare namespace RouterOutputStreamDetails { /** *Configuration details for a standard router output stream type. Contains information about the destination IP address and connection state for basic output routing.
* @public */ interface StandardMember { Standard: StandardRouterOutputStreamDetails; MediaConnectFlow?: never; MediaLiveInput?: never; $unknown?: never; } /** *Configuration details for a MediaConnect flow when used as a router output destination.
* @public */ interface MediaConnectFlowMember { Standard?: never; MediaConnectFlow: MediaConnectFlowRouterOutputStreamDetails; MediaLiveInput?: never; $unknown?: never; } /** *Configuration details for a MediaLive input when used as a router output destination.
* @public */ interface MediaLiveInputMember { Standard?: never; MediaConnectFlow?: never; MediaLiveInput: MediaLiveInputRouterOutputStreamDetails; $unknown?: never; } /** * @public */ interface $UnknownMember { Standard?: never; MediaConnectFlow?: never; MediaLiveInput?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorA router output in AWS Elemental MediaConnect. A router output is a destination for media content that can receive input from one or more router inputs.
* @public */ export interface RouterOutput { /** *The name of the router output.
* @public */ Name: string | undefined; /** *The Amazon Resource Name (ARN) of the router output.
* @public */ Arn: string | undefined; /** *The unique identifier of the router output.
* @public */ Id: string | undefined; /** *The overall state of the router output.
* @public */ State: RouterOutputState | undefined; /** *The type of the router output.
* @public */ OutputType: RouterOutputType | undefined; /** *The configuration settings for a router output.
* @public */ Configuration: RouterOutputConfiguration | undefined; /** *The current state of the association between the router output and its input.
* @public */ RoutedState: RouterOutputRoutedState | undefined; /** *The Amazon Web Services Region where the router output is located.
* @public */ RegionName: string | undefined; /** *The Availability Zone of the router output.
* @public */ AvailabilityZone: string | undefined; /** *The maximum bitrate for the router output.
* @public */ MaximumBitrate: number | undefined; /** *Indicates whether the router output is configured for Regional or global routing.
* @public */ RoutingScope: RoutingScope | undefined; /** *The tier level of the router output.
* @public */ Tier: RouterOutputTier | undefined; /** *The timestamp when the router output was created.
* @public */ CreatedAt: Date | undefined; /** *The timestamp when the router output was last updated.
* @public */ UpdatedAt: Date | undefined; /** *The messages associated with the router output.
* @public */ Messages: RouterOutputMessage[] | undefined; /** *Key-value pairs that can be used to tag and organize this router output.
* @public */ Tags: RecordInformation about the router output's stream, including connection state and destination details. The specific details provided vary based on the router output type.
* @public */ StreamDetails: RouterOutputStreamDetails | undefined; /** *The IP address of the router output.
* @public */ IpAddress?: string | undefined; /** *The Amazon Resource Name (ARN) of the router input associated with the output.
* @public */ RoutedInputArn?: string | undefined; /** *The type of maintenance configuration applied to this router output.
* @public */ MaintenanceType: MaintenanceType | undefined; /** *The maintenance configuration settings applied to this router output.
* @public */ MaintenanceConfiguration: MaintenanceConfiguration | undefined; /** *The type of maintenance schedule currently in effect for this router output.
* @public */ MaintenanceScheduleType?: MaintenanceScheduleType | undefined; /** *The current maintenance schedule details for this router output.
* @public */ MaintenanceSchedule?: MaintenanceSchedule | undefined; } /** * @public */ export interface BatchGetRouterOutputResponse { /** *An array of router outputs that were successfully retrieved.
* @public */ RouterOutputs: RouterOutput[] | undefined; /** *An array of errors that occurred when retrieving the requested router outputs.
* @public */ Errors: BatchGetRouterOutputError[] | undefined; } /** *Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
* @public */ export interface EgressGatewayBridge { /** *The ID of the instance running this bridge.
* @public */ InstanceId?: string | undefined; /** *The maximum expected bitrate (in bps) of the egress bridge.
* @public */ MaxBitrate: number | undefined; } /** *Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
* @public */ export interface IngressGatewayBridge { /** *The ID of the instance running this bridge.
* @public */ InstanceId?: string | undefined; /** *The maximum expected bitrate (in bps) of the ingress bridge.
* @public */ MaxBitrate: number | undefined; /** *The maximum number of outputs on the ingress bridge.
* @public */ MaxOutputs: number | undefined; } /** *The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
* @public */ export interface SourcePriority { /** *The name of the source you choose as the primary source for this flow.
* @public */ PrimarySource?: string | undefined; } /** *The settings for source failover.
* @public */ export interface FailoverConfig { /** *The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
* @public */ FailoverMode?: FailoverMode | undefined; /** *Search window time to look for dash-7 packets.
* @public */ RecoveryWindow?: number | undefined; /** *The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
* @public */ SourcePriority?: SourcePriority | undefined; /** *The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
* @public */ State?: State | undefined; } /** *A Bridge is the connection between your data center's Instances and the Amazon Web Services cloud. A bridge can be used to send video from the Amazon Web Services cloud to your data center or from your data center to the Amazon Web Services cloud.
* @public */ export interface Bridge { /** *The Amazon Resource Number (ARN) of the bridge.
* @public */ BridgeArn: string | undefined; /** *Messages with details about the bridge.
* @public */ BridgeMessages?: MessageDetail[] | undefined; /** *The state of the bridge.
* @public */ BridgeState: BridgeState | undefined; /** *An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
* @public */ EgressGatewayBridge?: EgressGatewayBridge | undefined; /** *An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
* @public */ IngressGatewayBridge?: IngressGatewayBridge | undefined; /** *The name of the bridge.
* @public */ Name: string | undefined; /** *The outputs on this bridge.
* @public */ Outputs?: BridgeOutput[] | undefined; /** *The placement Amazon Resource Number (ARN) of the bridge.
* @public */ PlacementArn: string | undefined; /** *The settings for source failover.
* @public */ SourceFailoverConfig?: FailoverConfig | undefined; /** *The sources on this bridge.
* @public */ Sources?: BridgeSource[] | undefined; } /** * @public */ export interface CreateBridgeRequest { /** *An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
* @public */ EgressGatewayBridge?: AddEgressGatewayBridgeRequest | undefined; /** *An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
* @public */ IngressGatewayBridge?: AddIngressGatewayBridgeRequest | undefined; /** *The name of the bridge. This name can not be modified after the bridge is created.
* @public */ Name: string | undefined; /** *The outputs that you want to add to this bridge.
* @public */ Outputs?: AddBridgeOutputRequest[] | undefined; /** *The bridge placement Amazon Resource Number (ARN).
* @public */ PlacementArn: string | undefined; /** *The settings for source failover.
* @public */ SourceFailoverConfig?: FailoverConfig | undefined; /** *The sources that you want to add to this bridge.
* @public */ Sources: AddBridgeSourceRequest[] | undefined; } /** * @public */ export interface CreateBridgeResponse { /** *The name of the bridge that was created.
* @public */ Bridge?: Bridge | undefined; } /** * @public */ export interface DeleteBridgeRequest { /** *The Amazon Resource Name (ARN) of the bridge that you want to delete.
* @public */ BridgeArn: string | undefined; } /** * @public */ export interface DeleteBridgeResponse { /** *The ARN of the deleted bridge.
* @public */ BridgeArn?: string | undefined; } /** * @public */ export interface DescribeBridgeRequest { /** *The Amazon Resource Name (ARN) of the bridge that you want to describe.
* @public */ BridgeArn: string | undefined; } /** * @public */ export interface DescribeBridgeResponse { /** *The bridge that you requested a description of.
* @public */ Bridge?: Bridge | undefined; } /** * @public */ export interface ListBridgesRequest { /** *Filter the list results to display only the bridges associated with the selected ARN.
* @public */ FilterArn?: string | undefined; /** *The maximum number of results to return per API request.
For example, you submit a ListBridges 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.
The token that identifies the batch of results that you want to see.
For example, you submit a ListBridges 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 ListBridges request a second time and specify the NextToken value.
A list of bridge summaries.
* @public */ Bridges?: ListedBridge[] | undefined; /** *The token that identifies the batch of results that you want to see.
For example, you submit a ListBridges 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 ListBridges request a second time and specify the NextToken value.
The Amazon Resource Name (ARN) of the bridge that you want to update.
* @public */ BridgeArn: string | undefined; /** *The name of the bridge output that you want to remove.
* @public */ OutputName: string | undefined; } /** * @public */ export interface RemoveBridgeOutputResponse { /** *The ARN of the bridge from which the output was removed.
* @public */ BridgeArn?: string | undefined; /** *The name of the bridge output that was removed.
* @public */ OutputName?: string | undefined; } /** * @public */ export interface RemoveBridgeSourceRequest { /** *The Amazon Resource Name (ARN) of the bridge that you want to update.
* @public */ BridgeArn: string | undefined; /** *The name of the bridge source that you want to remove.
* @public */ SourceName: string | undefined; } /** * @public */ export interface RemoveBridgeSourceResponse { /** *The ARN of the bridge from which the source was removed.
* @public */ BridgeArn?: string | undefined; /** *The name of the bridge source that was removed.
* @public */ SourceName?: string | undefined; } /** *Update an existing egress-type bridge.
* @public */ export interface UpdateEgressGatewayBridgeRequest { /** *The maximum expected bitrate (in bps).
* @public */ MaxBitrate?: number | undefined; } /** *Update an existing ingress-type bridge.
* @public */ export interface UpdateIngressGatewayBridgeRequest { /** *The maximum expected bitrate (in bps).
* @public */ MaxBitrate?: number | undefined; /** *The maximum number of expected outputs.
* @public */ MaxOutputs?: number | undefined; } /** *The settings for source failover.
* @public */ export interface UpdateFailoverConfig { /** *The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
* @public */ FailoverMode?: FailoverMode | undefined; /** *Recovery window time to look for dash-7 packets.
* @public */ RecoveryWindow?: number | undefined; /** *The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
* @public */ SourcePriority?: SourcePriority | undefined; /** *The state of source failover on the flow. If the state is inactive, the flow can have only one source. If the state is active, the flow can have one or two sources.
* @public */ State?: State | undefined; } /** * @public */ export interface UpdateBridgeRequest { /** *TheAmazon Resource Name (ARN) of the bridge that you want to update.
* @public */ BridgeArn: string | undefined; /** *A cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
* @public */ EgressGatewayBridge?: UpdateEgressGatewayBridgeRequest | undefined; /** *A ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
* @public */ IngressGatewayBridge?: UpdateIngressGatewayBridgeRequest | undefined; /** *The settings for source failover.
* @public */ SourceFailoverConfig?: UpdateFailoverConfig | undefined; } /** * @public */ export interface UpdateBridgeResponse { /** *The bridge that was updated.
* @public */ Bridge?: Bridge | undefined; } /** *Update an existing network output.
* @public */ export interface UpdateBridgeNetworkOutputRequest { /** *The network output IP Address.
* @public */ IpAddress?: string | undefined; /** *The network output's gateway network name.
* @public */ NetworkName?: string | undefined; /** *The network output port.
* @public */ Port?: number | undefined; /** *The network output protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The network output TTL.
* @public */ Ttl?: number | undefined; } /** * @public */ export interface UpdateBridgeOutputRequest { /** *The Amazon Resource Name (ARN) of the bridge that you want to update.
* @public */ BridgeArn: string | undefined; /** *The network of the bridge output.
* @public */ NetworkOutput?: UpdateBridgeNetworkOutputRequest | undefined; /** *Tname of the output that you want to update.
* @public */ OutputName: string | undefined; } /** * @public */ export interface UpdateBridgeOutputResponse { /** *The ARN of the bridge that was updated.
* @public */ BridgeArn?: string | undefined; /** *The bridge output that was updated.
* @public */ Output?: BridgeOutput | undefined; } /** *Update the flow source of the bridge.
* @public */ export interface UpdateBridgeFlowSourceRequest { /** *The Amazon Resource Name (ARN) that identifies the MediaConnect resource from which to delete tags.
* @public */ FlowArn?: string | undefined; /** *The name of the VPC interface attachment to use for this source.
* @public */ FlowVpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; } /** *Update the network source of the bridge.
* @public */ export interface UpdateBridgeNetworkSourceRequest { /** *The network source multicast IP.
* @public */ MulticastIp?: string | undefined; /** *The settings related to the multicast source.
* @public */ MulticastSourceSettings?: MulticastSourceSettings | undefined; /** *The network source's gateway network name.
* @public */ NetworkName?: string | undefined; /** *The network source port.
* @public */ Port?: number | undefined; /** *The network source protocol.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The Amazon Resource Name (ARN) of the bridge that you want to update.
* @public */ BridgeArn: string | undefined; /** *The name of the flow that you want to update.
* @public */ FlowSource?: UpdateBridgeFlowSourceRequest | undefined; /** *The network for the bridge source.
* @public */ NetworkSource?: UpdateBridgeNetworkSourceRequest | undefined; /** *The name of the source that you want to update.
* @public */ SourceName: string | undefined; } /** * @public */ export interface UpdateBridgeSourceResponse { /** *The ARN of the updated bridge source.
* @public */ BridgeArn?: string | undefined; /** *The updated bridge source.
* @public */ Source?: BridgeSource | undefined; } /** * @public */ export interface UpdateBridgeStateRequest { /** *The Amazon Resource Name (ARN) of the bridge that you want to update the state of.
* @public */ BridgeArn: string | undefined; /** *The desired state for the bridge.
* @public */ DesiredState: DesiredState | undefined; } /** * @public */ export interface UpdateBridgeStateResponse { /** *The ARN of the updated bridge.
* @public */ BridgeArn?: string | undefined; /** *The new state of the bridge.
* @public */ DesiredState?: DesiredState | undefined; } /** *The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution. You can choose between several predefined encoding profiles based on common use cases.
* @public */ export interface EncodingConfig { /** *The encoding profile to use when transcoding the NDI source content to a transport stream. You can change this value while the flow is running.
* @public */ EncodingProfile?: EncodingProfile | undefined; /** *The maximum video bitrate to use when transcoding the NDI source to a transport stream. This parameter enables you to override the default video bitrate within the encoding profile's supported range.
The supported range is 10,000,000 - 50,000,000 bits per second (bps). If you don't specify a value, MediaConnect uses the default value of 20,000,000 bps.
* @public */ VideoMaxBitrate?: number | undefined; } /** *Specifies the configuration settings for NDI sources and outputs.
* @public */ export interface NdiConfig { /** *A setting that controls whether NDI® sources or outputs can be used in the flow.
The default value is DISABLED. This value must be set as ENABLED for your flow to support NDI sources or outputs.
A prefix for the names of the NDI sources that the flow creates. If a custom name isn't specified, MediaConnect generates a unique 12-character ID as the prefix.
* @public */ MachineName?: string | undefined; /** *A list of up to three NDI discovery server configurations. While not required by the API, this configuration is necessary for NDI functionality to work properly.
* @public */ NdiDiscoveryServers?: NdiDiscoveryServerConfig[] | undefined; } /** *The settings for source monitoring.
* @public */ export interface MonitoringConfig { /** *Indicates whether thumbnails are enabled or disabled.
* @public */ ThumbnailState?: ThumbnailState | undefined; /** *Contains the settings for audio stream metrics monitoring.
* @public */ AudioMonitoringSettings?: AudioMonitoringSetting[] | undefined; /** *Indicates whether content quality analysis is enabled or disabled.
* @public */ ContentQualityAnalysisState?: ContentQualityAnalysisState | undefined; /** *Contains the settings for video stream metrics monitoring.
* @public */ VideoMonitoringSettings?: VideoMonitoringSetting[] | undefined; } /** * @public */ export interface CreateFlowRequest { /** *The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
* @public */ AvailabilityZone?: string | undefined; /** *The entitlements that you want to grant on a flow.
* @public */ Entitlements?: GrantEntitlementRequest[] | undefined; /** *The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.
* @public */ MediaStreams?: AddMediaStreamRequest[] | undefined; /** *The name of the flow.
* @public */ Name: string | undefined; /** *The outputs that you want to add to this flow.
* @public */ Outputs?: AddOutputRequest[] | undefined; /** *The settings for the source that you want to use for the new flow.
* @public */ Source?: SetSourceRequest | undefined; /** *The settings for source failover.
* @public */ SourceFailoverConfig?: FailoverConfig | undefined; /** *The sources that are assigned to the flow.
* @public */ Sources?: SetSourceRequest[] | undefined; /** *The VPC interfaces you want on the flow.
* @public */ VpcInterfaces?: VpcInterfaceRequest[] | undefined; /** *The maintenance settings you want to use for the flow.
* @public */ Maintenance?: AddMaintenance | undefined; /** *The settings for source monitoring.
* @public */ SourceMonitoringConfig?: MonitoringConfig | undefined; /** * Determines the processing capacity and feature set of the flow. Set this optional parameter to LARGE if you want to enable NDI sources or outputs on the flow.
Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output.
* @public */ NdiConfig?: NdiConfig | undefined; /** *The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution. You can choose between several predefined encoding profiles based on common use cases.
* @public */ EncodingConfig?: EncodingConfig | undefined; /** *The key-value pairs that can be used to tag and organize the flow.
* @public */ FlowTags?: RecordThe settings for a flow, including its source, outputs, and entitlements.
* @public */ export interface Flow { /** *The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current Amazon Web Services Region.
* @public */ AvailabilityZone: string | undefined; /** *A description of the flow. This value is not used or seen outside of the current MediaConnect account.
* @public */ Description?: string | undefined; /** *The IP address from which video will be sent to output destinations.
* @public */ EgressIp?: string | undefined; /** *The entitlements in this flow.
* @public */ Entitlements: Entitlement[] | undefined; /** *The Amazon Resource Name (ARN) of the flow.
* @public */ FlowArn: string | undefined; /** *The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
* @public */ MediaStreams?: MediaStream[] | undefined; /** *The name of the flow.
* @public */ Name: string | undefined; /** *The outputs in this flow.
* @public */ Outputs: Output[] | undefined; /** *The source for the flow.
* @public */ Source: Source | undefined; /** *The settings for the source failover.
* @public */ SourceFailoverConfig?: FailoverConfig | undefined; /** *The settings for the sources that are assigned to the flow.
* @public */ Sources?: Source[] | undefined; /** *The current status of the flow.
* @public */ Status: Status | undefined; /** *The VPC Interfaces for this flow.
* @public */ VpcInterfaces?: VpcInterface[] | undefined; /** *The maintenance settings for the flow.
* @public */ Maintenance?: Maintenance | undefined; /** *The settings for source monitoring.
* @public */ SourceMonitoringConfig?: MonitoringConfig | undefined; /** *Determines the processing capacity and feature set of the flow.
* @public */ FlowSize?: FlowSize | undefined; /** *Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output.
* @public */ NdiConfig?: NdiConfig | undefined; /** *The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution.
* @public */ EncodingConfig?: EncodingConfig | undefined; } /** * @public */ export interface CreateFlowResponse { /** *The flow that you created.
* @public */ Flow?: Flow | undefined; } /** * @public */ export interface CreateGatewayRequest { /** *The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
* @public */ EgressCidrBlocks: string[] | undefined; /** *The name of the gateway. This name can not be modified after the gateway is created.
* @public */ Name: string | undefined; /** *The list of networks that you want to add to the gateway.
* @public */ Networks: GatewayNetwork[] | undefined; } /** *The settings for a gateway, including its networks.
* @public */ export interface Gateway { /** *The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
* @public */ EgressCidrBlocks: string[] | undefined; /** *The Amazon Resource Name (ARN) of the gateway.
* @public */ GatewayArn: string | undefined; /** *Messages with information about the gateway.
* @public */ GatewayMessages?: MessageDetail[] | undefined; /** *The current status of the gateway.
* @public */ GatewayState?: GatewayState | undefined; /** *The name of the gateway. This name can not be modified after the gateway is created.
* @public */ Name: string | undefined; /** *The list of networks in the gateway.
* @public */ Networks: GatewayNetwork[] | undefined; } /** * @public */ export interface CreateGatewayResponse { /** *The gateway that you created.
* @public */ Gateway?: Gateway | undefined; } /** * @public */ export interface CreateRouterInputRequest { /** *The name of the router input.
* @public */ Name: string | undefined; /** *The configuration settings for the router input, which can include the protocol, network interface, and other details.
* @public */ Configuration: RouterInputConfiguration | undefined; /** *The maximum bitrate for the router input.
* @public */ MaximumBitrate: number | undefined; /** *Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - connects only to outputs in same Region. GLOBAL - connects to outputs in any Region.
* @public */ RoutingScope: RoutingScope | undefined; /** *The tier level for the router input.
* @public */ Tier: RouterInputTier | undefined; /** *The Amazon Web Services Region for the router input. Defaults to the current region if not specified.
* @public */ RegionName?: string | undefined; /** *The Availability Zone where you want to create the router input. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.
The transit encryption settings for the router input.
* @public */ TransitEncryption?: RouterInputTransitEncryption | undefined; /** *The maintenance configuration settings for the router input, including preferred maintenance windows and schedules.
* @public */ MaintenanceConfiguration?: MaintenanceConfiguration | undefined; /** *Key-value pairs that can be used to tag and organize this router input.
* @public */ Tags?: RecordA unique identifier for the request to ensure idempotency.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface CreateRouterInputResponse { /** *The newly-created router input.
* @public */ RouterInput: RouterInput | undefined; } /** * @public */ export interface CreateRouterNetworkInterfaceRequest { /** *The name of the router network interface.
* @public */ Name: string | undefined; /** *The configuration settings for the router network interface.
* @public */ Configuration: RouterNetworkInterfaceConfiguration | undefined; /** *The Amazon Web Services Region for the router network interface. Defaults to the current region if not specified.
* @public */ RegionName?: string | undefined; /** *Key-value pairs that can be used to tag and organize this router network interface.
* @public */ Tags?: RecordA unique identifier for the request to ensure idempotency.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface CreateRouterNetworkInterfaceResponse { /** *The newly-created router network interface.
* @public */ RouterNetworkInterface: RouterNetworkInterface | undefined; } /** * @public */ export interface CreateRouterOutputRequest { /** *The name of the router output.
* @public */ Name: string | undefined; /** *The configuration settings for the router output.
* @public */ Configuration: RouterOutputConfiguration | undefined; /** *The maximum bitrate for the router output.
* @public */ MaximumBitrate: number | undefined; /** *Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.
* @public */ RoutingScope: RoutingScope | undefined; /** *The tier level for the router output.
* @public */ Tier: RouterOutputTier | undefined; /** *The Amazon Web Services Region for the router output. Defaults to the current region if not specified.
* @public */ RegionName?: string | undefined; /** *The Availability Zone where you want to create the router output. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.
The maintenance configuration settings for the router output, including preferred maintenance windows and schedules.
* @public */ MaintenanceConfiguration?: MaintenanceConfiguration | undefined; /** *Key-value pairs that can be used to tag this router output.
* @public */ Tags?: RecordA unique identifier for the request to ensure idempotency.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface CreateRouterOutputResponse { /** *The newly-created router output.
* @public */ RouterOutput: RouterOutput | undefined; } /** * @public */ export interface DeleteFlowRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to delete.
* @public */ FlowArn: string | undefined; } /** * @public */ export interface DeleteFlowResponse { /** *The ARN of the flow that was deleted.
* @public */ FlowArn?: string | undefined; /** * The status of the flow when the DeleteFlow process begins.
The Amazon Resource Name (ARN) of the gateway that you want to delete.
* @public */ GatewayArn: string | undefined; } /** * @public */ export interface DeleteGatewayResponse { /** *The ARN of the gateway that was deleted.
* @public */ GatewayArn?: string | undefined; } /** * @public */ export interface DeleteRouterInputRequest { /** *The Amazon Resource Name (ARN) of the router input that you want to delete.
* @public */ Arn: string | undefined; } /** * @public */ export interface DeleteRouterInputResponse { /** *The ARN of the deleted router input.
* @public */ Arn: string | undefined; /** *The name of the deleted router input.
* @public */ Name: string | undefined; /** *The current state of the deleted router input, indicating where it is in the deletion process.
* @public */ State: RouterInputState | undefined; } /** * @public */ export interface DeleteRouterNetworkInterfaceRequest { /** *The Amazon Resource Name (ARN) of the router network interface that you want to delete.
* @public */ Arn: string | undefined; } /** * @public */ export interface DeleteRouterNetworkInterfaceResponse { /** *The ARN of the deleted router network interface.
* @public */ Arn: string | undefined; /** *The name of the deleted router network interface.
* @public */ Name: string | undefined; /** *The current state of the deleted router network interface, indicating where it is in the deletion process.
* @public */ State: RouterNetworkInterfaceState | undefined; } /** * @public */ export interface DeleteRouterOutputRequest { /** *The Amazon Resource Name (ARN) of the router output that you want to delete.
* @public */ Arn: string | undefined; } /** * @public */ export interface DeleteRouterOutputResponse { /** *The ARN of the deleted router output.
* @public */ Arn: string | undefined; /** *The name of the deleted router output.
* @public */ Name: string | undefined; /** *The current state of the deleted router output, indicating where it is in the deletion process.
* @public */ State: RouterOutputState | undefined; } /** * @public */ export interface DeregisterGatewayInstanceRequest { /** *Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.
* @public */ Force?: boolean | undefined; /** *The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.
* @public */ GatewayInstanceArn: string | undefined; } /** * @public */ export interface DeregisterGatewayInstanceResponse { /** *The ARN of the instance.
* @public */ GatewayInstanceArn?: string | undefined; /** *The status of the instance.
* @public */ InstanceState?: InstanceState | undefined; } /** * @public */ export interface DescribeFlowRequest { /** *The ARN of the flow that you want to describe.
* @public */ FlowArn: string | undefined; } /** *Messages that provide the state of the flow.
* @public */ export interface Messages { /** *A list of errors that might have been generated from processes on this flow.
* @public */ Errors: string[] | undefined; } /** * @public */ export interface DescribeFlowResponse { /** *The flow that you requested a description of.
* @public */ Flow?: Flow | undefined; /** *Any errors that apply currently to the flow. If there are no errors, MediaConnect will not include this field in the response.
* @public */ Messages?: Messages | undefined; } /** * @public */ export interface DescribeFlowSourceMetadataRequest { /** *The Amazon Resource Name (ARN) of the flow.
* @public */ FlowArn: string | undefined; } /** *Metadata about the audio and video media that is part of the NDI® source content. This includes details about the individual media streams.
* @public */ export interface NdiMediaInfo { /** *A list of the individual media streams that make up the NDI source. This includes details about each stream's codec, resolution, frame rate, audio channels, and other parameters.
* @public */ Streams: NdiMediaStreamInfo[] | undefined; } /** *Comprehensive information about the NDI® source that's associated with a flow. This includes the currently active NDI source, a list of all discovered NDI senders, metadata about the media streams, and any relevant status messages.
* @public */ export interface NdiSourceMetadataInfo { /** *The connected NDI sender that's currently sending source content to the flow's NDI source.
* @public */ ActiveSource?: NdiSourceInfo | undefined; /** *A list of the available upstream NDI senders aggregated from all of your configured discovery servers.
* @public */ DiscoveredSources: NdiSourceInfo[] | undefined; /** *Detailed information about the media streams (video, audio, and so on) that are part of the active NDI source.
* @public */ MediaInfo: NdiMediaInfo | undefined; /** *Any status messages or error codes related to the NDI source and its metadata.
* @public */ Messages: MessageDetail[] | undefined; } /** *The metadata of the transport stream in the current flow's source.
* @public */ export interface TransportMediaInfo { /** *The list of transport stream programs in the current flow's source.
* @public */ Programs: TransportStreamProgram[] | undefined; } /** * @public */ export interface DescribeFlowSourceMetadataResponse { /** *The ARN of the flow that DescribeFlowSourceMetadata was performed on.
* @public */ FlowArn?: string | undefined; /** *Provides a status code and message regarding issues found with the flow source metadata.
* @public */ Messages?: MessageDetail[] | undefined; /** *The timestamp of the most recent change in metadata for this flow’s source.
* @public */ Timestamp?: Date | undefined; /** *Information about the flow's transport media.
* @public */ TransportMediaInfo?: TransportMediaInfo | undefined; /** *The NDI® specific information about the flow's source. This includes the current active NDI sender, a list of all discovered NDI senders, the associated media streams for the active NDI sender, and any relevant status messages.
* @public */ NdiInfo?: NdiSourceMetadataInfo | undefined; } /** * @public */ export interface DescribeFlowSourceThumbnailRequest { /** *The Amazon Resource Name (ARN) of the flow.
* @public */ FlowArn: string | undefined; } /** *The details of the thumbnail, including thumbnail base64 string, timecode and the time when thumbnail was generated.
* @public */ export interface ThumbnailDetails { /** *The ARN of the flow that DescribeFlowSourceThumbnail was performed on.
* @public */ FlowArn: string | undefined; /** *Thumbnail Base64 string.
* @public */ Thumbnail?: string | undefined; /** *Status code and messages about the flow source thumbnail.
* @public */ ThumbnailMessages: MessageDetail[] | undefined; /** *Timecode of thumbnail.
* @public */ Timecode?: string | undefined; /** *The timestamp of when thumbnail was generated.
* @public */ Timestamp?: Date | undefined; } /** * @public */ export interface DescribeFlowSourceThumbnailResponse { /** *The details of the thumbnail, including thumbnail base64 string, timecode and the time when thumbnail was generated.
* @public */ ThumbnailDetails?: ThumbnailDetails | undefined; } /** * @public */ export interface DescribeGatewayRequest { /** *The ARN of the gateway that you want to describe.
* @public */ GatewayArn: string | undefined; } /** * @public */ export interface DescribeGatewayResponse { /** *The gateway that you wanted to describe.
* @public */ Gateway?: Gateway | undefined; } /** * @public */ export interface DescribeGatewayInstanceRequest { /** *The Amazon Resource Name (ARN) of the gateway instance that you want to describe.
* @public */ GatewayInstanceArn: string | undefined; } /** *The settings for an instance in a gateway.
* @public */ export interface GatewayInstance { /** *The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.
* @public */ BridgePlacement: BridgePlacement | undefined; /** *The connection state of the instance.
* @public */ ConnectionStatus: ConnectionStatus | undefined; /** *The Amazon Resource Name (ARN) of the instance.
* @public */ GatewayArn: string | undefined; /** *The ARN of the gateway.
* @public */ GatewayInstanceArn: string | undefined; /** *The instance ID generated by the SSM install. This will begin with "mi-".
* @public */ InstanceId: string | undefined; /** *Messages with information about the gateway.
* @public */ InstanceMessages?: MessageDetail[] | undefined; /** *The status of the instance.
* @public */ InstanceState: InstanceState | undefined; /** *The running bridge count.
* @public */ RunningBridgeCount: number | undefined; } /** * @public */ export interface DescribeGatewayInstanceResponse { /** *The gateway instance that you requested a description of.
* @public */ GatewayInstance?: GatewayInstance | undefined; } /** * @public */ export interface DescribeOfferingRequest { /** *The ARN of the offering.
* @public */ OfferingArn: string | undefined; } /** * @public */ export interface DescribeOfferingResponse { /** *The offering that you requested a description of.
* @public */ Offering?: Offering | undefined; } /** * @public */ export interface DescribeReservationRequest { /** *The Amazon Resource Name (ARN) of the offering.
* @public */ ReservationArn: string | undefined; } /** * @public */ export interface DescribeReservationResponse { /** *A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
* @public */ Reservation?: Reservation | undefined; } /** * @public */ export interface GrantFlowEntitlementsRequest { /** *The list of entitlements that you want to grant.
* @public */ Entitlements: GrantEntitlementRequest[] | undefined; /** *The Amazon Resource Name (ARN) of the flow that you want to grant entitlements on.
* @public */ FlowArn: string | undefined; } /** * @public */ export interface GrantFlowEntitlementsResponse { /** *The entitlements that were just granted.
* @public */ Entitlements?: Entitlement[] | undefined; /** *The ARN of the flow that these entitlements were granted to.
* @public */ FlowArn?: string | undefined; } /** * @public */ export interface ListFlowsRequest { /** *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.
The token that identifies the 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.
A list of flow summaries.
* @public */ Flows?: ListedFlow[] | undefined; /** *The token that identifies the 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.
The Amazon Resource Name (ARN) of the flow that you want to update.
* @public */ FlowArn: string | undefined; /** *The name of the media stream that you want to remove.
* @public */ MediaStreamName: string | undefined; } /** * @public */ export interface RemoveFlowMediaStreamResponse { /** *The ARN of the flow that was updated.
* @public */ FlowArn?: string | undefined; /** *The name of the media stream that was removed.
* @public */ MediaStreamName?: string | undefined; } /** * @public */ export interface RemoveFlowOutputRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to remove an output from.
* @public */ FlowArn: string | undefined; /** *The ARN of the output that you want to remove.
* @public */ OutputArn: string | undefined; } /** * @public */ export interface RemoveFlowOutputResponse { /** *The ARN of the flow that the output was removed from.
* @public */ FlowArn?: string | undefined; /** *The ARN of the output that was removed.
* @public */ OutputArn?: string | undefined; } /** * @public */ export interface RemoveFlowSourceRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to remove a source from.
* @public */ FlowArn: string | undefined; /** *The ARN of the source that you want to remove.
* @public */ SourceArn: string | undefined; } /** * @public */ export interface RemoveFlowSourceResponse { /** *The ARN of the flow that the source was removed from.
* @public */ FlowArn?: string | undefined; /** *The ARN of the source that was removed.
* @public */ SourceArn?: string | undefined; } /** * @public */ export interface RemoveFlowVpcInterfaceRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to remove a VPC interface from.
* @public */ FlowArn: string | undefined; /** *The name of the VPC interface that you want to remove.
* @public */ VpcInterfaceName: string | undefined; } /** * @public */ export interface RemoveFlowVpcInterfaceResponse { /** *The ARN of the flow that is associated with the VPC interface you removed.
* @public */ FlowArn?: string | undefined; /** *IDs of network interfaces associated with the removed VPC interface that MediaConnect was unable to remove.
* @public */ NonDeletedNetworkInterfaceIds?: string[] | undefined; /** *The name of the VPC interface that was removed.
* @public */ VpcInterfaceName?: string | undefined; } /** * @public */ export interface RevokeFlowEntitlementRequest { /** *The Amazon Resource Name (ARN) of the entitlement that you want to revoke.
* @public */ EntitlementArn: string | undefined; /** *The flow that you want to revoke an entitlement from.
* @public */ FlowArn: string | undefined; } /** * @public */ export interface RevokeFlowEntitlementResponse { /** *The ARN of the entitlement that was revoked.
* @public */ EntitlementArn?: string | undefined; /** *The ARN of the flow that the entitlement was revoked from.
* @public */ FlowArn?: string | undefined; } /** * @public */ export interface StartFlowRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to start.
* @public */ FlowArn: string | undefined; } /** * @public */ export interface StartFlowResponse { /** *The ARN of the flow that you started.
* @public */ FlowArn?: string | undefined; /** * The status of the flow when the StartFlow process begins.
The Amazon Resource Name (ARN) of the flow that you want to stop.
* @public */ FlowArn: string | undefined; } /** * @public */ export interface StopFlowResponse { /** *The ARN of the flow that you stopped.
* @public */ FlowArn?: string | undefined; /** * The status of the flow when the StopFlow process begins.
Update maintenance setting for a flow.
* @public */ export interface UpdateMaintenance { /** *A day of a week when the maintenance will happen.
* @public */ MaintenanceDay?: MaintenanceDay | undefined; /** *A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
* @public */ MaintenanceScheduledDate?: string | undefined; /** *UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
* @public */ MaintenanceStartHour?: string | undefined; } /** * @public */ export interface UpdateFlowRequest { /** *The Amazon Resource Name (ARN) of the flow that you want to update.
* @public */ FlowArn: string | undefined; /** *The settings for source failover.
* @public */ SourceFailoverConfig?: UpdateFailoverConfig | undefined; /** *The maintenance setting of the flow.
* @public */ Maintenance?: UpdateMaintenance | undefined; /** *The settings for source monitoring.
* @public */ SourceMonitoringConfig?: MonitoringConfig | undefined; /** *Specifies the configuration settings for a flow's NDI source or output. Required when the flow includes an NDI source or output.
* @public */ NdiConfig?: NdiConfig | undefined; /** *Determines the processing capacity and feature set of the flow.
* @public */ FlowSize?: FlowSize | undefined; /** *The encoding configuration to apply to the NDI® source when transcoding it to a transport stream for downstream distribution. You can choose between several predefined encoding profiles based on common use cases.
* @public */ EncodingConfig?: EncodingConfig | undefined; } /** * @public */ export interface UpdateFlowResponse { /** *The updated flow.
* @public */ Flow?: Flow | undefined; } /** *Information about the encryption of the flow.
* @public */ export interface UpdateEncryption { /** *The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
* @public */ Algorithm?: Algorithm | undefined; /** *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.
* @public */ ConstantInitializationVector?: string | undefined; /** *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.
* @public */ DeviceId?: string | undefined; /** *The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
* @public */ KeyType?: KeyType | undefined; /** *The Amazon Web Services 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.
* @public */ Region?: string | undefined; /** *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.
* @public */ ResourceId?: string | undefined; /** *The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).
* @public */ RoleArn?: string | undefined; /** *The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
* @public */ SecretArn?: string | undefined; /** *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.
* @public */ Url?: string | undefined; } /** * @public */ export interface UpdateFlowEntitlementRequest { /** *A description of the entitlement. This description appears only on the MediaConnect console and will not be seen by the subscriber or end user.
* @public */ Description?: string | undefined; /** *The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.
* @public */ Encryption?: UpdateEncryption | undefined; /** *The Amazon Resource Name (ARN) of the entitlement that you want to update.
* @public */ EntitlementArn: string | undefined; /** * An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
The ARN of the flow that is associated with the entitlement that you want to update.
* @public */ FlowArn: string | undefined; /** *The Amazon Web Services 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.
* @public */ Subscribers?: string[] | undefined; } /** * @public */ export interface UpdateFlowEntitlementResponse { /** *The new configuration of the entitlement that you updated.
* @public */ Entitlement?: Entitlement | undefined; /** *The ARN of the flow that this entitlement was granted on.
* @public */ FlowArn?: string | undefined; } /** * @public */ export interface UpdateFlowMediaStreamRequest { /** *The attributes that you want to assign to the media stream.
* @public */ Attributes?: MediaStreamAttributesRequest | undefined; /** *The sample rate for the stream. This value in measured in kHz.
* @public */ ClockRate?: number | undefined; /** *A description that can help you quickly identify what your media stream is used for.
* @public */ Description?: string | undefined; /** *The Amazon Resource Name (ARN) of the flow that is associated with the media stream that you updated.
* @public */ FlowArn: string | undefined; /** *The media stream that you updated.
* @public */ MediaStreamName: string | undefined; /** *The type of media stream.
* @public */ MediaStreamType?: MediaStreamType | undefined; /** *The resolution of the video.
* @public */ VideoFormat?: string | undefined; } /** * @public */ export interface UpdateFlowMediaStreamResponse { /** *The ARN of the flow that is associated with the media stream that you updated.
* @public */ FlowArn?: string | undefined; /** *The media stream that you updated.
* @public */ MediaStream?: MediaStream | undefined; } /** * @public */ export interface UpdateFlowOutputRequest { /** *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.
* @public */ CidrAllowList?: string[] | undefined; /** *A description of the output. This description appears only on the MediaConnect console and will not be seen by the end user.
* @public */ Description?: string | undefined; /** *The IP address where you want to send the output.
* @public */ Destination?: string | undefined; /** * 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.
The Amazon Resource Name (ARN) of the flow that is associated with the output that you want to update.
* @public */ FlowArn: string | undefined; /** *The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
* @public */ MaxLatency?: number | undefined; /** *The media streams that are associated with the output, and the parameters for those associations.
* @public */ MediaStreamOutputConfigurations?: MediaStreamOutputConfigurationRequest[] | undefined; /** *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.
* @public */ MinLatency?: number | undefined; /** *The ARN of the output that you want to update.
* @public */ OutputArn: string | undefined; /** *The port to use when content is distributed to this output.
* @public */ Port?: number | undefined; /** *The protocol to use for the output.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The remote ID for the Zixi-pull stream.
* @public */ RemoteId?: string | undefined; /** *The port that the flow uses to send outbound requests to initiate connection with the sender.
* @public */ SenderControlPort?: number | undefined; /** *The IP address that the flow communicates with to initiate connection with the sender.
* @public */ SenderIpAddress?: string | undefined; /** *The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
* @public */ SmoothingLatency?: number | undefined; /** *The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
* @public */ StreamId?: string | undefined; /** *The name of the VPC interface attachment to use for this output.
* @public */ VpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; /** * An indication of whether the output should transmit data or not. If you don't specify the outputStatus field in your request, MediaConnect leaves the value unchanged.
A suffix for the name of the NDI® sender that the flow creates. If a custom name isn't specified, MediaConnect uses the output name.
* @public */ NdiProgramName?: string | undefined; /** *A quality setting for the NDI Speed HQ encoder.
* @public */ NdiSpeedHqQuality?: number | undefined; /** *Indicates whether to enable or disable router integration for this flow output.
* @public */ RouterIntegrationState?: State | undefined; /** *The configuration that defines how content is encrypted during transit between the MediaConnect router and a MediaConnect flow.
* @public */ RouterIntegrationTransitEncryption?: FlowTransitEncryption | undefined; } /** * @public */ export interface UpdateFlowOutputResponse { /** *The ARN of the flow that is associated with the updated output.
* @public */ FlowArn?: string | undefined; /** *The new settings of the output that you updated.
* @public */ Output?: Output | undefined; } /** *The source configuration for cloud flows receiving a stream from a bridge.
* @public */ export interface UpdateGatewayBridgeSourceRequest { /** *The ARN of the bridge feeding this flow.
* @public */ BridgeArn?: string | undefined; /** *The name of the VPC interface attachment to use for this bridge source.
* @public */ VpcInterfaceAttachment?: VpcInterfaceAttachment | undefined; } /** * @public */ export interface UpdateFlowSourceRequest { /** *The type of encryption that is used on the content ingested from the source.
* @public */ Decryption?: UpdateEncryption | undefined; /** *A description of the source. This description is not visible outside of the current Amazon Web Services account.
* @public */ Description?: string | undefined; /** *The Amazon Resource Name (ARN) of the entitlement that allows you to subscribe to the flow. The entitlement is set by the content originator, and the ARN is generated as part of the originator's flow.
* @public */ EntitlementArn?: string | undefined; /** *The ARN of the flow that you want to update.
* @public */ FlowArn: string | undefined; /** *The port that the flow listens on for incoming content. If the protocol of the source is Zixi, the port must be set to 2088.
* @public */ IngestPort?: number | undefined; /** *The maximum bitrate for RIST, RTP, and RTP-FEC streams.
* @public */ MaxBitrate?: number | undefined; /** *The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.
* @public */ MaxLatency?: number | undefined; /** *The size of the buffer (in milliseconds) to use to sync incoming source data.
* @public */ MaxSyncBuffer?: number | undefined; /** *The media stream that is associated with the source, and the parameters for that association.
* @public */ MediaStreamSourceConfigurations?: MediaStreamSourceConfigurationRequest[] | undefined; /** *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.
* @public */ MinLatency?: number | undefined; /** *The protocol that the source uses to deliver the content to MediaConnect.
Elemental MediaConnect no longer supports the Fujitsu QoS protocol. This reference is maintained for legacy purposes only.
The port that the flow uses to send outbound requests to initiate connection with the sender.
* @public */ SenderControlPort?: number | undefined; /** *The IP address that the flow communicates with to initiate connection with the sender.
* @public */ SenderIpAddress?: string | undefined; /** *The ARN of the source that you want to update.
* @public */ SourceArn: string | undefined; /** *The source IP or domain name for SRT-caller protocol.
* @public */ SourceListenerAddress?: string | undefined; /** *Source port for SRT-caller protocol.
* @public */ SourceListenerPort?: number | undefined; /** *The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
* @public */ StreamId?: string | undefined; /** *The name of the VPC interface that you want to send your output to.
* @public */ VpcInterfaceName?: string | undefined; /** *The range of IP addresses that are allowed to contribute content to your source. Format the IP addresses as a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
* @public */ WhitelistCidr?: string | undefined; /** *The source configuration for cloud flows receiving a stream from a bridge.
* @public */ GatewayBridgeSource?: UpdateGatewayBridgeSourceRequest | undefined; /** *The settings for the NDI source. This includes the exact name of the upstream NDI sender that you want to connect to your source.
* @public */ NdiSourceSettings?: NdiSourceSettings | undefined; /** *Indicates whether to enable or disable router integration for this flow source.
* @public */ RouterIntegrationState?: State | undefined; /** *The encryption configuration for the flow source when router integration is enabled.
* @public */ RouterIntegrationTransitDecryption?: FlowTransitEncryption | undefined; } /** * @public */ export interface UpdateFlowSourceResponse { /** *The ARN of the flow that you updated.
* @public */ FlowArn?: string | undefined; /** *The details of the sources that are assigned to the flow.
* @public */ Source?: Source | undefined; } /** * @public */ export interface ListGatewayInstancesRequest { /** *Filter the list results to display only the instances associated with the selected Gateway ARN.
* @public */ FilterArn?: string | undefined; /** *The maximum number of results to return per API request.
For example, you submit a ListInstances 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.
The token that identifies the batch of results that you want to see.
For example, you submit a ListInstances 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 ListInstances request a second time and specify the NextToken value.
A list of instance summaries.
* @public */ Instances?: ListedGatewayInstance[] | undefined; /** *The token that identifies the batch of results that you want to see.
For example, you submit a ListInstances 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 ListInstances request a second time and specify the NextToken value.
The state of the instance. ACTIVE or INACTIVE.
The Amazon Resource Name (ARN) of the gateway instance that you want to update.
* @public */ GatewayInstanceArn: string | undefined; } /** * @public */ export interface UpdateGatewayInstanceResponse { /** *The state of the instance. ACTIVE or INACTIVE.
The ARN of the instance that was updated.
* @public */ GatewayInstanceArn?: string | undefined; } /** * @public */ export interface ListGatewaysRequest { /** *The maximum number of results to return per API request.
For example, you submit a ListGateways 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.
The token that identifies the batch of results that you want to see.
For example, you submit a ListGateways 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 ListGateways request a second time and specify the NextToken value.
A list of gateway summaries.
* @public */ Gateways?: ListedGateway[] | undefined; /** *The token that identifies the batch of results that you want to see.
For example, you submit a ListGateways 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 ListGateways request a second time and specify the NextToken value.
The Amazon Resource Name (ARN) of the router input to retrieve information about.
* @public */ Arn: string | undefined; } /** * @public */ export interface GetRouterInputResponse { /** *The details of the requested router input, including its configuration, state, and other attributes.
* @public */ RouterInput: RouterInput | undefined; } /** * @public */ export interface GetRouterInputSourceMetadataRequest { /** *The Amazon Resource Name (ARN) of the router input to retrieve metadata for.
* @public */ Arn: string | undefined; } /** *Metadata information associated with the router input, including stream details and connection state.
* @public */ export type RouterInputMetadata = RouterInputMetadata.TransportStreamMediaInfoMember | RouterInputMetadata.$UnknownMember; /** * @public */ export declare namespace RouterInputMetadata { /** *The metadata of the transport stream in the current flow's source.
* @public */ interface TransportStreamMediaInfoMember { TransportStreamMediaInfo: TransportMediaInfo; $unknown?: never; } /** * @public */ interface $UnknownMember { TransportStreamMediaInfo?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorDetailed metadata information about a router input source.
* @public */ export interface RouterInputSourceMetadataDetails { /** *Collection of metadata messages associated with the router input source.
* @public */ SourceMetadataMessages: RouterInputMessage[] | undefined; /** *The timestamp when the metadata was last updated.
* @public */ Timestamp: Date | undefined; /** *Metadata information specific to the router input configuration and state.
* @public */ RouterInputMetadata?: RouterInputMetadata | undefined; } /** * @public */ export interface GetRouterInputSourceMetadataResponse { /** *The Amazon Resource Name (ARN) of the router input.
* @public */ Arn: string | undefined; /** *The name of the router input.
* @public */ Name: string | undefined; /** *Detailed metadata information about the router input source, including connection state, timestamps, and stream configuration.
* @public */ SourceMetadataDetails: RouterInputSourceMetadataDetails | undefined; } /** * @public */ export interface GetRouterInputThumbnailRequest { /** *The Amazon Resource Name (ARN) of the router input that you want to see a thumbnail of.
* @public */ Arn: string | undefined; } /** *The details of a thumbnail associated with a router input, including the thumbnail messages, the thumbnail image, the timecode, and the timestamp.
* @public */ export interface RouterInputThumbnailDetails { /** *The messages associated with the router input thumbnail.
* @public */ ThumbnailMessages: RouterInputMessage[] | undefined; /** *The thumbnail image, encoded as a Base64-encoded binary data object.
* @public */ Thumbnail?: Uint8Array | undefined; /** *The timecode associated with the thumbnail.
* @public */ Timecode?: string | undefined; /** *The timestamp associated with the thumbnail.
* @public */ Timestamp?: Date | undefined; } /** * @public */ export interface GetRouterInputThumbnailResponse { /** *The ARN of the router input.
* @public */ Arn: string | undefined; /** *The name of the router input.
* @public */ Name: string | undefined; /** *The details of the thumbnail associated with the router input, including the thumbnail image, timecode, timestamp, and any associated error messages.
* @public */ ThumbnailDetails: RouterInputThumbnailDetails | undefined; } /** * @public */ export interface GetRouterNetworkInterfaceRequest { /** *The Amazon Resource Name (ARN) of the router network interface that you want to retrieve information about.
* @public */ Arn: string | undefined; } /** * @public */ export interface GetRouterNetworkInterfaceResponse { /** *The details of the requested router network interface, including its configuration and other attributes.
* @public */ RouterNetworkInterface: RouterNetworkInterface | undefined; } /** * @public */ export interface GetRouterOutputRequest { /** *The Amazon Resource Name (ARN) of the router output that you want to retrieve information about.
* @public */ Arn: string | undefined; } /** * @public */ export interface GetRouterOutputResponse { /** *The details of the requested router output, including its configuration, state, and other attributes.
* @public */ RouterOutput: RouterOutput | undefined; } /** *A summary of a router input, including its name, type, ARN, ID, state, and other key details. This structure is used in the response of the ListRouterInputs operation.
* @public */ export interface ListedRouterInput { /** *The name of the router input.
* @public */ Name: string | undefined; /** *The Amazon Resource Name (ARN) of the router input.
* @public */ Arn: string | undefined; /** *The unique identifier of the router input.
* @public */ Id: string | undefined; /** *The type of the router input.
* @public */ InputType: RouterInputType | undefined; /** *The overall state of the router input.
* @public */ State: RouterInputState | undefined; /** *The number of router outputs that are associated with this router input.
* @public */ RoutedOutputs: number | undefined; /** *The Amazon Web Services Region where the router input is located.
* @public */ RegionName: string | undefined; /** *The Availability Zone of the router input.
* @public */ AvailabilityZone: string | undefined; /** *The maximum bitrate of the router input.
* @public */ MaximumBitrate: number | undefined; /** *Indicates whether the router input is configured for Regional or global routing.
* @public */ RoutingScope: RoutingScope | undefined; /** *The timestamp when the router input was created.
* @public */ CreatedAt: Date | undefined; /** *The timestamp when the router input was last updated.
* @public */ UpdatedAt: Date | undefined; /** *The number of messages associated with the router input.
* @public */ MessageCount: number | undefined; /** *The ARN of the network interface associated with the router input.
* @public */ NetworkInterfaceArn?: string | undefined; /** *The type of maintenance schedule currently associated with the listed router input.
* @public */ MaintenanceScheduleType?: MaintenanceScheduleType | undefined; /** *The details of the maintenance schedule for the listed router input.
* @public */ MaintenanceSchedule?: MaintenanceSchedule | undefined; } /** *A summary of a router network interface, including its name, type, ARN, ID, associated input/output counts, state, and other key details. This structure is used in the response of the ListRouterNetworkInterfaces operation.
* @public */ export interface ListedRouterNetworkInterface { /** *The name of the router network interface.
* @public */ Name: string | undefined; /** *The Amazon Resource Name (ARN) of the router network interface.
* @public */ Arn: string | undefined; /** *The unique identifier of the router network interface.
* @public */ Id: string | undefined; /** *The type of the router network interface.
* @public */ NetworkInterfaceType: RouterNetworkInterfaceType | undefined; /** *The number of router outputs associated with the network interface.
* @public */ AssociatedOutputCount: number | undefined; /** *The number of router inputs associated with the network interface.
* @public */ AssociatedInputCount: number | undefined; /** *The current state of the router network interface.
* @public */ State: RouterNetworkInterfaceState | undefined; /** *The Amazon Web Services Region where the router network interface is located.
* @public */ RegionName: string | undefined; /** *The timestamp when the network interface was created.
* @public */ CreatedAt: Date | undefined; /** *The timestamp when the router network interface was last updated.
* @public */ UpdatedAt: Date | undefined; } /** *A summary of a router output, including its name, type, ARN, ID, state, routed state, and other key details. This structure is used in the response of the ListRouterOutputs operation.
* @public */ export interface ListedRouterOutput { /** *The name of the router output.
* @public */ Name: string | undefined; /** *The Amazon Resource Name (ARN) of the router output.
* @public */ Arn: string | undefined; /** *The unique identifier of the router output.
* @public */ Id: string | undefined; /** *The type of the router output.
* @public */ OutputType: RouterOutputType | undefined; /** *The overall state of the router output.
* @public */ State: RouterOutputState | undefined; /** *The current state of the association between the router output and its input.
* @public */ RoutedState: RouterOutputRoutedState | undefined; /** *The AAmazon Web Services Region where the router output is located.
* @public */ RegionName: string | undefined; /** *The Availability Zone of the router output.
* @public */ AvailabilityZone: string | undefined; /** *The maximum bitrate of the router output.
* @public */ MaximumBitrate: number | undefined; /** *Indicates whether the router output is configured for Regional or global routing.
* @public */ RoutingScope: RoutingScope | undefined; /** *The timestamp when the router output was created.
* @public */ CreatedAt: Date | undefined; /** *The timestamp when the router output was last updated.
* @public */ UpdatedAt: Date | undefined; /** *The number of messages associated with the router output.
* @public */ MessageCount: number | undefined; /** *The ARN of the router input associated with the output.
* @public */ RoutedInputArn?: string | undefined; /** *The ARN of the network interface associated with the router output.
* @public */ NetworkInterfaceArn?: string | undefined; /** *The type of maintenance schedule currently associated with the listed router output.
* @public */ MaintenanceScheduleType?: MaintenanceScheduleType | undefined; /** *The details of the maintenance schedule for the listed router output.
* @public */ MaintenanceSchedule?: MaintenanceSchedule | undefined; } /** * @public */ export interface ListEntitlementsRequest { /** *The maximum number of results to return per API request.
For example, you submit a ListEntitlements request with 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.
The token that identifies the 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.
A list of entitlements that have been granted to you from other Amazon Web Services accounts.
* @public */ Entitlements?: ListedEntitlement[] | undefined; /** *The token that identifies the 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.
The maximum number of results to return per API request.
For example, you submit a ListOfferings request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)
The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
The token that identifies the batch of results that you want to see.
For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
The token that identifies the batch of results that you want to see.
For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
A list of offerings that are available to this account in the current Amazon Web Services Region.
* @public */ Offerings?: Offering[] | undefined; } /** * @public */ export interface ListReservationsRequest { /** *The maximum number of results to return per API request.
For example, you submit a ListReservations request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)
The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
The token that identifies the batch of results that you want to see.
For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
The token that identifies the batch of results that you want to see.
For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.
A list of all reservations that have been purchased by this account in the current Amazon Web Services Region.
* @public */ Reservations?: Reservation[] | undefined; } /** *A filter that can be used to retrieve a list of router inputs.
* @public */ export type RouterInputFilter = RouterInputFilter.InputTypesMember | RouterInputFilter.NameContainsMember | RouterInputFilter.NetworkInterfaceArnsMember | RouterInputFilter.RegionNamesMember | RouterInputFilter.RoutingScopesMember | RouterInputFilter.$UnknownMember; /** * @public */ export declare namespace RouterInputFilter { /** *The names of the router inputs to include in the filter.
* @public */ interface NameContainsMember { NameContains: string[]; RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes?: never; InputTypes?: never; $unknown?: never; } /** *The AWS Regions of the router inputs to include in the filter.
* @public */ interface RegionNamesMember { NameContains?: never; RegionNames: string[]; NetworkInterfaceArns?: never; RoutingScopes?: never; InputTypes?: never; $unknown?: never; } /** *The Amazon Resource Names (ARNs) of the network interfaces associated with the router inputs to include in the filter.
* @public */ interface NetworkInterfaceArnsMember { NameContains?: never; RegionNames?: never; NetworkInterfaceArns: string[]; RoutingScopes?: never; InputTypes?: never; $unknown?: never; } /** *Filter criteria to list router inputs based on their routing scope (REGIONAL or GLOBAL).
* @public */ interface RoutingScopesMember { NameContains?: never; RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes: RoutingScope[]; InputTypes?: never; $unknown?: never; } /** *The types of router inputs to include in the filter.
* @public */ interface InputTypesMember { NameContains?: never; RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes?: never; InputTypes: RouterInputType[]; $unknown?: never; } /** * @public */ interface $UnknownMember { NameContains?: never; RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes?: never; InputTypes?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe maximum number of router inputs to return in the response.
* @public */ MaxResults?: number | undefined; /** *A token used to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *The filters to apply when retrieving the list of router inputs.
* @public */ Filters?: RouterInputFilter[] | undefined; } /** * @public */ export interface ListRouterInputsResponse { /** *The summary information for the retrieved router inputs.
* @public */ RouterInputs: ListedRouterInput[] | undefined; /** *The token to use to retrieve the next page of results.
* @public */ NextToken?: string | undefined; } /** *A filter that can be used to retrieve a list of router network interfaces.
* @public */ export type RouterNetworkInterfaceFilter = RouterNetworkInterfaceFilter.NameContainsMember | RouterNetworkInterfaceFilter.NetworkInterfaceTypesMember | RouterNetworkInterfaceFilter.RegionNamesMember | RouterNetworkInterfaceFilter.$UnknownMember; /** * @public */ export declare namespace RouterNetworkInterfaceFilter { /** *The AWS Regions of the router network interfaces to include in the filter.
* @public */ interface RegionNamesMember { RegionNames: string[]; NetworkInterfaceTypes?: never; NameContains?: never; $unknown?: never; } /** *The types of router network interfaces to include in the filter.
* @public */ interface NetworkInterfaceTypesMember { RegionNames?: never; NetworkInterfaceTypes: RouterNetworkInterfaceType[]; NameContains?: never; $unknown?: never; } /** *The names of the router network interfaces to include in the filter.
* @public */ interface NameContainsMember { RegionNames?: never; NetworkInterfaceTypes?: never; NameContains: string[]; $unknown?: never; } /** * @public */ interface $UnknownMember { RegionNames?: never; NetworkInterfaceTypes?: never; NameContains?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe maximum number of router network interfaces to return in the response.
* @public */ MaxResults?: number | undefined; /** *A token used to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *The filters to apply when retrieving the list of router network interfaces.
* @public */ Filters?: RouterNetworkInterfaceFilter[] | undefined; } /** * @public */ export interface ListRouterNetworkInterfacesResponse { /** *The summary information for the retrieved router network interfaces.
* @public */ RouterNetworkInterfaces: ListedRouterNetworkInterface[] | undefined; /** *The token to use to retrieve the next page of results.
* @public */ NextToken?: string | undefined; } /** *A filter that can be used to retrieve a list of router outputs.
* @public */ export type RouterOutputFilter = RouterOutputFilter.NameContainsMember | RouterOutputFilter.NetworkInterfaceArnsMember | RouterOutputFilter.OutputTypesMember | RouterOutputFilter.RegionNamesMember | RouterOutputFilter.RoutedInputArnsMember | RouterOutputFilter.RoutingScopesMember | RouterOutputFilter.$UnknownMember; /** * @public */ export declare namespace RouterOutputFilter { /** *The AWS Regions of the router outputs to include in the filter.
* @public */ interface RegionNamesMember { RegionNames: string[]; NetworkInterfaceArns?: never; RoutingScopes?: never; OutputTypes?: never; RoutedInputArns?: never; NameContains?: never; $unknown?: never; } /** *The Amazon Resource Names (ARNs) of the network interfaces associated with the router outputs to include in the filter.
* @public */ interface NetworkInterfaceArnsMember { RegionNames?: never; NetworkInterfaceArns: string[]; RoutingScopes?: never; OutputTypes?: never; RoutedInputArns?: never; NameContains?: never; $unknown?: never; } /** *Filter criteria to list router outputs based on their routing scope.
* @public */ interface RoutingScopesMember { RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes: RoutingScope[]; OutputTypes?: never; RoutedInputArns?: never; NameContains?: never; $unknown?: never; } /** *The types of router outputs to include in the filter.
* @public */ interface OutputTypesMember { RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes?: never; OutputTypes: RouterOutputType[]; RoutedInputArns?: never; NameContains?: never; $unknown?: never; } /** *The ARNs of the router inputs associated with the router outputs to include in the filter.
* @public */ interface RoutedInputArnsMember { RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes?: never; OutputTypes?: never; RoutedInputArns: string[]; NameContains?: never; $unknown?: never; } /** *The names of the router outputs to include in the filter.
* @public */ interface NameContainsMember { RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes?: never; OutputTypes?: never; RoutedInputArns?: never; NameContains: string[]; $unknown?: never; } /** * @public */ interface $UnknownMember { RegionNames?: never; NetworkInterfaceArns?: never; RoutingScopes?: never; OutputTypes?: never; RoutedInputArns?: never; NameContains?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe maximum number of router outputs to return in the response.
* @public */ MaxResults?: number | undefined; /** *A token used to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *The filters to apply when retrieving the list of router outputs.
* @public */ Filters?: RouterOutputFilter[] | undefined; } /** * @public */ export interface ListRouterOutputsResponse { /** *The summary information for the retrieved router outputs.
* @public */ RouterOutputs: ListedRouterOutput[] | undefined; /** *The token to use to retrieve the next page of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTagsForGlobalResourceRequest { /** *The Amazon Resource Name (ARN) of the global resource whose tags you want to list.
* @public */ ResourceArn: string | undefined; } /** * @public */ export interface ListTagsForGlobalResourceResponse { /** *A map of tag keys and values associated with the global resource.
* @public */ Tags?: RecordThe Amazon Resource Name (ARN) that identifies the MediaConnect resource for which to list the tags.
* @public */ ResourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *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.
* @public */ Tags?: RecordThe Amazon Resource Name (ARN) of the offering.
* @public */ OfferingArn: string | undefined; /** *The name that you want to use for the reservation.
* @public */ ReservationName: string | undefined; /** *The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC).
You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.
The details of the reservation that you just created when you purchased the offering.
* @public */ Reservation?: Reservation | undefined; }