prowler-sdk-poc
Version:
967 lines • 87.5 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class MediaConnect extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: MediaConnect.Types.ClientConfiguration)
config: Config & MediaConnect.Types.ClientConfiguration;
/**
* Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.
*/
addFlowMediaStreams(params: MediaConnect.Types.AddFlowMediaStreamsRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddFlowMediaStreamsResponse) => void): Request<MediaConnect.Types.AddFlowMediaStreamsResponse, AWSError>;
/**
* Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.
*/
addFlowMediaStreams(callback?: (err: AWSError, data: MediaConnect.Types.AddFlowMediaStreamsResponse) => void): Request<MediaConnect.Types.AddFlowMediaStreamsResponse, AWSError>;
/**
* Adds outputs to an existing flow. You can create up to 50 outputs per flow.
*/
addFlowOutputs(params: MediaConnect.Types.AddFlowOutputsRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddFlowOutputsResponse) => void): Request<MediaConnect.Types.AddFlowOutputsResponse, AWSError>;
/**
* Adds outputs to an existing flow. You can create up to 50 outputs per flow.
*/
addFlowOutputs(callback?: (err: AWSError, data: MediaConnect.Types.AddFlowOutputsResponse) => void): Request<MediaConnect.Types.AddFlowOutputsResponse, AWSError>;
/**
* Adds Sources to flow
*/
addFlowSources(params: MediaConnect.Types.AddFlowSourcesRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddFlowSourcesResponse) => void): Request<MediaConnect.Types.AddFlowSourcesResponse, AWSError>;
/**
* Adds Sources to flow
*/
addFlowSources(callback?: (err: AWSError, data: MediaConnect.Types.AddFlowSourcesResponse) => void): Request<MediaConnect.Types.AddFlowSourcesResponse, AWSError>;
/**
* Adds VPC interfaces to flow
*/
addFlowVpcInterfaces(params: MediaConnect.Types.AddFlowVpcInterfacesRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddFlowVpcInterfacesResponse) => void): Request<MediaConnect.Types.AddFlowVpcInterfacesResponse, AWSError>;
/**
* Adds VPC interfaces to flow
*/
addFlowVpcInterfaces(callback?: (err: AWSError, data: MediaConnect.Types.AddFlowVpcInterfacesResponse) => void): Request<MediaConnect.Types.AddFlowVpcInterfacesResponse, AWSError>;
/**
* Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
*/
createFlow(params: MediaConnect.Types.CreateFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.CreateFlowResponse) => void): Request<MediaConnect.Types.CreateFlowResponse, AWSError>;
/**
* Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
*/
createFlow(callback?: (err: AWSError, data: MediaConnect.Types.CreateFlowResponse) => void): Request<MediaConnect.Types.CreateFlowResponse, AWSError>;
/**
* Deletes a flow. Before you can delete a flow, you must stop the flow.
*/
deleteFlow(params: MediaConnect.Types.DeleteFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.DeleteFlowResponse) => void): Request<MediaConnect.Types.DeleteFlowResponse, AWSError>;
/**
* Deletes a flow. Before you can delete a flow, you must stop the flow.
*/
deleteFlow(callback?: (err: AWSError, data: MediaConnect.Types.DeleteFlowResponse) => void): Request<MediaConnect.Types.DeleteFlowResponse, AWSError>;
/**
* Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
*/
describeFlow(params: MediaConnect.Types.DescribeFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
/**
* Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
*/
describeFlow(callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
/**
* Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
*/
describeOffering(params: MediaConnect.Types.DescribeOfferingRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeOfferingResponse) => void): Request<MediaConnect.Types.DescribeOfferingResponse, AWSError>;
/**
* Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
*/
describeOffering(callback?: (err: AWSError, data: MediaConnect.Types.DescribeOfferingResponse) => void): Request<MediaConnect.Types.DescribeOfferingResponse, AWSError>;
/**
* Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).
*/
describeReservation(params: MediaConnect.Types.DescribeReservationRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeReservationResponse) => void): Request<MediaConnect.Types.DescribeReservationResponse, AWSError>;
/**
* Displays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up the rest of the reservation (such as price, duration, and outbound bandwidth).
*/
describeReservation(callback?: (err: AWSError, data: MediaConnect.Types.DescribeReservationResponse) => void): Request<MediaConnect.Types.DescribeReservationResponse, AWSError>;
/**
* Grants entitlements to an existing flow.
*/
grantFlowEntitlements(params: MediaConnect.Types.GrantFlowEntitlementsRequest, callback?: (err: AWSError, data: MediaConnect.Types.GrantFlowEntitlementsResponse) => void): Request<MediaConnect.Types.GrantFlowEntitlementsResponse, AWSError>;
/**
* Grants entitlements to an existing flow.
*/
grantFlowEntitlements(callback?: (err: AWSError, data: MediaConnect.Types.GrantFlowEntitlementsResponse) => void): Request<MediaConnect.Types.GrantFlowEntitlementsResponse, AWSError>;
/**
* Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
*/
listEntitlements(params: MediaConnect.Types.ListEntitlementsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListEntitlementsResponse) => void): Request<MediaConnect.Types.ListEntitlementsResponse, AWSError>;
/**
* Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
*/
listEntitlements(callback?: (err: AWSError, data: MediaConnect.Types.ListEntitlementsResponse) => void): Request<MediaConnect.Types.ListEntitlementsResponse, AWSError>;
/**
* Displays a list of flows that are associated with this account. This request returns a paginated result.
*/
listFlows(params: MediaConnect.Types.ListFlowsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListFlowsResponse) => void): Request<MediaConnect.Types.ListFlowsResponse, AWSError>;
/**
* Displays a list of flows that are associated with this account. This request returns a paginated result.
*/
listFlows(callback?: (err: AWSError, data: MediaConnect.Types.ListFlowsResponse) => void): Request<MediaConnect.Types.ListFlowsResponse, AWSError>;
/**
* Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.
*/
listOfferings(params: MediaConnect.Types.ListOfferingsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListOfferingsResponse) => void): Request<MediaConnect.Types.ListOfferingsResponse, AWSError>;
/**
* Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.
*/
listOfferings(callback?: (err: AWSError, data: MediaConnect.Types.ListOfferingsResponse) => void): Request<MediaConnect.Types.ListOfferingsResponse, AWSError>;
/**
* Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).
*/
listReservations(params: MediaConnect.Types.ListReservationsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListReservationsResponse) => void): Request<MediaConnect.Types.ListReservationsResponse, AWSError>;
/**
* Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).
*/
listReservations(callback?: (err: AWSError, data: MediaConnect.Types.ListReservationsResponse) => void): Request<MediaConnect.Types.ListReservationsResponse, AWSError>;
/**
* List all tags on an AWS Elemental MediaConnect resource
*/
listTagsForResource(params: MediaConnect.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListTagsForResourceResponse) => void): Request<MediaConnect.Types.ListTagsForResourceResponse, AWSError>;
/**
* List all tags on an AWS Elemental MediaConnect resource
*/
listTagsForResource(callback?: (err: AWSError, data: MediaConnect.Types.ListTagsForResourceResponse) => void): Request<MediaConnect.Types.ListTagsForResourceResponse, AWSError>;
/**
* Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.
*/
purchaseOffering(params: MediaConnect.Types.PurchaseOfferingRequest, callback?: (err: AWSError, data: MediaConnect.Types.PurchaseOfferingResponse) => void): Request<MediaConnect.Types.PurchaseOfferingResponse, AWSError>;
/**
* Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.
*/
purchaseOffering(callback?: (err: AWSError, data: MediaConnect.Types.PurchaseOfferingResponse) => void): Request<MediaConnect.Types.PurchaseOfferingResponse, AWSError>;
/**
* Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.
*/
removeFlowMediaStream(params: MediaConnect.Types.RemoveFlowMediaStreamRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowMediaStreamResponse) => void): Request<MediaConnect.Types.RemoveFlowMediaStreamResponse, AWSError>;
/**
* Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.
*/
removeFlowMediaStream(callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowMediaStreamResponse) => void): Request<MediaConnect.Types.RemoveFlowMediaStreamResponse, AWSError>;
/**
* Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.
*/
removeFlowOutput(params: MediaConnect.Types.RemoveFlowOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowOutputResponse) => void): Request<MediaConnect.Types.RemoveFlowOutputResponse, AWSError>;
/**
* Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.
*/
removeFlowOutput(callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowOutputResponse) => void): Request<MediaConnect.Types.RemoveFlowOutputResponse, AWSError>;
/**
* Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.
*/
removeFlowSource(params: MediaConnect.Types.RemoveFlowSourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowSourceResponse) => void): Request<MediaConnect.Types.RemoveFlowSourceResponse, AWSError>;
/**
* Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.
*/
removeFlowSource(callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowSourceResponse) => void): Request<MediaConnect.Types.RemoveFlowSourceResponse, AWSError>;
/**
* Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.
*/
removeFlowVpcInterface(params: MediaConnect.Types.RemoveFlowVpcInterfaceRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowVpcInterfaceResponse) => void): Request<MediaConnect.Types.RemoveFlowVpcInterfaceResponse, AWSError>;
/**
* Removes a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.
*/
removeFlowVpcInterface(callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowVpcInterfaceResponse) => void): Request<MediaConnect.Types.RemoveFlowVpcInterfaceResponse, AWSError>;
/**
* Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
*/
revokeFlowEntitlement(params: MediaConnect.Types.RevokeFlowEntitlementRequest, callback?: (err: AWSError, data: MediaConnect.Types.RevokeFlowEntitlementResponse) => void): Request<MediaConnect.Types.RevokeFlowEntitlementResponse, AWSError>;
/**
* Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
*/
revokeFlowEntitlement(callback?: (err: AWSError, data: MediaConnect.Types.RevokeFlowEntitlementResponse) => void): Request<MediaConnect.Types.RevokeFlowEntitlementResponse, AWSError>;
/**
* Starts a flow.
*/
startFlow(params: MediaConnect.Types.StartFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.StartFlowResponse) => void): Request<MediaConnect.Types.StartFlowResponse, AWSError>;
/**
* Starts a flow.
*/
startFlow(callback?: (err: AWSError, data: MediaConnect.Types.StartFlowResponse) => void): Request<MediaConnect.Types.StartFlowResponse, AWSError>;
/**
* Stops a flow.
*/
stopFlow(params: MediaConnect.Types.StopFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.StopFlowResponse) => void): Request<MediaConnect.Types.StopFlowResponse, AWSError>;
/**
* Stops a flow.
*/
stopFlow(callback?: (err: AWSError, data: MediaConnect.Types.StopFlowResponse) => void): Request<MediaConnect.Types.StopFlowResponse, AWSError>;
/**
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
*/
tagResource(params: MediaConnect.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(params: MediaConnect.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates flow
*/
updateFlow(params: MediaConnect.Types.UpdateFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowResponse) => void): Request<MediaConnect.Types.UpdateFlowResponse, AWSError>;
/**
* Updates flow
*/
updateFlow(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowResponse) => void): Request<MediaConnect.Types.UpdateFlowResponse, AWSError>;
/**
* You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.
*/
updateFlowEntitlement(params: MediaConnect.Types.UpdateFlowEntitlementRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowEntitlementResponse) => void): Request<MediaConnect.Types.UpdateFlowEntitlementResponse, AWSError>;
/**
* You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.
*/
updateFlowEntitlement(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowEntitlementResponse) => void): Request<MediaConnect.Types.UpdateFlowEntitlementResponse, AWSError>;
/**
* Updates an existing media stream.
*/
updateFlowMediaStream(params: MediaConnect.Types.UpdateFlowMediaStreamRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowMediaStreamResponse) => void): Request<MediaConnect.Types.UpdateFlowMediaStreamResponse, AWSError>;
/**
* Updates an existing media stream.
*/
updateFlowMediaStream(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowMediaStreamResponse) => void): Request<MediaConnect.Types.UpdateFlowMediaStreamResponse, AWSError>;
/**
* Updates an existing flow output.
*/
updateFlowOutput(params: MediaConnect.Types.UpdateFlowOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowOutputResponse) => void): Request<MediaConnect.Types.UpdateFlowOutputResponse, AWSError>;
/**
* Updates an existing flow output.
*/
updateFlowOutput(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowOutputResponse) => void): Request<MediaConnect.Types.UpdateFlowOutputResponse, AWSError>;
/**
* Updates the source of a flow.
*/
updateFlowSource(params: MediaConnect.Types.UpdateFlowSourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowSourceResponse) => void): Request<MediaConnect.Types.UpdateFlowSourceResponse, AWSError>;
/**
* Updates the source of a flow.
*/
updateFlowSource(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowSourceResponse) => void): Request<MediaConnect.Types.UpdateFlowSourceResponse, AWSError>;
/**
* Waits for the flowActive state by periodically calling the underlying MediaConnect.describeFlowoperation every 3 seconds (at most 40 times). Wait until a flow is active
*/
waitFor(state: "flowActive", params: MediaConnect.Types.DescribeFlowRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
/**
* Waits for the flowActive state by periodically calling the underlying MediaConnect.describeFlowoperation every 3 seconds (at most 40 times). Wait until a flow is active
*/
waitFor(state: "flowActive", callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
/**
* Waits for the flowStandby state by periodically calling the underlying MediaConnect.describeFlowoperation every 3 seconds (at most 40 times). Wait until a flow is in standby mode
*/
waitFor(state: "flowStandby", params: MediaConnect.Types.DescribeFlowRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
/**
* Waits for the flowStandby state by periodically calling the underlying MediaConnect.describeFlowoperation every 3 seconds (at most 40 times). Wait until a flow is in standby mode
*/
waitFor(state: "flowStandby", callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
/**
* Waits for the flowDeleted state by periodically calling the underlying MediaConnect.describeFlowoperation every 3 seconds (at most 40 times). Wait until a flow is deleted
*/
waitFor(state: "flowDeleted", params: MediaConnect.Types.DescribeFlowRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
/**
* Waits for the flowDeleted state by periodically calling the underlying MediaConnect.describeFlowoperation every 3 seconds (at most 40 times). Wait until a flow is deleted
*/
waitFor(state: "flowDeleted", callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
}
declare namespace MediaConnect {
export interface AddFlowMediaStreamsRequest {
/**
* The Amazon Resource Name (ARN) of the flow.
*/
FlowArn: __string;
/**
* The media streams that you want to add to the flow.
*/
MediaStreams: __listOfAddMediaStreamRequest;
}
export interface AddFlowMediaStreamsResponse {
/**
* The ARN of the flow that you added media streams to.
*/
FlowArn?: __string;
/**
* The media streams that you added to the flow.
*/
MediaStreams?: __listOfMediaStream;
}
export interface AddFlowOutputsRequest {
/**
* The flow that you want to add outputs to.
*/
FlowArn: __string;
/**
* A list of outputs that you want to add.
*/
Outputs: __listOfAddOutputRequest;
}
export interface AddFlowOutputsResponse {
/**
* The ARN of the flow that these outputs were added to.
*/
FlowArn?: __string;
/**
* The details of the newly added outputs.
*/
Outputs?: __listOfOutput;
}
export interface AddFlowSourcesRequest {
/**
* The flow that you want to mutate.
*/
FlowArn: __string;
/**
* A list of sources that you want to add.
*/
Sources: __listOfSetSourceRequest;
}
export interface AddFlowSourcesResponse {
/**
* The ARN of the flow that these sources were added to.
*/
FlowArn?: __string;
/**
* The details of the newly added sources.
*/
Sources?: __listOfSource;
}
export interface AddFlowVpcInterfacesRequest {
/**
* The flow that you want to mutate.
*/
FlowArn: __string;
/**
* A list of VPC interfaces that you want to add.
*/
VpcInterfaces: __listOfVpcInterfaceRequest;
}
export interface AddFlowVpcInterfacesResponse {
/**
* The ARN of the flow that these VPC interfaces were added to.
*/
FlowArn?: __string;
/**
* The details of the newly added VPC interfaces.
*/
VpcInterfaces?: __listOfVpcInterface;
}
export interface AddMediaStreamRequest {
/**
* The attributes that you want to assign to the new media stream.
*/
Attributes?: MediaStreamAttributesRequest;
/**
* 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.
*/
ClockRate?: __integer;
/**
* A description that can help you quickly identify what your media stream is used for.
*/
Description?: __string;
/**
* A unique identifier for the media stream.
*/
MediaStreamId: __integer;
/**
* A name that helps you distinguish one media stream from another.
*/
MediaStreamName: __string;
/**
* The type of media stream.
*/
MediaStreamType: MediaStreamType;
/**
* The resolution of the video.
*/
VideoFormat?: __string;
}
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.
*/
CidrAllowList?: __listOf__string;
/**
* A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
*/
Description?: __string;
/**
* The IP address from which video will be sent to output destinations.
*/
Destination?: __string;
/**
* The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
*/
Encryption?: Encryption;
/**
* The maximum latency in milliseconds for Zixi-based streams.
*/
MaxLatency?: __integer;
/**
* The media streams that are associated with the output, and the parameters for those associations.
*/
MediaStreamOutputConfigurations?: __listOfMediaStreamOutputConfigurationRequest;
/**
* 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.
*/
MinLatency?: __integer;
/**
* The name of the output. This value must be unique within the current flow.
*/
Name?: __string;
/**
* The port to use when content is distributed to this output.
*/
Port?: __integer;
/**
* The protocol to use for the output.
*/
Protocol: Protocol;
/**
* The remote ID for the Zixi-pull output stream.
*/
RemoteId?: __string;
/**
* The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
*/
SmoothingLatency?: __integer;
/**
* The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
*/
StreamId?: __string;
/**
* The name of the VPC interface attachment to use for this output.
*/
VpcInterfaceAttachment?: VpcInterfaceAttachment;
}
export type Algorithm = "aes128"|"aes192"|"aes256"|string;
export type Colorimetry = "BT601"|"BT709"|"BT2020"|"BT2100"|"ST2065-1"|"ST2065-3"|"XYZ"|string;
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 AWS Region.
*/
AvailabilityZone?: __string;
/**
* The entitlements that you want to grant on a flow.
*/
Entitlements?: __listOfGrantEntitlementRequest;
/**
* The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.
*/
MediaStreams?: __listOfAddMediaStreamRequest;
/**
* The name of the flow.
*/
Name: __string;
/**
* The outputs that you want to add to this flow.
*/
Outputs?: __listOfAddOutputRequest;
Source?: SetSourceRequest;
SourceFailoverConfig?: FailoverConfig;
Sources?: __listOfSetSourceRequest;
/**
* The VPC interfaces you want on the flow.
*/
VpcInterfaces?: __listOfVpcInterfaceRequest;
}
export interface CreateFlowResponse {
Flow?: Flow;
}
export interface DeleteFlowRequest {
/**
* The ARN of the flow that you want to delete.
*/
FlowArn: __string;
}
export interface DeleteFlowResponse {
/**
* The ARN of the flow that was deleted.
*/
FlowArn?: __string;
/**
* The status of the flow when the DeleteFlow process begins.
*/
Status?: Status;
}
export interface DescribeFlowRequest {
/**
* The ARN of the flow that you want to describe.
*/
FlowArn: __string;
}
export interface DescribeFlowResponse {
Flow?: Flow;
Messages?: Messages;
}
export interface DescribeOfferingRequest {
/**
* The Amazon Resource Name (ARN) of the offering.
*/
OfferingArn: __string;
}
export interface DescribeOfferingResponse {
Offering?: Offering;
}
export interface DescribeReservationRequest {
/**
* The Amazon Resource Name (ARN) of the reservation.
*/
ReservationArn: __string;
}
export interface DescribeReservationResponse {
Reservation?: Reservation;
}
export interface DestinationConfiguration {
/**
* The IP address where contents of the media stream will be sent.
*/
DestinationIp: __string;
/**
* The port to use when the content of the media stream is distributed to the output.
*/
DestinationPort: __integer;
/**
* The VPC interface that is used for the media stream associated with the output.
*/
Interface: Interface;
/**
* The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
*/
OutboundIp: __string;
}
export interface DestinationConfigurationRequest {
/**
* The IP address where you want MediaConnect to send contents of the media stream.
*/
DestinationIp: __string;
/**
* The port that you want MediaConnect to use when it distributes the media stream to the output.
*/
DestinationPort: __integer;
/**
* The VPC interface that you want to use for the media stream associated with the output.
*/
Interface: InterfaceRequest;
}
export type DurationUnits = "MONTHS"|string;
export type EncoderProfile = "main"|"high"|string;
export type EncodingName = "jxsv"|"raw"|"smpte291"|"pcm"|string;
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.
*/
CompressionFactor: __double;
/**
* 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.
*/
EncoderProfile: EncoderProfile;
}
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.
*/
CompressionFactor: __double;
/**
* 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.
*/
EncoderProfile: EncoderProfile;
}
export interface Encryption {
/**
* The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
*/
Algorithm?: Algorithm;
/**
* 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.
*/
ConstantInitializationVector?: __string;
/**
* The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
DeviceId?: __string;
/**
* The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
*/
KeyType?: KeyType;
/**
* The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
Region?: __string;
/**
* An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
ResourceId?: __string;
/**
* The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
*/
RoleArn: __string;
/**
* The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
*/
SecretArn?: __string;
/**
* The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
*/
Url?: __string;
}
export interface Entitlement {
/**
* Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
*/
DataTransferSubscriberFeePercent?: __integer;
/**
* A description of the entitlement.
*/
Description?: __string;
/**
* The type of encryption that will be used on the output that is associated with this entitlement.
*/
Encryption?: Encryption;
/**
* The ARN of the entitlement.
*/
EntitlementArn: __string;
/**
* An indication of whether the entitlement is enabled.
*/
EntitlementStatus?: EntitlementStatus;
/**
* The name of the entitlement.
*/
Name: __string;
/**
* The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
*/
Subscribers: __listOf__string;
}
export type EntitlementStatus = "ENABLED"|"DISABLED"|string;
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.
*/
FailoverMode?: FailoverMode;
/**
* Search window time to look for dash-7 packets
*/
RecoveryWindow?: __integer;
/**
* The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
*/
SourcePriority?: SourcePriority;
State?: State;
}
export type FailoverMode = "MERGE"|"FAILOVER"|string;
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 AWS.
*/
AvailabilityZone: __string;
/**
* A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
*/
Description?: __string;
/**
* The IP address from which video will be sent to output destinations.
*/
EgressIp?: __string;
/**
* The entitlements in this flow.
*/
Entitlements: __listOfEntitlement;
/**
* The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
*/
FlowArn: __string;
/**
* 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.
*/
MediaStreams?: __listOfMediaStream;
/**
* The name of the flow.
*/
Name: __string;
/**
* The outputs in this flow.
*/
Outputs: __listOfOutput;
Source: Source;
SourceFailoverConfig?: FailoverConfig;
Sources?: __listOfSource;
/**
* The current status of the flow.
*/
Status: Status;
/**
* The VPC Interfaces for this flow.
*/
VpcInterfaces?: __listOfVpcInterface;
}
export interface Fmtp {
/**
* The format of the audio channel.
*/
ChannelOrder?: __string;
/**
* The format that is used for the representation of color.
*/
Colorimetry?: Colorimetry;
/**
* 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.
*/
ExactFramerate?: __string;
/**
* The pixel aspect ratio (PAR) of the video.
*/
Par?: __string;
/**
* The encoding range of the video.
*/
Range?: Range;
/**
* The type of compression that was used to smooth the video’s appearance
*/
ScanMode?: ScanMode;
/**
* The transfer characteristic system (TCS) that is used in the video.
*/
Tcs?: Tcs;
}
export interface FmtpRequest {
/**
* The format of the audio channel.
*/
ChannelOrder?: __string;
/**
* The format that is used for the representation of color.
*/
Colorimetry?: Colorimetry;
/**
* 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.
*/
ExactFramerate?: __string;
/**
* The pixel aspect ratio (PAR) of the video.
*/
Par?: __string;
/**
* The encoding range of the video.
*/
Range?: Range;
/**
* The type of compression that was used to smooth the video’s appearance.
*/
ScanMode?: ScanMode;
/**
* The transfer characteristic system (TCS) that is used in the video.
*/
Tcs?: Tcs;
}
export interface GrantEntitlementRequest {
/**
* Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
*/
DataTransferSubscriberFeePercent?: __integer;
/**
* A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
*/
Description?: __string;
/**
* The type of encryption that will be used on the output that is associated with this entitlement.
*/
Encryption?: Encryption;
/**
* 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.
*/
EntitlementStatus?: EntitlementStatus;
/**
* The name of the entitlement. This value must be unique within the current flow.
*/
Name?: __string;
/**
* The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
*/
Subscribers: __listOf__string;
}
export interface GrantFlowEntitlementsRequest {
/**
* The list of entitlements that you want to grant.
*/
Entitlements: __listOfGrantEntitlementRequest;
/**
* The flow that you want to grant entitlements on.
*/
FlowArn: __string;
}
export interface GrantFlowEntitlementsResponse {
/**
* The entitlements that were just granted.
*/
Entitlements?: __listOfEntitlement;
/**
* The ARN of the flow that these entitlements were granted to.
*/
FlowArn?: __string;
}
export interface InputConfiguration {
/**
* The IP address that the flow listens on for incoming content for a media stream.
*/
InputIp: __string;
/**
* The port that the flow listens on for an incoming media stream.
*/
InputPort: __integer;
/**
* The VPC interface where the media stream comes in from.
*/
Interface: Interface;
}
export interface InputConfigurationRequest {
/**
* The port that you want the flow to listen on for an incoming media stream.
*/
InputPort: __integer;
/**
* The VPC interface that you want to use for the incoming media stream.
*/
Interface: InterfaceRequest;
}
export interface Interface {
/**
* The name of the VPC interface.
*/
Name: __string;
}
export interface InterfaceRequest {
/**
* The name of the VPC interface.
*/
Name: __string;
}
export type KeyType = "speke"|"static-key"|"srt-password"|string;
export interface ListEntitlementsRequest {
/**
* The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.
*/
MaxResults?: MaxResults;
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.
*/
NextToken?: __string;
}
export interface ListEntitlementsResponse {
/**
* A list of entitlements that have been granted to you from other AWS accounts.
*/
Entitlements?: __listOfListedEntitlement;
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.
*/
NextToken?: __string;
}
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.
*/
MaxResults?: MaxResults;
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.
*/
NextToken?: __string;
}
export interface ListFlowsResponse {
/**
* A list of flow summaries.
*/
Flows?: __listOfListedFlow;
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.
*/
NextToken?: __string;
}
export interface ListOfferingsRequest {
/**
* 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.
*/
MaxResults?: MaxResults;
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
*/
NextToken?: __string;
}
export interface ListOfferingsResponse {
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
*/
NextToken?: __string;
/**
* A list of offerings that are available to this account in the current AWS Region.
*/
Offerings?: __listOfOffering;
}
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.
*/
MaxResults?: MaxResults;
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListOfferings request a second time and specify the NextToken value.
*/
NextToken?: __string;
}
export interface ListReservationsResponse {
/**
* The token that identifies which batch of results that you want to see. For example, you submit a ListReservations request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListReservations request a second time and specify the NextToken value.
*/
NextToken?: __string;
/**
* A list of all reservations that have been purchased by this account in the current AWS Region.
*/
Reservations?: __listOfReservation;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags.
*/
ResourceArn: __string;
}
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.
*/
Tags?: __mapOf__string;
}
export interface ListedEntitlement {
/**
* Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
*/
DataTransferSubscriberFeePercent?: __integer;
/**
* The ARN of the entitlement.
*/
EntitlementArn: __string;
/**
* The name of the entitlement.
*/
EntitlementName: __string;
}
export interface ListedFlow {
/**
* The Availability Zone that the flow was created in.
*/
AvailabilityZone: __string;
/**
* A description