Class: Aws::NetworkManager::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb

Overview

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

client = Aws::NetworkManager::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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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.

  • :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 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.

  • :validate_params (Boolean) — default: true

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

  • :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 (Integer) — 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.

  • :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.



305
306
307
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 305

def initialize(*args)
  super
end

Instance Method Details

#associate_customer_gateway(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :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:



373
374
375
376
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 373

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

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"

Parameters:

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

    ({})

Options Hash (params):

  • :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:



414
415
416
417
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 414

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

#create_device(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



509
510
511
512
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 509

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

#create_global_network(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



555
556
557
558
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 555

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



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

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

#create_site(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



708
709
710
711
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 708

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

#delete_device(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String)

    The ID of the global network.

  • :device_id (required, String)

    The ID of the device.

Returns:

See Also:



757
758
759
760
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 757

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

#delete_global_network(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String)

    The ID of the global network.

Returns:

See Also:



794
795
796
797
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 794

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String)

    The ID of the global network.

  • :link_id (required, String)

    The ID of the link.

Returns:

See Also:



840
841
842
843
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 840

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

#delete_site(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String)

    The ID of the global network.

  • :site_id (required, String)

    The ID of the site.

Returns:

See Also:



884
885
886
887
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 884

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

#deregister_transit_gateway(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



921
922
923
924
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 921

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

#describe_global_networks(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



973
974
975
976
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 973

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

#disassociate_customer_gateway(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1014
1015
1016
1017
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1014

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

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"

Parameters:

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

    ({})

Options Hash (params):

  • :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:



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

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

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

Gets the association information for customer gateways that are associated with devices and links in your global 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.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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1110
1111
1112
1113
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1110

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

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

Gets information about one or more of your devices in a global 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.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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1176
1177
1178
1179
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1176

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1229
1230
1231
1232
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1229

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

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1304
1305
1306
1307
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1304

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

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

Gets information about one or more of your sites in a global 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.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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1360
1361
1362
1363
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1360

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

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

Gets information about the transit gateway registrations in a specified global 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.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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1410
1411
1412
1413
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1410

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

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1440
1441
1442
1443
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1440

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

#register_transit_gateway(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1483
1484
1485
1486
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1483

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

#tag_resource(params = {}) ⇒ 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",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1514
1515
1516
1517
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1514

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

#untag_resource(params = {}) ⇒ 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
})

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 to remove from the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1540
1541
1542
1543
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1540

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

#update_device(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1629
1630
1631
1632
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1629

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

#update_global_network(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1671
1672
1673
1674
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1671

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1742
1743
1744
1745
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1742

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

#update_site(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



1806
1807
1808
1809
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1806

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