MediaConnectClient

API for AWS Elemental MediaConnect

Installation

NPM
npm install @aws-sdk/client-mediaconnect
Yarn
yarn add @aws-sdk/client-mediaconnect
pnpm
pnpm add @aws-sdk/client-mediaconnect

MediaConnectClient Operations

Command
Summary
AddBridgeOutputsCommand
Adds outputs to an existing bridge.
AddBridgeSourcesCommand
Adds sources to an existing bridge.
AddFlowMediaStreamsCommand
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.
AddFlowOutputsCommand
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
AddFlowSourcesCommand
Adds Sources to flow
AddFlowVpcInterfacesCommand
Adds VPC interfaces to flow
CreateBridgeCommand
Creates a new bridge. The request must include one source.
CreateFlowCommand
Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
CreateGatewayCommand
Creates a new gateway. The request must include at least one network (up to 4).
DeleteBridgeCommand
Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
DeleteFlowCommand
Deletes a flow. Before you can delete a flow, you must stop the flow.
DeleteGatewayCommand
Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.
DeregisterGatewayInstanceCommand
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.
DescribeBridgeCommand
Displays the details of a bridge.
DescribeFlowCommand
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.
DescribeFlowSourceMetadataCommand
Displays details of the flow's source stream. The response contains information about the contents of the stream and its programs.
DescribeFlowSourceThumbnailCommand
Displays the thumbnail details of a flow's source stream.
DescribeGatewayCommand
Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.
DescribeGatewayInstanceCommand
Displays the details of an instance.
DescribeOfferingCommand
Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
DescribeReservationCommand
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).
GrantFlowEntitlementsCommand
Grants entitlements to an existing flow.
ListBridgesCommand
Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.
ListEntitlementsCommand
Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
ListFlowsCommand
Displays a list of flows that are associated with this account. This request returns a paginated result.
ListGatewayInstancesCommand
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).
ListGatewaysCommand
Displays a list of gateways that are associated with this account. This request returns a paginated result.
ListOfferingsCommand
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.
ListReservationsCommand
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).
ListTagsForResourceCommand
List all tags on an AWS Elemental MediaConnect resource
PurchaseOfferingCommand
Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.
RemoveBridgeOutputCommand
Removes an output from a bridge.
RemoveBridgeSourceCommand
Removes a source from a bridge.
RemoveFlowMediaStreamCommand
Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.
RemoveFlowOutputCommand
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.
RemoveFlowSourceCommand
Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.
RemoveFlowVpcInterfaceCommand
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.
RevokeFlowEntitlementCommand
Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
StartFlowCommand
Starts a flow.
StopFlowCommand
Stops a flow.
TagResourceCommand
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.
UntagResourceCommand
Deletes specified tags from a resource.
UpdateBridgeCommand
Updates the bridge
UpdateBridgeOutputCommand
Updates an existing bridge output.
UpdateBridgeSourceCommand
Updates an existing bridge source.
UpdateBridgeStateCommand
Updates the bridge state
UpdateFlowCommand
Updates flow
UpdateFlowEntitlementCommand
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.
UpdateFlowMediaStreamCommand
Updates an existing media stream.
UpdateFlowOutputCommand
Updates an existing flow output.
UpdateFlowSourceCommand
Updates the source of a flow.
UpdateGatewayInstanceCommand
Updates the configuration of an existing Gateway Instance.

MediaConnectClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: MediaConnectClientConfig