Class: Aws::MediaConnect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MediaConnect::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb
Overview
An API client for MediaConnect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MediaConnect::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_bridge_outputs(params = {}) ⇒ Types::AddBridgeOutputsResponse
Adds outputs to an existing bridge.
-
#add_bridge_sources(params = {}) ⇒ Types::AddBridgeSourcesResponse
Adds sources to an existing bridge.
-
#add_flow_media_streams(params = {}) ⇒ Types::AddFlowMediaStreamsResponse
Adds media streams to an existing flow.
-
#add_flow_outputs(params = {}) ⇒ Types::AddFlowOutputsResponse
Adds outputs to an existing flow.
-
#add_flow_sources(params = {}) ⇒ Types::AddFlowSourcesResponse
Adds Sources to flow.
-
#add_flow_vpc_interfaces(params = {}) ⇒ Types::AddFlowVpcInterfacesResponse
Adds VPC interfaces to flow.
-
#create_bridge(params = {}) ⇒ Types::CreateBridgeResponse
Creates a new bridge.
-
#create_flow(params = {}) ⇒ Types::CreateFlowResponse
Creates a new flow.
-
#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse
Creates a new gateway.
-
#delete_bridge(params = {}) ⇒ Types::DeleteBridgeResponse
Deletes a bridge.
-
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Deletes a flow.
-
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayResponse
Deletes a gateway.
-
#deregister_gateway_instance(params = {}) ⇒ Types::DeregisterGatewayInstanceResponse
Deregisters an instance.
-
#describe_bridge(params = {}) ⇒ Types::DescribeBridgeResponse
Displays the details of a bridge.
-
#describe_flow(params = {}) ⇒ Types::DescribeFlowResponse
Displays the details of a flow.
-
#describe_flow_source_metadata(params = {}) ⇒ Types::DescribeFlowSourceMetadataResponse
Displays details of the flow's source stream.
-
#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse
Displays the details of a gateway.
-
#describe_gateway_instance(params = {}) ⇒ Types::DescribeGatewayInstanceResponse
Displays the details of an instance.
-
#describe_offering(params = {}) ⇒ Types::DescribeOfferingResponse
Displays the details of an offering.
-
#describe_reservation(params = {}) ⇒ Types::DescribeReservationResponse
Displays the details of a reservation.
-
#grant_flow_entitlements(params = {}) ⇒ Types::GrantFlowEntitlementsResponse
Grants entitlements to an existing flow.
-
#list_bridges(params = {}) ⇒ Types::ListBridgesResponse
Displays a list of bridges that are associated with this account and an optionally specified Arn.
-
#list_entitlements(params = {}) ⇒ Types::ListEntitlementsResponse
Displays a list of all entitlements that have been granted to this account.
-
#list_flows(params = {}) ⇒ Types::ListFlowsResponse
Displays a list of flows that are associated with this account.
-
#list_gateway_instances(params = {}) ⇒ Types::ListGatewayInstancesResponse
Displays a list of instances associated with the AWS account.
-
#list_gateways(params = {}) ⇒ Types::ListGatewaysResponse
Displays a list of gateways that are associated with this account.
-
#list_offerings(params = {}) ⇒ Types::ListOfferingsResponse
Displays a list of all offerings that are available to this account in the current AWS Region.
-
#list_reservations(params = {}) ⇒ Types::ListReservationsResponse
Displays a list of all reservations that have been purchased by this account in the current AWS Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags on an AWS Elemental MediaConnect resource.
-
#purchase_offering(params = {}) ⇒ Types::PurchaseOfferingResponse
Submits a request to purchase an offering.
-
#remove_bridge_output(params = {}) ⇒ Types::RemoveBridgeOutputResponse
Removes an output from a bridge.
-
#remove_bridge_source(params = {}) ⇒ Types::RemoveBridgeSourceResponse
Removes a source from a bridge.
-
#remove_flow_media_stream(params = {}) ⇒ Types::RemoveFlowMediaStreamResponse
Removes a media stream from a flow.
-
#remove_flow_output(params = {}) ⇒ Types::RemoveFlowOutputResponse
Removes an output from an existing flow.
-
#remove_flow_source(params = {}) ⇒ Types::RemoveFlowSourceResponse
Removes a source from an existing flow.
-
#remove_flow_vpc_interface(params = {}) ⇒ Types::RemoveFlowVpcInterfaceResponse
Removes a VPC Interface from an existing flow.
-
#revoke_flow_entitlement(params = {}) ⇒ Types::RevokeFlowEntitlementResponse
Revokes an entitlement from a flow.
-
#start_flow(params = {}) ⇒ Types::StartFlowResponse
Starts a flow.
-
#stop_flow(params = {}) ⇒ Types::StopFlowResponse
Stops a flow.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified resourceArn.
-
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_bridge(params = {}) ⇒ Types::UpdateBridgeResponse
Updates the bridge.
-
#update_bridge_output(params = {}) ⇒ Types::UpdateBridgeOutputResponse
Updates an existing bridge output.
-
#update_bridge_source(params = {}) ⇒ Types::UpdateBridgeSourceResponse
Updates an existing bridge source.
-
#update_bridge_state(params = {}) ⇒ Types::UpdateBridgeStateResponse
Updates the bridge state.
-
#update_flow(params = {}) ⇒ Types::UpdateFlowResponse
Updates flow.
-
#update_flow_entitlement(params = {}) ⇒ Types::UpdateFlowEntitlementResponse
You can change an entitlement's description, subscribers, and encryption.
-
#update_flow_media_stream(params = {}) ⇒ Types::UpdateFlowMediaStreamResponse
Updates an existing media stream.
-
#update_flow_output(params = {}) ⇒ Types::UpdateFlowOutputResponse
Updates an existing flow output.
-
#update_flow_source(params = {}) ⇒ Types::UpdateFlowSourceResponse
Updates the source of a flow.
-
#update_gateway_instance(params = {}) ⇒ Types::UpdateGatewayInstanceResponse
Updates the configuration of an existing Gateway Instance.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#add_bridge_outputs(params = {}) ⇒ Types::AddBridgeOutputsResponse
Adds outputs to an existing bridge.
463 464 465 466 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 463 def add_bridge_outputs(params = {}, = {}) req = build_request(:add_bridge_outputs, params) req.send_request() end |
#add_bridge_sources(params = {}) ⇒ Types::AddBridgeSourcesResponse
Adds sources to an existing bridge.
522 523 524 525 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 522 def add_bridge_sources(params = {}, = {}) req = build_request(:add_bridge_sources, params) req.send_request() end |
#add_flow_media_streams(params = {}) ⇒ Types::AddFlowMediaStreamsResponse
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.
593 594 595 596 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 593 def add_flow_media_streams(params = {}, = {}) req = build_request(:add_flow_media_streams, params) req.send_request() end |
#add_flow_outputs(params = {}) ⇒ Types::AddFlowOutputsResponse
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
721 722 723 724 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 721 def add_flow_outputs(params = {}, = {}) req = build_request(:add_flow_outputs, params) req.send_request() end |
#add_flow_sources(params = {}) ⇒ Types::AddFlowSourcesResponse
Adds Sources to flow
847 848 849 850 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 847 def add_flow_sources(params = {}, = {}) req = build_request(:add_flow_sources, params) req.send_request() end |
#add_flow_vpc_interfaces(params = {}) ⇒ Types::AddFlowVpcInterfacesResponse
Adds VPC interfaces to flow
896 897 898 899 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 896 def add_flow_vpc_interfaces(params = {}, = {}) req = build_request(:add_flow_vpc_interfaces, params) req.send_request() end |
#create_bridge(params = {}) ⇒ Types::CreateBridgeResponse
Creates a new bridge. The request must include one source.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1029 def create_bridge(params = {}, = {}) req = build_request(:create_bridge, params) req.send_request() end |
#create_flow(params = {}) ⇒ Types::CreateFlowResponse
Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
1489 1490 1491 1492 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1489 def create_flow(params = {}, = {}) req = build_request(:create_flow, params) req.send_request() end |
#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse
Creates a new gateway. The request must include at least one network (up to 4).
1546 1547 1548 1549 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1546 def create_gateway(params = {}, = {}) req = build_request(:create_gateway, params) req.send_request() end |
#delete_bridge(params = {}) ⇒ Types::DeleteBridgeResponse
Deletes a bridge. Before you can delete a bridge, you must stop the bridge.
1574 1575 1576 1577 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1574 def delete_bridge(params = {}, = {}) req = build_request(:delete_bridge, params) req.send_request() end |
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Deletes a flow. Before you can delete a flow, you must stop the flow.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1603 def delete_flow(params = {}, = {}) req = build_request(:delete_flow, params) req.send_request() end |
#delete_gateway(params = {}) ⇒ Types::DeleteGatewayResponse
Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1631 def delete_gateway(params = {}, = {}) req = build_request(:delete_gateway, params) req.send_request() end |
#deregister_gateway_instance(params = {}) ⇒ Types::DeregisterGatewayInstanceResponse
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.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1666 def deregister_gateway_instance(params = {}, = {}) req = build_request(:deregister_gateway_instance, params) req.send_request() end |
#describe_bridge(params = {}) ⇒ Types::DescribeBridgeResponse
Displays the details of a bridge.
1729 1730 1731 1732 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1729 def describe_bridge(params = {}, = {}) req = build_request(:describe_bridge, params) req.send_request() end |
#describe_flow(params = {}) ⇒ Types::DescribeFlowResponse
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.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- flow_active
- flow_deleted
- flow_standby
1957 1958 1959 1960 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1957 def describe_flow(params = {}, = {}) req = build_request(:describe_flow, params) req.send_request() end |
#describe_flow_source_metadata(params = {}) ⇒ Types::DescribeFlowSourceMetadataResponse
Displays details of the flow's source stream. The response contains information about the contents of the stream and its programs.
2008 2009 2010 2011 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2008 def (params = {}, = {}) req = build_request(:describe_flow_source_metadata, params) req.send_request() end |
#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse
Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.
2047 2048 2049 2050 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2047 def describe_gateway(params = {}, = {}) req = build_request(:describe_gateway, params) req.send_request() end |
#describe_gateway_instance(params = {}) ⇒ Types::DescribeGatewayInstanceResponse
Displays the details of an instance.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2084 def describe_gateway_instance(params = {}, = {}) req = build_request(:describe_gateway_instance, params) req.send_request() end |
#describe_offering(params = {}) ⇒ Types::DescribeOfferingResponse
Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
2121 2122 2123 2124 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2121 def describe_offering(params = {}, = {}) req = build_request(:describe_offering, params) req.send_request() end |
#describe_reservation(params = {}) ⇒ Types::DescribeReservationResponse
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).
2164 2165 2166 2167 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2164 def describe_reservation(params = {}, = {}) req = build_request(:describe_reservation, params) req.send_request() end |
#grant_flow_entitlements(params = {}) ⇒ Types::GrantFlowEntitlementsResponse
Grants entitlements to an existing flow.
2232 2233 2234 2235 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2232 def grant_flow_entitlements(params = {}, = {}) req = build_request(:grant_flow_entitlements, params) req.send_request() end |
#list_bridges(params = {}) ⇒ Types::ListBridgesResponse
Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2275 2276 2277 2278 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2275 def list_bridges(params = {}, = {}) req = build_request(:list_bridges, params) req.send_request() end |
#list_entitlements(params = {}) ⇒ Types::ListEntitlementsResponse
Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2313 2314 2315 2316 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2313 def list_entitlements(params = {}, = {}) req = build_request(:list_entitlements, params) req.send_request() end |
#list_flows(params = {}) ⇒ Types::ListFlowsResponse
Displays a list of flows that are associated with this account. This request returns a paginated result.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2358 2359 2360 2361 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2358 def list_flows(params = {}, = {}) req = build_request(:list_flows, params) req.send_request() end |
#list_gateway_instances(params = {}) ⇒ Types::ListGatewayInstancesResponse
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).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2402 2403 2404 2405 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2402 def list_gateway_instances(params = {}, = {}) req = build_request(:list_gateway_instances, params) req.send_request() end |
#list_gateways(params = {}) ⇒ Types::ListGatewaysResponse
Displays a list of gateways that are associated with this account. This request returns a paginated result.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2440 2441 2442 2443 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2440 def list_gateways(params = {}, = {}) req = build_request(:list_gateways, params) req.send_request() end |
#list_offerings(params = {}) ⇒ Types::ListOfferingsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2486 2487 2488 2489 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2486 def list_offerings(params = {}, = {}) req = build_request(:list_offerings, params) req.send_request() end |
#list_reservations(params = {}) ⇒ Types::ListReservationsResponse
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).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2536 2537 2538 2539 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2536 def list_reservations(params = {}, = {}) req = build_request(:list_reservations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags on an AWS Elemental MediaConnect resource
2564 2565 2566 2567 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2564 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#purchase_offering(params = {}) ⇒ Types::PurchaseOfferingResponse
Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.
2619 2620 2621 2622 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2619 def purchase_offering(params = {}, = {}) req = build_request(:purchase_offering, params) req.send_request() end |
#remove_bridge_output(params = {}) ⇒ Types::RemoveBridgeOutputResponse
Removes an output from a bridge.
2651 2652 2653 2654 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2651 def remove_bridge_output(params = {}, = {}) req = build_request(:remove_bridge_output, params) req.send_request() end |
#remove_bridge_source(params = {}) ⇒ Types::RemoveBridgeSourceResponse
Removes a source from a bridge.
2683 2684 2685 2686 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2683 def remove_bridge_source(params = {}, = {}) req = build_request(:remove_bridge_source, params) req.send_request() end |
#remove_flow_media_stream(params = {}) ⇒ Types::RemoveFlowMediaStreamResponse
Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.
2716 2717 2718 2719 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2716 def remove_flow_media_stream(params = {}, = {}) req = build_request(:remove_flow_media_stream, params) req.send_request() end |
#remove_flow_output(params = {}) ⇒ Types::RemoveFlowOutputResponse
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.
2752 2753 2754 2755 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2752 def remove_flow_output(params = {}, = {}) req = build_request(:remove_flow_output, params) req.send_request() end |
#remove_flow_source(params = {}) ⇒ Types::RemoveFlowSourceResponse
Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.
2785 2786 2787 2788 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2785 def remove_flow_source(params = {}, = {}) req = build_request(:remove_flow_source, params) req.send_request() end |
#remove_flow_vpc_interface(params = {}) ⇒ Types::RemoveFlowVpcInterfaceResponse
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.
2824 2825 2826 2827 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2824 def remove_flow_vpc_interface(params = {}, = {}) req = build_request(:remove_flow_vpc_interface, params) req.send_request() end |
#revoke_flow_entitlement(params = {}) ⇒ Types::RevokeFlowEntitlementResponse
Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
2858 2859 2860 2861 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2858 def revoke_flow_entitlement(params = {}, = {}) req = build_request(:revoke_flow_entitlement, params) req.send_request() end |
#start_flow(params = {}) ⇒ Types::StartFlowResponse
Starts a flow.
2887 2888 2889 2890 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2887 def start_flow(params = {}, = {}) req = build_request(:start_flow, params) req.send_request() end |
#stop_flow(params = {}) ⇒ Types::StopFlowResponse
Stops a flow.
2916 2917 2918 2919 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2916 def stop_flow(params = {}, = {}) req = build_request(:stop_flow, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
2948 2949 2950 2951 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2948 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
2972 2973 2974 2975 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2972 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_bridge(params = {}) ⇒ Types::UpdateBridgeResponse
Updates the bridge
3057 3058 3059 3060 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3057 def update_bridge(params = {}, = {}) req = build_request(:update_bridge, params) req.send_request() end |
#update_bridge_output(params = {}) ⇒ Types::UpdateBridgeOutputResponse
Updates an existing bridge output.
3107 3108 3109 3110 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3107 def update_bridge_output(params = {}, = {}) req = build_request(:update_bridge_output, params) req.send_request() end |
#update_bridge_source(params = {}) ⇒ Types::UpdateBridgeSourceResponse
Updates an existing bridge source.
3165 3166 3167 3168 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3165 def update_bridge_source(params = {}, = {}) req = build_request(:update_bridge_source, params) req.send_request() end |
#update_bridge_state(params = {}) ⇒ Types::UpdateBridgeStateResponse
Updates the bridge state
3197 3198 3199 3200 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3197 def update_bridge_state(params = {}, = {}) req = build_request(:update_bridge_state, params) req.send_request() end |
#update_flow(params = {}) ⇒ Types::UpdateFlowResponse
Updates flow
3432 3433 3434 3435 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3432 def update_flow(params = {}, = {}) req = build_request(:update_flow, params) req.send_request() end |
#update_flow_entitlement(params = {}) ⇒ Types::UpdateFlowEntitlementResponse
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.
3515 3516 3517 3518 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3515 def update_flow_entitlement(params = {}, = {}) req = build_request(:update_flow_entitlement, params) req.send_request() end |
#update_flow_media_stream(params = {}) ⇒ Types::UpdateFlowMediaStreamResponse
Updates an existing media stream.
3594 3595 3596 3597 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3594 def update_flow_media_stream(params = {}, = {}) req = build_request(:update_flow_media_stream, params) req.send_request() end |
#update_flow_output(params = {}) ⇒ Types::UpdateFlowOutputResponse
Updates an existing flow output.
3777 3778 3779 3780 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3777 def update_flow_output(params = {}, = {}) req = build_request(:update_flow_output, params) req.send_request() end |
#update_flow_source(params = {}) ⇒ Types::UpdateFlowSourceResponse
Updates the source of a flow.
3969 3970 3971 3972 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 3969 def update_flow_source(params = {}, = {}) req = build_request(:update_flow_source, params) req.send_request() end |
#update_gateway_instance(params = {}) ⇒ Types::UpdateGatewayInstanceResponse
Updates the configuration of an existing Gateway Instance.
4005 4006 4007 4008 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4005 def update_gateway_instance(params = {}, = {}) req = build_request(:update_gateway_instance, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
flow_active | #describe_flow | 3 | 40 |
flow_deleted | #describe_flow | 3 | 40 |
flow_standby | #describe_flow | 3 | 40 |
4117 4118 4119 4120 4121 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 4117 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |