You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.NetworkManager

Inherits:
AWS.Service show all
Identifier:
networkmanager
API Version:
2019-07-05
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your Amazon Web Services and on-premises networks that are built around transit gateways.

Sending a Request Using NetworkManager

var networkmanager = new AWS.NetworkManager();
networkmanager.associateCustomerGateway(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the NetworkManager object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var networkmanager = new AWS.NetworkManager({apiVersion: '2019-07-05'});

You can also set the API version globally in AWS.config.apiVersions using the networkmanager service identifier:

AWS.config.apiVersions = {
  networkmanager: '2019-07-05',
  // other service API versions
};

var networkmanager = new AWS.NetworkManager();

Version:

  • 2019-07-05

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.NetworkManager(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a NetworkManager object

var networkmanager = new AWS.NetworkManager({apiVersion: '2019-07-05'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.NetworkManager.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.NetworkManager.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.NetworkManager.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateCustomerGateway(params = {}, callback) ⇒ AWS.Request

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

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

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

Service Reference:

Examples:

Calling the associateCustomerGateway operation

var params = {
  CustomerGatewayArn: 'STRING_VALUE', /* required */
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  LinkId: 'STRING_VALUE'
};
networkmanager.associateCustomerGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CustomerGatewayArn — (String)

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

    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceId — (String)

      The ID of the device.

    • LinkId — (String)

      The ID of the link.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomerGatewayAssociation — (map)

        The customer gateway association.

        • CustomerGatewayArn — (String)

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

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the device.

        • LinkId — (String)

          The ID of the link.

        • State — (String)

          The association state.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateLink(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateLink operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  LinkId: 'STRING_VALUE' /* required */
};
networkmanager.associateLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceId — (String)

      The ID of the device.

    • LinkId — (String)

      The ID of the link.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LinkAssociation — (map)

        The link association.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The device ID for the link association.

        • LinkId — (String)

          The ID of the link.

        • LinkAssociationState — (String)

          The state of the association.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateTransitGatewayConnectPeer(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateTransitGatewayConnectPeer operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  TransitGatewayConnectPeerArn: 'STRING_VALUE', /* required */
  LinkId: 'STRING_VALUE'
};
networkmanager.associateTransitGatewayConnectPeer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • TransitGatewayConnectPeerArn — (String)

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

    • DeviceId — (String)

      The ID of the device.

    • LinkId — (String)

      The ID of the link.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayConnectPeerAssociation — (map)

        The transit gateway Connect peer association.

        • TransitGatewayConnectPeerArn — (String)

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

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the device.

        • LinkId — (String)

          The ID of the link.

        • State — (String)

          The state of the association.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createConnection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createConnection operation

var params = {
  ConnectedDeviceId: 'STRING_VALUE', /* required */
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  ConnectedLinkId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  LinkId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceId — (String)

      The ID of the first device in the connection.

    • ConnectedDeviceId — (String)

      The ID of the second device in the connection.

    • LinkId — (String)

      The ID of the link for the first device.

    • ConnectedLinkId — (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<map>)

      The tags to apply to the resource during creation.

      • Key — (String)

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value — (String)

        The tag value.

        Constraints: Maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connection — (map)

        Information about the connection.

        • ConnectionId — (String)

          The ID of the connection.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of the connection.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the first device in the connection.

        • ConnectedDeviceId — (String)

          The ID of the second device in the connection.

        • LinkId — (String)

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

        • ConnectedLinkId — (String)

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

        • Description — (String)

          The description of the connection.

        • CreatedAt — (Date)

          The date and time that the connection was created.

        • State — (String)

          The state of the connection.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the connection.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDevice(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createDevice operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  AWSLocation: {
    SubnetArn: 'STRING_VALUE',
    Zone: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  Location: {
    Address: 'STRING_VALUE',
    Latitude: 'STRING_VALUE',
    Longitude: 'STRING_VALUE'
  },
  Model: 'STRING_VALUE',
  SerialNumber: 'STRING_VALUE',
  SiteId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Type: 'STRING_VALUE',
  Vendor: 'STRING_VALUE'
};
networkmanager.createDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • AWSLocation — (map)

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

      • Zone — (String)

        The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

      • SubnetArn — (String)

        The Amazon Resource Name (ARN) of the subnet that the device is located in.

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

    • SerialNumber — (String)

      The serial number of the device.

      Constraints: Maximum length of 128 characters.

    • Location — (map)

      The location of the device.

      • Address — (String)

        The physical address.

      • Latitude — (String)

        The latitude.

      • Longitude — (String)

        The longitude.

    • SiteId — (String)

      The ID of the site.

    • Tags — (Array<map>)

      The tags to apply to the resource during creation.

      • Key — (String)

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value — (String)

        The tag value.

        Constraints: Maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Device — (map)

        Information about the device.

        • DeviceId — (String)

          The ID of the device.

        • DeviceArn — (String)

          The Amazon Resource Name (ARN) of the device.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • AWSLocation — (map)

          The Amazon Web Services location of the device.

          • Zone — (String)

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn — (String)

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

        • Description — (String)

          The description of the device.

        • Type — (String)

          The device type.

        • Vendor — (String)

          The device vendor.

        • Model — (String)

          The device model.

        • SerialNumber — (String)

          The device serial number.

        • Location — (map)

          The site location.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • SiteId — (String)

          The site ID.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The device state.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the device.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createGlobalNetwork(params = {}, callback) ⇒ AWS.Request

Creates a new, empty global network.

Service Reference:

Examples:

Calling the createGlobalNetwork operation

var params = {
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createGlobalNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Description — (String)

      A description of the global network.

      Constraints: Maximum length of 256 characters.

    • Tags — (Array<map>)

      The tags to apply to the resource during creation.

      • Key — (String)

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value — (String)

        The tag value.

        Constraints: Maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalNetwork — (map)

        Information about the global network object.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • GlobalNetworkArn — (String)

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

        • Description — (String)

          The description of the global network.

        • CreatedAt — (Date)

          The date and time that the global network was created.

        • State — (String)

          The state of the global network.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the global network.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createLink(params = {}, callback) ⇒ AWS.Request

Creates a new link for a specified site.

Service Reference:

Examples:

Calling the createLink operation

var params = {
  Bandwidth: { /* required */
    DownloadSpeed: 'NUMBER_VALUE',
    UploadSpeed: 'NUMBER_VALUE'
  },
  GlobalNetworkId: 'STRING_VALUE', /* required */
  SiteId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Provider: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  Type: 'STRING_VALUE'
};
networkmanager.createLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (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 — (map)

      The upload speed and download speed in Mbps.

      • UploadSpeed — (Integer)

        Upload speed in Mbps.

      • DownloadSpeed — (Integer)

        Download speed in Mbps.

    • Provider — (String)

      The provider of the link.

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

    • SiteId — (String)

      The ID of the site.

    • Tags — (Array<map>)

      The tags to apply to the resource during creation.

      • Key — (String)

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value — (String)

        The tag value.

        Constraints: Maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Link — (map)

        Information about the link.

        • LinkId — (String)

          The ID of the link.

        • LinkArn — (String)

          The Amazon Resource Name (ARN) of the link.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • SiteId — (String)

          The ID of the site.

        • Description — (String)

          The description of the link.

        • Type — (String)

          The type of the link.

        • Bandwidth — (map)

          The bandwidth for the link.

          • UploadSpeed — (Integer)

            Upload speed in Mbps.

          • DownloadSpeed — (Integer)

            Download speed in Mbps.

        • Provider — (String)

          The provider of the link.

        • CreatedAt — (Date)

          The date and time that the link was created.

        • State — (String)

          The state of the link.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the link.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSite(params = {}, callback) ⇒ AWS.Request

Creates a new site in a global network.

Service Reference:

Examples:

Calling the createSite operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Location: {
    Address: 'STRING_VALUE',
    Latitude: 'STRING_VALUE',
    Longitude: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • Description — (String)

      A description of your site.

      Constraints: Maximum length of 256 characters.

    • Location — (map)

      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.

      • Address — (String)

        The physical address.

      • Latitude — (String)

        The latitude.

      • Longitude — (String)

        The longitude.

    • Tags — (Array<map>)

      The tags to apply to the resource during creation.

      • Key — (String)

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value — (String)

        The tag value.

        Constraints: Maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Site — (map)

        Information about the site.

        • SiteId — (String)

          The ID of the site.

        • SiteArn — (String)

          The Amazon Resource Name (ARN) of the site.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • Description — (String)

          The description of the site.

        • Location — (map)

          The location of the site.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The state of the site.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the site.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteConnection(params = {}, callback) ⇒ AWS.Request

Deletes the specified connection in your global network.

Service Reference:

Examples:

Calling the deleteConnection operation

var params = {
  ConnectionId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE' /* required */
};
networkmanager.deleteConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • ConnectionId — (String)

      The ID of the connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connection — (map)

        Information about the connection.

        • ConnectionId — (String)

          The ID of the connection.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of the connection.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the first device in the connection.

        • ConnectedDeviceId — (String)

          The ID of the second device in the connection.

        • LinkId — (String)

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

        • ConnectedLinkId — (String)

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

        • Description — (String)

          The description of the connection.

        • CreatedAt — (Date)

          The date and time that the connection was created.

        • State — (String)

          The state of the connection.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the connection.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDevice(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteDevice operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE' /* required */
};
networkmanager.deleteDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceId — (String)

      The ID of the device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Device — (map)

        Information about the device.

        • DeviceId — (String)

          The ID of the device.

        • DeviceArn — (String)

          The Amazon Resource Name (ARN) of the device.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • AWSLocation — (map)

          The Amazon Web Services location of the device.

          • Zone — (String)

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn — (String)

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

        • Description — (String)

          The description of the device.

        • Type — (String)

          The device type.

        • Vendor — (String)

          The device vendor.

        • Model — (String)

          The device model.

        • SerialNumber — (String)

          The device serial number.

        • Location — (map)

          The site location.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • SiteId — (String)

          The site ID.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The device state.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the device.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteGlobalNetwork(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteGlobalNetwork operation

var params = {
  GlobalNetworkId: 'STRING_VALUE' /* required */
};
networkmanager.deleteGlobalNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalNetwork — (map)

        Information about the global network.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • GlobalNetworkArn — (String)

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

        • Description — (String)

          The description of the global network.

        • CreatedAt — (Date)

          The date and time that the global network was created.

        • State — (String)

          The state of the global network.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the global network.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteLink(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteLink operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  LinkId: 'STRING_VALUE' /* required */
};
networkmanager.deleteLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • LinkId — (String)

      The ID of the link.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Link — (map)

        Information about the link.

        • LinkId — (String)

          The ID of the link.

        • LinkArn — (String)

          The Amazon Resource Name (ARN) of the link.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • SiteId — (String)

          The ID of the site.

        • Description — (String)

          The description of the link.

        • Type — (String)

          The type of the link.

        • Bandwidth — (map)

          The bandwidth for the link.

          • UploadSpeed — (Integer)

            Upload speed in Mbps.

          • DownloadSpeed — (Integer)

            Download speed in Mbps.

        • Provider — (String)

          The provider of the link.

        • CreatedAt — (Date)

          The date and time that the link was created.

        • State — (String)

          The state of the link.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the link.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSite(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteSite operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  SiteId: 'STRING_VALUE' /* required */
};
networkmanager.deleteSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • SiteId — (String)

      The ID of the site.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Site — (map)

        Information about the site.

        • SiteId — (String)

          The ID of the site.

        • SiteArn — (String)

          The Amazon Resource Name (ARN) of the site.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • Description — (String)

          The description of the site.

        • Location — (map)

          The location of the site.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The state of the site.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the site.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterTransitGateway(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deregisterTransitGateway operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  TransitGatewayArn: 'STRING_VALUE' /* required */
};
networkmanager.deregisterTransitGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • TransitGatewayArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayRegistration — (map)

        The transit gateway registration information.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • TransitGatewayArn — (String)

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

        • State — (map)

          The state of the transit gateway registration.

          • Code — (String)

            The code for the state reason.

            Possible values include:
            • "PENDING"
            • "AVAILABLE"
            • "DELETING"
            • "DELETED"
            • "FAILED"
          • Message — (String)

            The message for the state reason.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeGlobalNetworks(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeGlobalNetworks operation

var params = {
  GlobalNetworkIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
networkmanager.describeGlobalNetworks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkIds — (Array<String>)

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

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalNetworks — (Array<map>)

        Information about the global networks.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • GlobalNetworkArn — (String)

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

        • Description — (String)

          The description of the global network.

        • CreatedAt — (Date)

          The date and time that the global network was created.

        • State — (String)

          The state of the global network.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the global network.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateCustomerGateway(params = {}, callback) ⇒ AWS.Request

Disassociates a customer gateway from a device and a link.

Service Reference:

Examples:

Calling the disassociateCustomerGateway operation

var params = {
  CustomerGatewayArn: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE' /* required */
};
networkmanager.disassociateCustomerGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • CustomerGatewayArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomerGatewayAssociation — (map)

        Information about the customer gateway association.

        • CustomerGatewayArn — (String)

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

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the device.

        • LinkId — (String)

          The ID of the link.

        • State — (String)

          The association state.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateLink(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the disassociateLink operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  LinkId: 'STRING_VALUE' /* required */
};
networkmanager.disassociateLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceId — (String)

      The ID of the device.

    • LinkId — (String)

      The ID of the link.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LinkAssociation — (map)

        Information about the link association.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The device ID for the link association.

        • LinkId — (String)

          The ID of the link.

        • LinkAssociationState — (String)

          The state of the association.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateTransitGatewayConnectPeer(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the disassociateTransitGatewayConnectPeer operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  TransitGatewayConnectPeerArn: 'STRING_VALUE' /* required */
};
networkmanager.disassociateTransitGatewayConnectPeer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • TransitGatewayConnectPeerArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayConnectPeerAssociation — (map)

        The transit gateway Connect peer association.

        • TransitGatewayConnectPeerArn — (String)

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

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the device.

        • LinkId — (String)

          The ID of the link.

        • State — (String)

          The state of the association.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getConnections(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getConnections operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  ConnectionIds: [
    'STRING_VALUE',
    /* more items */
  ],
  DeviceId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
networkmanager.getConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • ConnectionIds — (Array<String>)

      One or more connection IDs.

    • DeviceId — (String)

      The ID of the device.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connections — (Array<map>)

        Information about the connections.

        • ConnectionId — (String)

          The ID of the connection.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of the connection.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the first device in the connection.

        • ConnectedDeviceId — (String)

          The ID of the second device in the connection.

        • LinkId — (String)

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

        • ConnectedLinkId — (String)

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

        • Description — (String)

          The description of the connection.

        • CreatedAt — (Date)

          The date and time that the connection was created.

        • State — (String)

          The state of the connection.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the connection.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

      • NextToken — (String)

        The token to use for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCustomerGatewayAssociations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getCustomerGatewayAssociations operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  CustomerGatewayArns: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
networkmanager.getCustomerGatewayAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • CustomerGatewayArns — (Array<String>)

      One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CustomerGatewayAssociations — (Array<map>)

        The customer gateway associations.

        • CustomerGatewayArn — (String)

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

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the device.

        • LinkId — (String)

          The ID of the link.

        • State — (String)

          The association state.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"
      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDevices(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getDevices operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  DeviceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SiteId: 'STRING_VALUE'
};
networkmanager.getDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceIds — (Array<String>)

      One or more device IDs. The maximum is 10.

    • SiteId — (String)

      The ID of the site.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Devices — (Array<map>)

        The devices.

        • DeviceId — (String)

          The ID of the device.

        • DeviceArn — (String)

          The Amazon Resource Name (ARN) of the device.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • AWSLocation — (map)

          The Amazon Web Services location of the device.

          • Zone — (String)

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn — (String)

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

        • Description — (String)

          The description of the device.

        • Type — (String)

          The device type.

        • Vendor — (String)

          The device vendor.

        • Model — (String)

          The device model.

        • SerialNumber — (String)

          The device serial number.

        • Location — (map)

          The site location.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • SiteId — (String)

          The site ID.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The device state.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the device.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getLinkAssociations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getLinkAssociations operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  DeviceId: 'STRING_VALUE',
  LinkId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
networkmanager.getLinkAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceId — (String)

      The ID of the device.

    • LinkId — (String)

      The ID of the link.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LinkAssociations — (Array<map>)

        The link associations.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The device ID for the link association.

        • LinkId — (String)

          The ID of the link.

        • LinkAssociationState — (String)

          The state of the association.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"
      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getLinks(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getLinks operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  LinkIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Provider: 'STRING_VALUE',
  SiteId: 'STRING_VALUE',
  Type: 'STRING_VALUE'
};
networkmanager.getLinks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • LinkIds — (Array<String>)

      One or more link IDs. The maximum is 10.

    • SiteId — (String)

      The ID of the site.

    • Type — (String)

      The link type.

    • Provider — (String)

      The link provider.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Links — (Array<map>)

        The links.

        • LinkId — (String)

          The ID of the link.

        • LinkArn — (String)

          The Amazon Resource Name (ARN) of the link.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • SiteId — (String)

          The ID of the site.

        • Description — (String)

          The description of the link.

        • Type — (String)

          The type of the link.

        • Bandwidth — (map)

          The bandwidth for the link.

          • UploadSpeed — (Integer)

            Upload speed in Mbps.

          • DownloadSpeed — (Integer)

            Download speed in Mbps.

        • Provider — (String)

          The provider of the link.

        • CreatedAt — (Date)

          The date and time that the link was created.

        • State — (String)

          The state of the link.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the link.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getNetworkResourceCounts(params = {}, callback) ⇒ AWS.Request

Gets the count of network resources, by resource type, for the specified global network.

Service Reference:

Examples:

Calling the getNetworkResourceCounts operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
networkmanager.getNetworkResourceCounts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • ResourceType — (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

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkResourceCounts — (Array<map>)

        The count of resources.

        • ResourceType — (String)

          The resource type.

        • Count — (Integer)

          The resource count.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getNetworkResourceRelationships(params = {}, callback) ⇒ AWS.Request

Gets the network resource relationships for the specified global network.

Service Reference:

Examples:

Calling the getNetworkResourceRelationships operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  AccountId: 'STRING_VALUE',
  AwsRegion: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegisteredGatewayArn: 'STRING_VALUE',
  ResourceArn: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
networkmanager.getNetworkResourceRelationships(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • RegisteredGatewayArn — (String)

      The ARN of the registered gateway.

    • AwsRegion — (String)

      The Amazon Web Services Region.

    • AccountId — (String)

      The Amazon Web Services account ID.

    • ResourceType — (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

    • ResourceArn — (String)

      The ARN of the gateway.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Relationships — (Array<map>)

        The resource relationships.

        • From — (String)

          The ARN of the resource.

        • To — (String)

          The ARN of the resource.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getNetworkResources(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getNetworkResources operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  AccountId: 'STRING_VALUE',
  AwsRegion: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegisteredGatewayArn: 'STRING_VALUE',
  ResourceArn: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
networkmanager.getNetworkResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • RegisteredGatewayArn — (String)

      The ARN of the gateway.

    • AwsRegion — (String)

      The Amazon Web Services Region.

    • AccountId — (String)

      The Amazon Web Services account ID.

    • ResourceType — (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:

    • ResourceArn — (String)

      The ARN of the resource.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkResources — (Array<map>)

        The network resources.

        • RegisteredGatewayArn — (String)

          The ARN of the gateway.

        • AwsRegion — (String)

          The Amazon Web Services Region.

        • AccountId — (String)

          The Amazon Web Services account ID.

        • ResourceType — (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

        • ResourceId — (String)

          The ID of the resource.

        • ResourceArn — (String)

          The ARN of the resource.

        • Definition — (String)

          Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

        • DefinitionTimestamp — (Date)

          The time that the resource definition was retrieved.

        • Tags — (Array<map>)

          The tags.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • Metadata — (map<String>)

          The resource metadata.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getNetworkRoutes(params = {}, callback) ⇒ AWS.Request

Gets the network routes of the specified global network.

Service Reference:

Examples:

Calling the getNetworkRoutes operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  RouteTableIdentifier: { /* required */
    TransitGatewayRouteTableArn: 'STRING_VALUE'
  },
  DestinationFilters: {
    '<FilterName>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<FilterName>': ... */
  },
  ExactCidrMatches: [
    'STRING_VALUE',
    /* more items */
  ],
  LongestPrefixMatches: [
    'STRING_VALUE',
    /* more items */
  ],
  PrefixListIds: [
    'STRING_VALUE',
    /* more items */
  ],
  States: [
    ACTIVE | BLACKHOLE,
    /* more items */
  ],
  SubnetOfMatches: [
    'STRING_VALUE',
    /* more items */
  ],
  SupernetOfMatches: [
    'STRING_VALUE',
    /* more items */
  ],
  Types: [
    PROPAGATED | STATIC,
    /* more items */
  ]
};
networkmanager.getNetworkRoutes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • RouteTableIdentifier — (map)

      The ID of the route table.

      • TransitGatewayRouteTableArn — (String)

        The ARN of the transit gateway route table.

    • ExactCidrMatches — (Array<String>)

      An exact CIDR block.

    • LongestPrefixMatches — (Array<String>)

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

    • SubnetOfMatches — (Array<String>)

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

    • SupernetOfMatches — (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.

    • PrefixListIds — (Array<String>)

      The IDs of the prefix lists.

    • States — (Array<String>)

      The route states.

    • Types — (Array<String>)

      The route types.

    • DestinationFilters — (map<Array<String>>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RouteTableArn — (String)

        The ARN of the route table.

      • RouteTableType — (String)

        The route table type.

        Possible values include:
        • "TRANSIT_GATEWAY_ROUTE_TABLE"
      • RouteTableTimestamp — (Date)

        The route table creation time.

      • NetworkRoutes — (Array<map>)

        The network routes.

        • DestinationCidrBlock — (String)

          A unique identifier for the route, such as a CIDR block.

        • Destinations — (Array<map>)

          The destinations.

          • TransitGatewayAttachmentId — (String)

            The ID of the transit gateway attachment.

          • ResourceType — (String)

            The resource type.

          • ResourceId — (String)

            The ID of the resource.

        • PrefixListId — (String)

          The ID of the prefix list.

        • State — (String)

          The route state. The possible values are active and blackhole.

          Possible values include:
          • "ACTIVE"
          • "BLACKHOLE"
        • Type — (String)

          The route type. The possible values are propagated and static.

          Possible values include:
          • "PROPAGATED"
          • "STATIC"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getNetworkTelemetry(params = {}, callback) ⇒ AWS.Request

Gets the network telemetry of the specified global network.

Service Reference:

Examples:

Calling the getNetworkTelemetry operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  AccountId: 'STRING_VALUE',
  AwsRegion: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RegisteredGatewayArn: 'STRING_VALUE',
  ResourceArn: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
networkmanager.getNetworkTelemetry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • RegisteredGatewayArn — (String)

      The ARN of the gateway.

    • AwsRegion — (String)

      The Amazon Web Services Region.

    • AccountId — (String)

      The Amazon Web Services account ID.

    • ResourceType — (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

    • ResourceArn — (String)

      The ARN of the resource.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkTelemetry — (Array<map>)

        The network telemetry.

        • RegisteredGatewayArn — (String)

          The ARN of the gateway.

        • AwsRegion — (String)

          The Amazon Web Services Region.

        • AccountId — (String)

          The Amazon Web Services account ID.

        • ResourceType — (String)

          The resource type.

        • ResourceId — (String)

          The ID of the resource.

        • ResourceArn — (String)

          The ARN of the resource.

        • Address — (String)

          The address.

        • Health — (map)

          The connection health.

          • Type — (String)

            The connection type.

            Possible values include:
            • "BGP"
            • "IPSEC"
          • Status — (String)

            The connection status.

            Possible values include:
            • "UP"
            • "DOWN"
          • Timestamp — (Date)

            The time the status was last updated.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRouteAnalysis(params = {}, callback) ⇒ AWS.Request

Gets information about the specified route analysis.

Service Reference:

Examples:

Calling the getRouteAnalysis operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  RouteAnalysisId: 'STRING_VALUE' /* required */
};
networkmanager.getRouteAnalysis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • RouteAnalysisId — (String)

      The ID of the route analysis.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RouteAnalysis — (map)

        The route analysis.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • OwnerAccountId — (String)

          The ID of the AWS account that created the route analysis.

        • RouteAnalysisId — (String)

          The ID of the route analysis.

        • StartTimestamp — (Date)

          The time that the analysis started.

        • Status — (String)

          The status of the route analysis.

          Possible values include:
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
        • Source — (map)

          The source.

          • TransitGatewayAttachmentArn — (String)

            The ARN of the transit gateway attachment.

          • TransitGatewayArn — (String)

            The ARN of the transit gateway.

          • IpAddress — (String)

            The IP address.

        • Destination — (map)

          The destination.

          • TransitGatewayAttachmentArn — (String)

            The ARN of the transit gateway attachment.

          • TransitGatewayArn — (String)

            The ARN of the transit gateway.

          • IpAddress — (String)

            The IP address.

        • IncludeReturnPath — (Boolean)

          Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

        • UseMiddleboxes — (Boolean)

          Indicates whether to include the location of middlebox appliances in the route analysis.

        • ForwardPath — (map)

          The forward path.

          • CompletionStatus — (map)

            The status of the analysis at completion.

            • ResultCode — (String)

              The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

              Possible values include:
              • "CONNECTED"
              • "NOT_CONNECTED"
            • ReasonCode — (String)

              The reason code. Available only if a connection is not found.

              • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.

              • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.

              • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.

              • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.

              • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.

              • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.

              • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.

              • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.

              • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

              Possible values include:
              • "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"
            • ReasonContext — (map<String>)

              Additional information about the path. Available only if a connection is not found.

          • Path — (Array<map>)

            The route analysis path.

            • Sequence — (Integer)

              The sequence number in the path. The destination is 0.

            • Resource — (map)

              The resource.

              • RegisteredGatewayArn — (String)

                The ARN of the gateway.

              • ResourceArn — (String)

                The ARN of the resource.

              • ResourceType — (String)

                The resource type.

              • Definition — (String)

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag — (String)

                The value for the Name tag.

              • IsMiddlebox — (Boolean)

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock — (String)

              The destination CIDR block in the route table.

        • ReturnPath — (map)

          The return path.

          • CompletionStatus — (map)

            The status of the analysis at completion.

            • ResultCode — (String)

              The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

              Possible values include:
              • "CONNECTED"
              • "NOT_CONNECTED"
            • ReasonCode — (String)

              The reason code. Available only if a connection is not found.

              • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.

              • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.

              • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.

              • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.

              • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.

              • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.

              • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.

              • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.

              • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

              Possible values include:
              • "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"
            • ReasonContext — (map<String>)

              Additional information about the path. Available only if a connection is not found.

          • Path — (Array<map>)

            The route analysis path.

            • Sequence — (Integer)

              The sequence number in the path. The destination is 0.

            • Resource — (map)

              The resource.

              • RegisteredGatewayArn — (String)

                The ARN of the gateway.

              • ResourceArn — (String)

                The ARN of the resource.

              • ResourceType — (String)

                The resource type.

              • Definition — (String)

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag — (String)

                The value for the Name tag.

              • IsMiddlebox — (Boolean)

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock — (String)

              The destination CIDR block in the route table.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSites(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getSites operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SiteIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
networkmanager.getSites(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • SiteIds — (Array<String>)

      One or more site IDs. The maximum is 10.

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Sites — (Array<map>)

        The sites.

        • SiteId — (String)

          The ID of the site.

        • SiteArn — (String)

          The Amazon Resource Name (ARN) of the site.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • Description — (String)

          The description of the site.

        • Location — (map)

          The location of the site.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The state of the site.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the site.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getTransitGatewayConnectPeerAssociations(params = {}, callback) ⇒ AWS.Request

Gets information about one or more of your transit gateway Connect peer associations in a global network.

Service Reference:

Examples:

Calling the getTransitGatewayConnectPeerAssociations operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TransitGatewayConnectPeerArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
networkmanager.getTransitGatewayConnectPeerAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • TransitGatewayConnectPeerArns — (Array<String>)

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

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayConnectPeerAssociations — (Array<map>)

        Information about the transit gateway Connect peer associations.

        • TransitGatewayConnectPeerArn — (String)

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

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the device.

        • LinkId — (String)

          The ID of the link.

        • State — (String)

          The state of the association.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"
      • NextToken — (String)

        The token to use for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getTransitGatewayRegistrations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getTransitGatewayRegistrations operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TransitGatewayArns: [
    'STRING_VALUE',
    /* more items */
  ]
};
networkmanager.getTransitGatewayRegistrations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • TransitGatewayArns — (Array<String>)

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

    • MaxResults — (Integer)

      The maximum number of results to return.

    • NextToken — (String)

      The token for the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayRegistrations — (Array<map>)

        The transit gateway registrations.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • TransitGatewayArn — (String)

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

        • State — (map)

          The state of the transit gateway registration.

          • Code — (String)

            The code for the state reason.

            Possible values include:
            • "PENDING"
            • "AVAILABLE"
            • "DELETING"
            • "DELETED"
            • "FAILED"
          • Message — (String)

            The message for the state reason.

      • NextToken — (String)

        The token for the next page of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags for a specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
networkmanager.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TagList — (Array<map>)

        The list of tags.

        • Key — (String)

          The tag key.

          Constraints: Maximum length of 128 characters.

        • Value — (String)

          The tag value.

          Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

registerTransitGateway(params = {}, callback) ⇒ AWS.Request

Registers a transit gateway in your global network. The transit gateway can be in any Amazon Web Services Region, 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.

Service Reference:

Examples:

Calling the registerTransitGateway operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  TransitGatewayArn: 'STRING_VALUE' /* required */
};
networkmanager.registerTransitGateway(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • TransitGatewayArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TransitGatewayRegistration — (map)

        Information about the transit gateway registration.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • TransitGatewayArn — (String)

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

        • State — (map)

          The state of the transit gateway registration.

          • Code — (String)

            The code for the state reason.

            Possible values include:
            • "PENDING"
            • "AVAILABLE"
            • "DELETING"
            • "DELETED"
            • "FAILED"
          • Message — (String)

            The message for the state reason.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startRouteAnalysis(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startRouteAnalysis operation

var params = {
  Destination: { /* required */
    IpAddress: 'STRING_VALUE',
    TransitGatewayAttachmentArn: 'STRING_VALUE'
  },
  GlobalNetworkId: 'STRING_VALUE', /* required */
  Source: { /* required */
    IpAddress: 'STRING_VALUE',
    TransitGatewayAttachmentArn: 'STRING_VALUE'
  },
  IncludeReturnPath: true || false,
  UseMiddleboxes: true || false
};
networkmanager.startRouteAnalysis(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • Source — (map)

      The source from which traffic originates.

      • TransitGatewayAttachmentArn — (String)

        The ARN of the transit gateway attachment.

      • IpAddress — (String)

        The IP address.

    • Destination — (map)

      The destination.

      • TransitGatewayAttachmentArn — (String)

        The ARN of the transit gateway attachment.

      • IpAddress — (String)

        The IP address.

    • IncludeReturnPath — (Boolean)

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

    • UseMiddleboxes — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RouteAnalysis — (map)

        The route analysis.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • OwnerAccountId — (String)

          The ID of the AWS account that created the route analysis.

        • RouteAnalysisId — (String)

          The ID of the route analysis.

        • StartTimestamp — (Date)

          The time that the analysis started.

        • Status — (String)

          The status of the route analysis.

          Possible values include:
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
        • Source — (map)

          The source.

          • TransitGatewayAttachmentArn — (String)

            The ARN of the transit gateway attachment.

          • TransitGatewayArn — (String)

            The ARN of the transit gateway.

          • IpAddress — (String)

            The IP address.

        • Destination — (map)

          The destination.

          • TransitGatewayAttachmentArn — (String)

            The ARN of the transit gateway attachment.

          • TransitGatewayArn — (String)

            The ARN of the transit gateway.

          • IpAddress — (String)

            The IP address.

        • IncludeReturnPath — (Boolean)

          Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

        • UseMiddleboxes — (Boolean)

          Indicates whether to include the location of middlebox appliances in the route analysis.

        • ForwardPath — (map)

          The forward path.

          • CompletionStatus — (map)

            The status of the analysis at completion.

            • ResultCode — (String)

              The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

              Possible values include:
              • "CONNECTED"
              • "NOT_CONNECTED"
            • ReasonCode — (String)

              The reason code. Available only if a connection is not found.

              • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.

              • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.

              • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.

              • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.

              • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.

              • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.

              • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.

              • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.

              • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

              Possible values include:
              • "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"
            • ReasonContext — (map<String>)

              Additional information about the path. Available only if a connection is not found.

          • Path — (Array<map>)

            The route analysis path.

            • Sequence — (Integer)

              The sequence number in the path. The destination is 0.

            • Resource — (map)

              The resource.

              • RegisteredGatewayArn — (String)

                The ARN of the gateway.

              • ResourceArn — (String)

                The ARN of the resource.

              • ResourceType — (String)

                The resource type.

              • Definition — (String)

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag — (String)

                The value for the Name tag.

              • IsMiddlebox — (Boolean)

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock — (String)

              The destination CIDR block in the route table.

        • ReturnPath — (map)

          The return path.

          • CompletionStatus — (map)

            The status of the analysis at completion.

            • ResultCode — (String)

              The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

              Possible values include:
              • "CONNECTED"
              • "NOT_CONNECTED"
            • ReasonCode — (String)

              The reason code. Available only if a connection is not found.

              • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.

              • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.

              • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.

              • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.

              • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.

              • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.

              • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.

              • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.

              • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

              Possible values include:
              • "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"
            • ReasonContext — (map<String>)

              Additional information about the path. Available only if a connection is not found.

          • Path — (Array<map>)

            The route analysis path.

            • Sequence — (Integer)

              The sequence number in the path. The destination is 0.

            • Resource — (map)

              The resource.

              • RegisteredGatewayArn — (String)

                The ARN of the gateway.

              • ResourceArn — (String)

                The ARN of the resource.

              • ResourceType — (String)

                The resource type.

              • Definition — (String)

                Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

              • NameTag — (String)

                The value for the Name tag.

              • IsMiddlebox — (Boolean)

                Indicates whether this is a middlebox appliance.

            • DestinationCidrBlock — (String)

              The destination CIDR block in the route table.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Tags a specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • Tags — (Array<map>)

      The tags to apply to the specified resource.

      • Key — (String)

        The tag key.

        Constraints: Maximum length of 128 characters.

      • Value — (String)

        The tag value.

        Constraints: Maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
networkmanager.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • TagKeys — (Array<String>)

      The tag keys to remove from the specified resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateConnection(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateConnection operation

var params = {
  ConnectionId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  ConnectedLinkId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  LinkId: 'STRING_VALUE'
};
networkmanager.updateConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • ConnectionId — (String)

      The ID of the connection.

    • LinkId — (String)

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

    • ConnectedLinkId — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connection — (map)

        Information about the connection.

        • ConnectionId — (String)

          The ID of the connection.

        • ConnectionArn — (String)

          The Amazon Resource Name (ARN) of the connection.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • DeviceId — (String)

          The ID of the first device in the connection.

        • ConnectedDeviceId — (String)

          The ID of the second device in the connection.

        • LinkId — (String)

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

        • ConnectedLinkId — (String)

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

        • Description — (String)

          The description of the connection.

        • CreatedAt — (Date)

          The date and time that the connection was created.

        • State — (String)

          The state of the connection.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the connection.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDevice(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateDevice operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  AWSLocation: {
    SubnetArn: 'STRING_VALUE',
    Zone: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE',
  Location: {
    Address: 'STRING_VALUE',
    Latitude: 'STRING_VALUE',
    Longitude: 'STRING_VALUE'
  },
  Model: 'STRING_VALUE',
  SerialNumber: 'STRING_VALUE',
  SiteId: 'STRING_VALUE',
  Type: 'STRING_VALUE',
  Vendor: 'STRING_VALUE'
};
networkmanager.updateDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • DeviceId — (String)

      The ID of the device.

    • AWSLocation — (map)

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

      • Zone — (String)

        The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

      • SubnetArn — (String)

        The Amazon Resource Name (ARN) of the subnet that the device is located in.

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

    • SerialNumber — (String)

      The serial number of the device.

      Constraints: Maximum length of 128 characters.

    • Location — (map)

      Describes a location.

      • Address — (String)

        The physical address.

      • Latitude — (String)

        The latitude.

      • Longitude — (String)

        The longitude.

    • SiteId — (String)

      The ID of the site.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Device — (map)

        Information about the device.

        • DeviceId — (String)

          The ID of the device.

        • DeviceArn — (String)

          The Amazon Resource Name (ARN) of the device.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • AWSLocation — (map)

          The Amazon Web Services location of the device.

          • Zone — (String)

            The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

          • SubnetArn — (String)

            The Amazon Resource Name (ARN) of the subnet that the device is located in.

        • Description — (String)

          The description of the device.

        • Type — (String)

          The device type.

        • Vendor — (String)

          The device vendor.

        • Model — (String)

          The device model.

        • SerialNumber — (String)

          The device serial number.

        • Location — (map)

          The site location.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • SiteId — (String)

          The site ID.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The device state.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the device.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateGlobalNetwork(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateGlobalNetwork operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
networkmanager.updateGlobalNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of your global network.

    • Description — (String)

      A description of the global network.

      Constraints: Maximum length of 256 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalNetwork — (map)

        Information about the global network object.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • GlobalNetworkArn — (String)

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

        • Description — (String)

          The description of the global network.

        • CreatedAt — (Date)

          The date and time that the global network was created.

        • State — (String)

          The state of the global network.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the global network.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateLink(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateLink operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  LinkId: 'STRING_VALUE', /* required */
  Bandwidth: {
    DownloadSpeed: 'NUMBER_VALUE',
    UploadSpeed: 'NUMBER_VALUE'
  },
  Description: 'STRING_VALUE',
  Provider: 'STRING_VALUE',
  Type: 'STRING_VALUE'
};
networkmanager.updateLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • LinkId — (String)

      The ID of the link.

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

    • Bandwidth — (map)

      The upload and download speed in Mbps.

      • UploadSpeed — (Integer)

        Upload speed in Mbps.

      • DownloadSpeed — (Integer)

        Download speed in Mbps.

    • Provider — (String)

      The provider of the link.

      Constraints: Maximum length of 128 characters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Link — (map)

        Information about the link.

        • LinkId — (String)

          The ID of the link.

        • LinkArn — (String)

          The Amazon Resource Name (ARN) of the link.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • SiteId — (String)

          The ID of the site.

        • Description — (String)

          The description of the link.

        • Type — (String)

          The type of the link.

        • Bandwidth — (map)

          The bandwidth for the link.

          • UploadSpeed — (Integer)

            Upload speed in Mbps.

          • DownloadSpeed — (Integer)

            Download speed in Mbps.

        • Provider — (String)

          The provider of the link.

        • CreatedAt — (Date)

          The date and time that the link was created.

        • State — (String)

          The state of the link.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the link.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateNetworkResourceMetadata(params = {}, callback) ⇒ AWS.Request

Updates the resource metadata for the specified global network.

Service Reference:

Examples:

Calling the updateNetworkResourceMetadata operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  Metadata: { /* required */
    '<NetworkResourceMetadataKey>': 'STRING_VALUE',
    /* '<NetworkResourceMetadataKey>': ... */
  },
  ResourceArn: 'STRING_VALUE' /* required */
};
networkmanager.updateNetworkResourceMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • ResourceArn — (String)

      The ARN of the resource.

    • Metadata — (map<String>)

      The resource metadata.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceArn — (String)

        The ARN of the resource.

      • Metadata — (map<String>)

        The updated resource metadata.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateSite(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateSite operation

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  SiteId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Location: {
    Address: 'STRING_VALUE',
    Latitude: 'STRING_VALUE',
    Longitude: 'STRING_VALUE'
  }
};
networkmanager.updateSite(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • GlobalNetworkId — (String)

      The ID of the global network.

    • SiteId — (String)

      The ID of your site.

    • Description — (String)

      A description of your site.

      Constraints: Maximum length of 256 characters.

    • Location — (map)

      The site location:

      • Address: The physical address of the site.

      • Latitude: The latitude of the site.

      • Longitude: The longitude of the site.

      • Address — (String)

        The physical address.

      • Latitude — (String)

        The latitude.

      • Longitude — (String)

        The longitude.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Site — (map)

        Information about the site.

        • SiteId — (String)

          The ID of the site.

        • SiteArn — (String)

          The Amazon Resource Name (ARN) of the site.

        • GlobalNetworkId — (String)

          The ID of the global network.

        • Description — (String)

          The description of the site.

        • Location — (map)

          The location of the site.

          • Address — (String)

            The physical address.

          • Latitude — (String)

            The latitude.

          • Longitude — (String)

            The longitude.

        • CreatedAt — (Date)

          The date and time that the site was created.

        • State — (String)

          The state of the site.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "DELETING"
          • "UPDATING"
        • Tags — (Array<map>)

          The tags for the site.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.