Class: AWS.NetworkManager

var params = {
  ConnectPeerId: 'STRING_VALUE', /* required */
  DeviceId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE', /* required */
  LinkId: 'STRING_VALUE'
};
networkmanager.associateConnectPeer(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.

  • ConnectPeerId — (String)

    The ID 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:

    • ConnectPeerAssociation — (map)

      The response to the Connect peer request.

      • ConnectPeerId — (String)

        The ID of the Connect peer.

      • GlobalNetworkId — (String)

        The ID of the global network.

      • DeviceId — (String)

        The ID of the device to connect to.

      • LinkId — (String)

        The ID of the link.

      • State — (String)

        The state of the Connect peer association.

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

Returns:

• (AWS.Request) —

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

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.

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.

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.

var params = {
  CoreNetworkId: 'STRING_VALUE', /* required */
  EdgeLocation: 'STRING_VALUE', /* required */
  Options: { /* required */
    Protocol: GRE | NO_ENCAP
  },
  TransportAttachmentId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createConnectAttachment(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: {}) —
  • CoreNetworkId — (String)

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

  • EdgeLocation — (String)

    The Region where the edge is located.

  • TransportAttachmentId — (String)

    The ID of the attachment between the two connections.

  • Options — (map)

    Options for creating an attachment.

    • Protocol — (String)

      The protocol used for the attachment connection.

      Possible values include:
      • "GRE"
      • "NO_ENCAP"
  • Tags — (Array<map>)

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

    • Key — (String)

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value — (String)

      The tag value.

      Constraints: Maximum length of 256 characters.

  • ClientToken — (String)

    The client token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • ConnectAttachment — (map)

      The response to a Connect attachment request.

      • Attachment — (map)

        The attachment details.

        • CoreNetworkId — (String)

          The ID of a core network.

        • CoreNetworkArn — (String)

          The ARN of a core network.

        • AttachmentId — (String)

          The ID of the attachment.

        • OwnerAccountId — (String)

          The ID of the attachment account owner.

        • AttachmentType — (String)

          The type of attachment.

          Possible values include:
          • "CONNECT"
          • "SITE_TO_SITE_VPN"
          • "VPC"
          • "TRANSIT_GATEWAY_ROUTE_TABLE"
        • State — (String)

          The state of the attachment.

          Possible values include:
          • "REJECTED"
          • "PENDING_ATTACHMENT_ACCEPTANCE"
          • "CREATING"
          • "FAILED"
          • "AVAILABLE"
          • "UPDATING"
          • "PENDING_NETWORK_UPDATE"
          • "PENDING_TAG_ACCEPTANCE"
          • "DELETING"
        • EdgeLocation — (String)

          The Region where the edge is located.

        • ResourceArn — (String)

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber — (Integer)

          The policy rule number associated with the attachment.

        • SegmentName — (String)

          The name of the segment attachment.

        • Tags — (Array<map>)

          The tags associated with the attachment.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange — (map)

          The attachment to move from one segment to another.

          • Tags — (Array<map>)

            The list of key-value tags that changed for the segment.

            • Key — (String)

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value — (String)

              The tag value.

              Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber — (Integer)

            The rule number in the policy document that applies to this change.

          • SegmentName — (String)

            The name of the segment to change.

        • CreatedAt — (Date)

          The timestamp when the attachment was created.

        • UpdatedAt — (Date)

          The timestamp when the attachment was last updated.

      • TransportAttachmentId — (String)

        The ID of the transport attachment.

      • Options — (map)

        Options for connecting an attachment.

        • Protocol — (String)

          The protocol used for the attachment connection.

          Possible values include:
          • "GRE"
          • "NO_ENCAP"

Returns:

• (AWS.Request) —

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

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.

var params = {
  ConnectAttachmentId: 'STRING_VALUE', /* required */
  PeerAddress: 'STRING_VALUE', /* required */
  BgpOptions: {
    PeerAsn: 'NUMBER_VALUE'
  },
  ClientToken: 'STRING_VALUE',
  CoreNetworkAddress: 'STRING_VALUE',
  InsideCidrBlocks: [
    'STRING_VALUE',
    /* more items */
  ],
  SubnetArn: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createConnectPeer(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: {}) —
  • ConnectAttachmentId — (String)

    The ID of the connection attachment.

  • CoreNetworkAddress — (String)

    A Connect peer core network address.

  • PeerAddress — (String)

    The Connect peer address.

  • BgpOptions — (map)

    The Connect peer BGP options.

    • PeerAsn — (Integer)

      The Peer ASN of the BGP.

  • InsideCidrBlocks — (Array<String>)

    The inside IP addresses used for BGP peering.

  • Tags — (Array<map>)

    The tags associated with the peer request.

    • Key — (String)

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value — (String)

      The tag value.

      Constraints: Maximum length of 256 characters.

  • ClientToken — (String)

    The client token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • SubnetArn — (String)

    The subnet ARN for the 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:

    • ConnectPeer — (map)

      The response to the request.

      • CoreNetworkId — (String)

        The ID of a core network.

      • ConnectAttachmentId — (String)

        The ID of the attachment to connect.

      • ConnectPeerId — (String)

        The ID of the Connect peer.

      • EdgeLocation — (String)

        The Connect peer Regions where edges are located.

      • State — (String)

        The state of the Connect peer.

        Possible values include:
        • "CREATING"
        • "FAILED"
        • "AVAILABLE"
        • "DELETING"
      • CreatedAt — (Date)

        The timestamp when the Connect peer was created.

      • Configuration — (map)

        The configuration of the Connect peer.

        • CoreNetworkAddress — (String)

          The IP address of a core network.

        • PeerAddress — (String)

          The IP address of the Connect peer.

        • InsideCidrBlocks — (Array<String>)

          The inside IP addresses used for a Connect peer configuration.

        • Protocol — (String)

          The protocol used for a Connect peer configuration.

          Possible values include:
          • "GRE"
          • "NO_ENCAP"
        • BgpConfigurations — (Array<map>)

          The Connect peer BGP configurations.

          • CoreNetworkAsn — (Integer)

            The ASN of the Coret Network.

          • PeerAsn — (Integer)

            The ASN of the Connect peer.

          • CoreNetworkAddress — (String)

            The address of a core network.

          • PeerAddress — (String)

            The address of a core network Connect peer.

      • Tags — (Array<map>)

        The list of key-value tags associated with the Connect peer.

        • Key — (String)

          The tag key.

          Constraints: Maximum length of 128 characters.

        • Value — (String)

          The tag value.

          Constraints: Maximum length of 256 characters.

      • SubnetArn — (String)

        The subnet ARN for the Connect peer.

Returns:

• (AWS.Request) —

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

var params = {
  GlobalNetworkId: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  PolicyDocument: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createCoreNetwork(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 that a core network will be a part of.

  • Description — (String)

    The description of a core network.

  • Tags — (Array<map>)

    Key-value tags associated with a core network request.

    • Key — (String)

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value — (String)

      The tag value.

      Constraints: Maximum length of 256 characters.

  • PolicyDocument — (String)

    The policy document for creating a core network.

  • ClientToken — (String)

    The client token associated with a core network request.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • CoreNetwork — (map)

      Returns details about a core network.

      • GlobalNetworkId — (String)

        The ID of the global network that your core network is a part of.

      • CoreNetworkId — (String)

        The ID of a core network.

      • CoreNetworkArn — (String)

        The ARN of a core network.

      • Description — (String)

        The description of a core network.

      • CreatedAt — (Date)

        The timestamp when a core network was created.

      • State — (String)

        The current state of a core network.

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

        The segments within a core network.

        • Name — (String)

          The name of a core network segment.

        • EdgeLocations — (Array<String>)

          The Regions where the edges are located.

        • SharedSegments — (Array<String>)

          The shared segments of a core network.

      • Edges — (Array<map>)

        The edges within a core network.

        • EdgeLocation — (String)

          The Region where a core network edge is located.

        • Asn — (Integer)

          The ASN of a core network edge.

        • InsideCidrBlocks — (Array<String>)

          The inside IP addresses used for core network edges.

      • Tags — (Array<map>)

        The list of key-value tags associated with a core 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.

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.

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.

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.

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.

var params = {
  CoreNetworkId: 'STRING_VALUE', /* required */
  VpnConnectionArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createSiteToSiteVpnAttachment(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: {}) —
  • CoreNetworkId — (String)

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

  • VpnConnectionArn — (String)

    The ARN identifying the VPN attachment.

  • Tags — (Array<map>)

    The tags associated with the request.

    • Key — (String)

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value — (String)

      The tag value.

      Constraints: Maximum length of 256 characters.

  • ClientToken — (String)

    The client token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • SiteToSiteVpnAttachment — (map)

      Details about a site-to-site VPN attachment.

      • Attachment — (map)

        Provides details about a site-to-site VPN attachment.

        • CoreNetworkId — (String)

          The ID of a core network.

        • CoreNetworkArn — (String)

          The ARN of a core network.

        • AttachmentId — (String)

          The ID of the attachment.

        • OwnerAccountId — (String)

          The ID of the attachment account owner.

        • AttachmentType — (String)

          The type of attachment.

          Possible values include:
          • "CONNECT"
          • "SITE_TO_SITE_VPN"
          • "VPC"
          • "TRANSIT_GATEWAY_ROUTE_TABLE"
        • State — (String)

          The state of the attachment.

          Possible values include:
          • "REJECTED"
          • "PENDING_ATTACHMENT_ACCEPTANCE"
          • "CREATING"
          • "FAILED"
          • "AVAILABLE"
          • "UPDATING"
          • "PENDING_NETWORK_UPDATE"
          • "PENDING_TAG_ACCEPTANCE"
          • "DELETING"
        • EdgeLocation — (String)

          The Region where the edge is located.

        • ResourceArn — (String)

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber — (Integer)

          The policy rule number associated with the attachment.

        • SegmentName — (String)

          The name of the segment attachment.

        • Tags — (Array<map>)

          The tags associated with the attachment.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange — (map)

          The attachment to move from one segment to another.

          • Tags — (Array<map>)

            The list of key-value tags that changed for the segment.

            • Key — (String)

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value — (String)

              The tag value.

              Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber — (Integer)

            The rule number in the policy document that applies to this change.

          • SegmentName — (String)

            The name of the segment to change.

        • CreatedAt — (Date)

          The timestamp when the attachment was created.

        • UpdatedAt — (Date)

          The timestamp when the attachment was last updated.

      • VpnConnectionArn — (String)

        The ARN of the site-to-site VPN attachment.

Returns:

• (AWS.Request) —

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

var params = {
  CoreNetworkId: 'STRING_VALUE', /* required */
  TransitGatewayArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createTransitGatewayPeering(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: {}) —
  • CoreNetworkId — (String)

    The ID of a core network.

  • TransitGatewayArn — (String)

    The ARN of the transit gateway for the peering request.

  • Tags — (Array<map>)

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

    • Key — (String)

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value — (String)

      The tag value.

      Constraints: Maximum length of 256 characters.

  • ClientToken — (String)

    The client token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • TransitGatewayPeering — (map)

      Returns information about the transit gateway peering connection request.

      • Peering — (map)

        Describes a transit gateway peer connection.

        • CoreNetworkId — (String)

          The ID of the core network for the peering request.

        • CoreNetworkArn — (String)

          The ARN of a core network.

        • PeeringId — (String)

          The ID of the peering attachment.

        • OwnerAccountId — (String)

          The ID of the account owner.

        • PeeringType — (String)

          The type of peering. This will be TRANSIT_GATEWAY.

          Possible values include:
          • "TRANSIT_GATEWAY"
        • State — (String)

          The current state of the peering connection.

          Possible values include:
          • "CREATING"
          • "FAILED"
          • "AVAILABLE"
          • "DELETING"
        • EdgeLocation — (String)

          The edge location for the peer.

        • ResourceArn — (String)

          The resource ARN of the peer.

        • Tags — (Array<map>)

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

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • CreatedAt — (Date)

          The timestamp when the attachment peer was created.

      • TransitGatewayArn — (String)

        The ARN of the transit gateway.

      • TransitGatewayPeeringAttachmentId — (String)

        The ID of the transit gateway peering attachment.

Returns:

• (AWS.Request) —

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

var params = {
  PeeringId: 'STRING_VALUE', /* required */
  TransitGatewayRouteTableArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createTransitGatewayRouteTableAttachment(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: {}) —
  • PeeringId — (String)

    The ID of the peer for the

  • TransitGatewayRouteTableArn — (String)

    The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

  • Tags — (Array<map>)

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

    • Key — (String)

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value — (String)

      The tag value.

      Constraints: Maximum length of 256 characters.

  • ClientToken — (String)

    The client token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • TransitGatewayRouteTableAttachment — (map)

      The route table associated with the create transit gateway route table attachment request.

      • Attachment — (map)

        Describes a core network attachment.

        • CoreNetworkId — (String)

          The ID of a core network.

        • CoreNetworkArn — (String)

          The ARN of a core network.

        • AttachmentId — (String)

          The ID of the attachment.

        • OwnerAccountId — (String)

          The ID of the attachment account owner.

        • AttachmentType — (String)

          The type of attachment.

          Possible values include:
          • "CONNECT"
          • "SITE_TO_SITE_VPN"
          • "VPC"
          • "TRANSIT_GATEWAY_ROUTE_TABLE"
        • State — (String)

          The state of the attachment.

          Possible values include:
          • "REJECTED"
          • "PENDING_ATTACHMENT_ACCEPTANCE"
          • "CREATING"
          • "FAILED"
          • "AVAILABLE"
          • "UPDATING"
          • "PENDING_NETWORK_UPDATE"
          • "PENDING_TAG_ACCEPTANCE"
          • "DELETING"
        • EdgeLocation — (String)

          The Region where the edge is located.

        • ResourceArn — (String)

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber — (Integer)

          The policy rule number associated with the attachment.

        • SegmentName — (String)

          The name of the segment attachment.

        • Tags — (Array<map>)

          The tags associated with the attachment.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange — (map)

          The attachment to move from one segment to another.

          • Tags — (Array<map>)

            The list of key-value tags that changed for the segment.

            • Key — (String)

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value — (String)

              The tag value.

              Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber — (Integer)

            The rule number in the policy document that applies to this change.

          • SegmentName — (String)

            The name of the segment to change.

        • CreatedAt — (Date)

          The timestamp when the attachment was created.

        • UpdatedAt — (Date)

          The timestamp when the attachment was last updated.

      • PeeringId — (String)

        The ID of the peering attachment.

      • TransitGatewayRouteTableArn — (String)

        The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

Returns:

• (AWS.Request) —

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

var params = {
  CoreNetworkId: 'STRING_VALUE', /* required */
  SubnetArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  VpcArn: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Options: {
    ApplianceModeSupport: true || false,
    Ipv6Support: true || false
  },
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
networkmanager.createVpcAttachment(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: {}) —
  • CoreNetworkId — (String)

    The ID of a core network for the VPC attachment.

  • VpcArn — (String)

    The ARN of the VPC.

  • SubnetArns — (Array<String>)

    The subnet ARN of the VPC attachment.

  • Options — (map)

    Options for the VPC attachment.

    • Ipv6Support — (Boolean)

      Indicates whether IPv6 is supported.

    • ApplianceModeSupport — (Boolean)

      Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

  • Tags — (Array<map>)

    The key-value tags associated with the request.

    • Key — (String)

      The tag key.

      Constraints: Maximum length of 128 characters.

    • Value — (String)

      The tag value.

      Constraints: Maximum length of 256 characters.

  • ClientToken — (String)

    The client token associated with the request.

    If a token is not provided, the SDK will use a version 4 UUID.

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:

    • VpcAttachment — (map)

      Provides details about the VPC attachment.

      • Attachment — (map)

        Provides details about the VPC attachment.

        • CoreNetworkId — (String)

          The ID of a core network.

        • CoreNetworkArn — (String)

          The ARN of a core network.

        • AttachmentId — (String)

          The ID of the attachment.

        • OwnerAccountId — (String)

          The ID of the attachment account owner.

        • AttachmentType — (String)

          The type of attachment.

          Possible values include:
          • "CONNECT"
          • "SITE_TO_SITE_VPN"
          • "VPC"
          • "TRANSIT_GATEWAY_ROUTE_TABLE"
        • State — (String)

          The state of the attachment.

          Possible values include:
          • "REJECTED"
          • "PENDING_ATTACHMENT_ACCEPTANCE"
          • "CREATING"
          • "FAILED"
          • "AVAILABLE"
          • "UPDATING"
          • "PENDING_NETWORK_UPDATE"
          • "PENDING_TAG_ACCEPTANCE"
          • "DELETING"
        • EdgeLocation — (String)

          The Region where the edge is located.

        • ResourceArn — (String)

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber — (Integer)

          The policy rule number associated with the attachment.

        • SegmentName — (String)

          The name of the segment attachment.

        • Tags — (Array<map>)

          The tags associated with the attachment.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange — (map)

          The attachment to move from one segment to another.

          • Tags — (Array<map>)

            The list of key-value tags that changed for the segment.

            • Key — (String)

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value — (String)

              The tag value.

              Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber — (Integer)

            The rule number in the policy document that applies to this change.

          • SegmentName — (String)

            The name of the segment to change.

        • CreatedAt — (Date)

          The timestamp when the attachment was created.

        • UpdatedAt — (Date)

          The timestamp when the attachment was last updated.

      • SubnetArns — (Array<String>)

        The subnet ARNs.

      • Options — (map)

        Provides details about the VPC attachment.

        • Ipv6Support — (Boolean)

          Indicates whether IPv6 is supported.

        • ApplianceModeSupport — (Boolean)

          Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

Returns:

• (AWS.Request) —

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

var params = {
  AttachmentId: 'STRING_VALUE' /* required */
};
networkmanager.deleteAttachment(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: {}) —
  • AttachmentId — (String)

    The ID of the attachment to delete.

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:

    • Attachment — (map)

      Information about the deleted attachment.

      • CoreNetworkId — (String)

        The ID of a core network.

      • CoreNetworkArn — (String)

        The ARN of a core network.

      • AttachmentId — (String)

        The ID of the attachment.

      • OwnerAccountId — (String)

        The ID of the attachment account owner.

      • AttachmentType — (String)

        The type of attachment.

        Possible values include:
        • "CONNECT"
        • "SITE_TO_SITE_VPN"
        • "VPC"
        • "TRANSIT_GATEWAY_ROUTE_TABLE"
      • State — (String)

        The state of the attachment.

        Possible values include:
        • "REJECTED"
        • "PENDING_ATTACHMENT_ACCEPTANCE"
        • "CREATING"
        • "FAILED"
        • "AVAILABLE"
        • "UPDATING"
        • "PENDING_NETWORK_UPDATE"
        • "PENDING_TAG_ACCEPTANCE"
        • "DELETING"
      • EdgeLocation — (String)

        The Region where the edge is located.

      • ResourceArn — (String)

        The attachment resource ARN.

      • AttachmentPolicyRuleNumber — (Integer)

        The policy rule number associated with the attachment.

      • SegmentName — (String)

        The name of the segment attachment.

      • Tags — (Array<map>)

        The tags associated with the attachment.

        • Key — (String)

          The tag key.

          Constraints: Maximum length of 128 characters.

        • Value — (String)

          The tag value.

          Constraints: Maximum length of 256 characters.

      • ProposedSegmentChange — (map)

        The attachment to move from one segment to another.

        • Tags — (Array<map>)

          The list of key-value tags that changed for the segment.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • AttachmentPolicyRuleNumber — (Integer)

          The rule number in the policy document that applies to this change.

        • SegmentName — (String)

          The name of the segment to change.

      • CreatedAt — (Date)

        The timestamp when the attachment was created.

      • UpdatedAt — (Date)

        The timestamp when the attachment was last updated.

Returns:

• (AWS.Request) —

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

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.

var params = {
  ConnectPeerId: 'STRING_VALUE' /* required */
};
networkmanager.deleteConnectPeer(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: {}) —
  • ConnectPeerId — (String)

    The ID of the deleted 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:

    • ConnectPeer — (map)

      Information about the deleted Connect peer.

      • CoreNetworkId — (String)

        The ID of a core network.

      • ConnectAttachmentId — (String)

        The ID of the attachment to connect.

      • ConnectPeerId — (String)

        The ID of the Connect peer.

      • EdgeLocation — (String)

        The Connect peer Regions where edges are located.

      • State — (String)

        The state of the Connect peer.

        Possible values include:
        • "CREATING"
        • "FAILED"
        • "AVAILABLE"
        • "DELETING"
      • CreatedAt — (Date)

        The timestamp when the Connect peer was created.

      • Configuration — (map)

        The configuration of the Connect peer.

        • CoreNetworkAddress — (String)

          The IP address of a core network.

        • PeerAddress — (String)

          The IP address of the Connect peer.

        • InsideCidrBlocks — (Array<String>)

          The inside IP addresses used for a Connect peer configuration.

        • Protocol — (String)

          The protocol used for a Connect peer configuration.

          Possible values include:
          • "GRE"
          • "NO_ENCAP"
        • BgpConfigurations — (Array<map>)

          The Connect peer BGP configurations.

          • CoreNetworkAsn — (Integer)

            The ASN of the Coret Network.

          • PeerAsn — (Integer)

            The ASN of the Connect peer.

          • CoreNetworkAddress — (String)

            The address of a core network.

          • PeerAddress — (String)

            The address of a core network Connect peer.

      • Tags — (Array<map>)

        The list of key-value tags associated with the Connect peer.

        • Key — (String)

          The tag key.

          Constraints: Maximum length of 128 characters.

        • Value — (String)

          The tag value.

          Constraints: Maximum length of 256 characters.

      • SubnetArn — (String)

        The subnet ARN for the Connect peer.

Returns:

• (AWS.Request) —

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

var params = {
  CoreNetworkId: 'STRING_VALUE' /* required */
};
networkmanager.deleteCoreNetwork(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: {}) —
  • CoreNetworkId — (String)

    The network ID of the deleted core 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:

    • CoreNetwork — (map)

      Information about the deleted core network.

      • GlobalNetworkId — (String)

        The ID of the global network that your core network is a part of.

      • CoreNetworkId — (String)

        The ID of a core network.

      • CoreNetworkArn — (String)

        The ARN of a core network.

      • Description — (String)

        The description of a core network.

      • CreatedAt — (Date)

        The timestamp when a core network was created.

      • State — (String)

        The current state of a core network.

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

        The segments within a core network.

        • Name — (String)

          The name of a core network segment.

        • EdgeLocations — (Array<String>)

          The Regions where the edges are located.

        • SharedSegments — (Array<String>)

          The shared segments of a core network.

      • Edges — (Array<map>)

        The edges within a core network.

        • EdgeLocation — (String)

          The Region where a core network edge is located.

        • Asn — (Integer)

          The ASN of a core network edge.

        • InsideCidrBlocks — (Array<String>)

          The inside IP addresses used for core network edges.

      • Tags — (Array<map>)

        The list of key-value tags associated with a core 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.

var params = {
  CoreNetworkId: 'STRING_VALUE', /* required */
  PolicyVersionId: 'NUMBER_VALUE' /* required */
};
networkmanager.deleteCoreNetworkPolicyVersion(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: {}) —
  • CoreNetworkId — (String)

    The ID of a core network for the deleted policy.

  • PolicyVersionId — (Integer)

    The version ID of the deleted policy.

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:

    • CoreNetworkPolicy — (map)

      Returns information about the deleted policy version.

      • CoreNetworkId — (String)

        The ID of a core network.

      • PolicyVersionId — (Integer)

        The ID of the policy version.

      • Alias — (String)

        Whether a core network policy is the current LIVE policy or the most recently submitted policy.

        Possible values include:
        • "LIVE"
        • "LATEST"
      • Description — (String)

        The description of a core network policy.

      • CreatedAt — (Date)

        The timestamp when a core network policy was created.

      • ChangeSetState — (String)

        The state of a core network policy.

        Possible values include:
        • "PENDING_GENERATION"
        • "FAILED_GENERATION"
        • "READY_TO_EXECUTE"
        • "EXECUTING"
        • "EXECUTION_SUCCEEDED"
        • "OUT_OF_DATE"
      • PolicyErrors — (Array<map>)

        Describes any errors in a core network policy.

        • ErrorCode — required — (String)

          The error code associated with a core network policy error.

        • Message — required — (String)

          The message associated with a core network policy error code.

        • Path — (String)

          The JSON path where the error was discovered in the policy document.

      • PolicyDocument — (String)

        Describes a core network policy.

Returns:

• (AWS.Request) —

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

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.

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.

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.

var params = {
  PeeringId: 'STRING_VALUE' /* required */
};
networkmanager.deletePeering(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: {}) —
  • PeeringId — (String)

    The ID of the peering connection to delete.

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:

    • Peering — (map)

      Information about a deleted peering connection.

      • CoreNetworkId — (String)

        The ID of the core network for the peering request.

      • CoreNetworkArn — (String)

        The ARN of a core network.

      • PeeringId — (String)

        The ID of the peering attachment.

      • OwnerAccountId — (String)

        The ID of the account owner.

      • PeeringType — (String)

        The type of peering. This will be TRANSIT_GATEWAY.

        Possible values include:
        • "TRANSIT_GATEWAY"
      • State — (String)

        The current state of the peering connection.

        Possible values include:
        • "CREATING"
        • "FAILED"
        • "AVAILABLE"
        • "DELETING"
      • EdgeLocation — (String)

        The edge location for the peer.

      • ResourceArn — (String)

        The resource ARN of the peer.

      • Tags — (Array<map>)

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

        • Key — (String)

          The tag key.

          Constraints: Maximum length of 128 characters.

        • Value — (String)

          The tag value.

          Constraints: Maximum length of 256 characters.

      • CreatedAt — (Date)

        The timestamp when the attachment peer was created.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
networkmanager.deleteResourcePolicy(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 ARN of the policy to delete.

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.

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.

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.

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.

var params = {
  ConnectPeerId: 'STRING_VALUE', /* required */
  GlobalNetworkId: 'STRING_VALUE' /* required */
};
networkmanager.disassociateConnectPeer(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.

  • ConnectPeerId — (String)

    The ID of the Connect peer to disassociate from a 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:

    • ConnectPeerAssociation — (map)

      Describes the Connect peer association.

      • ConnectPeerId — (String)

        The ID of the Connect peer.

      • GlobalNetworkId — (String)

        The ID of the global network.

      • DeviceId — (String)

        The ID of the device to connect to.

      • LinkId — (String)

        The ID of the link.

      • State — (String)

        The state of the Connect peer association.

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

Returns:

• (AWS.Request) —

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

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.

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.

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.

var params = {
  CoreNetworkId: 'STRING_VALUE', /* required */
  PolicyVersionId: 'NUMBER_VALUE' /* required */
};
networkmanager.executeCoreNetworkChangeSet(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: {}) —
  • CoreNetworkId — (String)

    The ID of a core network.

  • PolicyVersionId — (Integer)

    The ID of the policy version.

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.

var params = {
  AttachmentId: 'STRING_VALUE' /* required */
};
networkmanager.getConnectAttachment(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: {}) —
  • AttachmentId — (String)

    The ID of the attachment.

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:

    • ConnectAttachment — (map)

      Details about the Connect attachment.

      • Attachment — (map)

        The attachment details.

        • CoreNetworkId — (String)

          The ID of a core network.

        • CoreNetworkArn — (String)

          The ARN of a core network.

        • AttachmentId — (String)

          The ID of the attachment.

        • OwnerAccountId — (String)

          The ID of the attachment account owner.

        • AttachmentType — (String)

          The type of attachment.

          Possible values include:
          • "CONNECT"
          • "SITE_TO_SITE_VPN"
          • "VPC"
          • "TRANSIT_GATEWAY_ROUTE_TABLE"
        • State — (String)

          The state of the attachment.

          Possible values include:
          • "REJECTED"
          • "PENDING_ATTACHMENT_ACCEPTANCE"
          • "CREATING"
          • "FAILED"
          • "AVAILABLE"
          • "UPDATING"
          • "PENDING_NETWORK_UPDATE"
          • "PENDING_TAG_ACCEPTANCE"
          • "DELETING"
        • EdgeLocation — (String)

          The Region where the edge is located.

        • ResourceArn — (String)

          The attachment resource ARN.

        • AttachmentPolicyRuleNumber — (Integer)

          The policy rule number associated with the attachment.

        • SegmentName — (String)

          The name of the segment attachment.

        • Tags — (Array<map>)

          The tags associated with the attachment.

          • Key — (String)

            The tag key.

            Constraints: Maximum length of 128 characters.

          • Value — (String)

            The tag value.

            Constraints: Maximum length of 256 characters.

        • ProposedSegmentChange — (map)

          The attachment to move from one segment to another.

          • Tags — (Array<map>)

            The list of key-value tags that changed for the segment.

            • Key — (String)

              The tag key.

              Constraints: Maximum length of 128 characters.

            • Value — (String)

              The tag value.

              Constraints: Maximum length of 256 characters.

          • AttachmentPolicyRuleNumber — (Integer)

            The rule number in the policy document that applies to this change.

          • SegmentName — (String)

            The name of the segment to change.

        • CreatedAt — (Date)

          The timestamp when the attachment was created.

        • UpdatedAt — (Date)

          The timestamp when the attachment was last updated.

      • TransportAttachmentId — (String)

        The ID of the transport attachment.

      • Options — (map)

        Options for connecting an attachment.

        • Protocol — (String)

          The protocol used for the attachment connection.

          Possible values include:
          • "GRE"
          • "NO_ENCAP"

Returns:

• (AWS.Request) —

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

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.

var params = {
  ConnectPeerId: 'STRING_VALUE' /* required */
};
networkmanager.getConnectPeer(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: {}) —
  • ConnectPeerId — (String)

    The ID of the 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:

    • ConnectPeer — (map)

      Returns information about a core network Connect peer.

      • CoreNetworkId — (String)

        The ID of a core network.

      • ConnectAttachmentId — (String)

        The ID of the attachment to connect.

      • ConnectPeerId — (String)

        The ID of the Connect peer.

      • EdgeLocation — (String)

        The Connect peer Regions where edges are located.

      • State — (String)

        The state of the Connect peer.

        Possible values include:
        • "CREATING"
        • "FAILED"
        • "AVAILABLE"
        • "DELETING"
      • CreatedAt — (Date)

        The timestamp when the Connect peer was created.

      • Configuration — (map)

        The configuration of the Connect peer.

        • CoreNetworkAddress — (String)

          The IP address of a core network.

        • PeerAddress — (String)

          The IP address of the Connect peer.

        • InsideCidrBlocks — (Array<String>)

          The inside IP addresses used for a Connect peer configuration.

        • Protocol — (String)

          The protocol used for a Connect peer configuration.

          Possible values include:
          • "GRE"
          • "NO_ENCAP"
        • BgpConfigurations — (Array<map>)

          The Connect peer BGP configurations.

          • CoreNetworkAsn — (Integer)

            The ASN of the Coret Network.

          • PeerAsn — (Integer)

            The ASN of the Connect peer.

          • CoreNetworkAddress — (String)

            The address of a core network.

          • PeerAddress — (String)

            The address of a core network Connect peer.

      • Tags — (Array<map>)

        The list of key-value tags associated with the Connect peer.

        • Key — (String)

          The tag key.

          Constraints: Maximum length of 128 characters.

        • Value — (String)

          The tag value.

          Constraints: Maximum length of 256 characters.

      • SubnetArn — (String)

        The subnet ARN for the Connect peer.