AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::NetworkManager::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Network Manager. To construct a client, you need to configure a :region and :credentials.

networkmanager = Aws::NetworkManager::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::NetworkManager::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::NetworkManager::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

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

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_customer_gateway(options = {}) ⇒ Types::AssociateCustomerGatewayResponse

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

Examples:

Request syntax with placeholder values


resp = client.associate_customer_gateway({
  customer_gateway_arn: "String", # required
  global_network_id: "String", # required
  device_id: "String", # required
  link_id: "String",
})

Response structure


resp.customer_gateway_association.customer_gateway_arn #=> String
resp.customer_gateway_association.global_network_id #=> String
resp.customer_gateway_association.device_id #=> String
resp.customer_gateway_association.link_id #=> String
resp.customer_gateway_association.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED"

Options Hash (options):

  • :customer_gateway_arn (required, String)

    The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_id (required, String)

    The ID of the device.

  • :link_id (String)

    The ID of the link.

Returns:

See Also:

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

Examples:

Request syntax with placeholder values


resp = client.associate_link({
  global_network_id: "String", # required
  device_id: "String", # required
  link_id: "String", # required
})

Response structure


resp.link_association.global_network_id #=> String
resp.link_association.device_id #=> String
resp.link_association.link_id #=> String
resp.link_association.link_association_state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED"

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_id (required, String)

    The ID of the device.

  • :link_id (required, String)

    The ID of the link.

Returns:

See Also:

#create_device(options = {}) ⇒ Types::CreateDeviceResponse

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

Examples:

Request syntax with placeholder values


