Mediaconnect

This page documents function available when using the Mediaconnect module, created with @service Mediaconnect.

Index

Documentation

Main.Mediaconnect.add_bridge_outputsMethod
add_bridge_outputs(bridge_arn, outputs)
add_bridge_outputs(bridge_arn, outputs, params::Dict{String,<:Any})

Adds outputs to an existing bridge.

Arguments

  • bridge_arn: The ARN of the bridge that you want to update.
  • outputs: The outputs that you want to add to this bridge.
Main.Mediaconnect.add_bridge_sourcesMethod
add_bridge_sources(bridge_arn, sources)
add_bridge_sources(bridge_arn, sources, params::Dict{String,<:Any})

Adds sources to an existing bridge.

Arguments

  • bridge_arn: The ARN of the bridge that you want to update.
  • sources: The sources that you want to add to this bridge.
Main.Mediaconnect.add_flow_media_streamsMethod
add_flow_media_streams(flow_arn, media_streams)
add_flow_media_streams(flow_arn, media_streams, params::Dict{String,<:Any})

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.

Arguments

  • flow_arn: The Amazon Resource Name (ARN) of the flow.
  • media_streams: The media streams that you want to add to the flow.
Main.Mediaconnect.add_flow_outputsMethod
add_flow_outputs(flow_arn, outputs)
add_flow_outputs(flow_arn, outputs, params::Dict{String,<:Any})

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

Arguments

  • flow_arn: The flow that you want to add outputs to.
  • outputs: A list of outputs that you want to add.
Main.Mediaconnect.add_flow_sourcesMethod
add_flow_sources(flow_arn, sources)
add_flow_sources(flow_arn, sources, params::Dict{String,<:Any})

Adds Sources to flow

Arguments

  • flow_arn: The flow that you want to mutate.
  • sources: A list of sources that you want to add.
Main.Mediaconnect.add_flow_vpc_interfacesMethod
add_flow_vpc_interfaces(flow_arn, vpc_interfaces)
add_flow_vpc_interfaces(flow_arn, vpc_interfaces, params::Dict{String,<:Any})

Adds VPC interfaces to flow

Arguments

  • flow_arn: The flow that you want to mutate.
  • vpc_interfaces: A list of VPC interfaces that you want to add.
Main.Mediaconnect.create_bridgeMethod
create_bridge(name, placement_arn, sources)
create_bridge(name, placement_arn, sources, params::Dict{String,<:Any})

Creates a new bridge. The request must include one source.

Arguments

  • name: The name of the bridge. This name can not be modified after the bridge is created.
  • placement_arn: The bridge placement Amazon Resource Number (ARN).
  • sources: The sources that you want to add to this bridge.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "egressGatewayBridge": 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.
  • "ingressGatewayBridge": 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.
  • "outputs": The outputs that you want to add to this bridge.
  • "sourceFailoverConfig": The settings for source failover.
Main.Mediaconnect.create_flowMethod
create_flow(name)
create_flow(name, params::Dict{String,<:Any})

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).

Arguments

  • name: The name of the flow.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "availabilityZone": The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
  • "entitlements": The entitlements that you want to grant on a flow.
  • "maintenance":
  • "mediaStreams": The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.
  • "outputs": The outputs that you want to add to this flow.
  • "source":
  • "sourceFailoverConfig":
  • "sources":
  • "vpcInterfaces": The VPC interfaces you want on the flow.
Main.Mediaconnect.create_gatewayMethod
create_gateway(egress_cidr_blocks, name, networks)
create_gateway(egress_cidr_blocks, name, networks, params::Dict{String,<:Any})

Creates a new gateway. The request must include at least one network (up to 4).

Arguments

  • egress_cidr_blocks: The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
  • name: The name of the gateway. This name can not be modified after the gateway is created.
  • networks: The list of networks that you want to add.
Main.Mediaconnect.delete_bridgeMethod
delete_bridge(bridge_arn)
delete_bridge(bridge_arn, params::Dict{String,<:Any})

Deletes a bridge. Before you can delete a bridge, you must stop the bridge.

Arguments

  • bridge_arn: The ARN of the bridge that you want to delete.
Main.Mediaconnect.delete_flowMethod
delete_flow(flow_arn)
delete_flow(flow_arn, params::Dict{String,<:Any})

Deletes a flow. Before you can delete a flow, you must stop the flow.

Arguments

  • flow_arn: The ARN of the flow that you want to delete.
