Class: Aws::PrivateNetworks::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::PrivateNetworks::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::PrivateNetworks::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



365
366
367
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

#acknowledge_order_receipt(params = {}) ⇒ Types::AcknowledgeOrderReceiptResponse

Acknowledges that the specified network order was received.

Examples:

Request syntax with placeholder values


resp = client.acknowledge_order_receipt({
  order_arn: "Arn", # required
})

Response structure


resp.order.acknowledgment_status #=> String, one of "ACKNOWLEDGING", "ACKNOWLEDGED", "UNACKNOWLEDGED"
resp.order.created_at #=> Time
resp.order.network_arn #=> String
resp.order.network_site_arn #=> String
resp.order.order_arn #=> String
resp.order.shipping_address.city #=> String
resp.order.shipping_address.company #=> String
resp.order.shipping_address.country #=> String
resp.order.shipping_address.name #=> String
resp.order.shipping_address.phone_number #=> String
resp.order.shipping_address.postal_code #=> String
resp.order.shipping_address.state_or_province #=> String
resp.order.shipping_address.street1 #=> String
resp.order.shipping_address.street2 #=> String
resp.order.shipping_address.street3 #=> String
resp.order.tracking_information #=> Array
resp.order.tracking_information[0].tracking_number #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :order_arn (required, String) —

    The Amazon Resource Name (ARN) of the order.

Returns:

See Also:



410
411
412
413
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 410

def acknowledge_order_receipt(params = {}, options = {})
  req = build_request(:acknowledge_order_receipt, params)
  req.send_request(options)
end

#activate_device_identifier(params = {}) ⇒ Types::ActivateDeviceIdentifierResponse

Activates the specified device identifier.

Examples:

Request syntax with placeholder values


resp = client.activate_device_identifier({
  client_token: "ClientToken",
  device_identifier_arn: "Arn", # required
})

Response structure


resp.device_identifier.created_at #=> Time
resp.device_identifier.device_identifier_arn #=> String
resp.device_identifier.iccid #=> String
resp.device_identifier.imsi #=> String
resp.device_identifier.network_arn #=> String
resp.device_identifier.order_arn #=> String
resp.device_identifier.status #=> String, one of "ACTIVE", "INACTIVE"
resp.device_identifier.traffic_group_arn #=> String
resp.device_identifier.vendor #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :device_identifier_arn (required, String) —

    The Amazon Resource Name (ARN) of the device identifier.

Returns:

See Also:



459
460
461
462
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 459

def activate_device_identifier(params = {}, options = {})
  req = build_request(:activate_device_identifier, params)
  req.send_request(options)
end

#activate_network_site(params = {}) ⇒ Types::ActivateNetworkSiteResponse

Activates the specified network site.

Examples:

Request syntax with placeholder values


resp = client.activate_network_site({
  client_token: "ClientToken",
  network_site_arn: "Arn", # required
  shipping_address: { # required
    city: "AddressContent", # required
    company: "AddressContent",
    country: "AddressContent", # required
    name: "AddressContent", # required
    phone_number: "AddressContent",
    postal_code: "AddressContent", # required
    state_or_province: "AddressContent", # required
    street1: "AddressContent", # required
    street2: "AddressContent",
    street3: "AddressContent",
  },
})

Response structure


resp.network_site.availability_zone #=> String
resp.network_site.availability_zone_id #=> String
resp.network_site.created_at #=> Time
resp.network_site.current_plan.options #=> Array
resp.network_site.current_plan.options[0].name #=> String
resp.network_site.current_plan.options[0].value #=> String
resp.network_site.current_plan.resource_definitions #=> Array
resp.network_site.current_plan.resource_definitions[0].count #=> Integer
resp.network_site.current_plan.resource_definitions[0].options #=> Array
resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.description #=> String
resp.network_site.network_arn #=> String
resp.network_site.network_site_arn #=> String
resp.network_site.network_site_name #=> String
resp.network_site.pending_plan.options #=> Array
resp.network_site.pending_plan.options[0].name #=> String
resp.network_site.pending_plan.options[0].value #=> String
resp.network_site.pending_plan.resource_definitions #=> Array
resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
resp.network_site.pending_plan.resource_definitions[0].options #=> Array
resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network_site.status_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :network_site_arn (required, String) —

    The Amazon Resource Name (ARN) of the network site.

  • :shipping_address (required, Types::Address) —

    The shipping address of the network site.

Returns:

See Also:



538
539
540
541
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 538

