Class: Aws::PrivateNetworks::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PrivateNetworks::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb
Overview
An API client for PrivateNetworks. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PrivateNetworks::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
-
#acknowledge_order_receipt(params = {}) ⇒ Types::AcknowledgeOrderReceiptResponse
Acknowledges that the specified network order was received.
-
#activate_device_identifier(params = {}) ⇒ Types::ActivateDeviceIdentifierResponse
Activates the specified device identifier.
-
#activate_network_site(params = {}) ⇒ Types::ActivateNetworkSiteResponse
Activates the specified network site.
-
#configure_access_point(params = {}) ⇒ Types::ConfigureAccessPointResponse
Configures the specified network resource.
-
#create_network(params = {}) ⇒ Types::CreateNetworkResponse
Creates a network.
-
#create_network_site(params = {}) ⇒ Types::CreateNetworkSiteResponse
Creates a network site.
-
#deactivate_device_identifier(params = {}) ⇒ Types::DeactivateDeviceIdentifierResponse
Deactivates the specified device identifier.
-
#delete_network(params = {}) ⇒ Types::DeleteNetworkResponse
Deletes the specified network.
-
#delete_network_site(params = {}) ⇒ Types::DeleteNetworkSiteResponse
Deletes the specified network site.
-
#get_device_identifier(params = {}) ⇒ Types::GetDeviceIdentifierResponse
Gets the specified device identifier.
-
#get_network(params = {}) ⇒ Types::GetNetworkResponse
Gets the specified network.
-
#get_network_resource(params = {}) ⇒ Types::GetNetworkResourceResponse
Gets the specified network resource.
-
#get_network_site(params = {}) ⇒ Types::GetNetworkSiteResponse
Gets the specified network site.
-
#get_order(params = {}) ⇒ Types::GetOrderResponse
Gets the specified order.
-
#list_device_identifiers(params = {}) ⇒ Types::ListDeviceIdentifiersResponse
Lists device identifiers.
-
#list_network_resources(params = {}) ⇒ Types::ListNetworkResourcesResponse
Lists network resources.
-
#list_network_sites(params = {}) ⇒ Types::ListNetworkSitesResponse
Lists network sites.
-
#list_networks(params = {}) ⇒ Types::ListNetworksResponse
Lists networks.
-
#list_orders(params = {}) ⇒ Types::ListOrdersResponse
Lists orders.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#ping(params = {}) ⇒ Types::PingResponse
Checks the health of the service.
-
#start_network_resource_update(params = {}) ⇒ Types::StartNetworkResourceUpdateResponse
Use this action to do the following tasks:.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
-
#update_network_site(params = {}) ⇒ Types::UpdateNetworkSiteResponse
Updates the specified network site.
-
#update_network_site_plan(params = {}) ⇒ Types::UpdateNetworkSiteResponse
Updates the specified network site plan.
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.
440 441 442 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#acknowledge_order_receipt(params = {}) ⇒ Types::AcknowledgeOrderReceiptResponse
Acknowledges that the specified network order was received.
491 492 493 494 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 491 def acknowledge_order_receipt(params = {}, = {}) req = build_request(:acknowledge_order_receipt, params) req.send_request() end |
#activate_device_identifier(params = {}) ⇒ Types::ActivateDeviceIdentifierResponse
Activates the specified device identifier.
540 541 542 543 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 540 def activate_device_identifier(params = {}, = {}) req = build_request(:activate_device_identifier, params) req.send_request() end |
#activate_network_site(params = {}) ⇒ Types::ActivateNetworkSiteResponse
Activates the specified network site.
647 648 649 650 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 647 def activate_network_site(params = {}, = {}) req = build_request(:activate_network_site, params) req.send_request() end |
#configure_access_point(params = {}) ⇒ Types::ConfigureAccessPointResponse
Configures the specified network resource.
Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide.
753 754 755 756 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 753 def configure_access_point(params = {}, = {}) req = build_request(:configure_access_point, params) req.send_request() end |
#create_network(params = {}) ⇒ Types::CreateNetworkResponse
Creates a network.
810 811 812 813 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 810 def create_network(params = {}, = {}) req = build_request(:create_network, params) req.send_request() end |
#create_network_site(params = {}) ⇒ Types::CreateNetworkSiteResponse
Creates a network site.
925 926 927 928 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 925 def create_network_site(params = {}, = {}) req = build_request(:create_network_site, params) req.send_request() end |
#deactivate_device_identifier(params = {}) ⇒ Types::DeactivateDeviceIdentifierResponse
Deactivates the specified device identifier.
971 972 973 974 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 971 def deactivate_device_identifier(params = {}, = {}) req = build_request(:deactivate_device_identifier, params) req.send_request() end |
#delete_network(params = {}) ⇒ Types::DeleteNetworkResponse
Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1021 def delete_network(params = {}, = {}) req = build_request(:delete_network, params) req.send_request() end |
#delete_network_site(params = {}) ⇒ Types::DeleteNetworkSiteResponse
Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide.
1092 1093 1094 1095 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1092 def delete_network_site(params = {}, = {}) req = build_request(:delete_network_site, params) req.send_request() end |
#get_device_identifier(params = {}) ⇒ Types::GetDeviceIdentifierResponse
Gets the specified device identifier.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1131 def get_device_identifier(params = {}, = {}) req = build_request(:get_device_identifier, params) req.send_request() end |
#get_network(params = {}) ⇒ Types::GetNetworkResponse
Gets the specified network.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1167 def get_network(params = {}, = {}) req = build_request(:get_network, params) req.send_request() end |
#get_network_resource(params = {}) ⇒ Types::GetNetworkResourceResponse
Gets the specified network resource.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1236 def get_network_resource(params = {}, = {}) req = build_request(:get_network_resource, params) req.send_request() end |
#get_network_site(params = {}) ⇒ Types::GetNetworkSiteResponse
Gets the specified network site.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1293 def get_network_site(params = {}, = {}) req = build_request(:get_network_site, params) req.send_request() end |
#get_order(params = {}) ⇒ Types::GetOrderResponse
Gets the specified order.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1346 def get_order(params = {}, = {}) req = build_request(:get_order, params) req.send_request() end |
#list_device_identifiers(params = {}) ⇒ Types::ListDeviceIdentifiersResponse
Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1418 1419 1420 1421 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1418 def list_device_identifiers(params = {}, = {}) req = build_request(:list_device_identifiers, params) req.send_request() end |
#list_network_resources(params = {}) ⇒ Types::ListNetworkResourcesResponse
Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1517 1518 1519 1520 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1517 def list_network_resources(params = {}, = {}) req = build_request(:list_network_resources, params) req.send_request() end |
#list_network_sites(params = {}) ⇒ Types::ListNetworkSitesResponse
Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1602 1603 1604 1605 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1602 def list_network_sites(params = {}, = {}) req = build_request(:list_network_sites, params) req.send_request() end |
#list_networks(params = {}) ⇒ Types::ListNetworksResponse
Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1660 1661 1662 1663 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1660 def list_networks(params = {}, = {}) req = build_request(:list_networks, params) req.send_request() end |
#list_orders(params = {}) ⇒ Types::ListOrdersResponse
Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.
If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1743 1744 1745 1746 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1743 def list_orders(params = {}, = {}) req = build_request(:list_orders, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
1772 1773 1774 1775 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1772 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#ping(params = {}) ⇒ Types::PingResponse
Checks the health of the service.
1791 1792 1793 1794 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1791 def ping(params = {}, = {}) req = build_request(:ping, params) req.send_request() end |
#start_network_resource_update(params = {}) ⇒ Types::StartNetworkResourceUpdateResponse
Use this action to do the following tasks:
Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.
Request a replacement for a network resource.
Request that you return a network resource.
After you submit a request to replace or return a network resource,
the status of the network resource changes to
CREATING_SHIPPING_LABEL
. The shipping label is available when the
status of the network resource is PENDING_RETURN
. After the network
resource is successfully returned, its status changes to DELETED
.
For more information, see Return a radio unit.
1952 1953 1954 1955 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1952 def start_network_resource_update(params = {}, = {}) req = build_request(:start_network_resource_update, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified resource.
1980 1981 1982 1983 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1980 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
2006 2007 2008 2009 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 2006 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_network_site(params = {}) ⇒ Types::UpdateNetworkSiteResponse
Updates the specified network site.
2077 2078 2079 2080 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 2077 def update_network_site(params = {}, = {}) req = build_request(:update_network_site, params) req.send_request() end |
#update_network_site_plan(params = {}) ⇒ Types::UpdateNetworkSiteResponse
Updates the specified network site plan.
2167 2168 2169 2170 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 2167 def update_network_site_plan(params = {}, = {}) req = build_request(:update_network_site_plan, params) req.send_request() end |