Main.Mediaconnect.delete_gatewayMethod
delete_gateway(gateway_arn)
delete_gateway(gateway_arn, params::Dict{String,<:Any})

Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.

Arguments

  • gateway_arn: The ARN of the gateway that you want to delete.
Main.Mediaconnect.deregister_gateway_instanceMethod
deregister_gateway_instance(gateway_instance_arn)
deregister_gateway_instance(gateway_instance_arn, params::Dict{String,<:Any})

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.

Arguments

  • gateway_instance_arn: The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "force": Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.
Main.Mediaconnect.describe_bridgeMethod
describe_bridge(bridge_arn)
describe_bridge(bridge_arn, params::Dict{String,<:Any})

Displays the details of a bridge.

Arguments

  • bridge_arn: The ARN of the bridge that you want to describe.
Main.Mediaconnect.describe_flowMethod
describe_flow(flow_arn)
describe_flow(flow_arn, params::Dict{String,<:Any})

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.

Arguments

  • flow_arn: The ARN of the flow that you want to describe.
Main.Mediaconnect.describe_gatewayMethod
describe_gateway(gateway_arn)
describe_gateway(gateway_arn, params::Dict{String,<:Any})

Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.

Arguments

  • gateway_arn: The Amazon Resource Name (ARN) of the gateway that you want to describe.
Main.Mediaconnect.describe_gateway_instanceMethod
describe_gateway_instance(gateway_instance_arn)
describe_gateway_instance(gateway_instance_arn, params::Dict{String,<:Any})

Displays the details of an instance.

Arguments

  • gateway_instance_arn: The Amazon Resource Name (ARN) of the gateway instance that you want to describe.
Main.Mediaconnect.describe_offeringMethod
describe_offering(offering_arn)
describe_offering(offering_arn, params::Dict{String,<:Any})

Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).

Arguments

  • offering_arn: The Amazon Resource Name (ARN) of the offering.
Main.Mediaconnect.describe_reservationMethod
describe_reservation(reservation_arn)
describe_reservation(reservation_arn, params::Dict{String,<:Any})

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

Arguments

  • reservation_arn: The Amazon Resource Name (ARN) of the reservation.
Main.Mediaconnect.grant_flow_entitlementsMethod
grant_flow_entitlements(entitlements, flow_arn)
grant_flow_entitlements(entitlements, flow_arn, params::Dict{String,<:Any})

Grants entitlements to an existing flow.

Arguments

  • entitlements: The list of entitlements that you want to grant.
  • flow_arn: The flow that you want to grant entitlements on.
Main.Mediaconnect.list_bridgesMethod
list_bridges()
list_bridges(params::Dict{String,<:Any})

Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filterArn": Filter the list results to display only the bridges associated with the selected Amazon Resource Name (ARN).
  • "maxResults": The maximum number of results to return per API request. For example, you submit a ListBridges request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
  • "nextToken": The token that identifies which batch of results that you want to see. For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.
Main.Mediaconnect.list_entitlementsMethod
list_entitlements()
list_entitlements(params::Dict{String,<:Any})

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.
  • "nextToken": 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.
Main.Mediaconnect.list_flowsMethod
list_flows()
list_flows(params::Dict{String,<:Any})

Displays a list of flows that are associated with this account. This request returns a paginated result.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
  • "nextToken": 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.
