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.
446 447 448 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#acknowledge_order_receipt(params = {}) ⇒ Types::AcknowledgeOrderReceiptResponse
Acknowledges that the specified network order was received.
497 498 499 500 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 497 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.
546 547 548 549 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 546 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.
653 654 655 656 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 653 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.
759 760 761 762 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 759 def configure_access_point(params = {}, = {}) req = build_request(:configure_access_point, params) req.send_request() end |
#create_network(params = {}) ⇒ Types::CreateNetworkResponse
Creates a network.
816 817 818 819 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 816 def create_network(params = {}, = {}) req = build_request(:create_network, params) req.send_request() end |
#create_network_site(params = {}) ⇒ Types::CreateNetworkSiteResponse
Creates a network site.
931 932 933 934 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 931 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.
977 978 979 980 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 977 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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1027 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.
1098 1099 1100 1101 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1098 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.
1137 1138 1139 1140 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1137 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.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1173 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.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1242 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.
1299 1300 1301 1302 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1299 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.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1352 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.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1424 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1523 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.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1608 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.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1666 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.
1749 1750 1751 1752 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1749 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.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1778 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#ping(params = {}) ⇒ Types::PingResponse
Checks the health of the service.
1797 1798 1799 1800 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1797 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.
1958 1959 1960 1961 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1958 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.
1986 1987 1988 1989 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1986 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from the specified resource.
2012 2013 2014 2015 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 2012 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.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 2083 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.
2173 2174 2175 2176 |
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 2173 def update_network_site_plan(params = {}, = {}) req = build_request(:update_network_site_plan, params) req.send_request() end |