Struct aws_sdk_mediaconnect::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS MediaConnect
Client for invoking operations on AWS MediaConnect. Each operation on AWS MediaConnect is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_mediaconnect::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_mediaconnect::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the AddBridgeOutputs
operation has
a Client::add_bridge_outputs
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.add_bridge_outputs()
.bridge_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
§Waiters
This client provides wait_until
methods behind the Waiters
trait.
To use them, simply import the trait, and then call one of the wait_until
methods. This will
return a waiter fluent builder that takes various parameters, which are documented on the builder
type. Once parameters have been provided, the wait
method can be called to initiate waiting.
For example, if there was a wait_until_thing
method, it could look like:
let result = client.wait_until_thing()
.thing_id("someId")
.wait(Duration::from_secs(120))
.await;
Implementations§
source§impl Client
impl Client
sourcepub fn add_bridge_outputs(&self) -> AddBridgeOutputsFluentBuilder
pub fn add_bridge_outputs(&self) -> AddBridgeOutputsFluentBuilder
Constructs a fluent builder for the AddBridgeOutputs
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to update.outputs(AddBridgeOutputRequest)
/set_outputs(Option<Vec::<AddBridgeOutputRequest>>)
:
required: true
The outputs that you want to add to this bridge.
- On success, responds with
AddBridgeOutputsOutput
with field(s):bridge_arn(Option<String>)
: The Amazon Resource Number (ARN) of the bridge.outputs(Option<Vec::<BridgeOutput>>)
: The outputs that you added to this bridge.
- On failure, responds with
SdkError<AddBridgeOutputsError>
source§impl Client
impl Client
sourcepub fn add_bridge_sources(&self) -> AddBridgeSourcesFluentBuilder
pub fn add_bridge_sources(&self) -> AddBridgeSourcesFluentBuilder
Constructs a fluent builder for the AddBridgeSources
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to update.sources(AddBridgeSourceRequest)
/set_sources(Option<Vec::<AddBridgeSourceRequest>>)
:
required: true
The sources that you want to add to this bridge.
- On success, responds with
AddBridgeSourcesOutput
with field(s):bridge_arn(Option<String>)
: The Amazon Resource Number (ARN) of the bridge.sources(Option<Vec::<BridgeSource>>)
: The sources that you added to this bridge.
- On failure, responds with
SdkError<AddBridgeSourcesError>
source§impl Client
impl Client
sourcepub fn add_flow_media_streams(&self) -> AddFlowMediaStreamsFluentBuilder
pub fn add_flow_media_streams(&self) -> AddFlowMediaStreamsFluentBuilder
Constructs a fluent builder for the AddFlowMediaStreams
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the flow.media_streams(AddMediaStreamRequest)
/set_media_streams(Option<Vec::<AddMediaStreamRequest>>)
:
required: true
The media streams that you want to add to the flow.
- On success, responds with
AddFlowMediaStreamsOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that you added media streams to.media_streams(Option<Vec::<MediaStream>>)
: The media streams that you added to the flow.
- On failure, responds with
SdkError<AddFlowMediaStreamsError>
source§impl Client
impl Client
sourcepub fn add_flow_outputs(&self) -> AddFlowOutputsFluentBuilder
pub fn add_flow_outputs(&self) -> AddFlowOutputsFluentBuilder
Constructs a fluent builder for the AddFlowOutputs
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to add outputs to.outputs(AddOutputRequest)
/set_outputs(Option<Vec::<AddOutputRequest>>)
:
required: true
A list of outputs that you want to add.
- On success, responds with
AddFlowOutputsOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that these outputs were added to.outputs(Option<Vec::<Output>>)
: The details of the newly added outputs.
- On failure, responds with
SdkError<AddFlowOutputsError>
source§impl Client
impl Client
sourcepub fn add_flow_sources(&self) -> AddFlowSourcesFluentBuilder
pub fn add_flow_sources(&self) -> AddFlowSourcesFluentBuilder
Constructs a fluent builder for the AddFlowSources
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to mutate.sources(SetSourceRequest)
/set_sources(Option<Vec::<SetSourceRequest>>)
:
required: true
A list of sources that you want to add.
- On success, responds with
AddFlowSourcesOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that these sources were added to.sources(Option<Vec::<Source>>)
: The details of the newly added sources.
- On failure, responds with
SdkError<AddFlowSourcesError>
source§impl Client
impl Client
sourcepub fn add_flow_vpc_interfaces(&self) -> AddFlowVpcInterfacesFluentBuilder
pub fn add_flow_vpc_interfaces(&self) -> AddFlowVpcInterfacesFluentBuilder
Constructs a fluent builder for the AddFlowVpcInterfaces
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to mutate.vpc_interfaces(VpcInterfaceRequest)
/set_vpc_interfaces(Option<Vec::<VpcInterfaceRequest>>)
:
required: true
A list of VPC interfaces that you want to add.
- On success, responds with
AddFlowVpcInterfacesOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that these VPC interfaces were added to.vpc_interfaces(Option<Vec::<VpcInterface>>)
: The details of the newly added VPC interfaces.
- On failure, responds with
SdkError<AddFlowVpcInterfacesError>
source§impl Client
impl Client
sourcepub fn create_bridge(&self) -> CreateBridgeFluentBuilder
pub fn create_bridge(&self) -> CreateBridgeFluentBuilder
Constructs a fluent builder for the CreateBridge
operation.
- The fluent builder is configurable:
egress_gateway_bridge(AddEgressGatewayBridgeRequest)
/set_egress_gateway_bridge(Option<AddEgressGatewayBridgeRequest>)
:
required: false
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.ingress_gateway_bridge(AddIngressGatewayBridgeRequest)
/set_ingress_gateway_bridge(Option<AddIngressGatewayBridgeRequest>)
:
required: false
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.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the bridge. This name can not be modified after the bridge is created.outputs(AddBridgeOutputRequest)
/set_outputs(Option<Vec::<AddBridgeOutputRequest>>)
:
required: false
The outputs that you want to add to this bridge.placement_arn(impl Into<String>)
/set_placement_arn(Option<String>)
:
required: true
The bridge placement Amazon Resource Number (ARN).source_failover_config(FailoverConfig)
/set_source_failover_config(Option<FailoverConfig>)
:
required: false
The settings for source failover.sources(AddBridgeSourceRequest)
/set_sources(Option<Vec::<AddBridgeSourceRequest>>)
:
required: true
The sources that you want to add to this bridge.
- On success, responds with
CreateBridgeOutput
with field(s):bridge(Option<Bridge>)
: A Bridge is the connection between your datacenter’s Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
- On failure, responds with
SdkError<CreateBridgeError>
source§impl Client
impl Client
sourcepub fn create_flow(&self) -> CreateFlowFluentBuilder
pub fn create_flow(&self) -> CreateFlowFluentBuilder
Constructs a fluent builder for the CreateFlow
operation.
- The fluent builder is configurable:
availability_zone(impl Into<String>)
/set_availability_zone(Option<String>)
:
required: false
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(GrantEntitlementRequest)
/set_entitlements(Option<Vec::<GrantEntitlementRequest>>)
:
required: false
The entitlements that you want to grant on a flow.media_streams(AddMediaStreamRequest)
/set_media_streams(Option<Vec::<AddMediaStreamRequest>>)
:
required: false
The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.name(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the flow.outputs(AddOutputRequest)
/set_outputs(Option<Vec::<AddOutputRequest>>)
:
required: false
The outputs that you want to add to this flow.source(SetSourceRequest)
/set_source(Option<SetSourceRequest>)
:
required: false
The settings for the source of the flow.source_failover_config(FailoverConfig)
/set_source_failover_config(Option<FailoverConfig>)
:
required: false
The settings for source failover.sources(SetSourceRequest)
/set_sources(Option<Vec::<SetSourceRequest>>)
:
required: false
(undocumented)vpc_interfaces(VpcInterfaceRequest)
/set_vpc_interfaces(Option<Vec::<VpcInterfaceRequest>>)
:
required: false
The VPC interfaces you want on the flow.maintenance(AddMaintenance)
/set_maintenance(Option<AddMaintenance>)
:
required: false
Create maintenance setting for a flow
- On success, responds with
CreateFlowOutput
with field(s):flow(Option<Flow>)
: The settings for a flow, including its source, outputs, and entitlements.
- On failure, responds with
SdkError<CreateFlowError>
source§impl Client
impl Client
sourcepub fn create_gateway(&self) -> CreateGatewayFluentBuilder
pub fn create_gateway(&self) -> CreateGatewayFluentBuilder
Constructs a fluent builder for the CreateGateway
operation.
- The fluent builder is configurable:
egress_cidr_blocks(impl Into<String>)
/set_egress_cidr_blocks(Option<Vec::<String>>)
:
required: true
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(impl Into<String>)
/set_name(Option<String>)
:
required: true
The name of the gateway. This name can not be modified after the gateway is created.networks(GatewayNetwork)
/set_networks(Option<Vec::<GatewayNetwork>>)
:
required: true
The list of networks that you want to add.
- On success, responds with
CreateGatewayOutput
with field(s):gateway(Option<Gateway>)
: The settings for a gateway, including its networks.
- On failure, responds with
SdkError<CreateGatewayError>
source§impl Client
impl Client
sourcepub fn delete_bridge(&self) -> DeleteBridgeFluentBuilder
pub fn delete_bridge(&self) -> DeleteBridgeFluentBuilder
Constructs a fluent builder for the DeleteBridge
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to delete.
- On success, responds with
DeleteBridgeOutput
with field(s):bridge_arn(Option<String>)
: The Amazon Resource Number (ARN) of the deleted bridge.
- On failure, responds with
SdkError<DeleteBridgeError>
source§impl Client
impl Client
sourcepub fn delete_flow(&self) -> DeleteFlowFluentBuilder
pub fn delete_flow(&self) -> DeleteFlowFluentBuilder
Constructs a fluent builder for the DeleteFlow
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The ARN of the flow that you want to delete.
- On success, responds with
DeleteFlowOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that was deleted.status(Option<Status>)
: The status of the flow when the DeleteFlow process begins.
- On failure, responds with
SdkError<DeleteFlowError>
source§impl Client
impl Client
sourcepub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder
pub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder
Constructs a fluent builder for the DeleteGateway
operation.
- The fluent builder is configurable:
gateway_arn(impl Into<String>)
/set_gateway_arn(Option<String>)
:
required: true
The ARN of the gateway that you want to delete.
- On success, responds with
DeleteGatewayOutput
with field(s):gateway_arn(Option<String>)
: The Amazon Resource Name (ARN) of the gateway that was deleted.
- On failure, responds with
SdkError<DeleteGatewayError>
source§impl Client
impl Client
sourcepub fn deregister_gateway_instance(
&self,
) -> DeregisterGatewayInstanceFluentBuilder
pub fn deregister_gateway_instance( &self, ) -> DeregisterGatewayInstanceFluentBuilder
Constructs a fluent builder for the DeregisterGatewayInstance
operation.
- The fluent builder is configurable:
force(bool)
/set_force(Option<bool>)
:
required: false
Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.gateway_instance_arn(impl Into<String>)
/set_gateway_instance_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.
- On success, responds with
DeregisterGatewayInstanceOutput
with field(s):gateway_instance_arn(Option<String>)
: The Amazon Resource Name (ARN) of the instance.instance_state(Option<InstanceState>)
: The status of the instance.
- On failure, responds with
SdkError<DeregisterGatewayInstanceError>
source§impl Client
impl Client
sourcepub fn describe_bridge(&self) -> DescribeBridgeFluentBuilder
pub fn describe_bridge(&self) -> DescribeBridgeFluentBuilder
Constructs a fluent builder for the DescribeBridge
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to describe.
- On success, responds with
DescribeBridgeOutput
with field(s):bridge(Option<Bridge>)
: A Bridge is the connection between your datacenter’s Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
- On failure, responds with
SdkError<DescribeBridgeError>
source§impl Client
impl Client
sourcepub fn describe_flow(&self) -> DescribeFlowFluentBuilder
pub fn describe_flow(&self) -> DescribeFlowFluentBuilder
Constructs a fluent builder for the DescribeFlow
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The ARN of the flow that you want to describe.
- On success, responds with
DescribeFlowOutput
with field(s):flow(Option<Flow>)
: The settings for a flow, including its source, outputs, and entitlements.messages(Option<Messages>)
: Messages that provide the state of the flow.
- On failure, responds with
SdkError<DescribeFlowError>
source§impl Client
impl Client
sourcepub fn describe_flow_source_metadata(
&self,
) -> DescribeFlowSourceMetadataFluentBuilder
pub fn describe_flow_source_metadata( &self, ) -> DescribeFlowSourceMetadataFluentBuilder
Constructs a fluent builder for the DescribeFlowSourceMetadata
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the flow.
- On success, responds with
DescribeFlowSourceMetadataOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that DescribeFlowSourceMetadata was performed on.messages(Option<Vec::<MessageDetail>>)
: Provides a status code and message regarding issues found with the flow source metadata.timestamp(Option<DateTime>)
: The timestamp of the most recent change in metadata for this flow’s source.transport_media_info(Option<TransportMediaInfo>)
: The metadata of the transport stream in the current flow’s source.
- On failure, responds with
SdkError<DescribeFlowSourceMetadataError>
source§impl Client
impl Client
sourcepub fn describe_gateway(&self) -> DescribeGatewayFluentBuilder
pub fn describe_gateway(&self) -> DescribeGatewayFluentBuilder
Constructs a fluent builder for the DescribeGateway
operation.
- The fluent builder is configurable:
gateway_arn(impl Into<String>)
/set_gateway_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the gateway that you want to describe.
- On success, responds with
DescribeGatewayOutput
with field(s):gateway(Option<Gateway>)
: The settings for a gateway, including its networks.
- On failure, responds with
SdkError<DescribeGatewayError>
source§impl Client
impl Client
sourcepub fn describe_gateway_instance(&self) -> DescribeGatewayInstanceFluentBuilder
pub fn describe_gateway_instance(&self) -> DescribeGatewayInstanceFluentBuilder
Constructs a fluent builder for the DescribeGatewayInstance
operation.
- The fluent builder is configurable:
gateway_instance_arn(impl Into<String>)
/set_gateway_instance_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the gateway instance that you want to describe.
- On success, responds with
DescribeGatewayInstanceOutput
with field(s):gateway_instance(Option<GatewayInstance>)
: The settings for an instance in a gateway.
- On failure, responds with
SdkError<DescribeGatewayInstanceError>
source§impl Client
impl Client
sourcepub fn describe_offering(&self) -> DescribeOfferingFluentBuilder
pub fn describe_offering(&self) -> DescribeOfferingFluentBuilder
Constructs a fluent builder for the DescribeOffering
operation.
- The fluent builder is configurable:
offering_arn(impl Into<String>)
/set_offering_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the offering.
- On success, responds with
DescribeOfferingOutput
with field(s):offering(Option<Offering>)
: A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
- On failure, responds with
SdkError<DescribeOfferingError>
source§impl Client
impl Client
sourcepub fn describe_reservation(&self) -> DescribeReservationFluentBuilder
pub fn describe_reservation(&self) -> DescribeReservationFluentBuilder
Constructs a fluent builder for the DescribeReservation
operation.
- The fluent builder is configurable:
reservation_arn(impl Into<String>)
/set_reservation_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the reservation.
- On success, responds with
DescribeReservationOutput
with field(s):reservation(Option<Reservation>)
: A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
- On failure, responds with
SdkError<DescribeReservationError>
source§impl Client
impl Client
sourcepub fn grant_flow_entitlements(&self) -> GrantFlowEntitlementsFluentBuilder
pub fn grant_flow_entitlements(&self) -> GrantFlowEntitlementsFluentBuilder
Constructs a fluent builder for the GrantFlowEntitlements
operation.
- The fluent builder is configurable:
entitlements(GrantEntitlementRequest)
/set_entitlements(Option<Vec::<GrantEntitlementRequest>>)
:
required: true
The list of entitlements that you want to grant.flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to grant entitlements on.
- On success, responds with
GrantFlowEntitlementsOutput
with field(s):entitlements(Option<Vec::<Entitlement>>)
: The entitlements that were just granted.flow_arn(Option<String>)
: The ARN of the flow that these entitlements were granted to.
- On failure, responds with
SdkError<GrantFlowEntitlementsError>
source§impl Client
impl Client
sourcepub fn list_bridges(&self) -> ListBridgesFluentBuilder
pub fn list_bridges(&self) -> ListBridgesFluentBuilder
Constructs a fluent builder for the ListBridges
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter_arn(impl Into<String>)
/set_filter_arn(Option<String>)
:
required: false
Filter the list results to display only the bridges associated with the selected Amazon Resource Name (ARN).max_results(i32)
/set_max_results(Option<i32>)
:
required: false
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.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
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.
- On success, responds with
ListBridgesOutput
with field(s):bridges(Option<Vec::<ListedBridge>>)
: A list of bridge summaries.next_token(Option<String>)
: 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.
- On failure, responds with
SdkError<ListBridgesError>
source§impl Client
impl Client
sourcepub fn list_entitlements(&self) -> ListEntitlementsFluentBuilder
pub fn list_entitlements(&self) -> ListEntitlementsFluentBuilder
Constructs a fluent builder for the ListEntitlements
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
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.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
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.
- On success, responds with
ListEntitlementsOutput
with field(s):entitlements(Option<Vec::<ListedEntitlement>>)
: A list of entitlements that have been granted to you from other AWS accounts.next_token(Option<String>)
: 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.
- On failure, responds with
SdkError<ListEntitlementsError>
source§impl Client
impl Client
sourcepub fn list_flows(&self) -> ListFlowsFluentBuilder
pub fn list_flows(&self) -> ListFlowsFluentBuilder
Constructs a fluent builder for the ListFlows
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
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.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
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.
- On success, responds with
ListFlowsOutput
with field(s):flows(Option<Vec::<ListedFlow>>)
: A list of flow summaries.next_token(Option<String>)
: 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.
- On failure, responds with
SdkError<ListFlowsError>
source§impl Client
impl Client
sourcepub fn list_gateway_instances(&self) -> ListGatewayInstancesFluentBuilder
pub fn list_gateway_instances(&self) -> ListGatewayInstancesFluentBuilder
Constructs a fluent builder for the ListGatewayInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter_arn(impl Into<String>)
/set_filter_arn(Option<String>)
:
required: false
Filter the list results to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).max_results(i32)
/set_max_results(Option<i32>)
:
required: false
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.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
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.
- On success, responds with
ListGatewayInstancesOutput
with field(s):instances(Option<Vec::<ListedGatewayInstance>>)
: A list of instance summaries.next_token(Option<String>)
: 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.
- On failure, responds with
SdkError<ListGatewayInstancesError>
source§impl Client
impl Client
sourcepub fn list_gateways(&self) -> ListGatewaysFluentBuilder
pub fn list_gateways(&self) -> ListGatewaysFluentBuilder
Constructs a fluent builder for the ListGateways
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
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.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
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.
- On success, responds with
ListGatewaysOutput
with field(s):gateways(Option<Vec::<ListedGateway>>)
: A list of gateway summaries.next_token(Option<String>)
: 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.
- On failure, responds with
SdkError<ListGatewaysError>
source§impl Client
impl Client
sourcepub fn list_offerings(&self) -> ListOfferingsFluentBuilder
pub fn list_offerings(&self) -> ListOfferingsFluentBuilder
Constructs a fluent builder for the ListOfferings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
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.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
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.
- On success, responds with
ListOfferingsOutput
with field(s):next_token(Option<String>)
: 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.offerings(Option<Vec::<Offering>>)
: A list of offerings that are available to this account in the current AWS Region.
- On failure, responds with
SdkError<ListOfferingsError>
source§impl Client
impl Client
sourcepub fn list_reservations(&self) -> ListReservationsFluentBuilder
pub fn list_reservations(&self) -> ListReservationsFluentBuilder
Constructs a fluent builder for the ListReservations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
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.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
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.
- On success, responds with
ListReservationsOutput
with field(s):next_token(Option<String>)
: 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.reservations(Option<Vec::<Reservation>>)
: A list of all reservations that have been purchased by this account in the current AWS Region.
- On failure, responds with
SdkError<ListReservationsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
: 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.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn purchase_offering(&self) -> PurchaseOfferingFluentBuilder
pub fn purchase_offering(&self) -> PurchaseOfferingFluentBuilder
Constructs a fluent builder for the PurchaseOffering
operation.
- The fluent builder is configurable:
offering_arn(impl Into<String>)
/set_offering_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the offering.reservation_name(impl Into<String>)
/set_reservation_name(Option<String>)
:
required: true
The name that you want to use for the reservation.start(impl Into<String>)
/set_start(Option<String>)
:
required: true
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.
- On success, responds with
PurchaseOfferingOutput
with field(s):reservation(Option<Reservation>)
: A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
- On failure, responds with
SdkError<PurchaseOfferingError>
source§impl Client
impl Client
sourcepub fn remove_bridge_output(&self) -> RemoveBridgeOutputFluentBuilder
pub fn remove_bridge_output(&self) -> RemoveBridgeOutputFluentBuilder
Constructs a fluent builder for the RemoveBridgeOutput
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to update.output_name(impl Into<String>)
/set_output_name(Option<String>)
:
required: true
The name of the bridge output that you want to remove.
- On success, responds with
RemoveBridgeOutputOutput
with field(s):bridge_arn(Option<String>)
: (undocumented)output_name(Option<String>)
: (undocumented)
- On failure, responds with
SdkError<RemoveBridgeOutputError>
source§impl Client
impl Client
sourcepub fn remove_bridge_source(&self) -> RemoveBridgeSourceFluentBuilder
pub fn remove_bridge_source(&self) -> RemoveBridgeSourceFluentBuilder
Constructs a fluent builder for the RemoveBridgeSource
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to update.source_name(impl Into<String>)
/set_source_name(Option<String>)
:
required: true
The name of the bridge source that you want to remove.
- On success, responds with
RemoveBridgeSourceOutput
with field(s):bridge_arn(Option<String>)
: (undocumented)source_name(Option<String>)
: (undocumented)
- On failure, responds with
SdkError<RemoveBridgeSourceError>
source§impl Client
impl Client
sourcepub fn remove_flow_media_stream(&self) -> RemoveFlowMediaStreamFluentBuilder
pub fn remove_flow_media_stream(&self) -> RemoveFlowMediaStreamFluentBuilder
Constructs a fluent builder for the RemoveFlowMediaStream
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the flow.media_stream_name(impl Into<String>)
/set_media_stream_name(Option<String>)
:
required: true
The name of the media stream that you want to remove.
- On success, responds with
RemoveFlowMediaStreamOutput
with field(s):flow_arn(Option<String>)
: The Amazon Resource Name (ARN) of the flow.media_stream_name(Option<String>)
: The name of the media stream that was removed.
- On failure, responds with
SdkError<RemoveFlowMediaStreamError>
source§impl Client
impl Client
sourcepub fn remove_flow_output(&self) -> RemoveFlowOutputFluentBuilder
pub fn remove_flow_output(&self) -> RemoveFlowOutputFluentBuilder
Constructs a fluent builder for the RemoveFlowOutput
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to remove an output from.output_arn(impl Into<String>)
/set_output_arn(Option<String>)
:
required: true
The ARN of the output that you want to remove.
- On success, responds with
RemoveFlowOutputOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that is associated with the output you removed.output_arn(Option<String>)
: The ARN of the output that was removed.
- On failure, responds with
SdkError<RemoveFlowOutputError>
source§impl Client
impl Client
sourcepub fn remove_flow_source(&self) -> RemoveFlowSourceFluentBuilder
pub fn remove_flow_source(&self) -> RemoveFlowSourceFluentBuilder
Constructs a fluent builder for the RemoveFlowSource
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to remove a source from.source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:
required: true
The ARN of the source that you want to remove.
- On success, responds with
RemoveFlowSourceOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that is associated with the source you removed.source_arn(Option<String>)
: The ARN of the source that was removed.
- On failure, responds with
SdkError<RemoveFlowSourceError>
source§impl Client
impl Client
sourcepub fn remove_flow_vpc_interface(&self) -> RemoveFlowVpcInterfaceFluentBuilder
pub fn remove_flow_vpc_interface(&self) -> RemoveFlowVpcInterfaceFluentBuilder
Constructs a fluent builder for the RemoveFlowVpcInterface
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to remove a VPC interface from.vpc_interface_name(impl Into<String>)
/set_vpc_interface_name(Option<String>)
:
required: true
The name of the VPC interface that you want to remove.
- On success, responds with
RemoveFlowVpcInterfaceOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that is associated with the VPC interface you removed.non_deleted_network_interface_ids(Option<Vec::<String>>)
: IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove.vpc_interface_name(Option<String>)
: The name of the VPC interface that was removed.
- On failure, responds with
SdkError<RemoveFlowVpcInterfaceError>
source§impl Client
impl Client
sourcepub fn revoke_flow_entitlement(&self) -> RevokeFlowEntitlementFluentBuilder
pub fn revoke_flow_entitlement(&self) -> RevokeFlowEntitlementFluentBuilder
Constructs a fluent builder for the RevokeFlowEntitlement
operation.
- The fluent builder is configurable:
entitlement_arn(impl Into<String>)
/set_entitlement_arn(Option<String>)
:
required: true
The ARN of the entitlement that you want to revoke.flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to revoke an entitlement from.
- On success, responds with
RevokeFlowEntitlementOutput
with field(s):entitlement_arn(Option<String>)
: The ARN of the entitlement that was revoked.flow_arn(Option<String>)
: The ARN of the flow that the entitlement was revoked from.
- On failure, responds with
SdkError<RevokeFlowEntitlementError>
source§impl Client
impl Client
sourcepub fn start_flow(&self) -> StartFlowFluentBuilder
pub fn start_flow(&self) -> StartFlowFluentBuilder
Constructs a fluent builder for the StartFlow
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The ARN of the flow that you want to start.
- On success, responds with
StartFlowOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that you started.status(Option<Status>)
: The status of the flow when the StartFlow process begins.
- On failure, responds with
SdkError<StartFlowError>
source§impl Client
impl Client
sourcepub fn stop_flow(&self) -> StopFlowFluentBuilder
pub fn stop_flow(&self) -> StopFlowFluentBuilder
Constructs a fluent builder for the StopFlow
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The ARN of the flow that you want to stop.
- On success, responds with
StopFlowOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that you stopped.status(Option<Status>)
: The status of the flow when the StopFlow process begins.
- On failure, responds with
SdkError<StopFlowError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: true
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.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: true
The keys of the tags to be removed.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_bridge(&self) -> UpdateBridgeFluentBuilder
pub fn update_bridge(&self) -> UpdateBridgeFluentBuilder
Constructs a fluent builder for the UpdateBridge
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The Amazon Resource Number (ARN) of the bridge that you want to update.egress_gateway_bridge(UpdateEgressGatewayBridgeRequest)
/set_egress_gateway_bridge(Option<UpdateEgressGatewayBridgeRequest>)
:
required: false
(undocumented)ingress_gateway_bridge(UpdateIngressGatewayBridgeRequest)
/set_ingress_gateway_bridge(Option<UpdateIngressGatewayBridgeRequest>)
:
required: false
(undocumented)source_failover_config(UpdateFailoverConfig)
/set_source_failover_config(Option<UpdateFailoverConfig>)
:
required: false
The settings for source failover.
- On success, responds with
UpdateBridgeOutput
with field(s):bridge(Option<Bridge>)
: A Bridge is the connection between your datacenter’s Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
- On failure, responds with
SdkError<UpdateBridgeError>
source§impl Client
impl Client
sourcepub fn update_bridge_output(&self) -> UpdateBridgeOutputFluentBuilder
pub fn update_bridge_output(&self) -> UpdateBridgeOutputFluentBuilder
Constructs a fluent builder for the UpdateBridgeOutput
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to update.network_output(UpdateBridgeNetworkOutputRequest)
/set_network_output(Option<UpdateBridgeNetworkOutputRequest>)
:
required: false
Update an existing network output.output_name(impl Into<String>)
/set_output_name(Option<String>)
:
required: true
The name of the bridge output that you want to update.
- On success, responds with
UpdateBridgeOutputOutput
with field(s):bridge_arn(Option<String>)
: The Amazon Resource Number (ARN) of the bridge.output(Option<BridgeOutput>)
: The output that you updated.
- On failure, responds with
SdkError<UpdateBridgeOutputError>
source§impl Client
impl Client
sourcepub fn update_bridge_source(&self) -> UpdateBridgeSourceFluentBuilder
pub fn update_bridge_source(&self) -> UpdateBridgeSourceFluentBuilder
Constructs a fluent builder for the UpdateBridgeSource
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to update.flow_source(UpdateBridgeFlowSourceRequest)
/set_flow_source(Option<UpdateBridgeFlowSourceRequest>)
:
required: false
Update the flow source of the bridge.network_source(UpdateBridgeNetworkSourceRequest)
/set_network_source(Option<UpdateBridgeNetworkSourceRequest>)
:
required: false
Update the network source of the bridge.source_name(impl Into<String>)
/set_source_name(Option<String>)
:
required: true
The name of the source that you want to update.
- On success, responds with
UpdateBridgeSourceOutput
with field(s):bridge_arn(Option<String>)
: The Amazon Resource Number (ARN) of the bridge.source(Option<BridgeSource>)
: The bridge’s source.
- On failure, responds with
SdkError<UpdateBridgeSourceError>
source§impl Client
impl Client
sourcepub fn update_bridge_state(&self) -> UpdateBridgeStateFluentBuilder
pub fn update_bridge_state(&self) -> UpdateBridgeStateFluentBuilder
Constructs a fluent builder for the UpdateBridgeState
operation.
- The fluent builder is configurable:
bridge_arn(impl Into<String>)
/set_bridge_arn(Option<String>)
:
required: true
The ARN of the bridge that you want to update.desired_state(DesiredState)
/set_desired_state(Option<DesiredState>)
:
required: true
(undocumented)
- On success, responds with
UpdateBridgeStateOutput
with field(s):bridge_arn(Option<String>)
: The Amazon Resource Number (ARN) of the bridge.desired_state(Option<DesiredState>)
: The state of the bridge. ACTIVE or STANDBY.
- On failure, responds with
SdkError<UpdateBridgeStateError>
source§impl Client
impl Client
sourcepub fn update_flow(&self) -> UpdateFlowFluentBuilder
pub fn update_flow(&self) -> UpdateFlowFluentBuilder
Constructs a fluent builder for the UpdateFlow
operation.
- The fluent builder is configurable:
flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that you want to update.source_failover_config(UpdateFailoverConfig)
/set_source_failover_config(Option<UpdateFailoverConfig>)
:
required: false
The settings for source failover.maintenance(UpdateMaintenance)
/set_maintenance(Option<UpdateMaintenance>)
:
required: false
Update maintenance setting for a flow
- On success, responds with
UpdateFlowOutput
with field(s):flow(Option<Flow>)
: The settings for a flow, including its source, outputs, and entitlements.
- On failure, responds with
SdkError<UpdateFlowError>
source§impl Client
impl Client
sourcepub fn update_flow_entitlement(&self) -> UpdateFlowEntitlementFluentBuilder
pub fn update_flow_entitlement(&self) -> UpdateFlowEntitlementFluentBuilder
Constructs a fluent builder for the UpdateFlowEntitlement
operation.
- The fluent builder is configurable:
description(impl Into<String>)
/set_description(Option<String>)
:
required: false
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(UpdateEncryption)
/set_encryption(Option<UpdateEncryption>)
:
required: false
The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.entitlement_arn(impl Into<String>)
/set_entitlement_arn(Option<String>)
:
required: true
The ARN of the entitlement that you want to update.entitlement_status(EntitlementStatus)
/set_entitlement_status(Option<EntitlementStatus>)
:
required: false
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.flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that is associated with the entitlement that you want to update.subscribers(impl Into<String>)
/set_subscribers(Option<Vec::<String>>)
:
required: false
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.
- On success, responds with
UpdateFlowEntitlementOutput
with field(s):entitlement(Option<Entitlement>)
: The new configuration of the entitlement that you updated.flow_arn(Option<String>)
: The ARN of the flow that this entitlement was granted on.
- On failure, responds with
SdkError<UpdateFlowEntitlementError>
source§impl Client
impl Client
sourcepub fn update_flow_media_stream(&self) -> UpdateFlowMediaStreamFluentBuilder
pub fn update_flow_media_stream(&self) -> UpdateFlowMediaStreamFluentBuilder
Constructs a fluent builder for the UpdateFlowMediaStream
operation.
- The fluent builder is configurable:
attributes(MediaStreamAttributesRequest)
/set_attributes(Option<MediaStreamAttributesRequest>)
:
required: false
The attributes that you want to assign to the media stream.clock_rate(i32)
/set_clock_rate(Option<i32>)
:
required: false
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(impl Into<String>)
/set_description(Option<String>)
:
required: false
Descriptionflow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the flow.media_stream_name(impl Into<String>)
/set_media_stream_name(Option<String>)
:
required: true
The name of the media stream that you want to update.media_stream_type(MediaStreamType)
/set_media_stream_type(Option<MediaStreamType>)
:
required: false
The type of media stream.video_format(impl Into<String>)
/set_video_format(Option<String>)
:
required: false
The resolution of the video.
- On success, responds with
UpdateFlowMediaStreamOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that is associated with the media stream that you updated.media_stream(Option<MediaStream>)
: The media stream that you updated.
- On failure, responds with
SdkError<UpdateFlowMediaStreamError>
source§impl Client
impl Client
sourcepub fn update_flow_output(&self) -> UpdateFlowOutputFluentBuilder
pub fn update_flow_output(&self) -> UpdateFlowOutputFluentBuilder
Constructs a fluent builder for the UpdateFlowOutput
operation.
- The fluent builder is configurable:
cidr_allow_list(impl Into<String>)
/set_cidr_allow_list(Option<Vec::<String>>)
:
required: false
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(impl Into<String>)
/set_description(Option<String>)
:
required: false
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(impl Into<String>)
/set_destination(Option<String>)
:
required: false
The IP address where you want to send the output.encryption(UpdateEncryption)
/set_encryption(Option<UpdateEncryption>)
:
required: false
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.flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that is associated with the output that you want to update.max_latency(i32)
/set_max_latency(Option<i32>)
:
required: false
The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.media_stream_output_configurations(MediaStreamOutputConfigurationRequest)
/set_media_stream_output_configurations(Option<Vec::<MediaStreamOutputConfigurationRequest>>)
:
required: false
The media streams that are associated with the output, and the parameters for those associations.min_latency(i32)
/set_min_latency(Option<i32>)
:
required: false
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.output_arn(impl Into<String>)
/set_output_arn(Option<String>)
:
required: true
The ARN of the output that you want to update.port(i32)
/set_port(Option<i32>)
:
required: false
The port to use when content is distributed to this output.protocol(Protocol)
/set_protocol(Option<Protocol>)
:
required: false
The protocol to use for the output.remote_id(impl Into<String>)
/set_remote_id(Option<String>)
:
required: false
The remote ID for the Zixi-pull stream.sender_control_port(i32)
/set_sender_control_port(Option<i32>)
:
required: false
The port that the flow uses to send outbound requests to initiate connection with the sender.sender_ip_address(impl Into<String>)
/set_sender_ip_address(Option<String>)
:
required: false
The IP address that the flow communicates with to initiate connection with the sender.smoothing_latency(i32)
/set_smoothing_latency(Option<i32>)
:
required: false
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.stream_id(impl Into<String>)
/set_stream_id(Option<String>)
:
required: false
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.vpc_interface_attachment(VpcInterfaceAttachment)
/set_vpc_interface_attachment(Option<VpcInterfaceAttachment>)
:
required: false
The name of the VPC interface attachment to use for this output.
- On success, responds with
UpdateFlowOutputOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that is associated with the updated output.output(Option<Output>)
: The new settings of the output that you updated.
- On failure, responds with
SdkError<UpdateFlowOutputError>
source§impl Client
impl Client
sourcepub fn update_flow_source(&self) -> UpdateFlowSourceFluentBuilder
pub fn update_flow_source(&self) -> UpdateFlowSourceFluentBuilder
Constructs a fluent builder for the UpdateFlowSource
operation.
- The fluent builder is configurable:
decryption(UpdateEncryption)
/set_decryption(Option<UpdateEncryption>)
:
required: false
The type of encryption used on the content ingested from this source. Allowable encryption types: static-key.description(impl Into<String>)
/set_description(Option<String>)
:
required: false
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.entitlement_arn(impl Into<String>)
/set_entitlement_arn(Option<String>)
:
required: false
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.flow_arn(impl Into<String>)
/set_flow_arn(Option<String>)
:
required: true
The flow that is associated with the source that you want to update.ingest_port(i32)
/set_ingest_port(Option<i32>)
:
required: false
The port that the flow will be listening on for incoming content.max_bitrate(i32)
/set_max_bitrate(Option<i32>)
:
required: false
The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.max_latency(i32)
/set_max_latency(Option<i32>)
:
required: false
The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.max_sync_buffer(i32)
/set_max_sync_buffer(Option<i32>)
:
required: false
The size of the buffer (in milliseconds) to use to sync incoming source data.media_stream_source_configurations(MediaStreamSourceConfigurationRequest)
/set_media_stream_source_configurations(Option<Vec::<MediaStreamSourceConfigurationRequest>>)
:
required: false
The media streams that are associated with the source, and the parameters for those associations.min_latency(i32)
/set_min_latency(Option<i32>)
:
required: false
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(Protocol)
/set_protocol(Option<Protocol>)
:
required: false
The protocol that is used by the source.sender_control_port(i32)
/set_sender_control_port(Option<i32>)
:
required: false
The port that the flow uses to send outbound requests to initiate connection with the sender.sender_ip_address(impl Into<String>)
/set_sender_ip_address(Option<String>)
:
required: false
The IP address that the flow communicates with to initiate connection with the sender.source_arn(impl Into<String>)
/set_source_arn(Option<String>)
:
required: true
The ARN of the source that you want to update.source_listener_address(impl Into<String>)
/set_source_listener_address(Option<String>)
:
required: false
Source IP or domain name for SRT-caller protocol.source_listener_port(i32)
/set_source_listener_port(Option<i32>)
:
required: false
Source port for SRT-caller protocol.stream_id(impl Into<String>)
/set_stream_id(Option<String>)
:
required: false
The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.vpc_interface_name(impl Into<String>)
/set_vpc_interface_name(Option<String>)
:
required: false
The name of the VPC interface to use for this source.whitelist_cidr(impl Into<String>)
/set_whitelist_cidr(Option<String>)
:
required: false
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.gateway_bridge_source(UpdateGatewayBridgeSourceRequest)
/set_gateway_bridge_source(Option<UpdateGatewayBridgeSourceRequest>)
:
required: false
The source configuration for cloud flows receiving a stream from a bridge.
- On success, responds with
UpdateFlowSourceOutput
with field(s):flow_arn(Option<String>)
: The ARN of the flow that you want to update.source(Option<Source>)
: The settings for the source of the flow.
- On failure, responds with
SdkError<UpdateFlowSourceError>
source§impl Client
impl Client
sourcepub fn update_gateway_instance(&self) -> UpdateGatewayInstanceFluentBuilder
pub fn update_gateway_instance(&self) -> UpdateGatewayInstanceFluentBuilder
Constructs a fluent builder for the UpdateGatewayInstance
operation.
- The fluent builder is configurable:
bridge_placement(BridgePlacement)
/set_bridge_placement(Option<BridgePlacement>)
:
required: false
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.gateway_instance_arn(impl Into<String>)
/set_gateway_instance_arn(Option<String>)
:
required: true
The Amazon Resource Name (ARN) of the instance that you want to update.
- On success, responds with
UpdateGatewayInstanceOutput
with field(s):bridge_placement(Option<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.gateway_instance_arn(Option<String>)
: The Amazon Resource Name (ARN) of the instance.
- On failure, responds with
SdkError<UpdateGatewayInstanceError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
source§impl Waiters for Client
impl Waiters for Client
source§fn wait_until_flow_active(&self) -> FlowActiveFluentBuilder
fn wait_until_flow_active(&self) -> FlowActiveFluentBuilder
source§fn wait_until_flow_deleted(&self) -> FlowDeletedFluentBuilder
fn wait_until_flow_deleted(&self) -> FlowDeletedFluentBuilder
source§fn wait_until_flow_standby(&self) -> FlowStandbyFluentBuilder
fn wait_until_flow_standby(&self) -> FlowStandbyFluentBuilder
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more