resp = client.create_device({
  global_network_id: "String", # required
  description: "String",
  type: "String",
  vendor: "String",
  model: "String",
  serial_number: "String",
  location: {
    address: "String",
    latitude: "String",
    longitude: "String",
  },
  site_id: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.device.device_id #=> String
resp.device.device_arn #=> String
resp.device.global_network_id #=> String
resp.device.description #=> String
resp.device.type #=> String
resp.device.vendor #=> String
resp.device.model #=> String
resp.device.serial_number #=> String
resp.device.location.address #=> String
resp.device.location.latitude #=> String
resp.device.location.longitude #=> String
resp.device.site_id #=> String
resp.device.created_at #=> Time
resp.device.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.device.tags #=> Array
resp.device.tags[0].key #=> String
resp.device.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :description (String)

    A description of the device.

    Length Constraints: Maximum length of 256 characters.

  • :type (String)

    The type of the device.

  • :vendor (String)

    The vendor of the device.

    Length Constraints: Maximum length of 128 characters.

  • :model (String)

    The model of the device.

    Length Constraints: Maximum length of 128 characters.

  • :serial_number (String)

    The serial number of the device.

    Length Constraints: Maximum length of 128 characters.

  • :location (Types::Location)

    The location of the device.

  • :site_id (String)

    The ID of the site.

  • :tags (Array<Types::Tag>)

    The tags to apply to the resource during creation.

Returns:

See Also:

#create_global_network(options = {}) ⇒ Types::CreateGlobalNetworkResponse

Creates a new, empty global network.

Examples:

Request syntax with placeholder values


resp = client.create_global_network({
  description: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.global_network.global_network_id #=> String
resp.global_network.global_network_arn #=> String
resp.global_network.description #=> String
resp.global_network.created_at #=> Time
resp.global_network.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.global_network.tags #=> Array
resp.global_network.tags[0].key #=> String
resp.global_network.tags[0].value #=> String

Options Hash (options):

  • :description (String)

    A description of the global network.

    Length Constraints: Maximum length of 256 characters.

  • :tags (Array<Types::Tag>)

    The tags to apply to the resource during creation.

Returns:

See Also:

Creates a new link for a specified site.

Examples:

Request syntax with placeholder values


resp = client.create_link({
  global_network_id: "String", # required
  description: "String",
  type: "String",
  bandwidth: { # required
    upload_speed: 1,
    download_speed: 1,
  },
  provider: "String",
  site_id: "String", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.link.link_id #=> String
resp.link.link_arn #=> String
resp.link.global_network_id #=> String
resp.link.site_id #=> String
resp.link.description #=> String
resp.link.type #=> String
resp.link.bandwidth.upload_speed #=> Integer
resp.link.bandwidth.download_speed #=> Integer
resp.link.provider #=> String
resp.link.created_at #=> Time
resp.link.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.link.tags #=> Array
resp.link.tags[0].key #=> String
resp.link.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :description (String)

    A description of the link.

    Length Constraints: Maximum length of 256 characters.

  • :type (String)

    The type of the link.

    Constraints: Cannot include the following characters: | \ ^

    Length Constraints: Maximum length of 128 characters.

  • :bandwidth (required, Types::Bandwidth)

    The upload speed and download speed in Mbps.

  • :provider (String)

    The provider of the link.

    Constraints: Cannot include the following characters: | \ ^

    Length Constraints: Maximum length of 128 characters.

  • :site_id (required, String)

    The ID of the site.

  • :tags (Array<Types::Tag>)

    The tags to apply to the resource during creation.

Returns:

See Also:

#create_site(options = {}) ⇒ Types::CreateSiteResponse

Creates a new site in a global network.

Examples:

Request syntax with placeholder values


resp = client.create_site({
  global_network_id: "String", # required
  description: "String",
  location: {
    address: "String",
    latitude: "String",
    longitude: "String",
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.site.site_id #=> String
resp.site.site_arn #=> String
resp.site.global_network_id #=> String
resp.site.description #=> String
resp.site.location.address #=> String
resp.site.location.latitude #=> String
resp.site.location.longitude #=> String
resp.site.created_at #=> Time
resp.site.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.site.tags #=> Array
resp.site.tags[0].key #=> String
resp.site.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :description (String)

    A description of your site.

    Length Constraints: Maximum length of 256 characters.

  • :location (Types::Location)

    The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

    • Address: The physical address of the site.

    • Latitude: The latitude of the site.

    • Longitude: The longitude of the site.

  • :tags (Array<Types::Tag>)

    The tags to apply to the resource during creation.

Returns:

See Also:

#delete_device(options = {}) ⇒ Types::DeleteDeviceResponse

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

Examples:

Request syntax with placeholder values


resp = client.delete_device({
  global_network_id: "String", # required
  device_id: "String", # required
})

Response structure


resp.device.device_id #=> String
resp.device.device_arn #=> String
resp.device.global_network_id #=> String
resp.device.description #=> String
resp.device.type #=> String
resp.device.vendor #=> String
resp.device.model #=> String
resp.device.serial_number #=> String
resp.device.location.address #=> String
resp.device.location.latitude #=> String
resp.device.location.longitude #=> String
resp.device.site_id #=> String
resp.device.created_at #=> Time
resp.device.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.device.tags #=> Array
resp.device.tags[0].key #=> String
resp.device.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_id (required, String)

    The ID of the device.

Returns:

See Also:

#delete_global_network(options = {}) ⇒ Types::DeleteGlobalNetworkResponse

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.

Examples:

Request syntax with placeholder values


resp = client.delete_global_network({
  global_network_id: "String", # required
})

Response structure


resp.global_network.global_network_id #=> String
resp.global_network.global_network_arn #=> String
resp.global_network.description #=> String
resp.global_network.created_at #=> Time
resp.global_network.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.global_network.tags #=> Array
resp.global_network.tags[0].key #=> String
resp.global_network.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

Returns:

See Also:

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

Examples:

Request syntax with placeholder values


resp = client.delete_link({
  global_network_id: "String", # required
  link_id: "String", # required
})

Response structure


resp.link.link_id #=> String
resp.link.link_arn #=> String
resp.link.global_network_id #=> String
resp.link.site_id #=> String
resp.link.description #=> String
resp.link.type #=> String
resp.link.bandwidth.upload_speed #=> Integer
resp.link.bandwidth.download_speed #=> Integer
resp.link.provider #=> String
resp.link.created_at #=> Time
resp.link.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.link.tags #=> Array
resp.link.tags[0].key #=> String
resp.link.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :link_id (required, String)

    The ID of the link.

Returns:

See Also:

#delete_site(options = {}) ⇒ Types::DeleteSiteResponse

Deletes an existing site. The site cannot be associated with any device or link.

Examples:

Request syntax with placeholder values


resp = client.delete_site({
  global_network_id: "String", # required
  site_id: "String", # required
})

Response structure


resp.site.site_id #=> String
resp.site.site_arn #=> String
resp.site.global_network_id #=> String
resp.site.description #=> String
resp.site.location.address #=> String
resp.site.location.latitude #=> String
resp.site.location.longitude #=> String
resp.site.created_at #=> Time
resp.site.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.site.tags #=> Array
resp.site.tags[0].key #=> String
resp.site.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :site_id (required, String)

    The ID of the site.

Returns:

See Also:

#deregister_transit_gateway(options = {}) ⇒ Types::DeregisterTransitGatewayResponse

Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

Examples:

Request syntax with placeholder values


resp = client.deregister_transit_gateway({
  global_network_id: "String", # required
  transit_gateway_arn: "String", # required
})

Response structure


resp.transit_gateway_registration.global_network_id #=> String
resp.transit_gateway_registration.transit_gateway_arn #=> String
resp.transit_gateway_registration.state.code #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED", "FAILED"
resp.transit_gateway_registration.state.message #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :transit_gateway_arn (required, String)

    The Amazon Resource Name (ARN) of the transit gateway.

Returns:

See Also:

#describe_global_networks(options = {}) ⇒ Types::DescribeGlobalNetworksResponse

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

Examples:

Request syntax with placeholder values


resp = client.describe_global_networks({
  global_network_ids: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.global_networks #=> Array
resp.global_networks[0].global_network_id #=> String
resp.global_networks[0].global_network_arn #=> String
resp.global_networks[0].description #=> String
resp.global_networks[0].created_at #=> Time
resp.global_networks[0].state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.global_networks[0].tags #=> Array
resp.global_networks[0].tags[0].key #=> String
resp.global_networks[0].tags[0].value #=> String
resp.next_token #=> String

Options Hash (options):

  • :global_network_ids (Array<String>)

    The IDs of one or more global networks. The maximum is 10.

  • :max_results (Integer)

    The maximum number of results to return.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:

#disassociate_customer_gateway(options = {}) ⇒ Types::DisassociateCustomerGatewayResponse

Disassociates a customer gateway from a device and a link.

Examples:

Request syntax with placeholder values


resp = client.disassociate_customer_gateway({
  global_network_id: "String", # required
  customer_gateway_arn: "String", # required
})

Response structure


resp.customer_gateway_association.customer_gateway_arn #=> String
resp.customer_gateway_association.global_network_id #=> String
resp.customer_gateway_association.device_id #=> String
resp.customer_gateway_association.link_id #=> String
resp.customer_gateway_association.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED"

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :customer_gateway_arn (required, String)

    The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

Returns:

See Also:

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

Examples:

Request syntax with placeholder values


resp = client.disassociate_link({
  global_network_id: "String", # required
  device_id: "String", # required
  link_id: "String", # required
})

Response structure


resp.link_association.global_network_id #=> String
resp.link_association.device_id #=> String
resp.link_association.link_id #=> String
resp.link_association.link_association_state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED"

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_id (required, String)

    The ID of the device.

  • :link_id (required, String)

    The ID of the link.

Returns:

See Also:

#get_customer_gateway_associations(options = {}) ⇒ Types::GetCustomerGatewayAssociationsResponse

Gets the association information for customer gateways that are associated with devices and links in your global network.

Examples:

Request syntax with placeholder values


resp = client.get_customer_gateway_associations({
  global_network_id: "String", # required
  customer_gateway_arns: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.customer_gateway_associations #=> Array
resp.customer_gateway_associations[0].customer_gateway_arn #=> String
resp.customer_gateway_associations[0].global_network_id #=> String
resp.customer_gateway_associations[0].device_id #=> String
resp.customer_gateway_associations[0].link_id #=> String
resp.customer_gateway_associations[0].state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED"
resp.next_token #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :customer_gateway_arns (Array<String>)

    One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.

  • :max_results (Integer)

    The maximum number of results to return.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:

#get_devices(options = {}) ⇒ Types::GetDevicesResponse

Gets information about one or more of your devices in a global network.

Examples:

Request syntax with placeholder values


resp = client.get_devices({
  global_network_id: "String", # required
  device_ids: ["String"],
  site_id: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.devices #=> Array
resp.devices[0].device_id #=> String
resp.devices[0].device_arn #=> String
resp.devices[0].global_network_id #=> String
resp.devices[0].description #=> String
resp.devices[0].type #=> String
resp.devices[0].vendor #=> String
resp.devices[0].model #=> String
resp.devices[0].serial_number #=> String
resp.devices[0].location.address #=> String
resp.devices[0].location.latitude #=> String
resp.devices[0].location.longitude #=> String
resp.devices[0].site_id #=> String
resp.devices[0].created_at #=> Time
resp.devices[0].state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.devices[0].tags #=> Array
resp.devices[0].tags[0].key #=> String
resp.devices[0].tags[0].value #=> String
resp.next_token #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_ids (Array<String>)

    One or more device IDs. The maximum is 10.

  • :site_id (String)

    The ID of the site.

  • :max_results (Integer)

    The maximum number of results to return.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

Examples:

Request syntax with placeholder values


resp = client.get_link_associations({
  global_network_id: "String", # required
  device_id: "String",
  link_id: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.link_associations #=> Array
resp.link_associations[0].global_network_id #=> String
resp.link_associations[0].device_id #=> String
resp.link_associations[0].link_id #=> String
resp.link_associations[0].link_association_state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED"
resp.next_token #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_id (String)

    The ID of the device.

  • :link_id (String)

    The ID of the link.

  • :max_results (Integer)

    The maximum number of results to return.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

Examples:

Request syntax with placeholder values


resp = client.get_links({
  global_network_id: "String", # required
  link_ids: ["String"],
  site_id: "String",
  type: "String",
  provider: "String",
  max_results: 1,
  next_token: "String",
})

Response structure


resp.links #=> Array
resp.links[0].link_id #=> String
resp.links[0].link_arn #=> String
resp.links[0].global_network_id #=> String
resp.links[0].site_id #=> String
resp.links[0].description #=> String
resp.links[0].type #=> String
resp.links[0].bandwidth.upload_speed #=> Integer
resp.links[0].bandwidth.download_speed #=> Integer
resp.links[0].provider #=> String
resp.links[0].created_at #=> Time
resp.links[0].state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.links[0].tags #=> Array
resp.links[0].tags[0].key #=> String
resp.links[0].tags[0].value #=> String
resp.next_token #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :link_ids (Array<String>)

    One or more link IDs. The maximum is 10.

  • :site_id (String)

    The ID of the site.

  • :type (String)

    The link type.

  • :provider (String)

    The link provider.

  • :max_results (Integer)

    The maximum number of results to return.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:

#get_sites(options = {}) ⇒ Types::GetSitesResponse

Gets information about one or more of your sites in a global network.

Examples:

Request syntax with placeholder values


resp = client.get_sites({
  global_network_id: "String", # required
  site_ids: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.sites #=> Array
resp.sites[0].site_id #=> String
resp.sites[0].site_arn #=> String
resp.sites[0].global_network_id #=> String
resp.sites[0].description #=> String
resp.sites[0].location.address #=> String
resp.sites[0].location.latitude #=> String
resp.sites[0].location.longitude #=> String
resp.sites[0].created_at #=> Time
resp.sites[0].state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.sites[0].tags #=> Array
resp.sites[0].tags[0].key #=> String
resp.sites[0].tags[0].value #=> String
resp.next_token #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :site_ids (Array<String>)

    One or more site IDs. The maximum is 10.

  • :max_results (Integer)

    The maximum number of results to return.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:

#get_transit_gateway_registrations(options = {}) ⇒ Types::GetTransitGatewayRegistrationsResponse

Gets information about the transit gateway registrations in a specified global network.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_registrations({
  global_network_id: "String", # required
  transit_gateway_arns: ["String"],
  max_results: 1,
  next_token: "String",
})

Response structure


resp.transit_gateway_registrations #=> Array
resp.transit_gateway_registrations[0].global_network_id #=> String
resp.transit_gateway_registrations[0].transit_gateway_arn #=> String
resp.transit_gateway_registrations[0].state.code #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED", "FAILED"
resp.transit_gateway_registrations[0].state.message #=> String
resp.next_token #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :transit_gateway_arns (Array<String>)

    The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

  • :max_results (Integer)

    The maximum number of results to return.

  • :next_token (String)

    The token for the next page of results.

Returns:

See Also:

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

Lists the tags for a specified resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:

#register_transit_gateway(options = {}) ⇒ Types::RegisterTransitGatewayResponse

Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.

Examples:

Request syntax with placeholder values


resp = client.register_transit_gateway({
  global_network_id: "String", # required
  transit_gateway_arn: "String", # required
})

Response structure


resp.transit_gateway_registration.global_network_id #=> String
resp.transit_gateway_registration.transit_gateway_arn #=> String
resp.transit_gateway_registration.state.code #=> String, one of "PENDING", "AVAILABLE", "DELETING", "DELETED", "FAILED"
resp.transit_gateway_registration.state.message #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :transit_gateway_arn (required, String)

    The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Tags a specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceARN", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Array<Types::Tag>)

    The tags to apply to the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes tags from a specified resource.

Examples:

Request syntax with placeholder values


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

Options Hash (options):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>)

    The tag keys to remove from the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_device(options = {}) ⇒ Types::UpdateDeviceResponse

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

Examples:

Request syntax with placeholder values


resp = client.update_device({
  global_network_id: "String", # required
  device_id: "String", # required
  description: "String",
  type: "String",
  vendor: "String",
  model: "String",
  serial_number: "String",
  location: {
    address: "String",
    latitude: "String",
    longitude: "String",
  },
  site_id: "String",
})

Response structure


resp.device.device_id #=> String
resp.device.device_arn #=> String
resp.device.global_network_id #=> String
resp.device.description #=> String
resp.device.type #=> String
resp.device.vendor #=> String
resp.device.model #=> String
resp.device.serial_number #=> String
resp.device.location.address #=> String
resp.device.location.latitude #=> String
resp.device.location.longitude #=> String
resp.device.site_id #=> String
resp.device.created_at #=> Time
resp.device.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.device.tags #=> Array
resp.device.tags[0].key #=> String
resp.device.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_id (required, String)

    The ID of the device.

  • :description (String)

    A description of the device.

    Length Constraints: Maximum length of 256 characters.

  • :type (String)

    The type of the device.

  • :vendor (String)

    The vendor of the device.

    Length Constraints: Maximum length of 128 characters.

  • :model (String)

    The model of the device.

    Length Constraints: Maximum length of 128 characters.

  • :serial_number (String)

    The serial number of the device.

    Length Constraints: Maximum length of 128 characters.

  • :location (Types::Location)

    Describes a location.

  • :site_id (String)

    The ID of the site.

Returns:

See Also:

#update_global_network(options = {}) ⇒ Types::UpdateGlobalNetworkResponse

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

Examples:

Request syntax with placeholder values


resp = client.update_global_network({
  global_network_id: "String", # required
  description: "String",
})

Response structure


resp.global_network.global_network_id #=> String
resp.global_network.global_network_arn #=> String
resp.global_network.description #=> String
resp.global_network.created_at #=> Time
resp.global_network.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.global_network.tags #=> Array
resp.global_network.tags[0].key #=> String
resp.global_network.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of your global network.

  • :description (String)

    A description of the global network.

    Length Constraints: Maximum length of 256 characters.

Returns:

See Also:

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

Examples:

Request syntax with placeholder values


resp = client.update_link({
  global_network_id: "String", # required
  link_id: "String", # required
  description: "String",
  type: "String",
  bandwidth: {
    upload_speed: 1,
    download_speed: 1,
  },
  provider: "String",
})

Response structure


resp.link.link_id #=> String
resp.link.link_arn #=> String
resp.link.global_network_id #=> String
resp.link.site_id #=> String
resp.link.description #=> String
resp.link.type #=> String
resp.link.bandwidth.upload_speed #=> Integer
resp.link.bandwidth.download_speed #=> Integer
resp.link.provider #=> String
resp.link.created_at #=> Time
resp.link.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.link.tags #=> Array
resp.link.tags[0].key #=> String
resp.link.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :link_id (required, String)

    The ID of the link.

  • :description (String)

    A description of the link.

    Length Constraints: Maximum length of 256 characters.

  • :type (String)

    The type of the link.

    Length Constraints: Maximum length of 128 characters.

  • :bandwidth (Types::Bandwidth)

    The upload and download speed in Mbps.

  • :provider (String)

    The provider of the link.

    Length Constraints: Maximum length of 128 characters.

Returns:

See Also:

#update_site(options = {}) ⇒ Types::UpdateSiteResponse

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

Examples:

Request syntax with placeholder values


resp = client.update_site({
  global_network_id: "String", # required
  site_id: "String", # required
  description: "String",
  location: {
    address: "String",
    latitude: "String",
    longitude: "String",
  },
})

Response structure


resp.site.site_id #=> String
resp.site.site_arn #=> String
resp.site.global_network_id #=> String
resp.site.description #=> String
resp.site.location.address #=> String
resp.site.location.latitude #=> String
resp.site.location.longitude #=> String
resp.site.created_at #=> Time
resp.site.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.site.tags #=> Array
resp.site.tags[0].key #=> String
resp.site.tags[0].value #=> String

Options Hash (options):

  • :global_network_id (required, String)

    The ID of the global network.

  • :site_id (required, String)

    The ID of your site.

  • :description (String)

    A description of your site.

    Length Constraints: Maximum length of 256 characters.

  • :location (Types::Location)

    The site location:

    • Address: The physical address of the site.

    • Latitude: The latitude of the site.

    • Longitude: The longitude of the site.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.