Main.Mediaconnect.list_gateway_instancesMethod
list_gateway_instances()
list_gateway_instances(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filterArn": Filter the list results to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
  • "maxResults": The maximum number of results to return per API request. For example, you submit a ListInstances request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
  • "nextToken": The token that identifies which batch of results that you want to see. For example, you submit a ListInstances request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListInstances request a second time and specify the NextToken value.
Main.Mediaconnect.list_gatewaysMethod
list_gateways()
list_gateways(params::Dict{String,<:Any})

Displays a list of gateways that are associated with this account. This request returns a paginated result.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per API request. For example, you submit a ListGateways request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
  • "nextToken": The token that identifies which batch of results that you want to see. For example, you submit a ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value.
Main.Mediaconnect.list_offeringsMethod
list_offerings()
list_offerings(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": 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.
  • "nextToken": 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.
Main.Mediaconnect.list_reservationsMethod
list_reservations()
list_reservations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": 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.
  • "nextToken": 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.
Main.Mediaconnect.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

List all tags on an AWS Elemental MediaConnect resource

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags.
Main.Mediaconnect.purchase_offeringMethod
purchase_offering(offering_arn, reservation_name, start)
purchase_offering(offering_arn, reservation_name, start, params::Dict{String,<:Any})

Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.

Arguments

  • offering_arn: The Amazon Resource Name (ARN) of the offering.
  • reservation_name: The name that you want to use for the reservation.
  • start: The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.
Main.Mediaconnect.remove_bridge_outputMethod
remove_bridge_output(bridge_arn, output_name)
remove_bridge_output(bridge_arn, output_name, params::Dict{String,<:Any})

Removes an output from a bridge.

Arguments

  • bridge_arn: The ARN of the bridge that you want to update.
  • output_name: The name of the bridge output that you want to remove.
Main.Mediaconnect.remove_bridge_sourceMethod
remove_bridge_source(bridge_arn, source_name)
remove_bridge_source(bridge_arn, source_name, params::Dict{String,<:Any})

Removes a source from a bridge.

Arguments

  • bridge_arn: The ARN of the bridge that you want to update.
  • source_name: The name of the bridge source that you want to remove.
Main.Mediaconnect.remove_flow_media_streamMethod
remove_flow_media_stream(flow_arn, media_stream_name)
remove_flow_media_stream(flow_arn, media_stream_name, params::Dict{String,<:Any})

Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.

Arguments

  • flow_arn: The Amazon Resource Name (ARN) of the flow.
  • media_stream_name: The name of the media stream that you want to remove.
Main.Mediaconnect.remove_flow_outputMethod
remove_flow_output(flow_arn, output_arn)
remove_flow_output(flow_arn, output_arn, params::Dict{String,<:Any})

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.

Arguments

  • flow_arn: The flow that you want to remove an output from.
  • output_arn: The ARN of the output that you want to remove.
Main.Mediaconnect.remove_flow_sourceMethod
remove_flow_source(flow_arn, source_arn)
remove_flow_source(flow_arn, source_arn, params::Dict{String,<:Any})

Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.

Arguments

  • flow_arn: The flow that you want to remove a source from.
  • source_arn: The ARN of the source that you want to remove.
Main.Mediaconnect.remove_flow_vpc_interfaceMethod
remove_flow_vpc_interface(flow_arn, vpc_interface_name)
remove_flow_vpc_interface(flow_arn, vpc_interface_name, params::Dict{String,<:Any})

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.

Arguments

  • flow_arn: The flow that you want to remove a VPC interface from.
  • vpc_interface_name: The name of the VPC interface that you want to remove.
Main.Mediaconnect.revoke_flow_entitlementMethod
revoke_flow_entitlement(entitlement_arn, flow_arn)
revoke_flow_entitlement(entitlement_arn, flow_arn, params::Dict{String,<:Any})

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.

Arguments

  • entitlement_arn: The ARN of the entitlement that you want to revoke.
  • flow_arn: The flow that you want to revoke an entitlement from.
Main.Mediaconnect.start_flowMethod
start_flow(flow_arn)
start_flow(flow_arn, params::Dict{String,<:Any})

Starts a flow.

Arguments

  • flow_arn: The ARN of the flow that you want to start.
Main.Mediaconnect.stop_flowMethod
stop_flow(flow_arn)
stop_flow(flow_arn, params::Dict{String,<:Any})

Stops a flow.

Arguments

  • flow_arn: The ARN of the flow that you want to stop.
Main.Mediaconnect.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags.
  • tags: 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.
Main.Mediaconnect.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Deletes specified tags from a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.
  • tag_keys: The keys of the tags to be removed.
Main.Mediaconnect.update_bridgeMethod
update_bridge(bridge_arn)
update_bridge(bridge_arn, params::Dict{String,<:Any})

Updates the bridge

Arguments

  • bridge_arn: The Amazon Resource Number (ARN) of the bridge that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "egressGatewayBridge":
  • "ingressGatewayBridge":
  • "sourceFailoverConfig":
Main.Mediaconnect.update_bridge_outputMethod
update_bridge_output(bridge_arn, output_name)
update_bridge_output(bridge_arn, output_name, params::Dict{String,<:Any})

Updates an existing bridge output.

Arguments

  • bridge_arn: The ARN of the bridge that you want to update.
  • output_name: The name of the bridge output that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "networkOutput":
Main.Mediaconnect.update_bridge_sourceMethod
update_bridge_source(bridge_arn, source_name)
update_bridge_source(bridge_arn, source_name, params::Dict{String,<:Any})

Updates an existing bridge source.

Arguments

  • bridge_arn: The ARN of the bridge that you want to update.
  • source_name: The name of the source that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "flowSource":
  • "networkSource":
Main.Mediaconnect.update_bridge_stateMethod
update_bridge_state(bridge_arn, desired_state)
update_bridge_state(bridge_arn, desired_state, params::Dict{String,<:Any})

Updates the bridge state

Arguments

  • bridge_arn: The ARN of the bridge that you want to update.
  • desired_state:
Main.Mediaconnect.update_flowMethod
update_flow(flow_arn)
update_flow(flow_arn, params::Dict{String,<:Any})

Updates flow

Arguments

  • flow_arn: The flow that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maintenance":
  • "sourceFailoverConfig":
Main.Mediaconnect.update_flow_entitlementMethod
update_flow_entitlement(entitlement_arn, flow_arn)
update_flow_entitlement(entitlement_arn, flow_arn, params::Dict{String,<:Any})

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.

Arguments

  • entitlement_arn: The ARN of the entitlement that you want to update.
  • flow_arn: The flow that is associated with the entitlement that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
  • "encryption": The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.
  • "entitlementStatus": An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
  • "subscribers": 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.
Main.Mediaconnect.update_flow_media_streamMethod
update_flow_media_stream(flow_arn, media_stream_name)
update_flow_media_stream(flow_arn, media_stream_name, params::Dict{String,<:Any})

Updates an existing media stream.

Arguments

  • flow_arn: The Amazon Resource Name (ARN) of the flow.
  • media_stream_name: The name of the media stream that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "attributes": The attributes that you want to assign to the media stream.
  • "clockRate": 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.
  • "description": Description
  • "mediaStreamType": The type of media stream.
  • "videoFormat": The resolution of the video.
Main.Mediaconnect.update_flow_outputMethod
update_flow_output(flow_arn, output_arn)
update_flow_output(flow_arn, output_arn, params::Dict{String,<:Any})

Updates an existing flow output.

Arguments

  • flow_arn: The flow that is associated with the output that you want to update.
  • output_arn: The ARN of the output that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "cidrAllowList": 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.
  • "description": A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
  • "destination": The IP address where you want to send the output.
  • "encryption": 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.
  • "maxLatency": The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
  • "mediaStreamOutputConfigurations": The media streams that are associated with the output, and the parameters for those associations.
  • "minLatency": 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.
  • "port": The port to use when content is distributed to this output.
  • "protocol": The protocol to use for the output.
  • "remoteId": The remote ID for the Zixi-pull stream.
  • "senderControlPort": The port that the flow uses to send outbound requests to initiate connection with the sender.
  • "senderIpAddress": The IP address that the flow communicates with to initiate connection with the sender.
  • "smoothingLatency": The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
  • "streamId": The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
  • "vpcInterfaceAttachment": The name of the VPC interface attachment to use for this output.
Main.Mediaconnect.update_flow_sourceMethod
update_flow_source(flow_arn, source_arn)
update_flow_source(flow_arn, source_arn, params::Dict{String,<:Any})

Updates the source of a flow.

Arguments

  • flow_arn: The flow that is associated with the source that you want to update.
  • source_arn: The ARN of the source that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "decryption": The type of encryption used on the content ingested from this source. Allowable encryption types: static-key.
  • "description": A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
  • "entitlementArn": The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
  • "gatewayBridgeSource": The source configuration for cloud flows receiving a stream from a bridge.
  • "ingestPort": The port that the flow will be listening on for incoming content.
  • "maxBitrate": The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
  • "maxLatency": The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
  • "maxSyncBuffer": The size of the buffer (in milliseconds) to use to sync incoming source data.
  • "mediaStreamSourceConfigurations": The media streams that are associated with the source, and the parameters for those associations.
  • "minLatency": 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.
  • "protocol": The protocol that is used by the source.
  • "senderControlPort": The port that the flow uses to send outbound requests to initiate connection with the sender.
  • "senderIpAddress": The IP address that the flow communicates with to initiate connection with the sender.
  • "sourceListenerAddress": Source IP or domain name for SRT-caller protocol.
  • "sourceListenerPort": Source port for SRT-caller protocol.
  • "streamId": The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
  • "vpcInterfaceName": The name of the VPC interface to use for this source.
  • "whitelistCidr": The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
Main.Mediaconnect.update_gateway_instanceMethod
update_gateway_instance(gateway_instance_arn)
update_gateway_instance(gateway_instance_arn, params::Dict{String,<:Any})

Updates the configuration of an existing Gateway Instance.

Arguments

  • gateway_instance_arn: The Amazon Resource Name (ARN) of the instance that you want to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "bridgePlacement": The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.