PrivateNetworks

import { PrivateNetworks } from "https://aws-api.deno.dev/v0.4/services/privatenetworks.ts?docs=full";

class PrivateNetworks {

constructor(apiFactory: client.ApiFactory);

async acknowledgeOrderReceipt(params: AcknowledgeOrderReceiptRequest, opts?: client.RequestOptions): Promise<AcknowledgeOrderReceiptResponse>;

async activateDeviceIdentifier(params: ActivateDeviceIdentifierRequest, opts?: client.RequestOptions): Promise<ActivateDeviceIdentifierResponse>;

async activateNetworkSite(params: ActivateNetworkSiteRequest, opts?: client.RequestOptions): Promise<ActivateNetworkSiteResponse>;

async configureAccessPoint(params: ConfigureAccessPointRequest, opts?: client.RequestOptions): Promise<ConfigureAccessPointResponse>;

async createNetwork(params: CreateNetworkRequest, opts?: client.RequestOptions): Promise<CreateNetworkResponse>;

async createNetworkSite(params: CreateNetworkSiteRequest, opts?: client.RequestOptions): Promise<CreateNetworkSiteResponse>;

async deactivateDeviceIdentifier(params: DeactivateDeviceIdentifierRequest, opts?: client.RequestOptions): Promise<DeactivateDeviceIdentifierResponse>;

async deleteNetwork(params: DeleteNetworkRequest, opts?: client.RequestOptions): Promise<DeleteNetworkResponse>;

async deleteNetworkSite(params: DeleteNetworkSiteRequest, opts?: client.RequestOptions): Promise<DeleteNetworkSiteResponse>;

async getDeviceIdentifier(params: GetDeviceIdentifierRequest, opts?: client.RequestOptions): Promise<GetDeviceIdentifierResponse>;

async getNetwork(params: GetNetworkRequest, opts?: client.RequestOptions): Promise<GetNetworkResponse>;

async getNetworkResource(params: GetNetworkResourceRequest, opts?: client.RequestOptions): Promise<GetNetworkResourceResponse>;

async getNetworkSite(params: GetNetworkSiteRequest, opts?: client.RequestOptions): Promise<GetNetworkSiteResponse>;

async getOrder(params: GetOrderRequest, opts?: client.RequestOptions): Promise<GetOrderResponse>;

async listDeviceIdentifiers(params: ListDeviceIdentifiersRequest, opts?: client.RequestOptions): Promise<ListDeviceIdentifiersResponse>;

async listNetworkResources(params: ListNetworkResourcesRequest, opts?: client.RequestOptions): Promise<ListNetworkResourcesResponse>;

async listNetworks(params?: ListNetworksRequest, opts?: client.RequestOptions): Promise<ListNetworksResponse>;

async listNetworkSites(params: ListNetworkSitesRequest, opts?: client.RequestOptions): Promise<ListNetworkSitesResponse>;

async listOrders(params: ListOrdersRequest, opts?: client.RequestOptions): Promise<ListOrdersResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async ping(opts?: client.RequestOptions): Promise<PingResponse>;

async startNetworkResourceUpdate(params: StartNetworkResourceUpdateRequest, opts?: client.RequestOptions): Promise<StartNetworkResourceUpdateResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateNetworkSite(params: UpdateNetworkSiteRequest, opts?: client.RequestOptions): Promise<UpdateNetworkSiteResponse>;

async updateNetworkSitePlan(params: UpdateNetworkSitePlanRequest, opts?: client.RequestOptions): Promise<UpdateNetworkSiteResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new PrivateNetworks(apiFactory: client.ApiFactory)

[src]

§Methods

acknowledgeOrderReceipt(params: AcknowledgeOrderReceiptRequest, opts?: client.RequestOptions): Promise<AcknowledgeOrderReceiptResponse>

[src]

Acknowledges that the specified network order was received.

activateDeviceIdentifier(params: ActivateDeviceIdentifierRequest, opts?: client.RequestOptions): Promise<ActivateDeviceIdentifierResponse>

[src]

Activates the specified device identifier.

activateNetworkSite(params: ActivateNetworkSiteRequest, opts?: client.RequestOptions): Promise<ActivateNetworkSiteResponse>

[src]

Activates the specified network site.

configureAccessPoint(params: ConfigureAccessPointRequest, opts?: client.RequestOptions): Promise<ConfigureAccessPointResponse>

[src]

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.

createNetwork(params: CreateNetworkRequest, opts?: client.RequestOptions): Promise<CreateNetworkResponse>

[src]

Creates a network.

createNetworkSite(params: CreateNetworkSiteRequest, opts?: client.RequestOptions): Promise<CreateNetworkSiteResponse>

[src]

Creates a network site.

deactivateDeviceIdentifier(params: DeactivateDeviceIdentifierRequest, opts?: client.RequestOptions): Promise<DeactivateDeviceIdentifierResponse>

[src]

Deactivates the specified device identifier.

deleteNetwork(params: DeleteNetworkRequest, opts?: client.RequestOptions): Promise<DeleteNetworkResponse>

[src]

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.

deleteNetworkSite(params: DeleteNetworkSiteRequest, opts?: client.RequestOptions): Promise<DeleteNetworkSiteResponse>

[src]

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.

getDeviceIdentifier(params: GetDeviceIdentifierRequest, opts?: client.RequestOptions): Promise<GetDeviceIdentifierResponse>

[src]

Gets the specified device identifier.

getNetwork(params: GetNetworkRequest, opts?: client.RequestOptions): Promise<GetNetworkResponse>

[src]

Gets the specified network.

getNetworkResource(params: GetNetworkResourceRequest, opts?: client.RequestOptions): Promise<GetNetworkResourceResponse>

[src]

Gets the specified network resource.

getNetworkSite(params: GetNetworkSiteRequest, opts?: client.RequestOptions): Promise<GetNetworkSiteResponse>

[src]

Gets the specified network site.

getOrder(params: GetOrderRequest, opts?: client.RequestOptions): Promise<GetOrderResponse>

[src]

Gets the specified order.

listDeviceIdentifiers(params: ListDeviceIdentifiersRequest, opts?: client.RequestOptions): Promise<ListDeviceIdentifiersResponse>

[src]

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.

listNetworkResources(params: ListNetworkResourcesRequest, opts?: client.RequestOptions): Promise<ListNetworkResourcesResponse>

[src]

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.

listNetworks(params?: ListNetworksRequest, opts?: client.RequestOptions): Promise<ListNetworksResponse>

[src]

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

listNetworkSites(params: ListNetworkSitesRequest, opts?: client.RequestOptions): Promise<ListNetworkSitesResponse>

[src]

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.

listOrders(params: ListOrdersRequest, opts?: client.RequestOptions): Promise<ListOrdersResponse>

[src]

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.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags for the specified resource.

ping(opts?: client.RequestOptions): Promise<PingResponse>

[src]

Checks the health of the service.

startNetworkResourceUpdate(params: StartNetworkResourceUpdateRequest, opts?: client.RequestOptions): Promise<StartNetworkResourceUpdateResponse>

[src]

Starts an update of the specified network resource.

After you submit a request to replace or return a network resource, the status of the network resource is 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 is DELETED. For more information, see Return a radio unit.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds tags to the specified resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from the specified resource.

updateNetworkSite(params: UpdateNetworkSiteRequest, opts?: client.RequestOptions): Promise<UpdateNetworkSiteResponse>

[src]

Updates the specified network site.

updateNetworkSitePlan(params: UpdateNetworkSitePlanRequest, opts?: client.RequestOptions): Promise<UpdateNetworkSiteResponse>

[src]

Updates the specified network site plan.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]