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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

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

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

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

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

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

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

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

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

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :endpoint (String) —

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

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

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

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

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

  • :token_provider (Aws::TokenProvider) —

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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

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

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

  • :http_open_timeout (Float) — default: 15 —

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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



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

def initialize(*args)
  super
end

Instance Method Details

#accept_attachment(params = {}) ⇒ Types::AcceptAttachmentResponse

Accepts a core network attachment request.

Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.

Examples:

Request syntax with placeholder values


resp = client.accept_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.attachment.core_network_id #=> String
resp.attachment.core_network_arn #=> String
resp.attachment.attachment_id #=> String
resp.attachment. #=> String
resp.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.attachment.edge_location #=> String
resp.attachment.resource_arn #=> String
resp.attachment.attachment_policy_rule_number #=> Integer
resp.attachment.segment_name #=> String
resp.attachment.tags #=> Array
resp.attachment.tags[0].key #=> String
resp.attachment.tags[0].value #=> String
resp.attachment.proposed_segment_change.tags #=> Array
resp.attachment.proposed_segment_change.tags[0].key #=> String
resp.attachment.proposed_segment_change.tags[0].value #=> String
resp.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.attachment.proposed_segment_change.segment_name #=> String
resp.attachment.created_at #=> Time
resp.attachment.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    The ID of the attachment.

Returns:

See Also:



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

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

#associate_connect_peer(params = {}) ⇒ Types::AssociateConnectPeerResponse

Associates a core network Connect peer 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 core network Connect peers that have been created on a core network Connect attachment on a core network.

Examples:

Request syntax with placeholder values


resp = client.associate_connect_peer({
  global_network_id: "GlobalNetworkId", # required
  connect_peer_id: "ConnectPeerId", # required
  device_id: "DeviceId", # required
  link_id: "LinkId",
})

Response structure


resp.connect_peer_association.connect_peer_id #=> String
resp.connect_peer_association.global_network_id #=> String
resp.connect_peer_association.device_id #=> String
resp.connect_peer_association.link_id #=> String
resp.connect_peer_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 your global network.

  • :connect_peer_id (required, String) —

    The ID of the Connect peer.

  • :device_id (required, String) —

    The ID of the device.

  • :link_id (String) —

    The ID of the link.

Returns:

See Also:



465
466
467
468
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 465

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

#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 or core network registered in your global network. When you register a transit gateway or core network, 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: "CustomerGatewayArn", # required
  global_network_id: "GlobalNetworkId", # required
  device_id: "DeviceId", # required
  link_id: "LinkId",
})

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.

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



527
528
529
530
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 527

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

#associate_link(params = {}) ⇒ Types::AssociateLinkResponse

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: "GlobalNetworkId", # required
  device_id: "DeviceId", # required
  link_id: "LinkId", # 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:



568
569
570
571
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 568

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

#associate_transit_gateway_connect_peer(params = {}) ⇒ Types::AssociateTransitGatewayConnectPeerResponse

Associates a transit gateway Connect peer 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 transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

Examples:

Request syntax with placeholder values


resp = client.associate_transit_gateway_connect_peer({
  global_network_id: "GlobalNetworkId", # required
  transit_gateway_connect_peer_arn: "TransitGatewayConnectPeerArn", # required
  device_id: "DeviceId", # required
  link_id: "LinkId",
})

Response structure


resp.transit_gateway_connect_peer_association.transit_gateway_connect_peer_arn #=> String
resp.transit_gateway_connect_peer_association.global_network_id #=> String
resp.transit_gateway_connect_peer_association.device_id #=> String
resp.transit_gateway_connect_peer_association.link_id #=> String
resp.transit_gateway_connect_peer_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.

  • :transit_gateway_connect_peer_arn (required, String) —

    The Amazon Resource Name (ARN) of the Connect peer.

  • :device_id (required, String) —

    The ID of the device.

  • :link_id (String) —

    The ID of the link.

Returns:

See Also:



621
622
623
624
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 621

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

#create_connect_attachment(params = {}) ⇒ Types::CreateConnectAttachmentResponse

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

Examples:

Request syntax with placeholder values


