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_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_flow(params = {}) ⇒ Types::CreateFlowResponse
Creates a new flow.
-
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Deletes a flow.
-
#describe_flow(params = {}) ⇒ Types::DescribeFlowResponse
Displays the details of a flow.
-
#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_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_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_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_flow(params = {}) ⇒ Types::UpdateFlowResponse
Updates flow.
-
#update_flow_entitlement(params = {}) ⇒ Types::UpdateFlowEntitlementResponse
You can change an entitlement's description, subscribers, and encryption.
-
#update_flow_output(params = {}) ⇒ Types::UpdateFlowOutputResponse
Updates an existing flow output.
-
#update_flow_source(params = {}) ⇒ Types::UpdateFlowSourceResponse
Updates the source of a flow.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
324 325 326 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#add_flow_outputs(params = {}) ⇒ Types::AddFlowOutputsResponse
Adds outputs to an existing flow. You can create up to 50 outputs per flow.
414 415 416 417 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 414 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
499 500 501 502 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 499 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
546 547 548 549 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 546 def add_flow_vpc_interfaces(params = {}, = {}) req = build_request(:add_flow_vpc_interfaces, 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).
824 825 826 827 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 824 def create_flow(params = {}, = {}) req = build_request(:create_flow, params) req.send_request() end |
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Deletes a flow. Before you can delete a flow, you must stop the flow.
853 854 855 856 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 853 def delete_flow(params = {}, = {}) req = build_request(:delete_flow, 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.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1000 def describe_flow(params = {}, = {}) req = build_request(:describe_flow, 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).
1037 1038 1039 1040 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1037 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).
1080 1081 1082 1083 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1080 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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1148 def grant_flow_entitlements(params = {}, = {}) req = build_request(:grant_flow_entitlements, 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.
1186 1187 1188 1189 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1186 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.
1227 1228 1229 1230 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1227 def list_flows(params = {}, = {}) req = build_request(:list_flows, 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.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1273 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.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1323 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
1351 1352 1353 1354 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1351 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.
1406 1407 1408 1409 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1406 def purchase_offering(params = {}, = {}) req = build_request(:purchase_offering, 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.
1442 1443 1444 1445 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1442 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1475 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.
1514 1515 1516 1517 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1514 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.
1548 1549 1550 1551 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1548 def revoke_flow_entitlement(params = {}, = {}) req = build_request(:revoke_flow_entitlement, params) req.send_request() end |
#start_flow(params = {}) ⇒ Types::StartFlowResponse
Starts a flow.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1577 def start_flow(params = {}, = {}) req = build_request(:start_flow, params) req.send_request() end |
#stop_flow(params = {}) ⇒ Types::StopFlowResponse
Stops a flow.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1606 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.
1638 1639 1640 1641 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1638 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
1662 1663 1664 1665 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1662 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_flow(params = {}) ⇒ Types::UpdateFlowResponse
Updates flow
1811 1812 1813 1814 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1811 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.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 1894 def update_flow_entitlement(params = {}, = {}) req = build_request(:update_flow_entitlement, params) req.send_request() end |
#update_flow_output(params = {}) ⇒ Types::UpdateFlowOutputResponse
Updates an existing flow output.
2023 2024 2025 2026 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2023 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.
2147 2148 2149 2150 |
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/client.rb', line 2147 def update_flow_source(params = {}, = {}) req = build_request(:update_flow_source, params) req.send_request() end |