aws-elixir

View Source AWS.PrivateNetworks (aws-elixir v1.0.4)

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location.

Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.

Link to this section Summary

Functions

acknowledge_order_receipt(client, input, options \\ [])

Acknowledges that the specified network order was received.

activate_device_identifier(client, input, options \\ [])

Activates the specified device identifier.

activate_network_site(client, input, options \\ [])

Activates the specified network site.

configure_access_point(client, input, options \\ [])

Configures the specified network resource.

create_network(client, input, options \\ [])

Creates a network.

create_network_site(client, input, options \\ [])

Creates a network site.

deactivate_device_identifier(client, input, options \\ [])

Deactivates the specified device identifier.

delete_network(client, network_arn, input, options \\ [])

Deletes the specified network.

delete_network_site(client, network_site_arn, input, options \\ [])

Deletes the specified network site.

get_device_identifier(client, device_identifier_arn, options \\ [])

Gets the specified device identifier.

get_network(client, network_arn, options \\ [])

Gets the specified network.

get_network_resource(client, network_resource_arn, options \\ [])

Gets the specified network resource.

get_network_site(client, network_site_arn, options \\ [])

Gets the specified network site.

get_order(client, order_arn, options \\ [])

Gets the specified order.

list_device_identifiers(client, input, options \\ [])

Lists device identifiers.

list_network_resources(client, input, options \\ [])

Lists network resources.

list_network_sites(client, input, options \\ [])

Lists network sites.

list_networks(client, input, options \\ [])

Lists networks.

list_orders(client, input, options \\ [])

Lists orders.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags for the specified resource.

metadata()
ping(client, options \\ [])

Checks the health of the service.

start_network_resource_update(client, input, options \\ [])

Use this action to do the following tasks

tag_resource(client, resource_arn, input, options \\ [])

Adds tags to the specified resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes tags from the specified resource.

update_network_site(client, input, options \\ [])

Updates the specified network site.

update_network_site_plan(client, input, options \\ [])

Updates the specified network site plan.

Link to this section Functions

Link to this function

acknowledge_order_receipt(client, input, options \\ [])

View Source

Acknowledges that the specified network order was received.

Link to this function

activate_device_identifier(client, input, options \\ [])

View Source

Activates the specified device identifier.

Link to this function

activate_network_site(client, input, options \\ [])

View Source

Activates the specified network site.

Link to this function

configure_access_point(client, input, options \\ [])

View Source

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.

Link to this function

create_network(client, input, options \\ [])

View Source

Creates a network.

Link to this function

create_network_site(client, input, options \\ [])

View Source

Creates a network site.

Link to this function

deactivate_device_identifier(client, input, options \\ [])

View Source

Deactivates the specified device identifier.

Link to this function

delete_network(client, network_arn, input, options \\ [])

View Source

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.

Link to this function

delete_network_site(client, network_site_arn, input, options \\ [])

View Source

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.

Link to this function

get_device_identifier(client, device_identifier_arn, options \\ [])

View Source

Gets the specified device identifier.

Link to this function

get_network(client, network_arn, options \\ [])

View Source

Gets the specified network.

Link to this function

get_network_resource(client, network_resource_arn, options \\ [])

View Source

Gets the specified network resource.

Link to this function

get_network_site(client, network_site_arn, options \\ [])

View Source

Gets the specified network site.

Link to this function

get_order(client, order_arn, options \\ [])

View Source

Gets the specified order.

Link to this function

list_device_identifiers(client, input, options \\ [])

View Source

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.

Link to this function

list_network_resources(client, input, options \\ [])

View Source

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.

Link to this function

list_network_sites(client, input, options \\ [])

View Source

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.

Link to this function

list_networks(client, input, options \\ [])

View Source

Lists networks.

Add filters to your request to return a more specific list of results. Use filters to match the status of the network.

Link to this function

list_orders(client, input, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags for the specified resource.

Link to this function

metadata()

View Source
Link to this function

ping(client, options \\ [])

View Source

Checks the health of the service.

Link to this function

start_network_resource_update(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds tags to the specified resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from the specified resource.

Link to this function

update_network_site(client, input, options \\ [])

View Source

Updates the specified network site.

Link to this function

update_network_site_plan(client, input, options \\ [])

View Source

Updates the specified network site plan.