def activate_network_site(params = {}, options = {})
  req = build_request(:activate_network_site, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.configure_access_point({
  access_point_arn: "Arn", # required
  cpi_secret_key: "ConfigureAccessPointRequestCpiSecretKeyString",
  cpi_user_id: "ConfigureAccessPointRequestCpiUserIdString",
  cpi_user_password: "ConfigureAccessPointRequestCpiUserPasswordString",
  cpi_username: "ConfigureAccessPointRequestCpiUsernameString",
  position: {
    elevation: 1.0,
    elevation_reference: "AGL", # accepts AGL, AMSL
    elevation_unit: "FEET", # accepts FEET
    latitude: 1.0,
    longitude: 1.0,
  },
})

Response structure


resp.access_point.attributes #=> Array
resp.access_point.attributes[0].name #=> String
resp.access_point.attributes[0].value #=> String
resp.access_point.created_at #=> Time
resp.access_point.description #=> String
resp.access_point.health #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.access_point.model #=> String
resp.access_point.network_arn #=> String
resp.access_point.network_resource_arn #=> String
resp.access_point.network_site_arn #=> String
resp.access_point.order_arn #=> String
resp.access_point.position.elevation #=> Float
resp.access_point.position.elevation_reference #=> String, one of "AGL", "AMSL"
resp.access_point.position.elevation_unit #=> String, one of "FEET"
resp.access_point.position.latitude #=> Float
resp.access_point.position.longitude #=> Float
resp.access_point.return_information.replacement_order_arn #=> String
resp.access_point.return_information.return_reason #=> String
resp.access_point.return_information.shipping_address.city #=> String
resp.access_point.return_information.shipping_address.company #=> String
resp.access_point.return_information.shipping_address.country #=> String
resp.access_point.return_information.shipping_address.name #=> String
resp.access_point.return_information.shipping_address.phone_number #=> String
resp.access_point.return_information.shipping_address.postal_code #=> String
resp.access_point.return_information.shipping_address.state_or_province #=> String
resp.access_point.return_information.shipping_address.street1 #=> String
resp.access_point.return_information.shipping_address.street2 #=> String
resp.access_point.return_information.shipping_address.street3 #=> String
resp.access_point.return_information.shipping_label #=> String
resp.access_point.serial_number #=> String
resp.access_point.status #=> String, one of "PENDING", "SHIPPED", "PROVISIONING", "PROVISIONED", "AVAILABLE", "DELETING", "PENDING_RETURN", "DELETED", "CREATING_SHIPPING_LABEL"
resp.access_point.status_reason #=> String
resp.access_point.type #=> String, one of "RADIO_UNIT"
resp.access_point.vendor #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_point_arn (required, String) —

    The Amazon Resource Name (ARN) of the network resource.

  • :cpi_secret_key (String) —

    A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

  • :cpi_user_id (String) —

    The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

  • :cpi_user_password (String) —

    The CPI password associated with the CPI certificate in cpiSecretKey.

  • :cpi_username (String) —

    The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

  • :position (Types::Position) —

    The position of the network resource.

Returns:

See Also:



639
640
641
642
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 639

def configure_access_point(params = {}, options = {})
  req = build_request(:configure_access_point, params)
  req.send_request(options)
end

#create_network(params = {}) ⇒ Types::CreateNetworkResponse

Creates a network.

Examples:

Request syntax with placeholder values


resp = client.create_network({
  client_token: "ClientToken",
  description: "Description",
  network_name: "Name", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.network.created_at #=> Time
resp.network.description #=> String
resp.network.network_arn #=> String
resp.network.network_name #=> String
resp.network.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :description (String) —

    The description of the network.

  • :network_name (required, String) —

    The name of the network. You can't change the name after you create the network.

  • :tags (Hash<String,String>) —

    The tags to apply to the network.

Returns:

See Also:



696
697
698
699
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 696

def create_network(params = {}, options = {})
  req = build_request(:create_network, params)
  req.send_request(options)
end

#create_network_site(params = {}) ⇒ Types::CreateNetworkSiteResponse

Creates a network site.

Examples:

Request syntax with placeholder values


resp = client.create_network_site({
  availability_zone: "String",
  availability_zone_id: "String",
  client_token: "ClientToken",
  description: "Description",
  network_arn: "Arn", # required
  network_site_name: "Name", # required
  pending_plan: {
    options: [
      {
        name: "String", # required
        value: "String",
      },
    ],
    resource_definitions: [
      {
        count: 1, # required
        options: [
          {
            name: "String", # required
            value: "String",
          },
        ],
        type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.network_site.availability_zone #=> String
resp.network_site.availability_zone_id #=> String
resp.network_site.created_at #=> Time
resp.network_site.current_plan.options #=> Array
resp.network_site.current_plan.options[0].name #=> String
resp.network_site.current_plan.options[0].value #=> String
resp.network_site.current_plan.resource_definitions #=> Array
resp.network_site.current_plan.resource_definitions[0].count #=> Integer
resp.network_site.current_plan.resource_definitions[0].options #=> Array
resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.description #=> String
resp.network_site.network_arn #=> String
resp.network_site.network_site_arn #=> String
resp.network_site.network_site_name #=> String
resp.network_site.pending_plan.options #=> Array
resp.network_site.pending_plan.options[0].name #=> String
resp.network_site.pending_plan.options[0].value #=> String
resp.network_site.pending_plan.resource_definitions #=> Array
resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
resp.network_site.pending_plan.resource_definitions[0].options #=> Array
resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network_site.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :availability_zone (String) —

    The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.

  • :availability_zone_id (String) —

    The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :description (String) —

    The description of the site.

  • :network_arn (required, String) —

    The Amazon Resource Name (ARN) of the network.

  • :network_site_name (required, String) —

    The name of the site. You can't change the name after you create the site.

  • :pending_plan (Types::SitePlan) —

    Information about the pending plan for this site.

  • :tags (Hash<String,String>) —

    The tags to apply to the network site.

Returns:

See Also:



811
812
813
814
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 811

def create_network_site(params = {}, options = {})
  req = build_request(:create_network_site, params)
  req.send_request(options)
end

#deactivate_device_identifier(params = {}) ⇒ Types::DeactivateDeviceIdentifierResponse

Deactivates the specified device identifier.

Examples:

Request syntax with placeholder values


resp = client.deactivate_device_identifier({
  client_token: "ClientToken",
  device_identifier_arn: "Arn", # required
})

Response structure


resp.device_identifier.created_at #=> Time
resp.device_identifier.device_identifier_arn #=> String
resp.device_identifier.iccid #=> String
resp.device_identifier.imsi #=> String
resp.device_identifier.network_arn #=> String
resp.device_identifier.order_arn #=> String
resp.device_identifier.status #=> String, one of "ACTIVE", "INACTIVE"
resp.device_identifier.traffic_group_arn #=> String
resp.device_identifier.vendor #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :device_identifier_arn (required, String) —

    The Amazon Resource Name (ARN) of the device identifier.

Returns:

See Also:



857
858
859
860
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 857

def deactivate_device_identifier(params = {}, options = {})
  req = build_request(:deactivate_device_identifier, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_network({
  client_token: "ClientToken",
  network_arn: "Arn", # required
})

Response structure


resp.network.created_at #=> Time
resp.network.description #=> String
resp.network.network_arn #=> String
resp.network.network_name #=> String
resp.network.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network.status_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :network_arn (required, String) —

    The Amazon Resource Name (ARN) of the network.

Returns:

See Also:



907
908
909
910
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 907

def delete_network(params = {}, options = {})
  req = build_request(:delete_network, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_network_site({
  client_token: "ClientToken",
  network_site_arn: "Arn", # required
})

Response structure


resp.network_site.availability_zone #=> String
resp.network_site.availability_zone_id #=> String
resp.network_site.created_at #=> Time
resp.network_site.current_plan.options #=> Array
resp.network_site.current_plan.options[0].name #=> String
resp.network_site.current_plan.options[0].value #=> String
resp.network_site.current_plan.resource_definitions #=> Array
resp.network_site.current_plan.resource_definitions[0].count #=> Integer
resp.network_site.current_plan.resource_definitions[0].options #=> Array
resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.description #=> String
resp.network_site.network_arn #=> String
resp.network_site.network_site_arn #=> String
resp.network_site.network_site_name #=> String
resp.network_site.pending_plan.options #=> Array
resp.network_site.pending_plan.options[0].name #=> String
resp.network_site.pending_plan.options[0].value #=> String
resp.network_site.pending_plan.resource_definitions #=> Array
resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
resp.network_site.pending_plan.resource_definitions[0].options #=> Array
resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network_site.status_reason #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :network_site_arn (required, String) —

    The Amazon Resource Name (ARN) of the network site.

Returns:

See Also:



978
979
980
981
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 978

def delete_network_site(params = {}, options = {})
  req = build_request(:delete_network_site, params)
  req.send_request(options)
end

#get_device_identifier(params = {}) ⇒ Types::GetDeviceIdentifierResponse

Gets the specified device identifier.

Examples:

Request syntax with placeholder values


resp = client.get_device_identifier({
  device_identifier_arn: "Arn", # required
})

Response structure


resp.device_identifier.created_at #=> Time
resp.device_identifier.device_identifier_arn #=> String
resp.device_identifier.iccid #=> String
resp.device_identifier.imsi #=> String
resp.device_identifier.network_arn #=> String
resp.device_identifier.order_arn #=> String
resp.device_identifier.status #=> String, one of "ACTIVE", "INACTIVE"
resp.device_identifier.traffic_group_arn #=> String
resp.device_identifier.vendor #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :device_identifier_arn (required, String) —

    The Amazon Resource Name (ARN) of the device identifier.

Returns:

See Also:



1017
1018
1019
1020
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1017

def get_device_identifier(params = {}, options = {})
  req = build_request(:get_device_identifier, params)
  req.send_request(options)
end

#get_network(params = {}) ⇒ Types::GetNetworkResponse

Gets the specified network.

Examples:

Request syntax with placeholder values


resp = client.get_network({
  network_arn: "Arn", # required
})

Response structure


resp.network.created_at #=> Time
resp.network.description #=> String
resp.network.network_arn #=> String
resp.network.network_name #=> String
resp.network.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_arn (required, String) —

    The Amazon Resource Name (ARN) of the network.

Returns:

See Also:



1053
1054
1055
1056
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1053

def get_network(params = {}, options = {})
  req = build_request(:get_network, params)
  req.send_request(options)
end

#get_network_resource(params = {}) ⇒ Types::GetNetworkResourceResponse

Gets the specified network resource.

Examples:

Request syntax with placeholder values


resp = client.get_network_resource({
  network_resource_arn: "Arn", # required
})

Response structure


resp.network_resource.attributes #=> Array
resp.network_resource.attributes[0].name #=> String
resp.network_resource.attributes[0].value #=> String
resp.network_resource.created_at #=> Time
resp.network_resource.description #=> String
resp.network_resource.health #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.network_resource.model #=> String
resp.network_resource.network_arn #=> String
resp.network_resource.network_resource_arn #=> String
resp.network_resource.network_site_arn #=> String
resp.network_resource.order_arn #=> String
resp.network_resource.position.elevation #=> Float
resp.network_resource.position.elevation_reference #=> String, one of "AGL", "AMSL"
resp.network_resource.position.elevation_unit #=> String, one of "FEET"
resp.network_resource.position.latitude #=> Float
resp.network_resource.position.longitude #=> Float
resp.network_resource.return_information.replacement_order_arn #=> String
resp.network_resource.return_information.return_reason #=> String
resp.network_resource.return_information.shipping_address.city #=> String
resp.network_resource.return_information.shipping_address.company #=> String
resp.network_resource.return_information.shipping_address.country #=> String
resp.network_resource.return_information.shipping_address.name #=> String
resp.network_resource.return_information.shipping_address.phone_number #=> String
resp.network_resource.return_information.shipping_address.postal_code #=> String
resp.network_resource.return_information.shipping_address.state_or_province #=> String
resp.network_resource.return_information.shipping_address.street1 #=> String
resp.network_resource.return_information.shipping_address.street2 #=> String
resp.network_resource.return_information.shipping_address.street3 #=> String
resp.network_resource.return_information.shipping_label #=> String
resp.network_resource.serial_number #=> String
resp.network_resource.status #=> String, one of "PENDING", "SHIPPED", "PROVISIONING", "PROVISIONED", "AVAILABLE", "DELETING", "PENDING_RETURN", "DELETED", "CREATING_SHIPPING_LABEL"
resp.network_resource.status_reason #=> String
resp.network_resource.type #=> String, one of "RADIO_UNIT"
resp.network_resource.vendor #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the network resource.

Returns:

See Also:



1117
1118
1119
1120
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1117

def get_network_resource(params = {}, options = {})
  req = build_request(:get_network_resource, params)
  req.send_request(options)
end

#get_network_site(params = {}) ⇒ Types::GetNetworkSiteResponse

Gets the specified network site.

Examples:

Request syntax with placeholder values


resp = client.get_network_site({
  network_site_arn: "Arn", # required
})

Response structure


resp.network_site.availability_zone #=> String
resp.network_site.availability_zone_id #=> String
resp.network_site.created_at #=> Time
resp.network_site.current_plan.options #=> Array
resp.network_site.current_plan.options[0].name #=> String
resp.network_site.current_plan.options[0].value #=> String
resp.network_site.current_plan.resource_definitions #=> Array
resp.network_site.current_plan.resource_definitions[0].count #=> Integer
resp.network_site.current_plan.resource_definitions[0].options #=> Array
resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.description #=> String
resp.network_site.network_arn #=> String
resp.network_site.network_site_arn #=> String
resp.network_site.network_site_name #=> String
resp.network_site.pending_plan.options #=> Array
resp.network_site.pending_plan.options[0].name #=> String
resp.network_site.pending_plan.options[0].value #=> String
resp.network_site.pending_plan.resource_definitions #=> Array
resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
resp.network_site.pending_plan.resource_definitions[0].options #=> Array
resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network_site.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_site_arn (required, String) —

    The Amazon Resource Name (ARN) of the network site.

Returns:

See Also:



1174
1175
1176
1177
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1174

def get_network_site(params = {}, options = {})
  req = build_request(:get_network_site, params)
  req.send_request(options)
end

#get_order(params = {}) ⇒ Types::GetOrderResponse

Gets the specified order.

Examples:

Request syntax with placeholder values


resp = client.get_order({
  order_arn: "Arn", # required
})

Response structure


resp.order.acknowledgment_status #=> String, one of "ACKNOWLEDGING", "ACKNOWLEDGED", "UNACKNOWLEDGED"
resp.order.created_at #=> Time
resp.order.network_arn #=> String
resp.order.network_site_arn #=> String
resp.order.order_arn #=> String
resp.order.shipping_address.city #=> String
resp.order.shipping_address.company #=> String
resp.order.shipping_address.country #=> String
resp.order.shipping_address.name #=> String
resp.order.shipping_address.phone_number #=> String
resp.order.shipping_address.postal_code #=> String
resp.order.shipping_address.state_or_province #=> String
resp.order.shipping_address.street1 #=> String
resp.order.shipping_address.street2 #=> String
resp.order.shipping_address.street3 #=> String
resp.order.tracking_information #=> Array
resp.order.tracking_information[0].tracking_number #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :order_arn (required, String) —

    The Amazon Resource Name (ARN) of the order.

Returns:

See Also:



1221
1222
1223
1224
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1221

def get_order(params = {}, options = {})
  req = build_request(:get_order, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_device_identifiers({
  filters: {
    "STATUS" => ["String"],
  },
  max_results: 1,
  network_arn: "Arn", # required
  start_token: "PaginationToken",
})

Response structure


resp.device_identifiers #=> Array
resp.device_identifiers[0].created_at #=> Time
resp.device_identifiers[0].device_identifier_arn #=> String
resp.device_identifiers[0].iccid #=> String
resp.device_identifiers[0].imsi #=> String
resp.device_identifiers[0].network_arn #=> String
resp.device_identifiers[0].order_arn #=> String
resp.device_identifiers[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.device_identifiers[0].traffic_group_arn #=> String
resp.device_identifiers[0].vendor #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Hash<String,Array>) —

    The filters.

    • ORDER - The Amazon Resource Name (ARN) of the order.

    • STATUS - The status (ACTIVE | INACTIVE).

    • TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :network_arn (required, String) —

    The Amazon Resource Name (ARN) of the network.

  • :start_token (String) —

    The token for the next page of results.

Returns:

See Also:



1293
1294
1295
1296
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1293

def list_device_identifiers(params = {}, options = {})
  req = build_request(:list_device_identifiers, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_network_resources({
  filters: {
    "ORDER" => ["String"],
  },
  max_results: 1,
  network_arn: "Arn", # required
  start_token: "PaginationToken",
})

Response structure


resp.network_resources #=> Array
resp.network_resources[0].attributes #=> Array
resp.network_resources[0].attributes[0].name #=> String
resp.network_resources[0].attributes[0].value #=> String
resp.network_resources[0].created_at #=> Time
resp.network_resources[0].description #=> String
resp.network_resources[0].health #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.network_resources[0].model #=> String
resp.network_resources[0].network_arn #=> String
resp.network_resources[0].network_resource_arn #=> String
resp.network_resources[0].network_site_arn #=> String
resp.network_resources[0].order_arn #=> String
resp.network_resources[0].position.elevation #=> Float
resp.network_resources[0].position.elevation_reference #=> String, one of "AGL", "AMSL"
resp.network_resources[0].position.elevation_unit #=> String, one of "FEET"
resp.network_resources[0].position.latitude #=> Float
resp.network_resources[0].position.longitude #=> Float
resp.network_resources[0].return_information.replacement_order_arn #=> String
resp.network_resources[0].return_information.return_reason #=> String
resp.network_resources[0].return_information.shipping_address.city #=> String
resp.network_resources[0].return_information.shipping_address.company #=> String
resp.network_resources[0].return_information.shipping_address.country #=> String
resp.network_resources[0].return_information.shipping_address.name #=> String
resp.network_resources[0].return_information.shipping_address.phone_number #=> String
resp.network_resources[0].return_information.shipping_address.postal_code #=> String
resp.network_resources[0].return_information.shipping_address.state_or_province #=> String
resp.network_resources[0].return_information.shipping_address.street1 #=> String
resp.network_resources[0].return_information.shipping_address.street2 #=> String
resp.network_resources[0].return_information.shipping_address.street3 #=> String
resp.network_resources[0].return_information.shipping_label #=> String
resp.network_resources[0].serial_number #=> String
resp.network_resources[0].status #=> String, one of "PENDING", "SHIPPED", "PROVISIONING", "PROVISIONED", "AVAILABLE", "DELETING", "PENDING_RETURN", "DELETED", "CREATING_SHIPPING_LABEL"
resp.network_resources[0].status_reason #=> String
resp.network_resources[0].type #=> String, one of "RADIO_UNIT"
resp.network_resources[0].vendor #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Hash<String,Array>) —

    The filters.

    • ORDER - The Amazon Resource Name (ARN) of the order.

    • STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :network_arn (required, String) —

    The Amazon Resource Name (ARN) of the network.

  • :start_token (String) —

    The token for the next page of results.

Returns:

See Also:



1387
1388
1389
1390
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1387

def list_network_resources(params = {}, options = {})
  req = build_request(:list_network_resources, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_network_sites({
  filters: {
    "STATUS" => ["String"],
  },
  max_results: 1,
  network_arn: "Arn", # required
  start_token: "PaginationToken",
})

Response structure


resp.network_sites #=> Array
resp.network_sites[0].availability_zone #=> String
resp.network_sites[0].availability_zone_id #=> String
resp.network_sites[0].created_at #=> Time
resp.network_sites[0].current_plan.options #=> Array
resp.network_sites[0].current_plan.options[0].name #=> String
resp.network_sites[0].current_plan.options[0].value #=> String
resp.network_sites[0].current_plan.resource_definitions #=> Array
resp.network_sites[0].current_plan.resource_definitions[0].count #=> Integer
resp.network_sites[0].current_plan.resource_definitions[0].options #=> Array
resp.network_sites[0].current_plan.resource_definitions[0].options[0].name #=> String
resp.network_sites[0].current_plan.resource_definitions[0].options[0].value #=> String
resp.network_sites[0].current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_sites[0].description #=> String
resp.network_sites[0].network_arn #=> String
resp.network_sites[0].network_site_arn #=> String
resp.network_sites[0].network_site_name #=> String
resp.network_sites[0].pending_plan.options #=> Array
resp.network_sites[0].pending_plan.options[0].name #=> String
resp.network_sites[0].pending_plan.options[0].value #=> String
resp.network_sites[0].pending_plan.resource_definitions #=> Array
resp.network_sites[0].pending_plan.resource_definitions[0].count #=> Integer
resp.network_sites[0].pending_plan.resource_definitions[0].options #=> Array
resp.network_sites[0].pending_plan.resource_definitions[0].options[0].name #=> String
resp.network_sites[0].pending_plan.resource_definitions[0].options[0].value #=> String
resp.network_sites[0].pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_sites[0].status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network_sites[0].status_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Hash<String,Array>) —

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

    • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

    ^

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :network_arn (required, String) —

    The Amazon Resource Name (ARN) of the network.

  • :start_token (String) —

    The token for the next page of results.

Returns:

See Also:



1472
1473
1474
1475
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1472

def list_network_sites(params = {}, options = {})
  req = build_request(:list_network_sites, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_networks({
  filters: {
    "STATUS" => ["String"],
  },
  max_results: 1,
  start_token: "PaginationToken",
})

Response structure


resp.networks #=> Array
resp.networks[0].created_at #=> Time
resp.networks[0].description #=> String
resp.networks[0].network_arn #=> String
resp.networks[0].network_name #=> String
resp.networks[0].status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.networks[0].status_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Hash<String,Array>) —

    The filters.

    • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

    ^

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :start_token (String) —

    The token for the next page of results.

Returns:

See Also:



1530
1531
1532
1533
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1530

def list_networks(params = {}, options = {})
  req = build_request(:list_networks, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_orders({
  filters: {
    "STATUS" => ["String"],
  },
  max_results: 1,
  network_arn: "Arn", # required
  start_token: "PaginationToken",
})

Response structure


resp.next_token #=> String
resp.orders #=> Array
resp.orders[0].acknowledgment_status #=> String, one of "ACKNOWLEDGING", "ACKNOWLEDGED", "UNACKNOWLEDGED"
resp.orders[0].created_at #=> Time
resp.orders[0].network_arn #=> String
resp.orders[0].network_site_arn #=> String
resp.orders[0].order_arn #=> String
resp.orders[0].shipping_address.city #=> String
resp.orders[0].shipping_address.company #=> String
resp.orders[0].shipping_address.country #=> String
resp.orders[0].shipping_address.name #=> String
resp.orders[0].shipping_address.phone_number #=> String
resp.orders[0].shipping_address.postal_code #=> String
resp.orders[0].shipping_address.state_or_province #=> String
resp.orders[0].shipping_address.street1 #=> String
resp.orders[0].shipping_address.street2 #=> String
resp.orders[0].shipping_address.street3 #=> String
resp.orders[0].tracking_information #=> Array
resp.orders[0].tracking_information[0].tracking_number #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Hash<String,Array>) —

    The filters.

    • NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.

    • STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :network_arn (required, String) —

    The Amazon Resource Name (ARN) of the network.

  • :start_token (String) —

    The token for the next page of results.

Returns:

See Also:



1607
1608
1609
1610
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1607

def list_orders(params = {}, options = {})
  req = build_request(:list_orders, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1636
1637
1638
1639
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1636

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#ping(params = {}) ⇒ Types::PingResponse

Checks the health of the service.

Examples:

Response structure


resp.status #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1655
1656
1657
1658
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1655

def ping(params = {}, options = {})
  req = build_request(:ping, params)
  req.send_request(options)
end

#start_network_resource_update(params = {}) ⇒ Types::StartNetworkResourceUpdateResponse

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.

Examples:

Request syntax with placeholder values


resp = client.start_network_resource_update({
  network_resource_arn: "Arn", # required
  return_reason: "StartNetworkResourceUpdateRequestReturnReasonString",
  shipping_address: {
    city: "AddressContent", # required
    company: "AddressContent",
    country: "AddressContent", # required
    name: "AddressContent", # required
    phone_number: "AddressContent",
    postal_code: "AddressContent", # required
    state_or_province: "AddressContent", # required
    street1: "AddressContent", # required
    street2: "AddressContent",
    street3: "AddressContent",
  },
  update_type: "REPLACE", # required, accepts REPLACE, RETURN
})

Response structure


resp.network_resource.attributes #=> Array
resp.network_resource.attributes[0].name #=> String
resp.network_resource.attributes[0].value #=> String
resp.network_resource.created_at #=> Time
resp.network_resource.description #=> String
resp.network_resource.health #=> String, one of "INITIAL", "HEALTHY", "UNHEALTHY"
resp.network_resource.model #=> String
resp.network_resource.network_arn #=> String
resp.network_resource.network_resource_arn #=> String
resp.network_resource.network_site_arn #=> String
resp.network_resource.order_arn #=> String
resp.network_resource.position.elevation #=> Float
resp.network_resource.position.elevation_reference #=> String, one of "AGL", "AMSL"
resp.network_resource.position.elevation_unit #=> String, one of "FEET"
resp.network_resource.position.latitude #=> Float
resp.network_resource.position.longitude #=> Float
resp.network_resource.return_information.replacement_order_arn #=> String
resp.network_resource.return_information.return_reason #=> String
resp.network_resource.return_information.shipping_address.city #=> String
resp.network_resource.return_information.shipping_address.company #=> String
resp.network_resource.return_information.shipping_address.country #=> String
resp.network_resource.return_information.shipping_address.name #=> String
resp.network_resource.return_information.shipping_address.phone_number #=> String
resp.network_resource.return_information.shipping_address.postal_code #=> String
resp.network_resource.return_information.shipping_address.state_or_province #=> String
resp.network_resource.return_information.shipping_address.street1 #=> String
resp.network_resource.return_information.shipping_address.street2 #=> String
resp.network_resource.return_information.shipping_address.street3 #=> String
resp.network_resource.return_information.shipping_label #=> String
resp.network_resource.serial_number #=> String
resp.network_resource.status #=> String, one of "PENDING", "SHIPPED", "PROVISIONING", "PROVISIONED", "AVAILABLE", "DELETING", "PENDING_RETURN", "DELETED", "CREATING_SHIPPING_LABEL"
resp.network_resource.status_reason #=> String
resp.network_resource.type #=> String, one of "RADIO_UNIT"
resp.network_resource.vendor #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :network_resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the network resource.

  • :return_reason (String) —

    The reason for the return. Providing a reason for a return is optional.

  • :shipping_address (Types::Address) —

    The shipping address. If you don't provide a shipping address when replacing or returning a network resource, we use the address from the original order for the network resource.

  • :update_type (required, String) —

    The update type.

    • REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you.

    • RETURN - Submits a request to replace a radio unit that you no longer need. We provide a shipping label that you can use for the return process.

Returns:

See Also:



1761
1762
1763
1764
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1761

def start_network_resource_update(params = {}, options = {})
  req = build_request(:start_network_resource_update, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

    The tags to add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1789
1790
1791
1792
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1789

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1815
1816
1817
1818
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1815

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_network_site(params = {}) ⇒ Types::UpdateNetworkSiteResponse

Updates the specified network site.

Examples:

Request syntax with placeholder values


resp = client.update_network_site({
  client_token: "ClientToken",
  description: "Description",
  network_site_arn: "Arn", # required
})

Response structure


resp.network_site.availability_zone #=> String
resp.network_site.availability_zone_id #=> String
resp.network_site.created_at #=> Time
resp.network_site.current_plan.options #=> Array
resp.network_site.current_plan.options[0].name #=> String
resp.network_site.current_plan.options[0].value #=> String
resp.network_site.current_plan.resource_definitions #=> Array
resp.network_site.current_plan.resource_definitions[0].count #=> Integer
resp.network_site.current_plan.resource_definitions[0].options #=> Array
resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.description #=> String
resp.network_site.network_arn #=> String
resp.network_site.network_site_arn #=> String
resp.network_site.network_site_name #=> String
resp.network_site.pending_plan.options #=> Array
resp.network_site.pending_plan.options[0].name #=> String
resp.network_site.pending_plan.options[0].value #=> String
resp.network_site.pending_plan.resource_definitions #=> Array
resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
resp.network_site.pending_plan.resource_definitions[0].options #=> Array
resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network_site.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :description (String) —

    The description.

  • :network_site_arn (required, String) —

    The Amazon Resource Name (ARN) of the network site.

Returns:

See Also:



1886
1887
1888
1889
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1886

def update_network_site(params = {}, options = {})
  req = build_request(:update_network_site, params)
  req.send_request(options)
end

#update_network_site_plan(params = {}) ⇒ Types::UpdateNetworkSiteResponse

Updates the specified network site plan.

Examples:

Request syntax with placeholder values


resp = client.update_network_site_plan({
  client_token: "ClientToken",
  network_site_arn: "Arn", # required
  pending_plan: { # required
    options: [
      {
        name: "String", # required
        value: "String",
      },
    ],
    resource_definitions: [
      {
        count: 1, # required
        options: [
          {
            name: "String", # required
            value: "String",
          },
        ],
        type: "RADIO_UNIT", # required, accepts RADIO_UNIT, DEVICE_IDENTIFIER
      },
    ],
  },
})

Response structure


resp.network_site.availability_zone #=> String
resp.network_site.availability_zone_id #=> String
resp.network_site.created_at #=> Time
resp.network_site.current_plan.options #=> Array
resp.network_site.current_plan.options[0].name #=> String
resp.network_site.current_plan.options[0].value #=> String
resp.network_site.current_plan.resource_definitions #=> Array
resp.network_site.current_plan.resource_definitions[0].count #=> Integer
resp.network_site.current_plan.resource_definitions[0].options #=> Array
resp.network_site.current_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.current_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.current_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.description #=> String
resp.network_site.network_arn #=> String
resp.network_site.network_site_arn #=> String
resp.network_site.network_site_name #=> String
resp.network_site.pending_plan.options #=> Array
resp.network_site.pending_plan.options[0].name #=> String
resp.network_site.pending_plan.options[0].value #=> String
resp.network_site.pending_plan.resource_definitions #=> Array
resp.network_site.pending_plan.resource_definitions[0].count #=> Integer
resp.network_site.pending_plan.resource_definitions[0].options #=> Array
resp.network_site.pending_plan.resource_definitions[0].options[0].name #=> String
resp.network_site.pending_plan.resource_definitions[0].options[0].value #=> String
resp.network_site.pending_plan.resource_definitions[0].type #=> String, one of "RADIO_UNIT", "DEVICE_IDENTIFIER"
resp.network_site.status #=> String, one of "CREATED", "PROVISIONING", "AVAILABLE", "DEPROVISIONING", "DELETED"
resp.network_site.status_reason #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

  • :network_site_arn (required, String) —

    The Amazon Resource Name (ARN) of the network site.

  • :pending_plan (required, Types::SitePlan) —

    The pending plan.

Returns:

See Also:



1976
1977
1978
1979
 
# File 'gems/aws-sdk-privatenetworks/lib/aws-sdk-privatenetworks/client.rb', line 1976

def update_network_site_plan(params = {}, options = {})
  req = build_request(:update_network_site_plan, params)
  req.send_request(options)
end