aws-sdk
Version:
AWS SDK for JavaScript
931 lines • 136 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 outputs to an existing bridge.
*/
addBridgeOutputs(params: MediaConnect.Types.AddBridgeOutputsRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddBridgeOutputsResponse) => void): Request<MediaConnect.Types.AddBridgeOutputsResponse, AWSError>;
/**
* Adds outputs to an existing bridge.
*/
addBridgeOutputs(callback?: (err: AWSError, data: MediaConnect.Types.AddBridgeOutputsResponse) => void): Request<MediaConnect.Types.AddBridgeOutputsResponse, AWSError>;
/**
* Adds sources to an existing bridge.
*/
addBridgeSources(params: MediaConnect.Types.AddBridgeSourcesRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddBridgeSourcesResponse) => void): Request<MediaConnect.Types.AddBridgeSourcesResponse, AWSError>;
/**
* Adds sources to an existing bridge.
*/
addBridgeSources(callback?: (err: AWSError, data: MediaConnect.Types.AddBridgeSourcesResponse) => void): Request<MediaConnect.Types.AddBridgeSourcesResponse, 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(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 bridge. The request must include one source.
*/
createBridge(params: MediaConnect.Types.CreateBridgeRequest, callback?: (err: AWSError, data: MediaConnect.Types.CreateBridgeResponse) => void): Request<MediaConnect.Types.CreateBridgeResponse, AWSError>;
/**
* Creates a new bridge. The request must include one source.
*/
createBridge(callback?: (err: AWSError, data: MediaConnect.Types.CreateBridgeResponse) => void): Request<MediaConnect.Types.CreateBridgeResponse, 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>;
/**
* Creates a new gateway. The request must include at least one network (up to 4).
*/
createGateway(params: MediaConnect.Types.CreateGatewayRequest, callback?: (err: AWSError, data: MediaConnect.Types.CreateGatewayResponse) => void): Request<MediaConnect.Types.CreateGatewayResponse, AWSError>;
/**
* Creates a new gateway. The request must include at least one network (up to 4).
*/
createGateway(callback?: (err: AWSError, data: MediaConnect.Types.CreateGatewayResponse) => void): Request<MediaConnect.Types.CreateGatewayResponse, AWSError>;
/**
* Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
*/
deleteBridge(params: MediaConnect.Types.DeleteBridgeRequest, callback?: (err: AWSError, data: MediaConnect.Types.DeleteBridgeResponse) => void): Request<MediaConnect.Types.DeleteBridgeResponse, AWSError>;
/**
* Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
*/
deleteBridge(callback?: (err: AWSError, data: MediaConnect.Types.DeleteBridgeResponse) => void): Request<MediaConnect.Types.DeleteBridgeResponse, 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>;
/**
* Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.
*/
deleteGateway(params: MediaConnect.Types.DeleteGatewayRequest, callback?: (err: AWSError, data: MediaConnect.Types.DeleteGatewayResponse) => void): Request<MediaConnect.Types.DeleteGatewayResponse, AWSError>;
/**
* Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.
*/
deleteGateway(callback?: (err: AWSError, data: MediaConnect.Types.DeleteGatewayResponse) => void): Request<MediaConnect.Types.DeleteGatewayResponse, AWSError>;
/**
* Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.
*/
deregisterGatewayInstance(params: MediaConnect.Types.DeregisterGatewayInstanceRequest, callback?: (err: AWSError, data: MediaConnect.Types.DeregisterGatewayInstanceResponse) => void): Request<MediaConnect.Types.DeregisterGatewayInstanceResponse, AWSError>;
/**
* Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.
*/
deregisterGatewayInstance(callback?: (err: AWSError, data: MediaConnect.Types.DeregisterGatewayInstanceResponse) => void): Request<MediaConnect.Types.DeregisterGatewayInstanceResponse, AWSError>;
/**
* Displays the details of a bridge.
*/
describeBridge(params: MediaConnect.Types.DescribeBridgeRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeBridgeResponse) => void): Request<MediaConnect.Types.DescribeBridgeResponse, AWSError>;
/**
* Displays the details of a bridge.
*/
describeBridge(callback?: (err: AWSError, data: MediaConnect.Types.DescribeBridgeResponse) => void): Request<MediaConnect.Types.DescribeBridgeResponse, 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 details of the flow's source stream. The response contains information about the contents of the stream and its programs.
*/
describeFlowSourceMetadata(params: MediaConnect.Types.DescribeFlowSourceMetadataRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowSourceMetadataResponse) => void): Request<MediaConnect.Types.DescribeFlowSourceMetadataResponse, AWSError>;
/**
* Displays details of the flow's source stream. The response contains information about the contents of the stream and its programs.
*/
describeFlowSourceMetadata(callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowSourceMetadataResponse) => void): Request<MediaConnect.Types.DescribeFlowSourceMetadataResponse, AWSError>;
/**
* Displays the thumbnail details of a flow's source stream.
*/
describeFlowSourceThumbnail(params: MediaConnect.Types.DescribeFlowSourceThumbnailRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowSourceThumbnailResponse) => void): Request<MediaConnect.Types.DescribeFlowSourceThumbnailResponse, AWSError>;
/**
* Displays the thumbnail details of a flow's source stream.
*/
describeFlowSourceThumbnail(callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowSourceThumbnailResponse) => void): Request<MediaConnect.Types.DescribeFlowSourceThumbnailResponse, AWSError>;
/**
* Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.
*/
describeGateway(params: MediaConnect.Types.DescribeGatewayRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeGatewayResponse) => void): Request<MediaConnect.Types.DescribeGatewayResponse, AWSError>;
/**
* Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.
*/
describeGateway(callback?: (err: AWSError, data: MediaConnect.Types.DescribeGatewayResponse) => void): Request<MediaConnect.Types.DescribeGatewayResponse, AWSError>;
/**
* Displays the details of an instance.
*/
describeGatewayInstance(params: MediaConnect.Types.DescribeGatewayInstanceRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeGatewayInstanceResponse) => void): Request<MediaConnect.Types.DescribeGatewayInstanceResponse, AWSError>;
/**
* Displays the details of an instance.
*/
describeGatewayInstance(callback?: (err: AWSError, data: MediaConnect.Types.DescribeGatewayInstanceResponse) => void): Request<MediaConnect.Types.DescribeGatewayInstanceResponse, 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 bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.
*/
listBridges(params: MediaConnect.Types.ListBridgesRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListBridgesResponse) => void): Request<MediaConnect.Types.ListBridgesResponse, AWSError>;
/**
* Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.
*/
listBridges(callback?: (err: AWSError, data: MediaConnect.Types.ListBridgesResponse) => void): Request<MediaConnect.Types.ListBridgesResponse, 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 instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
*/
listGatewayInstances(params: MediaConnect.Types.ListGatewayInstancesRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListGatewayInstancesResponse) => void): Request<MediaConnect.Types.ListGatewayInstancesResponse, AWSError>;
/**
* Displays a list of instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
*/
listGatewayInstances(callback?: (err: AWSError, data: MediaConnect.Types.ListGatewayInstancesResponse) => void): Request<MediaConnect.Types.ListGatewayInstancesResponse, AWSError>;
/**
* Displays a list of gateways that are associated with this account. This request returns a paginated result.
*/
listGateways(params: MediaConnect.Types.ListGatewaysRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListGatewaysResponse) => void): Request<MediaConnect.Types.ListGatewaysResponse, AWSError>;
/**
* Displays a list of gateways that are associated with this account. This request returns a paginated result.
*/
listGateways(callback?: (err: AWSError, data: MediaConnect.Types.ListGatewaysResponse) => void): Request<MediaConnect.Types.ListGatewaysResponse, 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 an output from a bridge.
*/
removeBridgeOutput(params: MediaConnect.Types.RemoveBridgeOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveBridgeOutputResponse) => void): Request<MediaConnect.Types.RemoveBridgeOutputResponse, AWSError>;
/**
* Removes an output from a bridge.
*/
removeBridgeOutput(callback?: (err: AWSError, data: MediaConnect.Types.RemoveBridgeOutputResponse) => void): Request<MediaConnect.Types.RemoveBridgeOutputResponse, AWSError>;
/**
* Removes a source from a bridge.
*/
removeBridgeSource(params: MediaConnect.Types.RemoveBridgeSourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveBridgeSourceResponse) => void): Request<MediaConnect.Types.RemoveBridgeSourceResponse, AWSError>;
/**
* Removes a source from a bridge.
*/
removeBridgeSource(callback?: (err: AWSError, data: MediaConnect.Types.RemoveBridgeSourceResponse) => void): Request<MediaConnect.Types.RemoveBridgeSourceResponse, 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 the bridge
*/
updateBridge(params: MediaConnect.Types.UpdateBridgeRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeResponse) => void): Request<MediaConnect.Types.UpdateBridgeResponse, AWSError>;
/**
* Updates the bridge
*/
updateBridge(callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeResponse) => void): Request<MediaConnect.Types.UpdateBridgeResponse, AWSError>;
/**
* Updates an existing bridge output.
*/
updateBridgeOutput(params: MediaConnect.Types.UpdateBridgeOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeOutputResponse) => void): Request<MediaConnect.Types.UpdateBridgeOutputResponse, AWSError>;
/**
* Updates an existing bridge output.
*/
updateBridgeOutput(callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeOutputResponse) => void): Request<MediaConnect.Types.UpdateBridgeOutputResponse, AWSError>;
/**
* Updates an existing bridge source.
*/
updateBridgeSource(params: MediaConnect.Types.UpdateBridgeSourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeSourceResponse) => void): Request<MediaConnect.Types.UpdateBridgeSourceResponse, AWSError>;
/**
* Updates an existing bridge source.
*/
updateBridgeSource(callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeSourceResponse) => void): Request<MediaConnect.Types.UpdateBridgeSourceResponse, AWSError>;
/**
* Updates the bridge state
*/
updateBridgeState(params: MediaConnect.Types.UpdateBridgeStateRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeStateResponse) => void): Request<MediaConnect.Types.UpdateBridgeStateResponse, AWSError>;
/**
* Updates the bridge state
*/
updateBridgeState(callback?: (err: AWSError, data: MediaConnect.Types.UpdateBridgeStateResponse) => void): Request<MediaConnect.Types.UpdateBridgeStateResponse, 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>;
/**
* Updates the configuration of an existing Gateway Instance.
*/
updateGatewayInstance(params: MediaConnect.Types.UpdateGatewayInstanceRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateGatewayInstanceResponse) => void): Request<MediaConnect.Types.UpdateGatewayInstanceResponse, AWSError>;
/**
* Updates the configuration of an existing Gateway Instance.
*/
updateGatewayInstance(callback?: (err: AWSError, data: MediaConnect.Types.UpdateGatewayInstanceResponse) => void): Request<MediaConnect.Types.UpdateGatewayInstanceResponse, 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 AddBridgeFlowSourceRequest {
/**
* The Amazon Resource Number (ARN) of the cloud flow to use as a source of this bridge.
*/
FlowArn: __string;
/**
* The name of the VPC interface attachment to use for this source.
*/
FlowVpcInterfaceAttachment?: VpcInterfaceAttachment;
/**
* The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
*/
Name: __string;
}
export interface AddBridgeNetworkOutputRequest {
/**
* The network output IP Address.
*/
IpAddress: __string;
/**
* The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
*/
Name: __string;
/**
* The network output's gateway network name.
*/
NetworkName: __string;
/**
* The network output port.
*/
Port: __integer;
/**
* The network output protocol.
*/
Protocol: Protocol;
/**
* The network output TTL.
*/
Ttl: __integer;
}
export interface AddBridgeNetworkSourceRequest {
/**
* The network source multicast IP.
*/
MulticastIp: __string;
/**
* The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
*/
Name: __string;
/**
* The network source's gateway network name.
*/
NetworkName: __string;
/**
* The network source port.
*/
Port: __integer;
/**
* The network source protocol.
*/
Protocol: Protocol;
}
export interface AddBridgeOutputRequest {
NetworkOutput?: AddBridgeNetworkOutputRequest;
}
export interface AddBridgeOutputsRequest {
/**
* The ARN of the bridge that you want to update.
*/
BridgeArn: __string;
/**
* The outputs that you want to add to this bridge.
*/
Outputs: __listOfAddBridgeOutputRequest;
}
export interface AddBridgeOutputsResponse {
/**
* The Amazon Resource Number (ARN) of the bridge.
*/
BridgeArn?: __string;
/**
* The outputs that you added to this bridge.
*/
Outputs?: __listOfBridgeOutput;
}
export interface AddBridgeSourceRequest {
FlowSource?: AddBridgeFlowSourceRequest;
NetworkSource?: AddBridgeNetworkSourceRequest;
}
export interface AddBridgeSourcesRequest {
/**
* The ARN of the bridge that you want to update.
*/
BridgeArn: __string;
/**
* The sources that you want to add to this bridge.
*/
Sources: __listOfAddBridgeSourceRequest;
}
export interface AddBridgeSourcesResponse {
/**
* The Amazon Resource Number (ARN) of the bridge.
*/
BridgeArn?: __string;
/**
* The sources that you added to this bridge.
*/
Sources?: __listOfBridgeSource;
}
export interface AddEgressGatewayBridgeRequest {
/**
* The maximum expected bitrate (in bps).
*/
MaxBitrate: __integer;
}
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 AddIngressGatewayBridgeRequest {
/**
* The maximum expected bitrate (in bps).
*/
MaxBitrate: __integer;
/**
* The maximum number of expected outputs.
*/
MaxOutputs: __integer;
}
export interface AddMaintenance {
/**
* A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
*/
MaintenanceDay: MaintenanceDay;
/**
* 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.
*/
MaintenanceStartHour: __string;
}
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). Allowable encryption types: static-key.
*/
Encryption?: Encryption;
/**
* The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-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 port that the flow uses to send outbound requests to initiate connection with the sender.
*/
SenderControlPort?: __integer;
/**
* 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 and SRT caller-based streams.
*/
StreamId?: __string;
/**
* The name of the VPC interface attachment to use for this output.
*/
VpcInterfaceAttachment?: VpcInterfaceAttachment;
/**
* 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.
*/
OutputStatus?: OutputStatus;
}
export type Algorithm = "aes128"|"aes192"|"aes256"|string;
export interface Bridge {
/**
* The Amazon Resource Number (ARN) of the bridge.
*/
BridgeArn: __string;
BridgeMessages?: __listOfMessageDetail;
BridgeState: BridgeState;
EgressGatewayBridge?: EgressGatewayBridge;
IngressGatewayBridge?: IngressGatewayBridge;
/**
* The name of the bridge.
*/
Name: __string;
/**
* The outputs on this bridge.
*/
Outputs?: __listOfBridgeOutput;
/**
* The placement Amazon Resource Number (ARN) of the bridge.
*/
PlacementArn: __string;
SourceFailoverConfig?: FailoverConfig;
/**
* The sources on this bridge.
*/
Sources?: __listOfBridgeSource;
}
export interface BridgeFlowOutput {
/**
* The Amazon Resource Number (ARN) of the cloud flow.
*/
FlowArn: __string;
/**
* The Amazon Resource Number (ARN) of the flow source.
*/
FlowSourceArn: __string;
/**
* The name of the bridge's output.
*/
Name: __string;
}
export interface BridgeFlowSource {
/**
* The ARN of the cloud flow used as a source of this bridge.
*/
FlowArn: __string;
/**
* The name of the VPC interface attachment to use for this source.
*/
FlowVpcInterfaceAttachment?: VpcInterfaceAttachment;
/**
* The name of the flow source.
*/
Name: __string;
/**
* The Amazon Resource Number (ARN) of the output.
*/
OutputArn?: __string;
}
export interface BridgeNetworkOutput {
/**
* The network output IP Address.
*/
IpAddress: __string;
/**
* The network output name.
*/
Name: __string;
/**
* The network output's gateway network name.
*/
NetworkName: __string;
/**
* The network output port.
*/
Port: __integer;
/**
* The network output protocol.
*/
Protocol: Protocol;
/**
* The network output TTL.
*/
Ttl: __integer;
}
export interface BridgeNetworkSource {
/**
* The network source multicast IP.
*/
MulticastIp: __string;
/**
* The name of the network source.
*/
Name: __string;
/**
* The network source's gateway network name.
*/
NetworkName: __string;
/**
* The network source port.
*/
Port: __integer;
/**
* The network source protocol.
*/
Protocol: Protocol;
}
export interface BridgeOutput {
FlowOutput?: BridgeFlowOutput;
NetworkOutput?: BridgeNetworkOutput;
}
export type BridgePlacement = "AVAILABLE"|"LOCKED"|string;
export interface BridgeSource {
FlowSource?: BridgeFlowSource;
NetworkSource?: BridgeNetworkSource;
}
export type BridgeState = "CREATING"|"STANDBY"|"STARTING"|"DEPLOYING"|"ACTIVE"|"STOPPING"|"DELETING"|"DELETED"|"START_FAILED"|"START_PENDING"|"STOP_FAILED"|"UPDATING"|string;
export type Colorimetry = "BT601"|"BT709"|"BT2020"|"BT2100"|"ST2065-1"|"ST2065-3"|"XYZ"|string;
export type ConnectionStatus = "CONNECTED"|"DISCONNECTED"|string;
export interface CreateBridgeRequest {
/**
* 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.
*/
EgressGatewayBridge?: AddEgressGatewayBridgeRequest;
/**
* 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.
*/
IngressGatewayBridge?: AddIngressGatewayBridgeRequest;
/**
* The name of the bridge. This name can not be modified after the bridge is created.
*/
Name: __string;
/**
* The outputs that you want to add to this bridge.
*/
Outputs?: __listOfAddBridgeOutputRequest;
/**
* The bridge placement Amazon Resource Number (ARN).
*/
PlacementArn: __string;
/**
* The settings for source failover.
*/
SourceFailoverConfig?: FailoverConfig;
/**
* The sources that you want to add to this bridge.
*/
Sources: __listOfAddBridgeSourceRequest;
}
export interface CreateBridgeResponse {
Bridge?: Bridge;
}
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