resp = client.create_connect_attachment({
  core_network_id: "CoreNetworkId", # required
  edge_location: "ExternalRegionCode", # required
  transport_attachment_id: "AttachmentId", # required
  options: { # required
    protocol: "GRE", # accepts GRE
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.connect_attachment.attachment.core_network_id #=> String
resp.connect_attachment.attachment.core_network_arn #=> String
resp.connect_attachment.attachment.attachment_id #=> String
resp.connect_attachment.attachment. #=> String
resp.connect_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.connect_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.connect_attachment.attachment.edge_location #=> String
resp.connect_attachment.attachment.resource_arn #=> String
resp.connect_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.connect_attachment.attachment.segment_name #=> String
resp.connect_attachment.attachment.tags #=> Array
resp.connect_attachment.attachment.tags[0].key #=> String
resp.connect_attachment.attachment.tags[0].value #=> String
resp.connect_attachment.attachment.proposed_segment_change.tags #=> Array
resp.connect_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.connect_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.connect_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.connect_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.connect_attachment.attachment.created_at #=> Time
resp.connect_attachment.attachment.updated_at #=> Time
resp.connect_attachment.transport_attachment_id #=> String
resp.connect_attachment.options.protocol #=> String, one of "GRE"

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network where you want to create the attachment.

  • :edge_location (required, String) —

    The Region where the edge is located.

  • :transport_attachment_id (required, String) —

    The ID of the attachment between the two connections.

  • :options (required, Types::ConnectAttachmentOptions) —

    Options for creating an attachment.

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

    The list of key-value tags associated with the request.

  • :client_token (String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



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

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

#create_connect_peer(params = {}) ⇒ Types::CreateConnectPeerResponse

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

Examples:

Request syntax with placeholder values


resp = client.create_connect_peer({
  connect_attachment_id: "AttachmentId", # required
  core_network_address: "IPAddress",
  peer_address: "IPAddress", # required
  bgp_options: {
    peer_asn: 1,
  },
  inside_cidr_blocks: ["ConstrainedString"], # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.connect_peer.core_network_id #=> String
resp.connect_peer.connect_attachment_id #=> String
resp.connect_peer.connect_peer_id #=> String
resp.connect_peer.edge_location #=> String
resp.connect_peer.state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.connect_peer.created_at #=> Time
resp.connect_peer.configuration.core_network_address #=> String
resp.connect_peer.configuration.peer_address #=> String
resp.connect_peer.configuration.inside_cidr_blocks #=> Array
resp.connect_peer.configuration.inside_cidr_blocks[0] #=> String
resp.connect_peer.configuration.protocol #=> String, one of "GRE"
resp.connect_peer.configuration.bgp_configurations #=> Array
resp.connect_peer.configuration.bgp_configurations[0].core_network_asn #=> Integer
resp.connect_peer.configuration.bgp_configurations[0].peer_asn #=> Integer
resp.connect_peer.configuration.bgp_configurations[0].core_network_address #=> String
resp.connect_peer.configuration.bgp_configurations[0].peer_address #=> String
resp.connect_peer.tags #=> Array
resp.connect_peer.tags[0].key #=> String
resp.connect_peer.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connect_attachment_id (required, String) —

    The ID of the connection attachment.

  • :core_network_address (String) —

    A Connect peer core network address.

  • :peer_address (required, String) —

    The Connect peer address.

  • :bgp_options (Types::BgpOptions) —

    The Connect peer BGP options.

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

    The inside IP addresses used for BGP peering.

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

    The tags associated with the peer request.

  • :client_token (String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



789
790
791
792
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 789

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

#create_connection(params = {}) ⇒ Types::CreateConnectionResponse

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  global_network_id: "GlobalNetworkId", # required
  device_id: "DeviceId", # required
  connected_device_id: "DeviceId", # required
  link_id: "LinkId",
  connected_link_id: "LinkId",
  description: "ConstrainedString",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.connection.connection_id #=> String
resp.connection.connection_arn #=> String
resp.connection.global_network_id #=> String
resp.connection.device_id #=> String
resp.connection.connected_device_id #=> String
resp.connection.link_id #=> String
resp.connection.connected_link_id #=> String
resp.connection.description #=> String
resp.connection.created_at #=> Time
resp.connection.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.connection.tags #=> Array
resp.connection.tags[0].key #=> String
resp.connection.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 first device in the connection.

  • :connected_device_id (required, String) —

    The ID of the second device in the connection.

  • :link_id (String) —

    The ID of the link for the first device.

  • :connected_link_id (String) —

    The ID of the link for the second device.

  • :description (String) —

    A description of the connection.

    Length Constraints: Maximum length of 256 characters.

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

    The tags to apply to the resource during creation.

Returns:

See Also:



863
864
865
866
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 863

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

#create_core_network(params = {}) ⇒ Types::CreateCoreNetworkResponse

Creates a core network as part of your global network, and optionally, with a core network policy.

Examples:

Request syntax with placeholder values


resp = client.create_core_network({
  global_network_id: "GlobalNetworkId", # required
  description: "ConstrainedString",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  policy_document: "CoreNetworkPolicyDocument",
  client_token: "ClientToken",
})

Response structure


resp.core_network.global_network_id #=> String
resp.core_network.core_network_id #=> String
resp.core_network.core_network_arn #=> String
resp.core_network.description #=> String
resp.core_network.created_at #=> Time
resp.core_network.state #=> String, one of "CREATING", "UPDATING", "AVAILABLE", "DELETING"
resp.core_network.segments #=> Array
resp.core_network.segments[0].name #=> String
resp.core_network.segments[0].edge_locations #=> Array
resp.core_network.segments[0].edge_locations[0] #=> String
resp.core_network.segments[0].shared_segments #=> Array
resp.core_network.segments[0].shared_segments[0] #=> String
resp.core_network.edges #=> Array
resp.core_network.edges[0].edge_location #=> String
resp.core_network.edges[0].asn #=> Integer
resp.core_network.edges[0].inside_cidr_blocks #=> Array
resp.core_network.edges[0].inside_cidr_blocks[0] #=> String
resp.core_network.tags #=> Array
resp.core_network.tags[0].key #=> String
resp.core_network.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network that a core network will be a part of.

  • :description (String) —

    The description of a core network.

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

    Key-value tags associated with a core network request.

  • :policy_document (String) —

    The policy document for creating a core network.

  • :client_token (String) —

    The client token associated with a core network request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



935
936
937
938
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 935

def create_core_network(params = {}, options = {})
  req = build_request(:create_core_network, 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: "GlobalNetworkId", # required
  aws_location: {
    zone: "ConstrainedString",
    subnet_arn: "SubnetArn",
  },
  description: "ConstrainedString",
  type: "ConstrainedString",
  vendor: "ConstrainedString",
  model: "ConstrainedString",
  serial_number: "ConstrainedString",
  location: {
    address: "ConstrainedString",
    latitude: "ConstrainedString",
    longitude: "ConstrainedString",
  },
  site_id: "SiteId",
  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.aws_location.zone #=> String
resp.device.aws_location.subnet_arn #=> 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.

  • :aws_location (Types::AWSLocation) —

    The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

  • :description (String) —

    A description of the device.

    Constraints: Maximum length of 256 characters.

  • :type (String) —

    The type of the device.

  • :vendor (String) —

    The vendor of the device.

    Constraints: Maximum length of 128 characters.

  • :model (String) —

    The model of the device.

    Constraints: Maximum length of 128 characters.

  • :serial_number (String) —

    The serial number of the device.

    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:



1040
1041
1042
1043
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1040

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: "ConstrainedString",
  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.

    Constraints: Maximum length of 256 characters.

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

    The tags to apply to the resource during creation.

Returns:

See Also:



1086
1087
1088
1089
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1086

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

#create_link(params = {}) ⇒ Types::CreateLinkResponse

Creates a new link for a specified site.

Examples:

Request syntax with placeholder values


resp = client.create_link({
  global_network_id: "GlobalNetworkId", # required
  description: "ConstrainedString",
  type: "ConstrainedString",
  bandwidth: { # required
    upload_speed: 1,
    download_speed: 1,
  },
  provider: "ConstrainedString",
  site_id: "SiteId", # 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.

    Constraints: Maximum length of 256 characters.

  • :type (String) —

    The type of the link.

    Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^

  • :bandwidth (required, Types::Bandwidth) —

    The upload speed and download speed in Mbps.

  • :provider (String) —

    The provider of the link.

    Constraints: Maximum length of 128 characters. Cannot include the following 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:



1167
1168
1169
1170
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1167

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: "GlobalNetworkId", # required
  description: "ConstrainedString",
  location: {
    address: "ConstrainedString",
    latitude: "ConstrainedString",
    longitude: "ConstrainedString",
  },
  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.

    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:



1237
1238
1239
1240
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1237

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

#create_site_to_site_vpn_attachment(params = {}) ⇒ Types::CreateSiteToSiteVpnAttachmentResponse

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

Examples:

Request syntax with placeholder values


resp = client.create_site_to_site_vpn_attachment({
  core_network_id: "CoreNetworkId", # required
  vpn_connection_arn: "VpnConnectionArn", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.site_to_site_vpn_attachment.attachment.core_network_id #=> String
resp.site_to_site_vpn_attachment.attachment.core_network_arn #=> String
resp.site_to_site_vpn_attachment.attachment.attachment_id #=> String
resp.site_to_site_vpn_attachment.attachment. #=> String
resp.site_to_site_vpn_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.site_to_site_vpn_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.site_to_site_vpn_attachment.attachment.edge_location #=> String
resp.site_to_site_vpn_attachment.attachment.resource_arn #=> String
resp.site_to_site_vpn_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.site_to_site_vpn_attachment.attachment.segment_name #=> String
resp.site_to_site_vpn_attachment.attachment.tags #=> Array
resp.site_to_site_vpn_attachment.attachment.tags[0].key #=> String
resp.site_to_site_vpn_attachment.attachment.tags[0].value #=> String
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.tags #=> Array
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.site_to_site_vpn_attachment.attachment.created_at #=> Time
resp.site_to_site_vpn_attachment.attachment.updated_at #=> Time
resp.site_to_site_vpn_attachment.vpn_connection_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network where you're creating a site-to-site VPN attachment.

  • :vpn_connection_arn (required, String) —

    The ARN identifying the VPN attachment.

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

    The tags associated with the request.

  • :client_token (String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1307
1308
1309
1310
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1307

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

#create_transit_gateway_peering(params = {}) ⇒ Types::CreateTransitGatewayPeeringResponse

Creates a transit gateway peering connection.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_peering({
  core_network_id: "CoreNetworkId", # required
  transit_gateway_arn: "TransitGatewayArn", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.transit_gateway_peering.peering.core_network_id #=> String
resp.transit_gateway_peering.peering.core_network_arn #=> String
resp.transit_gateway_peering.peering.peering_id #=> String
resp.transit_gateway_peering.peering. #=> String
resp.transit_gateway_peering.peering.peering_type #=> String, one of "TRANSIT_GATEWAY"
resp.transit_gateway_peering.peering.state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.transit_gateway_peering.peering.edge_location #=> String
resp.transit_gateway_peering.peering.resource_arn #=> String
resp.transit_gateway_peering.peering.tags #=> Array
resp.transit_gateway_peering.peering.tags[0].key #=> String
resp.transit_gateway_peering.peering.tags[0].value #=> String
resp.transit_gateway_peering.peering.created_at #=> Time
resp.transit_gateway_peering.transit_gateway_arn #=> String
resp.transit_gateway_peering.transit_gateway_peering_attachment_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :transit_gateway_arn (required, String) —

    The ARN of the transit gateway for the peering request.

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

    The list of key-value tags associated with the request.

  • :client_token (String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1368
1369
1370
1371
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1368

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

#create_transit_gateway_route_table_attachment(params = {}) ⇒ Types::CreateTransitGatewayRouteTableAttachmentResponse

Creates a transit gateway route table attachment.

Examples:

Request syntax with placeholder values


resp = client.create_transit_gateway_route_table_attachment({
  peering_id: "PeeringId", # required
  transit_gateway_route_table_arn: "TransitGatewayRouteTableArn", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.transit_gateway_route_table_attachment.attachment.core_network_id #=> String
resp.transit_gateway_route_table_attachment.attachment.core_network_arn #=> String
resp.transit_gateway_route_table_attachment.attachment.attachment_id #=> String
resp.transit_gateway_route_table_attachment.attachment. #=> String
resp.transit_gateway_route_table_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.transit_gateway_route_table_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.transit_gateway_route_table_attachment.attachment.edge_location #=> String
resp.transit_gateway_route_table_attachment.attachment.resource_arn #=> String
resp.transit_gateway_route_table_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.transit_gateway_route_table_attachment.attachment.segment_name #=> String
resp.transit_gateway_route_table_attachment.attachment.tags #=> Array
resp.transit_gateway_route_table_attachment.attachment.tags[0].key #=> String
resp.transit_gateway_route_table_attachment.attachment.tags[0].value #=> String
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.tags #=> Array
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.transit_gateway_route_table_attachment.attachment.created_at #=> Time
resp.transit_gateway_route_table_attachment.attachment.updated_at #=> Time
resp.transit_gateway_route_table_attachment.peering_id #=> String
resp.transit_gateway_route_table_attachment.transit_gateway_route_table_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :peering_id (required, String) —

    The ID of the peer for the

  • :transit_gateway_route_table_arn (required, String) —

    The ARN of the transit gateway route table for the attachment request.

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

    The list of key-value tags associated with the request.

  • :client_token (String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1437
1438
1439
1440
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1437

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

#create_vpc_attachment(params = {}) ⇒ Types::CreateVpcAttachmentResponse

Creates a VPC attachment on an edge location of a core network.

Examples:

Request syntax with placeholder values


resp = client.create_vpc_attachment({
  core_network_id: "CoreNetworkId", # required
  vpc_arn: "VpcArn", # required
  subnet_arns: ["SubnetArn"], # required
  options: {
    ipv_6_support: false,
    appliance_mode_support: false,
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.vpc_attachment.attachment.core_network_id #=> String
resp.vpc_attachment.attachment.core_network_arn #=> String
resp.vpc_attachment.attachment.attachment_id #=> String
resp.vpc_attachment.attachment. #=> String
resp.vpc_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.vpc_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.vpc_attachment.attachment.edge_location #=> String
resp.vpc_attachment.attachment.resource_arn #=> String
resp.vpc_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.vpc_attachment.attachment.segment_name #=> String
resp.vpc_attachment.attachment.tags #=> Array
resp.vpc_attachment.attachment.tags[0].key #=> String
resp.vpc_attachment.attachment.tags[0].value #=> String
resp.vpc_attachment.attachment.proposed_segment_change.tags #=> Array
resp.vpc_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.vpc_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.vpc_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.vpc_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.vpc_attachment.attachment.created_at #=> Time
resp.vpc_attachment.attachment.updated_at #=> Time
resp.vpc_attachment.subnet_arns #=> Array
resp.vpc_attachment.subnet_arns[0] #=> String
resp.vpc_attachment.options.ipv_6_support #=> Boolean
resp.vpc_attachment.options.appliance_mode_support #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network for the VPC attachment.

  • :vpc_arn (required, String) —

    The ARN of the VPC.

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

    The subnet ARN of the VPC attachment.

  • :options (Types::VpcOptions) —

    Options for the VPC attachment.

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

    The key-value tags associated with the request.

  • :client_token (String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1519
1520
1521
1522
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1519

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

#delete_attachment(params = {}) ⇒ Types::DeleteAttachmentResponse

Deletes an attachment. Supports all attachment types.

Examples:

Request syntax with placeholder values


resp = client.delete_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.attachment.core_network_id #=> String
resp.attachment.core_network_arn #=> String
resp.attachment.attachment_id #=> String
resp.attachment. #=> String
resp.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.attachment.edge_location #=> String
resp.attachment.resource_arn #=> String
resp.attachment.attachment_policy_rule_number #=> Integer
resp.attachment.segment_name #=> String
resp.attachment.tags #=> Array
resp.attachment.tags[0].key #=> String
resp.attachment.tags[0].value #=> String
resp.attachment.proposed_segment_change.tags #=> Array
resp.attachment.proposed_segment_change.tags[0].key #=> String
resp.attachment.proposed_segment_change.tags[0].value #=> String
resp.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.attachment.proposed_segment_change.segment_name #=> String
resp.attachment.created_at #=> Time
resp.attachment.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    The ID of the attachment to delete.

Returns:

See Also:



1566
1567
1568
1569
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1566

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

#delete_connect_peer(params = {}) ⇒ Types::DeleteConnectPeerResponse

Deletes a Connect peer.

Examples:

Request syntax with placeholder values


resp = client.delete_connect_peer({
  connect_peer_id: "ConnectPeerId", # required
})

Response structure


resp.connect_peer.core_network_id #=> String
resp.connect_peer.connect_attachment_id #=> String
resp.connect_peer.connect_peer_id #=> String
resp.connect_peer.edge_location #=> String
resp.connect_peer.state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.connect_peer.created_at #=> Time
resp.connect_peer.configuration.core_network_address #=> String
resp.connect_peer.configuration.peer_address #=> String
resp.connect_peer.configuration.inside_cidr_blocks #=> Array
resp.connect_peer.configuration.inside_cidr_blocks[0] #=> String
resp.connect_peer.configuration.protocol #=> String, one of "GRE"
resp.connect_peer.configuration.bgp_configurations #=> Array
resp.connect_peer.configuration.bgp_configurations[0].core_network_asn #=> Integer
resp.connect_peer.configuration.bgp_configurations[0].peer_asn #=> Integer
resp.connect_peer.configuration.bgp_configurations[0].core_network_address #=> String
resp.connect_peer.configuration.bgp_configurations[0].peer_address #=> String
resp.connect_peer.tags #=> Array
resp.connect_peer.tags[0].key #=> String
resp.connect_peer.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connect_peer_id (required, String) —

    The ID of the deleted Connect peer.

Returns:

See Also:



1612
1613
1614
1615
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1612

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

#delete_connection(params = {}) ⇒ Types::DeleteConnectionResponse

Deletes the specified connection in your global network.

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  global_network_id: "GlobalNetworkId", # required
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection.connection_id #=> String
resp.connection.connection_arn #=> String
resp.connection.global_network_id #=> String
resp.connection.device_id #=> String
resp.connection.connected_device_id #=> String
resp.connection.link_id #=> String
resp.connection.connected_link_id #=> String
resp.connection.description #=> String
resp.connection.created_at #=> Time
resp.connection.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.connection.tags #=> Array
resp.connection.tags[0].key #=> String
resp.connection.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :connection_id (required, String) —

    The ID of the connection.

Returns:

See Also:



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

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

#delete_core_network(params = {}) ⇒ Types::DeleteCoreNetworkResponse

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

Examples:

Request syntax with placeholder values


resp = client.delete_core_network({
  core_network_id: "CoreNetworkId", # required
})

Response structure


resp.core_network.global_network_id #=> String
resp.core_network.core_network_id #=> String
resp.core_network.core_network_arn #=> String
resp.core_network.description #=> String
resp.core_network.created_at #=> Time
resp.core_network.state #=> String, one of "CREATING", "UPDATING", "AVAILABLE", "DELETING"
resp.core_network.segments #=> Array
resp.core_network.segments[0].name #=> String
resp.core_network.segments[0].edge_locations #=> Array
resp.core_network.segments[0].edge_locations[0] #=> String
resp.core_network.segments[0].shared_segments #=> Array
resp.core_network.segments[0].shared_segments[0] #=> String
resp.core_network.edges #=> Array
resp.core_network.edges[0].edge_location #=> String
resp.core_network.edges[0].asn #=> Integer
resp.core_network.edges[0].inside_cidr_blocks #=> Array
resp.core_network.edges[0].inside_cidr_blocks[0] #=> String
resp.core_network.tags #=> Array
resp.core_network.tags[0].key #=> String
resp.core_network.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The network ID of the deleted core network.

Returns:

See Also:



1704
1705
1706
1707
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1704

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

#delete_core_network_policy_version(params = {}) ⇒ Types::DeleteCoreNetworkPolicyVersionResponse

Deletes a policy version from a core network. You can't delete the current LIVE policy.

Examples:

Request syntax with placeholder values


resp = client.delete_core_network_policy_version({
  core_network_id: "CoreNetworkId", # required
  policy_version_id: 1, # required
})

Response structure


resp.core_network_policy.core_network_id #=> String
resp.core_network_policy.policy_version_id #=> Integer
resp.core_network_policy.alias #=> String, one of "LIVE", "LATEST"
resp.core_network_policy.description #=> String
resp.core_network_policy.created_at #=> Time
resp.core_network_policy.change_set_state #=> String, one of "PENDING_GENERATION", "FAILED_GENERATION", "READY_TO_EXECUTE", "EXECUTING", "EXECUTION_SUCCEEDED", "OUT_OF_DATE"
resp.core_network_policy.policy_errors #=> Array
resp.core_network_policy.policy_errors[0].error_code #=> String
resp.core_network_policy.policy_errors[0].message #=> String
resp.core_network_policy.policy_errors[0].path #=> String
resp.core_network_policy.policy_document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network for the deleted policy.

  • :policy_version_id (required, Integer) —

    The version ID of the deleted policy.

Returns:

See Also:



1747
1748
1749
1750
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1747

def delete_core_network_policy_version(params = {}, options = {})
  req = build_request(:delete_core_network_policy_version, 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: "GlobalNetworkId", # required
  device_id: "DeviceId", # required
})

Response structure


resp.device.device_id #=> String
resp.device.device_arn #=> String
resp.device.global_network_id #=> String
resp.device.aws_location.zone #=> String
resp.device.aws_location.subnet_arn #=> 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:



1798
1799
1800
1801
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1798

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), deregister all transit gateways, and delete any core networks.

Examples:

Request syntax with placeholder values


resp = client.delete_global_network({
  global_network_id: "GlobalNetworkId", # 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:



1835
1836
1837
1838
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1835

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

#delete_link(params = {}) ⇒ Types::DeleteLinkResponse

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: "GlobalNetworkId", # required
  link_id: "LinkId", # 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:



1881
1882
1883
1884
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1881

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

#delete_peering(params = {}) ⇒ Types::DeletePeeringResponse

Deletes an existing peering connection.

Examples:

Request syntax with placeholder values


resp = client.delete_peering({
  peering_id: "PeeringId", # required
})

Response structure


resp.peering.core_network_id #=> String
resp.peering.core_network_arn #=> String
resp.peering.peering_id #=> String
resp.peering. #=> String
resp.peering.peering_type #=> String, one of "TRANSIT_GATEWAY"
resp.peering.state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.peering.edge_location #=> String
resp.peering.resource_arn #=> String
resp.peering.tags #=> Array
resp.peering.tags[0].key #=> String
resp.peering.tags[0].value #=> String
resp.peering.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :peering_id (required, String) —

    The ID of the peering connection to delete.

Returns:

See Also:



1920
1921
1922
1923
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1920

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

#delete_resource_policy(params = {}) ⇒ Struct

Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "ResourceArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the policy to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1943
1944
1945
1946
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1943

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, 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: "GlobalNetworkId", # required
  site_id: "SiteId", # 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:



1987
1988
1989
1990
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 1987

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: "GlobalNetworkId", # required
  transit_gateway_arn: "TransitGatewayArn", # 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:



2024
2025
2026
2027
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2024

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: ["GlobalNetworkId"],
  max_results: 1,
  next_token: "NextToken",
})

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:



2076
2077
2078
2079
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2076

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

#disassociate_connect_peer(params = {}) ⇒ Types::DisassociateConnectPeerResponse

Disassociates a core network Connect peer from a device and a link.

Examples:

Request syntax with placeholder values


resp = client.disassociate_connect_peer({
  global_network_id: "GlobalNetworkId", # required
  connect_peer_id: "ConnectPeerId", # required
})

Response structure


resp.connect_peer_association.connect_peer_id #=> String
resp.connect_peer_association.global_network_id #=> String
resp.connect_peer_association.device_id #=> String
resp.connect_peer_association.link_id #=> String
resp.connect_peer_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.

  • :connect_peer_id (required, String) —

    The ID of the Connect peer to disassociate from a device.

Returns:

See Also:



2112
2113
2114
2115
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2112

def disassociate_connect_peer(params = {}, options = {})
  req = build_request(:disassociate_connect_peer, 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: "GlobalNetworkId", # required
  customer_gateway_arn: "CustomerGatewayArn", # 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.

Returns:

See Also:



2148
2149
2150
2151
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2148

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

#disassociate_link(params = {}) ⇒ Types::DisassociateLinkResponse

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: "GlobalNetworkId", # required
  device_id: "DeviceId", # required
  link_id: "LinkId", # 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:



2188
2189
2190
2191
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2188

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

#disassociate_transit_gateway_connect_peer(params = {}) ⇒ Types::DisassociateTransitGatewayConnectPeerResponse

Disassociates a transit gateway Connect peer from a device and link.

Examples:

Request syntax with placeholder values


resp = client.disassociate_transit_gateway_connect_peer({
  global_network_id: "GlobalNetworkId", # required
  transit_gateway_connect_peer_arn: "TransitGatewayConnectPeerArn", # required
})

Response structure


resp.transit_gateway_connect_peer_association.transit_gateway_connect_peer_arn #=> String
resp.transit_gateway_connect_peer_association.global_network_id #=> String
resp.transit_gateway_connect_peer_association.device_id #=> String
resp.transit_gateway_connect_peer_association.link_id #=> String
resp.transit_gateway_connect_peer_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.

  • :transit_gateway_connect_peer_arn (required, String) —

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

Returns:

See Also:



2224
2225
2226
2227
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2224

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

#execute_core_network_change_set(params = {}) ⇒ Struct

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

Examples:

Request syntax with placeholder values


resp = client.execute_core_network_change_set({
  core_network_id: "CoreNetworkId", # required
  policy_version_id: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :policy_version_id (required, Integer) —

    The ID of the policy version.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2251
2252
2253
2254
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2251

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

#get_connect_attachment(params = {}) ⇒ Types::GetConnectAttachmentResponse

Returns information about a core network Connect attachment.

Examples:

Request syntax with placeholder values


resp = client.get_connect_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.connect_attachment.attachment.core_network_id #=> String
resp.connect_attachment.attachment.core_network_arn #=> String
resp.connect_attachment.attachment.attachment_id #=> String
resp.connect_attachment.attachment. #=> String
resp.connect_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.connect_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.connect_attachment.attachment.edge_location #=> String
resp.connect_attachment.attachment.resource_arn #=> String
resp.connect_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.connect_attachment.attachment.segment_name #=> String
resp.connect_attachment.attachment.tags #=> Array
resp.connect_attachment.attachment.tags[0].key #=> String
resp.connect_attachment.attachment.tags[0].value #=> String
resp.connect_attachment.attachment.proposed_segment_change.tags #=> Array
resp.connect_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.connect_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.connect_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.connect_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.connect_attachment.attachment.created_at #=> Time
resp.connect_attachment.attachment.updated_at #=> Time
resp.connect_attachment.transport_attachment_id #=> String
resp.connect_attachment.options.protocol #=> String, one of "GRE"

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    The ID of the attachment.

Returns:

See Also:



2300
2301
2302
2303
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2300

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

#get_connect_peer(params = {}) ⇒ Types::GetConnectPeerResponse

Returns information about a core network Connect peer.

Examples:

Request syntax with placeholder values


resp = client.get_connect_peer({
  connect_peer_id: "ConnectPeerId", # required
})

Response structure


resp.connect_peer.core_network_id #=> String
resp.connect_peer.connect_attachment_id #=> String
resp.connect_peer.connect_peer_id #=> String
resp.connect_peer.edge_location #=> String
resp.connect_peer.state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.connect_peer.created_at #=> Time
resp.connect_peer.configuration.core_network_address #=> String
resp.connect_peer.configuration.peer_address #=> String
resp.connect_peer.configuration.inside_cidr_blocks #=> Array
resp.connect_peer.configuration.inside_cidr_blocks[0] #=> String
resp.connect_peer.configuration.protocol #=> String, one of "GRE"
resp.connect_peer.configuration.bgp_configurations #=> Array
resp.connect_peer.configuration.bgp_configurations[0].core_network_asn #=> Integer
resp.connect_peer.configuration.bgp_configurations[0].peer_asn #=> Integer
resp.connect_peer.configuration.bgp_configurations[0].core_network_address #=> String
resp.connect_peer.configuration.bgp_configurations[0].peer_address #=> String
resp.connect_peer.tags #=> Array
resp.connect_peer.tags[0].key #=> String
resp.connect_peer.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connect_peer_id (required, String) —

    The ID of the Connect peer.

Returns:

See Also:



2346
2347
2348
2349
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2346

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

#get_connect_peer_associations(params = {}) ⇒ Types::GetConnectPeerAssociationsResponse

Returns information about a core network Connect peer associations.

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_connect_peer_associations({
  global_network_id: "GlobalNetworkId", # required
  connect_peer_ids: ["ConnectPeerId"],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connect_peer_associations #=> Array
resp.connect_peer_associations[0].connect_peer_id #=> String
resp.connect_peer_associations[0].global_network_id #=> String
resp.connect_peer_associations[0].device_id #=> String
resp.connect_peer_associations[0].link_id #=> String
resp.connect_peer_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.

  • :connect_peer_ids (Array<String>) —

    The IDs of the Connect peers.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



2395
2396
2397
2398
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2395

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

#get_connections(params = {}) ⇒ Types::GetConnectionsResponse

Gets information about one or more of your connections 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_connections({
  global_network_id: "GlobalNetworkId", # required
  connection_ids: ["ConnectionId"],
  device_id: "DeviceId",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connections #=> Array
resp.connections[0].connection_id #=> String
resp.connections[0].connection_arn #=> String
resp.connections[0].global_network_id #=> String
resp.connections[0].device_id #=> String
resp.connections[0].connected_device_id #=> String
resp.connections[0].link_id #=> String
resp.connections[0].connected_link_id #=> String
resp.connections[0].description #=> String
resp.connections[0].created_at #=> Time
resp.connections[0].state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.connections[0].tags #=> Array
resp.connections[0].tags[0].key #=> String
resp.connections[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.

  • :connection_ids (Array<String>) —

    One or more connection IDs.

  • :device_id (String) —

    The ID of the device.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



2457
2458
2459
2460
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2457

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

#get_core_network(params = {}) ⇒ Types::GetCoreNetworkResponse

Returns information about the LIVE policy for a core network.

Examples:

Request syntax with placeholder values


resp = client.get_core_network({
  core_network_id: "CoreNetworkId", # required
})

Response structure


resp.core_network.global_network_id #=> String
resp.core_network.core_network_id #=> String
resp.core_network.core_network_arn #=> String
resp.core_network.description #=> String
resp.core_network.created_at #=> Time
resp.core_network.state #=> String, one of "CREATING", "UPDATING", "AVAILABLE", "DELETING"
resp.core_network.segments #=> Array
resp.core_network.segments[0].name #=> String
resp.core_network.segments[0].edge_locations #=> Array
resp.core_network.segments[0].edge_locations[0] #=> String
resp.core_network.segments[0].shared_segments #=> Array
resp.core_network.segments[0].shared_segments[0] #=> String
resp.core_network.edges #=> Array
resp.core_network.edges[0].edge_location #=> String
resp.core_network.edges[0].asn #=> Integer
resp.core_network.edges[0].inside_cidr_blocks #=> Array
resp.core_network.edges[0].inside_cidr_blocks[0] #=> String
resp.core_network.tags #=> Array
resp.core_network.tags[0].key #=> String
resp.core_network.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

Returns:

See Also:



2504
2505
2506
2507
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2504

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

#get_core_network_change_events(params = {}) ⇒ Types::GetCoreNetworkChangeEventsResponse

Returns information about a core network change event.

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_core_network_change_events({
  core_network_id: "CoreNetworkId", # required
  policy_version_id: 1, # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.core_network_change_events #=> Array
resp.core_network_change_events[0].type #=> String, one of "CORE_NETWORK_SEGMENT", "CORE_NETWORK_EDGE", "ATTACHMENT_MAPPING", "ATTACHMENT_ROUTE_PROPAGATION", "ATTACHMENT_ROUTE_STATIC", "CORE_NETWORK_CONFIGURATION", "SEGMENTS_CONFIGURATION", "SEGMENT_ACTIONS_CONFIGURATION", "ATTACHMENT_POLICIES_CONFIGURATION"
resp.core_network_change_events[0].action #=> String, one of "ADD", "MODIFY", "REMOVE"
resp.core_network_change_events[0].identifier_path #=> String
resp.core_network_change_events[0].event_time #=> Time
resp.core_network_change_events[0].status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "FAILED"
resp.core_network_change_events[0].values.edge_location #=> String
resp.core_network_change_events[0].values.segment_name #=> String
resp.core_network_change_events[0].values.attachment_id #=> String
resp.core_network_change_events[0].values.cidr #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :policy_version_id (required, Integer) —

    The ID of the policy version.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



2557
2558
2559
2560
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2557

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

#get_core_network_change_set(params = {}) ⇒ Types::GetCoreNetworkChangeSetResponse

Returns a change set between the LIVE core network policy and a submitted policy.

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_core_network_change_set({
  core_network_id: "CoreNetworkId", # required
  policy_version_id: 1, # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.core_network_changes #=> Array
resp.core_network_changes[0].type #=> String, one of "CORE_NETWORK_SEGMENT", "CORE_NETWORK_EDGE", "ATTACHMENT_MAPPING", "ATTACHMENT_ROUTE_PROPAGATION", "ATTACHMENT_ROUTE_STATIC", "CORE_NETWORK_CONFIGURATION", "SEGMENTS_CONFIGURATION", "SEGMENT_ACTIONS_CONFIGURATION", "ATTACHMENT_POLICIES_CONFIGURATION"
resp.core_network_changes[0].action #=> String, one of "ADD", "MODIFY", "REMOVE"
resp.core_network_changes[0].identifier #=> String
resp.core_network_changes[0].previous_values.segment_name #=> String
resp.core_network_changes[0].previous_values.edge_locations #=> Array
resp.core_network_changes[0].previous_values.edge_locations[0] #=> String
resp.core_network_changes[0].previous_values.asn #=> Integer
resp.core_network_changes[0].previous_values.cidr #=> String
resp.core_network_changes[0].previous_values.destination_identifier #=> String
resp.core_network_changes[0].previous_values.inside_cidr_blocks #=> Array
resp.core_network_changes[0].previous_values.inside_cidr_blocks[0] #=> String
resp.core_network_changes[0].previous_values.shared_segments #=> Array
resp.core_network_changes[0].previous_values.shared_segments[0] #=> String
resp.core_network_changes[0].new_values.segment_name #=> String
resp.core_network_changes[0].new_values.edge_locations #=> Array
resp.core_network_changes[0].new_values.edge_locations[0] #=> String
resp.core_network_changes[0].new_values.asn #=> Integer
resp.core_network_changes[0].new_values.cidr #=> String
resp.core_network_changes[0].new_values.destination_identifier #=> String
resp.core_network_changes[0].new_values.inside_cidr_blocks #=> Array
resp.core_network_changes[0].new_values.inside_cidr_blocks[0] #=> String
resp.core_network_changes[0].new_values.shared_segments #=> Array
resp.core_network_changes[0].new_values.shared_segments[0] #=> String
resp.core_network_changes[0].identifier_path #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :policy_version_id (required, Integer) —

    The ID of the policy version.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



2626
2627
2628
2629
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2626

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

#get_core_network_policy(params = {}) ⇒ Types::GetCoreNetworkPolicyResponse

Returns details about a core network policy. You can get details about your current live policy or any previous policy version.

Examples:

Request syntax with placeholder values


resp = client.get_core_network_policy({
  core_network_id: "CoreNetworkId", # required
  policy_version_id: 1,
  alias: "LIVE", # accepts LIVE, LATEST
})

Response structure


resp.core_network_policy.core_network_id #=> String
resp.core_network_policy.policy_version_id #=> Integer
resp.core_network_policy.alias #=> String, one of "LIVE", "LATEST"
resp.core_network_policy.description #=> String
resp.core_network_policy.created_at #=> Time
resp.core_network_policy.change_set_state #=> String, one of "PENDING_GENERATION", "FAILED_GENERATION", "READY_TO_EXECUTE", "EXECUTING", "EXECUTION_SUCCEEDED", "OUT_OF_DATE"
resp.core_network_policy.policy_errors #=> Array
resp.core_network_policy.policy_errors[0].error_code #=> String
resp.core_network_policy.policy_errors[0].message #=> String
resp.core_network_policy.policy_errors[0].path #=> String
resp.core_network_policy.policy_document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :policy_version_id (Integer) —

    The ID of a core network policy version.

  • :alias (String) —

    The alias of a core network policy

Returns:

See Also:



2673
2674
2675
2676
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2673

def get_core_network_policy(params = {}, options = {})
  req = build_request(:get_core_network_policy, 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: "GlobalNetworkId", # required
  customer_gateway_arns: ["CustomerGatewayArn"],
  max_results: 1,
  next_token: "NextToken",
})

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



2724
2725
2726
2727
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2724

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: "GlobalNetworkId", # required
  device_ids: ["DeviceId"],
  site_id: "SiteId",
  max_results: 1,
  next_token: "NextToken",
})

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].aws_location.zone #=> String
resp.devices[0].aws_location.subnet_arn #=> 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:



2792
2793
2794
2795
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2792

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

#get_link_associations(params = {}) ⇒ Types::GetLinkAssociationsResponse

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: "GlobalNetworkId", # required
  device_id: "DeviceId",
  link_id: "LinkId",
  max_results: 1,
  next_token: "NextToken",
})

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:



2845
2846
2847
2848
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2845

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

#get_links(params = {}) ⇒ Types::GetLinksResponse

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: "GlobalNetworkId", # required
  link_ids: ["LinkId"],
  site_id: "SiteId",
  type: "ConstrainedString",
  provider: "ConstrainedString",
  max_results: 1,
  next_token: "NextToken",
})

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:



2920
2921
2922
2923
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2920

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

#get_network_resource_counts(params = {}) ⇒ Types::GetNetworkResourceCountsResponse

Gets the count of network resources, by resource type, for the 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_network_resource_counts({
  global_network_id: "GlobalNetworkId", # required
  resource_type: "ConstrainedString",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.network_resource_counts #=> Array
resp.network_resource_counts[0].resource_type #=> String
resp.network_resource_counts[0].count #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :resource_type (String) —

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon

    • dx-gateway

    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection

    • device

    • link

    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway

    • transit-gateway

    • transit-gateway-attachment

    • transit-gateway-connect-peer

    • transit-gateway-route-table

    • vpn-connection

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



2999
3000
3001
3002
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 2999

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

#get_network_resource_relationships(params = {}) ⇒ Types::GetNetworkResourceRelationshipsResponse

Gets the network resource relationships for the 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_network_resource_relationships({
  global_network_id: "GlobalNetworkId", # required
  core_network_id: "CoreNetworkId",
  registered_gateway_arn: "ResourceArn",
  aws_region: "ExternalRegionCode",
  account_id: "AWSAccountId",
  resource_type: "ConstrainedString",
  resource_arn: "ResourceArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.relationships #=> Array
resp.relationships[0].from #=> String
resp.relationships[0].to #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :core_network_id (String) —

    The ID of a core network.

  • :registered_gateway_arn (String) —

    The ARN of the registered gateway.

  • :aws_region (String) —

    The Amazon Web Services Region.

  • :account_id (String) —

    The Amazon Web Services account ID.

  • :resource_type (String) —

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon

    • dx-gateway

    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection

    • device

    • link

    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway

    • transit-gateway

    • transit-gateway-attachment

    • transit-gateway-connect-peer

    • transit-gateway-route-table

    • vpn-connection

  • :resource_arn (String) —

    The ARN of the gateway.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



3098
3099
3100
3101
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3098

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

#get_network_resources(params = {}) ⇒ Types::GetNetworkResourcesResponse

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

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_network_resources({
  global_network_id: "GlobalNetworkId", # required
  core_network_id: "CoreNetworkId",
  registered_gateway_arn: "ResourceArn",
  aws_region: "ExternalRegionCode",
  account_id: "AWSAccountId",
  resource_type: "ConstrainedString",
  resource_arn: "ResourceArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.network_resources #=> Array
resp.network_resources[0].registered_gateway_arn #=> String
resp.network_resources[0].core_network_id #=> String
resp.network_resources[0].aws_region #=> String
resp.network_resources[0]. #=> String
resp.network_resources[0].resource_type #=> String
resp.network_resources[0].resource_id #=> String
resp.network_resources[0].resource_arn #=> String
resp.network_resources[0].definition #=> String
resp.network_resources[0].definition_timestamp #=> Time
resp.network_resources[0].tags #=> Array
resp.network_resources[0].tags[0].key #=> String
resp.network_resources[0].tags[0].value #=> String
resp.network_resources[0].metadata #=> Hash
resp.network_resources[0].metadata["ConstrainedString"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :core_network_id (String) —

    The ID of a core network.

  • :registered_gateway_arn (String) —

    The ARN of the gateway.

  • :aws_region (String) —

    The Amazon Web Services Region.

  • :account_id (String) —

    The Amazon Web Services account ID.

  • :resource_type (String) —

    The resource type.

    The following are the supported resource types for Direct Connect:

    The following are the supported resource types for Network Manager:

    • connection - The definition model is Connection.

    • device - The definition model is Device.

    • link - The definition model is Link.

    • site - The definition model is Site.

    The following are the supported resource types for Amazon VPC:

  • :resource_arn (String) —

    The ARN of the resource.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



3231
3232
3233
3234
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3231

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

#get_network_routes(params = {}) ⇒ Types::GetNetworkRoutesResponse

Gets the network routes of the specified global network.

Examples:

Request syntax with placeholder values


resp = client.get_network_routes({
  global_network_id: "GlobalNetworkId", # required
  route_table_identifier: { # required
    transit_gateway_route_table_arn: "TransitGatewayRouteTableArn",
    core_network_segment_edge: {
      core_network_id: "CoreNetworkId",
      segment_name: "ConstrainedString",
      edge_location: "ExternalRegionCode",
    },
  },
  exact_cidr_matches: ["ConstrainedString"],
  longest_prefix_matches: ["ConstrainedString"],
  subnet_of_matches: ["ConstrainedString"],
  supernet_of_matches: ["ConstrainedString"],
  prefix_list_ids: ["ConstrainedString"],
  states: ["ACTIVE"], # accepts ACTIVE, BLACKHOLE
  types: ["PROPAGATED"], # accepts PROPAGATED, STATIC
  destination_filters: {
    "FilterName" => ["FilterValue"],
  },
})

Response structure


resp.route_table_arn #=> String
resp.core_network_segment_edge.core_network_id #=> String
resp.core_network_segment_edge.segment_name #=> String
resp.core_network_segment_edge.edge_location #=> String
resp.route_table_type #=> String, one of "TRANSIT_GATEWAY_ROUTE_TABLE", "CORE_NETWORK_SEGMENT"
resp.route_table_timestamp #=> Time
resp.network_routes #=> Array
resp.network_routes[0].destination_cidr_block #=> String
resp.network_routes[0].destinations #=> Array
resp.network_routes[0].destinations[0].core_network_attachment_id #=> String
resp.network_routes[0].destinations[0].transit_gateway_attachment_id #=> String
resp.network_routes[0].destinations[0].segment_name #=> String
resp.network_routes[0].destinations[0].edge_location #=> String
resp.network_routes[0].destinations[0].resource_type #=> String
resp.network_routes[0].destinations[0].resource_id #=> String
resp.network_routes[0].prefix_list_id #=> String
resp.network_routes[0].state #=> String, one of "ACTIVE", "BLACKHOLE"
resp.network_routes[0].type #=> String, one of "PROPAGATED", "STATIC"

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :route_table_identifier (required, Types::RouteTableIdentifier) —

    The ID of the route table.

  • :exact_cidr_matches (Array<String>) —

    An exact CIDR block.

  • :longest_prefix_matches (Array<String>) —

    The most specific route that matches the traffic (longest prefix match).

  • :subnet_of_matches (Array<String>) —

    The routes with a subnet that match the specified CIDR filter.

  • :supernet_of_matches (Array<String>) —

    The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

  • :prefix_list_ids (Array<String>) —

    The IDs of the prefix lists.

  • :states (Array<String>) —

    The route states.

  • :types (Array<String>) —

    The route types.

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

    Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

Returns:

See Also:



3328
3329
3330
3331
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3328

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

#get_network_telemetry(params = {}) ⇒ Types::GetNetworkTelemetryResponse

Gets the network telemetry of the 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_network_telemetry({
  global_network_id: "GlobalNetworkId", # required
  core_network_id: "CoreNetworkId",
  registered_gateway_arn: "ResourceArn",
  aws_region: "ExternalRegionCode",
  account_id: "AWSAccountId",
  resource_type: "ConstrainedString",
  resource_arn: "ResourceArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.network_telemetry #=> Array
resp.network_telemetry[0].registered_gateway_arn #=> String
resp.network_telemetry[0].core_network_id #=> String
resp.network_telemetry[0].aws_region #=> String
resp.network_telemetry[0]. #=> String
resp.network_telemetry[0].resource_type #=> String
resp.network_telemetry[0].resource_id #=> String
resp.network_telemetry[0].resource_arn #=> String
resp.network_telemetry[0].address #=> String
resp.network_telemetry[0].health.type #=> String, one of "BGP", "IPSEC"
resp.network_telemetry[0].health.status #=> String, one of "UP", "DOWN"
resp.network_telemetry[0].health.timestamp #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :core_network_id (String) —

    The ID of a core network.

  • :registered_gateway_arn (String) —

    The ARN of the gateway.

  • :aws_region (String) —

    The Amazon Web Services Region.

  • :account_id (String) —

    The Amazon Web Services account ID.

  • :resource_type (String) —

    The resource type.

    The following are the supported resource types for Direct Connect:

    • dxcon

    • dx-gateway

    • dx-vif

    The following are the supported resource types for Network Manager:

    • connection

    • device

    • link

    • site

    The following are the supported resource types for Amazon VPC:

    • customer-gateway

    • transit-gateway

    • transit-gateway-attachment

    • transit-gateway-connect-peer

    • transit-gateway-route-table

    • vpn-connection

  • :resource_arn (String) —

    The ARN of the resource.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



3435
3436
3437
3438
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3435

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

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Returns information about a resource policy.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.policy_document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

Returns:

See Also:



3463
3464
3465
3466
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3463

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

#get_route_analysis(params = {}) ⇒ Types::GetRouteAnalysisResponse

Gets information about the specified route analysis.

Examples:

Request syntax with placeholder values


resp = client.get_route_analysis({
  global_network_id: "GlobalNetworkId", # required
  route_analysis_id: "ConstrainedString", # required
})

Response structure


resp.route_analysis.global_network_id #=> String
resp.route_analysis. #=> String
resp.route_analysis.route_analysis_id #=> String
resp.route_analysis.start_timestamp #=> Time
resp.route_analysis.status #=> String, one of "RUNNING", "COMPLETED", "FAILED"
resp.route_analysis.source.transit_gateway_attachment_arn #=> String
resp.route_analysis.source.transit_gateway_arn #=> String
resp.route_analysis.source.ip_address #=> String
resp.route_analysis.destination.transit_gateway_attachment_arn #=> String
resp.route_analysis.destination.transit_gateway_arn #=> String
resp.route_analysis.destination.ip_address #=> String
resp.route_analysis.include_return_path #=> Boolean
resp.route_analysis.use_middleboxes #=> Boolean
resp.route_analysis.forward_path.completion_status.result_code #=> String, one of "CONNECTED", "NOT_CONNECTED"
resp.route_analysis.forward_path.completion_status.reason_code #=> String, one of "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY", "CYCLIC_PATH_DETECTED", "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND", "ROUTE_NOT_FOUND", "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND", "INACTIVE_ROUTE_FOR_DESTINATION_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH", "MAX_HOPS_EXCEEDED", "POSSIBLE_MIDDLEBOX", "NO_DESTINATION_ARN_PROVIDED"
resp.route_analysis.forward_path.completion_status.reason_context #=> Hash
resp.route_analysis.forward_path.completion_status.reason_context["ReasonContextKey"] #=> String
resp.route_analysis.forward_path.path #=> Array
resp.route_analysis.forward_path.path[0].sequence #=> Integer
resp.route_analysis.forward_path.path[0].resource.registered_gateway_arn #=> String
resp.route_analysis.forward_path.path[0].resource.resource_arn #=> String
resp.route_analysis.forward_path.path[0].resource.resource_type #=> String
resp.route_analysis.forward_path.path[0].resource.definition #=> String
resp.route_analysis.forward_path.path[0].resource.name_tag #=> String
resp.route_analysis.forward_path.path[0].resource.is_middlebox #=> Boolean
resp.route_analysis.forward_path.path[0].destination_cidr_block #=> String
resp.route_analysis.return_path.completion_status.result_code #=> String, one of "CONNECTED", "NOT_CONNECTED"
resp.route_analysis.return_path.completion_status.reason_code #=> String, one of "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY", "CYCLIC_PATH_DETECTED", "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND", "ROUTE_NOT_FOUND", "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND", "INACTIVE_ROUTE_FOR_DESTINATION_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH", "MAX_HOPS_EXCEEDED", "POSSIBLE_MIDDLEBOX", "NO_DESTINATION_ARN_PROVIDED"
resp.route_analysis.return_path.completion_status.reason_context #=> Hash
resp.route_analysis.return_path.completion_status.reason_context["ReasonContextKey"] #=> String
resp.route_analysis.return_path.path #=> Array
resp.route_analysis.return_path.path[0].sequence #=> Integer
resp.route_analysis.return_path.path[0].resource.registered_gateway_arn #=> String
resp.route_analysis.return_path.path[0].resource.resource_arn #=> String
resp.route_analysis.return_path.path[0].resource.resource_type #=> String
resp.route_analysis.return_path.path[0].resource.definition #=> String
resp.route_analysis.return_path.path[0].resource.name_tag #=> String
resp.route_analysis.return_path.path[0].resource.is_middlebox #=> Boolean
resp.route_analysis.return_path.path[0].destination_cidr_block #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :route_analysis_id (required, String) —

    The ID of the route analysis.

Returns:

See Also:



3533
3534
3535
3536
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3533

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

#get_site_to_site_vpn_attachment(params = {}) ⇒ Types::GetSiteToSiteVpnAttachmentResponse

Returns information about a site-to-site VPN attachment.

Examples:

Request syntax with placeholder values


resp = client.get_site_to_site_vpn_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.site_to_site_vpn_attachment.attachment.core_network_id #=> String
resp.site_to_site_vpn_attachment.attachment.core_network_arn #=> String
resp.site_to_site_vpn_attachment.attachment.attachment_id #=> String
resp.site_to_site_vpn_attachment.attachment. #=> String
resp.site_to_site_vpn_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.site_to_site_vpn_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.site_to_site_vpn_attachment.attachment.edge_location #=> String
resp.site_to_site_vpn_attachment.attachment.resource_arn #=> String
resp.site_to_site_vpn_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.site_to_site_vpn_attachment.attachment.segment_name #=> String
resp.site_to_site_vpn_attachment.attachment.tags #=> Array
resp.site_to_site_vpn_attachment.attachment.tags[0].key #=> String
resp.site_to_site_vpn_attachment.attachment.tags[0].value #=> String
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.tags #=> Array
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.site_to_site_vpn_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.site_to_site_vpn_attachment.attachment.created_at #=> Time
resp.site_to_site_vpn_attachment.attachment.updated_at #=> Time
resp.site_to_site_vpn_attachment.vpn_connection_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    The ID of the attachment.

Returns:

See Also:



3581
3582
3583
3584
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3581

def get_site_to_site_vpn_attachment(params = {}, options = {})
  req = build_request(:get_site_to_site_vpn_attachment, 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: "GlobalNetworkId", # required
  site_ids: ["SiteId"],
  max_results: 1,
  next_token: "NextToken",
})

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:



3637
3638
3639
3640
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3637

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

#get_transit_gateway_connect_peer_associations(params = {}) ⇒ Types::GetTransitGatewayConnectPeerAssociationsResponse

Gets information about one or more of your transit gateway Connect peer associations 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_transit_gateway_connect_peer_associations({
  global_network_id: "GlobalNetworkId", # required
  transit_gateway_connect_peer_arns: ["TransitGatewayConnectPeerArn"],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.transit_gateway_connect_peer_associations #=> Array
resp.transit_gateway_connect_peer_associations[0].transit_gateway_connect_peer_arn #=> String
resp.transit_gateway_connect_peer_associations[0].global_network_id #=> String
resp.transit_gateway_connect_peer_associations[0].device_id #=> String
resp.transit_gateway_connect_peer_associations[0].link_id #=> String
resp.transit_gateway_connect_peer_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.

  • :transit_gateway_connect_peer_arns (Array<String>) —

    One or more transit gateway Connect peer Amazon Resource Names (ARNs).

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



3687
3688
3689
3690
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3687

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

#get_transit_gateway_peering(params = {}) ⇒ Types::GetTransitGatewayPeeringResponse

Returns information about a transit gateway peer.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_peering({
  peering_id: "PeeringId", # required
})

Response structure


resp.transit_gateway_peering.peering.core_network_id #=> String
resp.transit_gateway_peering.peering.core_network_arn #=> String
resp.transit_gateway_peering.peering.peering_id #=> String
resp.transit_gateway_peering.peering. #=> String
resp.transit_gateway_peering.peering.peering_type #=> String, one of "TRANSIT_GATEWAY"
resp.transit_gateway_peering.peering.state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.transit_gateway_peering.peering.edge_location #=> String
resp.transit_gateway_peering.peering.resource_arn #=> String
resp.transit_gateway_peering.peering.tags #=> Array
resp.transit_gateway_peering.peering.tags[0].key #=> String
resp.transit_gateway_peering.peering.tags[0].value #=> String
resp.transit_gateway_peering.peering.created_at #=> Time
resp.transit_gateway_peering.transit_gateway_arn #=> String
resp.transit_gateway_peering.transit_gateway_peering_attachment_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :peering_id (required, String) —

    The ID of the peering request.

Returns:

See Also:



3728
3729
3730
3731
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3728

def get_transit_gateway_peering(params = {}, options = {})
  req = build_request(:get_transit_gateway_peering, 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: "GlobalNetworkId", # required
  transit_gateway_arns: ["TransitGatewayArn"],
  max_results: 1,
  next_token: "NextToken",
})

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:



3778
3779
3780
3781
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3778

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

#get_transit_gateway_route_table_attachment(params = {}) ⇒ Types::GetTransitGatewayRouteTableAttachmentResponse

Returns information about a transit gateway route table attachment.

Examples:

Request syntax with placeholder values


resp = client.get_transit_gateway_route_table_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.transit_gateway_route_table_attachment.attachment.core_network_id #=> String
resp.transit_gateway_route_table_attachment.attachment.core_network_arn #=> String
resp.transit_gateway_route_table_attachment.attachment.attachment_id #=> String
resp.transit_gateway_route_table_attachment.attachment. #=> String
resp.transit_gateway_route_table_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.transit_gateway_route_table_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.transit_gateway_route_table_attachment.attachment.edge_location #=> String
resp.transit_gateway_route_table_attachment.attachment.resource_arn #=> String
resp.transit_gateway_route_table_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.transit_gateway_route_table_attachment.attachment.segment_name #=> String
resp.transit_gateway_route_table_attachment.attachment.tags #=> Array
resp.transit_gateway_route_table_attachment.attachment.tags[0].key #=> String
resp.transit_gateway_route_table_attachment.attachment.tags[0].value #=> String
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.tags #=> Array
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.transit_gateway_route_table_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.transit_gateway_route_table_attachment.attachment.created_at #=> Time
resp.transit_gateway_route_table_attachment.attachment.updated_at #=> Time
resp.transit_gateway_route_table_attachment.peering_id #=> String
resp.transit_gateway_route_table_attachment.transit_gateway_route_table_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    The ID of the transit gateway route table attachment.

Returns:

See Also:



3827
3828
3829
3830
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3827

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

#get_vpc_attachment(params = {}) ⇒ Types::GetVpcAttachmentResponse

Returns information about a VPC attachment.

Examples:

Request syntax with placeholder values


resp = client.get_vpc_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.vpc_attachment.attachment.core_network_id #=> String
resp.vpc_attachment.attachment.core_network_arn #=> String
resp.vpc_attachment.attachment.attachment_id #=> String
resp.vpc_attachment.attachment. #=> String
resp.vpc_attachment.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.vpc_attachment.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.vpc_attachment.attachment.edge_location #=> String
resp.vpc_attachment.attachment.resource_arn #=> String
resp.vpc_attachment.attachment.attachment_policy_rule_number #=> Integer
resp.vpc_attachment.attachment.segment_name #=> String
resp.vpc_attachment.attachment.tags #=> Array
resp.vpc_attachment.attachment.tags[0].key #=> String
resp.vpc_attachment.attachment.tags[0].value #=> String
resp.vpc_attachment.attachment.proposed_segment_change.tags #=> Array
resp.vpc_attachment.attachment.proposed_segment_change.tags[0].key #=> String
resp.vpc_attachment.attachment.proposed_segment_change.tags[0].value #=> String
resp.vpc_attachment.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.vpc_attachment.attachment.proposed_segment_change.segment_name #=> String
resp.vpc_attachment.attachment.created_at #=> Time
resp.vpc_attachment.attachment.updated_at #=> Time
resp.vpc_attachment.subnet_arns #=> Array
resp.vpc_attachment.subnet_arns[0] #=> String
resp.vpc_attachment.options.ipv_6_support #=> Boolean
resp.vpc_attachment.options.appliance_mode_support #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    The ID of the attachment.

Returns:

See Also:



3878
3879
3880
3881
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3878

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

#list_attachments(params = {}) ⇒ Types::ListAttachmentsResponse

Returns a list of core network attachments.

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

Examples:

Request syntax with placeholder values


resp = client.list_attachments({
  core_network_id: "CoreNetworkId",
  attachment_type: "CONNECT", # accepts CONNECT, SITE_TO_SITE_VPN, VPC, TRANSIT_GATEWAY_ROUTE_TABLE
  edge_location: "ExternalRegionCode",
  state: "REJECTED", # accepts REJECTED, PENDING_ATTACHMENT_ACCEPTANCE, CREATING, FAILED, AVAILABLE, UPDATING, PENDING_NETWORK_UPDATE, PENDING_TAG_ACCEPTANCE, DELETING
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.attachments #=> Array
resp.attachments[0].core_network_id #=> String
resp.attachments[0].core_network_arn #=> String
resp.attachments[0].attachment_id #=> String
resp.attachments[0]. #=> String
resp.attachments[0].attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.attachments[0].state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.attachments[0].edge_location #=> String
resp.attachments[0].resource_arn #=> String
resp.attachments[0].attachment_policy_rule_number #=> Integer
resp.attachments[0].segment_name #=> String
resp.attachments[0].tags #=> Array
resp.attachments[0].tags[0].key #=> String
resp.attachments[0].tags[0].value #=> String
resp.attachments[0].proposed_segment_change.tags #=> Array
resp.attachments[0].proposed_segment_change.tags[0].key #=> String
resp.attachments[0].proposed_segment_change.tags[0].value #=> String
resp.attachments[0].proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.attachments[0].proposed_segment_change.segment_name #=> String
resp.attachments[0].created_at #=> Time
resp.attachments[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (String) —

    The ID of a core network.

  • :attachment_type (String) —

    The type of attachment.

  • :edge_location (String) —

    The Region where the edge is located.

  • :state (String) —

    The state of the attachment.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



3950
3951
3952
3953
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 3950

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

#list_connect_peers(params = {}) ⇒ Types::ListConnectPeersResponse

Returns a list of core network Connect peers.

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

Examples:

Request syntax with placeholder values


resp = client.list_connect_peers({
  core_network_id: "CoreNetworkId",
  connect_attachment_id: "AttachmentId",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connect_peers #=> Array
resp.connect_peers[0].core_network_id #=> String
resp.connect_peers[0].connect_attachment_id #=> String
resp.connect_peers[0].connect_peer_id #=> String
resp.connect_peers[0].edge_location #=> String
resp.connect_peers[0].connect_peer_state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.connect_peers[0].created_at #=> Time
resp.connect_peers[0].tags #=> Array
resp.connect_peers[0].tags[0].key #=> String
resp.connect_peers[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (String) —

    The ID of a core network.

  • :connect_attachment_id (String) —

    The ID of the attachment.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



4003
4004
4005
4006
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4003

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

#list_core_network_policy_versions(params = {}) ⇒ Types::ListCoreNetworkPolicyVersionsResponse

Returns a list of core network policy versions.

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

Examples:

Request syntax with placeholder values


resp = client.list_core_network_policy_versions({
  core_network_id: "CoreNetworkId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.core_network_policy_versions #=> Array
resp.core_network_policy_versions[0].core_network_id #=> String
resp.core_network_policy_versions[0].policy_version_id #=> Integer
resp.core_network_policy_versions[0].alias #=> String, one of "LIVE", "LATEST"
resp.core_network_policy_versions[0].description #=> String
resp.core_network_policy_versions[0].created_at #=> Time
resp.core_network_policy_versions[0].change_set_state #=> String, one of "PENDING_GENERATION", "FAILED_GENERATION", "READY_TO_EXECUTE", "EXECUTING", "EXECUTION_SUCCEEDED", "OUT_OF_DATE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



4049
4050
4051
4052
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4049

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

#list_core_networks(params = {}) ⇒ Types::ListCoreNetworksResponse

Returns a list of owned and shared core networks.

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

Examples:

Request syntax with placeholder values


resp = client.list_core_networks({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.core_networks #=> Array
resp.core_networks[0].core_network_id #=> String
resp.core_networks[0].core_network_arn #=> String
resp.core_networks[0].global_network_id #=> String
resp.core_networks[0]. #=> String
resp.core_networks[0].state #=> String, one of "CREATING", "UPDATING", "AVAILABLE", "DELETING"
resp.core_networks[0].description #=> String
resp.core_networks[0].tags #=> Array
resp.core_networks[0].tags[0].key #=> String
resp.core_networks[0].tags[0].value #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



4094
4095
4096
4097
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4094

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

#list_organization_service_access_status(params = {}) ⇒ Types::ListOrganizationServiceAccessStatusResponse

Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

Examples:

Request syntax with placeholder values


resp = client.list_organization_service_access_status({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.organization_status.organization_id #=> String
resp.organization_status.organization_aws_service_access_status #=> String
resp.organization_status.slr_deployment_status #=> String
resp.organization_status. #=> Array
resp.organization_status.[0]. #=> String
resp.organization_status.[0].slr_deployment_status #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



4134
4135
4136
4137
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4134

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

#list_peerings(params = {}) ⇒ Types::ListPeeringsResponse

Lists the peerings for a core network.

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

Examples:

Request syntax with placeholder values


resp = client.list_peerings({
  core_network_id: "CoreNetworkId",
  peering_type: "TRANSIT_GATEWAY", # accepts TRANSIT_GATEWAY
  edge_location: "ExternalRegionCode",
  state: "CREATING", # accepts CREATING, FAILED, AVAILABLE, DELETING
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.peerings #=> Array
resp.peerings[0].core_network_id #=> String
resp.peerings[0].core_network_arn #=> String
resp.peerings[0].peering_id #=> String
resp.peerings[0]. #=> String
resp.peerings[0].peering_type #=> String, one of "TRANSIT_GATEWAY"
resp.peerings[0].state #=> String, one of "CREATING", "FAILED", "AVAILABLE", "DELETING"
resp.peerings[0].edge_location #=> String
resp.peerings[0].resource_arn #=> String
resp.peerings[0].tags #=> Array
resp.peerings[0].tags[0].key #=> String
resp.peerings[0].tags[0].value #=> String
resp.peerings[0].created_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (String) —

    The ID of a core network.

  • :peering_type (String) —

    Returns a list of a peering requests.

  • :edge_location (String) —

    Returns a list edge locations for the

  • :state (String) —

    Returns a list of the peering request states.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The token for the next page of results.

Returns:

See Also:



4198
4199
4200
4201
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4198

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



4228
4229
4230
4231
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4228

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

#put_core_network_policy(params = {}) ⇒ Types::PutCoreNetworkPolicyResponse

Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.

Examples:

Request syntax with placeholder values


resp = client.put_core_network_policy({
  core_network_id: "CoreNetworkId", # required
  policy_document: "CoreNetworkPolicyDocument", # required
  description: "ConstrainedString",
  latest_version_id: 1,
  client_token: "ClientToken",
})

Response structure


resp.core_network_policy.core_network_id #=> String
resp.core_network_policy.policy_version_id #=> Integer
resp.core_network_policy.alias #=> String, one of "LIVE", "LATEST"
resp.core_network_policy.description #=> String
resp.core_network_policy.created_at #=> Time
resp.core_network_policy.change_set_state #=> String, one of "PENDING_GENERATION", "FAILED_GENERATION", "READY_TO_EXECUTE", "EXECUTING", "EXECUTION_SUCCEEDED", "OUT_OF_DATE"
resp.core_network_policy.policy_errors #=> Array
resp.core_network_policy.policy_errors[0].error_code #=> String
resp.core_network_policy.policy_errors[0].message #=> String
resp.core_network_policy.policy_errors[0].path #=> String
resp.core_network_policy.policy_document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :policy_document (required, String) —

    The policy document.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :description (String) —

    a core network policy description.

  • :latest_version_id (Integer) —

    The ID of a core network policy.

  • :client_token (String) —

    The client token associated with the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



4291
4292
4293
4294
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4291

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

#put_resource_policy(params = {}) ⇒ Struct

Creates or updates a resource policy.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  policy_document: "ResourcePolicyDocument", # required
  resource_arn: "ResourceArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :policy_document (required, String) —

    The JSON resource policy document.

    SDK automatically handles json encoding and base64 encoding for you when the required value (Hash, Array, etc.) is provided according to the description.

  • :resource_arn (required, String) —

    The ARN of the resource policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4321
4322
4323
4324
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4321

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

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

Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services 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: "GlobalNetworkId", # required
  transit_gateway_arn: "TransitGatewayArn", # 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:



4367
4368
4369
4370
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4367

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

#reject_attachment(params = {}) ⇒ Types::RejectAttachmentResponse

Rejects a core network attachment request.

Examples:

Request syntax with placeholder values


resp = client.reject_attachment({
  attachment_id: "AttachmentId", # required
})

Response structure


resp.attachment.core_network_id #=> String
resp.attachment.core_network_arn #=> String
resp.attachment.attachment_id #=> String
resp.attachment. #=> String
resp.attachment.attachment_type #=> String, one of "CONNECT", "SITE_TO_SITE_VPN", "VPC", "TRANSIT_GATEWAY_ROUTE_TABLE"
resp.attachment.state #=> String, one of "REJECTED", "PENDING_ATTACHMENT_ACCEPTANCE", "CREATING", "FAILED", "AVAILABLE", "UPDATING", "PENDING_NETWORK_UPDATE", "PENDING_TAG_ACCEPTANCE", "DELETING"
resp.attachment.edge_location #=> String
resp.attachment.resource_arn #=> String
resp.attachment.attachment_policy_rule_number #=> Integer
resp.attachment.segment_name #=> String
resp.attachment.tags #=> Array
resp.attachment.tags[0].key #=> String
resp.attachment.tags[0].value #=> String
resp.attachment.proposed_segment_change.tags #=> Array
resp.attachment.proposed_segment_change.tags[0].key #=> String
resp.attachment.proposed_segment_change.tags[0].value #=> String
resp.attachment.proposed_segment_change.attachment_policy_rule_number #=> Integer
resp.attachment.proposed_segment_change.segment_name #=> String
resp.attachment.created_at #=> Time
resp.attachment.updated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :attachment_id (required, String) —

    The ID of the attachment.

Returns:

See Also:



4414
4415
4416
4417
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4414

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

#restore_core_network_policy_version(params = {}) ⇒ Types::RestoreCoreNetworkPolicyVersionResponse

Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.

Examples:

Request syntax with placeholder values


resp = client.restore_core_network_policy_version({
  core_network_id: "CoreNetworkId", # required
  policy_version_id: 1, # required
})

Response structure


resp.core_network_policy.core_network_id #=> String
resp.core_network_policy.policy_version_id #=> Integer
resp.core_network_policy.alias #=> String, one of "LIVE", "LATEST"
resp.core_network_policy.description #=> String
resp.core_network_policy.created_at #=> Time
resp.core_network_policy.change_set_state #=> String, one of "PENDING_GENERATION", "FAILED_GENERATION", "READY_TO_EXECUTE", "EXECUTING", "EXECUTION_SUCCEEDED", "OUT_OF_DATE"
resp.core_network_policy.policy_errors #=> Array
resp.core_network_policy.policy_errors[0].error_code #=> String
resp.core_network_policy.policy_errors[0].message #=> String
resp.core_network_policy.policy_errors[0].path #=> String
resp.core_network_policy.policy_document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :policy_version_id (required, Integer) —

    The ID of the policy version to restore.

Returns:

See Also:



4458
4459
4460
4461
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4458

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

#start_organization_service_access_update(params = {}) ⇒ Types::StartOrganizationServiceAccessUpdateResponse

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

Examples:

Request syntax with placeholder values


resp = client.start_organization_service_access_update({
  action: "Action", # required
})

Response structure


resp.organization_status.organization_id #=> String
resp.organization_status.organization_aws_service_access_status #=> String
resp.organization_status.slr_deployment_status #=> String
resp.organization_status. #=> Array
resp.organization_status.[0]. #=> String
resp.organization_status.[0].slr_deployment_status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :action (required, String) —

    The action to take for the update request. This can be either ENABLE or DISABLE.

Returns:

See Also:



4494
4495
4496
4497
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4494

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

#start_route_analysis(params = {}) ⇒ Types::StartRouteAnalysisResponse

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

Examples:

Request syntax with placeholder values


resp = client.start_route_analysis({
  global_network_id: "GlobalNetworkId", # required
  source: { # required
    transit_gateway_attachment_arn: "TransitGatewayAttachmentArn",
    ip_address: "IPAddress",
  },
  destination: { # required
    transit_gateway_attachment_arn: "TransitGatewayAttachmentArn",
    ip_address: "IPAddress",
  },
  include_return_path: false,
  use_middleboxes: false,
})

Response structure


resp.route_analysis.global_network_id #=> String
resp.route_analysis. #=> String
resp.route_analysis.route_analysis_id #=> String
resp.route_analysis.start_timestamp #=> Time
resp.route_analysis.status #=> String, one of "RUNNING", "COMPLETED", "FAILED"
resp.route_analysis.source.transit_gateway_attachment_arn #=> String
resp.route_analysis.source.transit_gateway_arn #=> String
resp.route_analysis.source.ip_address #=> String
resp.route_analysis.destination.transit_gateway_attachment_arn #=> String
resp.route_analysis.destination.transit_gateway_arn #=> String
resp.route_analysis.destination.ip_address #=> String
resp.route_analysis.include_return_path #=> Boolean
resp.route_analysis.use_middleboxes #=> Boolean
resp.route_analysis.forward_path.completion_status.result_code #=> String, one of "CONNECTED", "NOT_CONNECTED"
resp.route_analysis.forward_path.completion_status.reason_code #=> String, one of "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY", "CYCLIC_PATH_DETECTED", "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND", "ROUTE_NOT_FOUND", "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND", "INACTIVE_ROUTE_FOR_DESTINATION_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH", "MAX_HOPS_EXCEEDED", "POSSIBLE_MIDDLEBOX", "NO_DESTINATION_ARN_PROVIDED"
resp.route_analysis.forward_path.completion_status.reason_context #=> Hash
resp.route_analysis.forward_path.completion_status.reason_context["ReasonContextKey"] #=> String
resp.route_analysis.forward_path.path #=> Array
resp.route_analysis.forward_path.path[0].sequence #=> Integer
resp.route_analysis.forward_path.path[0].resource.registered_gateway_arn #=> String
resp.route_analysis.forward_path.path[0].resource.resource_arn #=> String
resp.route_analysis.forward_path.path[0].resource.resource_type #=> String
resp.route_analysis.forward_path.path[0].resource.definition #=> String
resp.route_analysis.forward_path.path[0].resource.name_tag #=> String
resp.route_analysis.forward_path.path[0].resource.is_middlebox #=> Boolean
resp.route_analysis.forward_path.path[0].destination_cidr_block #=> String
resp.route_analysis.return_path.completion_status.result_code #=> String, one of "CONNECTED", "NOT_CONNECTED"
resp.route_analysis.return_path.completion_status.reason_code #=> String, one of "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY", "CYCLIC_PATH_DETECTED", "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND", "ROUTE_NOT_FOUND", "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND", "INACTIVE_ROUTE_FOR_DESTINATION_FOUND", "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH", "MAX_HOPS_EXCEEDED", "POSSIBLE_MIDDLEBOX", "NO_DESTINATION_ARN_PROVIDED"
resp.route_analysis.return_path.completion_status.reason_context #=> Hash
resp.route_analysis.return_path.completion_status.reason_context["ReasonContextKey"] #=> String
resp.route_analysis.return_path.path #=> Array
resp.route_analysis.return_path.path[0].sequence #=> Integer
resp.route_analysis.return_path.path[0].resource.registered_gateway_arn #=> String
resp.route_analysis.return_path.path[0].resource.resource_arn #=> String
resp.route_analysis.return_path.path[0].resource.resource_type #=> String
resp.route_analysis.return_path.path[0].resource.definition #=> String
resp.route_analysis.return_path.path[0].resource.name_tag #=> String
resp.route_analysis.return_path.path[0].resource.is_middlebox #=> Boolean
resp.route_analysis.return_path.path[0].destination_cidr_block #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :source (required, Types::RouteAnalysisEndpointOptionsSpecification) —

    The source from which traffic originates.

  • :destination (required, Types::RouteAnalysisEndpointOptionsSpecification) —

    The destination.

  • :include_return_path (Boolean) —

    Indicates whether to analyze the return path. The default is false.

  • :use_middleboxes (Boolean) —

    Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

Returns:

See Also:



4588
4589
4590
4591
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4588

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



4619
4620
4621
4622
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4619

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:



4645
4646
4647
4648
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4645

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

#update_connection(params = {}) ⇒ Types::UpdateConnectionResponse

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

Examples:

Request syntax with placeholder values


resp = client.update_connection({
  global_network_id: "GlobalNetworkId", # required
  connection_id: "ConnectionId", # required
  link_id: "LinkId",
  connected_link_id: "LinkId",
  description: "ConstrainedString",
})

Response structure


resp.connection.connection_id #=> String
resp.connection.connection_arn #=> String
resp.connection.global_network_id #=> String
resp.connection.device_id #=> String
resp.connection.connected_device_id #=> String
resp.connection.link_id #=> String
resp.connection.connected_link_id #=> String
resp.connection.description #=> String
resp.connection.created_at #=> Time
resp.connection.state #=> String, one of "PENDING", "AVAILABLE", "DELETING", "UPDATING"
resp.connection.tags #=> Array
resp.connection.tags[0].key #=> String
resp.connection.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :global_network_id (required, String) —

    The ID of the global network.

  • :connection_id (required, String) —

    The ID of the connection.

  • :link_id (String) —

    The ID of the link for the first device in the connection.

  • :connected_link_id (String) —

    The ID of the link for the second device in the connection.

  • :description (String) —

    A description of the connection.

    Length Constraints: Maximum length of 256 characters.

Returns:

See Also:



4704
4705
4706
4707
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4704

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

#update_core_network(params = {}) ⇒ Types::UpdateCoreNetworkResponse

Updates the description of a core network.

Examples:

Request syntax with placeholder values


resp = client.update_core_network({
  core_network_id: "CoreNetworkId", # required
  description: "ConstrainedString",
})

Response structure


resp.core_network.global_network_id #=> String
resp.core_network.core_network_id #=> String
resp.core_network.core_network_arn #=> String
resp.core_network.description #=> String
resp.core_network.created_at #=> Time
resp.core_network.state #=> String, one of "CREATING", "UPDATING", "AVAILABLE", "DELETING"
resp.core_network.segments #=> Array
resp.core_network.segments[0].name #=> String
resp.core_network.segments[0].edge_locations #=> Array
resp.core_network.segments[0].edge_locations[0] #=> String
resp.core_network.segments[0].shared_segments #=> Array
resp.core_network.segments[0].shared_segments[0] #=> String
resp.core_network.edges #=> Array
resp.core_network.edges[0].edge_location #=> String
resp.core_network.edges[0].asn #=> Integer
resp.core_network.edges[0].inside_cidr_blocks #=> Array
resp.core_network.edges[0].inside_cidr_blocks[0] #=> String
resp.core_network.tags #=> Array
resp.core_network.tags[0].key #=> String
resp.core_network.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :core_network_id (required, String) —

    The ID of a core network.

  • :description (String) —

    The description of the update.

Returns:

See Also:



4755
4756
4757
4758
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4755

def update_core_network(params = {}, options = {})
  req = build_request(:update_core_network, 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: "GlobalNetworkId", # required
  device_id: "DeviceId", # required
  aws_location: {
    zone: "ConstrainedString",
    subnet_arn: "SubnetArn",
  },
  description: "ConstrainedString",
  type: "ConstrainedString",
  vendor: "ConstrainedString",
  model: "ConstrainedString",
  serial_number: "ConstrainedString",
  location: {
    address: "ConstrainedString",
    latitude: "ConstrainedString",
    longitude: "ConstrainedString",
  },
  site_id: "SiteId",
})

Response structure


resp.device.device_id #=> String
resp.device.device_arn #=> String
resp.device.global_network_id #=> String
resp.device.aws_location.zone #=> String
resp.device.aws_location.subnet_arn #=> 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.

  • :aws_location (Types::AWSLocation) —

    The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

  • :description (String) —

    A description of the device.

    Constraints: Maximum length of 256 characters.

  • :type (String) —

    The type of the device.

  • :vendor (String) —

    The vendor of the device.

    Constraints: Maximum length of 128 characters.

  • :model (String) —

    The model of the device.

    Constraints: Maximum length of 128 characters.

  • :serial_number (String) —

    The serial number of the device.

    Constraints: Maximum length of 128 characters.

  • :location (Types::Location) —

    Describes a location.

  • :site_id (String) —

    The ID of the site.

Returns:

See Also:



4854
4855
4856
4857
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4854

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: "GlobalNetworkId", # required
  description: "ConstrainedString",
})

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.

    Constraints: Maximum length of 256 characters.

Returns:

See Also:



4896
4897
4898
4899
 
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/client.rb', line 4896

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