NetworkManager

public struct NetworkManager

Client object for interacting with AWS NetworkManager service.

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

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the NetworkManager client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls

associateCustomerGateway(_:)
Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id. You cannot associate a customer gateway with more than one device and link.
Declaration
Swift

public func associateCustomerGateway(_ input: AssociateCustomerGatewayRequest) -> EventLoopFuture<AssociateCustomerGatewayResponse>
associateLink(_:)
Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.
Declaration
Swift

public func associateLink(_ input: AssociateLinkRequest) -> EventLoopFuture<AssociateLinkResponse>
createDevice(_:)
Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.
Declaration
Swift

public func createDevice(_ input: CreateDeviceRequest) -> EventLoopFuture<CreateDeviceResponse>


                    
                    
                    createGlobalNetwork(_:)

Creates a new, empty global network.

Declaration

Swift

public func createGlobalNetwork(_ input: CreateGlobalNetworkRequest) -> EventLoopFuture<CreateGlobalNetworkResponse>


                    
                    
                    createLink(_:)

Creates a new link for a specified site.

Declaration

Swift

public func createLink(_ input: CreateLinkRequest) -> EventLoopFuture<CreateLinkResponse>


                    
                    
                    createSite(_:)

Creates a new site in a global network.

Declaration

Swift

public func createSite(_ input: CreateSiteRequest) -> EventLoopFuture<CreateSiteResponse>

deleteDevice(_:)
Deletes an existing device. You must first disassociate the device from any links and customer gateways.
Declaration
Swift

public func deleteDevice(_ input: DeleteDeviceRequest) -> EventLoopFuture<DeleteDeviceResponse>
deleteGlobalNetwork(_:)
Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
Declaration
Swift

public func deleteGlobalNetwork(_ input: DeleteGlobalNetworkRequest) -> EventLoopFuture<DeleteGlobalNetworkResponse>
deleteLink(_:)
Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
Declaration
Swift

public func deleteLink(_ input: DeleteLinkRequest) -> EventLoopFuture<DeleteLinkResponse>
deleteSite(_:)
Deletes an existing site. The site cannot be associated with any device or link.
Declaration
Swift

public func deleteSite(_ input: DeleteSiteRequest) -> EventLoopFuture<DeleteSiteResponse>
deregisterTransitGateway(_:)
Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.
Declaration
Swift

public func deregisterTransitGateway(_ input: DeregisterTransitGatewayRequest) -> EventLoopFuture<DeregisterTransitGatewayResponse>
describeGlobalNetworks(_:)
Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.
Declaration
Swift

public func describeGlobalNetworks(_ input: DescribeGlobalNetworksRequest) -> EventLoopFuture<DescribeGlobalNetworksResponse>


                    
                    
                    disassociateCustomerGateway(_:)

Disassociates a customer gateway from a device and a link.

Declaration

Swift

public func disassociateCustomerGateway(_ input: DisassociateCustomerGatewayRequest) -> EventLoopFuture<DisassociateCustomerGatewayResponse>

disassociateLink(_:)
Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
Declaration
Swift

public func disassociateLink(_ input: DisassociateLinkRequest) -> EventLoopFuture<DisassociateLinkResponse>
getCustomerGatewayAssociations(_:)
Gets the association information for customer gateways that are associated with devices and links in your global network.
Declaration
Swift

public func getCustomerGatewayAssociations(_ input: GetCustomerGatewayAssociationsRequest) -> EventLoopFuture<GetCustomerGatewayAssociationsResponse>
getDevices(_:)
Gets information about one or more of your devices in a global network.
Declaration
Swift

public func getDevices(_ input: GetDevicesRequest) -> EventLoopFuture<GetDevicesResponse>
getLinkAssociations(_:)
Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
Declaration
Swift

public func getLinkAssociations(_ input: GetLinkAssociationsRequest) -> EventLoopFuture<GetLinkAssociationsResponse>
getLinks(_:)
Gets information about one or more links in a specified global network. If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.
Declaration
Swift

public func getLinks(_ input: GetLinksRequest) -> EventLoopFuture<GetLinksResponse>
getSites(_:)
Gets information about one or more of your sites in a global network.
Declaration
Swift

public func getSites(_ input: GetSitesRequest) -> EventLoopFuture<GetSitesResponse>


                    
                    
                    getTransitGatewayRegistrations(_:)

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

Declaration

Swift

public func getTransitGatewayRegistrations(_ input: GetTransitGatewayRegistrationsRequest) -> EventLoopFuture<GetTransitGatewayRegistrationsResponse>


                    
                    
                    listTagsForResource(_:)

Lists the tags for a specified resource.

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

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

public func registerTransitGateway(_ input: RegisterTransitGatewayRequest) -> EventLoopFuture<RegisterTransitGatewayResponse>


                    
                    
                    tagResource(_:)

Tags a specified resource.

Declaration

Swift

public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>


                    
                    
                    untagResource(_:)

Removes tags from a specified resource.

Declaration

Swift

public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

updateDevice(_:)
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
Declaration
Swift

public func updateDevice(_ input: UpdateDeviceRequest) -> EventLoopFuture<UpdateDeviceResponse>
updateGlobalNetwork(_:)
Updates an existing global network. To remove information for any of the parameters, specify an empty string.
Declaration
Swift

public func updateGlobalNetwork(_ input: UpdateGlobalNetworkRequest) -> EventLoopFuture<UpdateGlobalNetworkResponse>
updateLink(_:)
Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
Declaration
Swift

public func updateLink(_ input: UpdateLinkRequest) -> EventLoopFuture<UpdateLinkResponse>
updateSite(_:)
Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
Declaration
Swift

public func updateSite(_ input: UpdateSiteRequest) -> EventLoopFuture<UpdateSiteResponse>

Paginators

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

public func describeGlobalNetworksPaginator(_ input: DescribeGlobalNetworksRequest, onPage: @escaping (DescribeGlobalNetworksResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    getCustomerGatewayAssociationsPaginator(_:onPage:)

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

Declaration

Swift

public func getCustomerGatewayAssociationsPaginator(_ input: GetCustomerGatewayAssociationsRequest, onPage: @escaping (GetCustomerGatewayAssociationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    getDevicesPaginator(_:onPage:)

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

Declaration

Swift

public func getDevicesPaginator(_ input: GetDevicesRequest, onPage: @escaping (GetDevicesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    getLinkAssociationsPaginator(_:onPage:)

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

Declaration

Swift

public func getLinkAssociationsPaginator(_ input: GetLinkAssociationsRequest, onPage: @escaping (GetLinkAssociationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

getLinksPaginator(_:onPage:)
Gets information about one or more links in a specified global network. If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.
Declaration
Swift

public func getLinksPaginator(_ input: GetLinksRequest, onPage: @escaping (GetLinksResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    getSitesPaginator(_:onPage:)

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

Declaration

Swift

public func getSitesPaginator(_ input: GetSitesRequest, onPage: @escaping (GetSitesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    getTransitGatewayRegistrationsPaginator(_:onPage:)

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

Declaration

Swift

public func getTransitGatewayRegistrationsPaginator(_ input: GetTransitGatewayRegistrationsRequest, onPage: @escaping (GetTransitGatewayRegistrationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    DescribeGlobalNetworksRequest

Undocumented

Declaration

Swift

public struct DescribeGlobalNetworksRequest : AWSShape

extension NetworkManager.DescribeGlobalNetworksRequest: AWSPaginateStringToken


                    
                    
                    GetCustomerGatewayAssociationsRequest

Undocumented

Declaration

Swift

public struct GetCustomerGatewayAssociationsRequest : AWSShape

extension NetworkManager.GetCustomerGatewayAssociationsRequest: AWSPaginateStringToken


                    
                    
                    GetDevicesRequest

Undocumented

Declaration

Swift

public struct GetDevicesRequest : AWSShape

extension NetworkManager.GetDevicesRequest: AWSPaginateStringToken


                    
                    
                    GetLinkAssociationsRequest

Undocumented

Declaration

Swift

public struct GetLinkAssociationsRequest : AWSShape

extension NetworkManager.GetLinkAssociationsRequest: AWSPaginateStringToken


                    
                    
                    GetLinksRequest

Undocumented

Declaration

Swift

public struct GetLinksRequest : AWSShape

extension NetworkManager.GetLinksRequest: AWSPaginateStringToken


                    
                    
                    GetSitesRequest

Undocumented

Declaration

Swift

public struct GetSitesRequest : AWSShape

extension NetworkManager.GetSitesRequest: AWSPaginateStringToken


                    
                    
                    GetTransitGatewayRegistrationsRequest

Undocumented

Declaration

Swift

public struct GetTransitGatewayRegistrationsRequest : AWSShape

extension NetworkManager.GetTransitGatewayRegistrationsRequest: AWSPaginateStringToken

AssociateCustomerGatewayRequest
Undocumented
See more
Declaration
Swift

public struct AssociateCustomerGatewayRequest : AWSShape
AssociateCustomerGatewayResponse
Undocumented
See more
Declaration
Swift

public struct AssociateCustomerGatewayResponse : AWSShape
AssociateLinkRequest
Undocumented
See more
Declaration
Swift

public struct AssociateLinkRequest : AWSShape
AssociateLinkResponse
Undocumented
See more
Declaration
Swift

public struct AssociateLinkResponse : AWSShape
Bandwidth
Undocumented
See more
Declaration
Swift

public struct Bandwidth : AWSShape
CreateDeviceRequest
Undocumented
See more
Declaration
Swift

public struct CreateDeviceRequest : AWSShape
CreateDeviceResponse
Undocumented
See more
Declaration
Swift

public struct CreateDeviceResponse : AWSShape
CreateGlobalNetworkRequest
Undocumented
See more
Declaration
Swift

public struct CreateGlobalNetworkRequest : AWSShape
CreateGlobalNetworkResponse
Undocumented
See more
Declaration
Swift

public struct CreateGlobalNetworkResponse : AWSShape
CreateLinkRequest
Undocumented
See more
Declaration
Swift

public struct CreateLinkRequest : AWSShape
CreateLinkResponse
Undocumented
See more
Declaration
Swift

public struct CreateLinkResponse : AWSShape
CreateSiteRequest
Undocumented
See more
Declaration
Swift

public struct CreateSiteRequest : AWSShape
CreateSiteResponse
Undocumented
See more
Declaration
Swift

public struct CreateSiteResponse : AWSShape
CustomerGatewayAssociation
Undocumented
See more
Declaration
Swift

public struct CustomerGatewayAssociation : AWSShape
DeleteDeviceRequest
Undocumented
See more
Declaration
Swift

public struct DeleteDeviceRequest : AWSShape
DeleteDeviceResponse
Undocumented
See more
Declaration
Swift

public struct DeleteDeviceResponse : AWSShape
DeleteGlobalNetworkRequest
Undocumented
See more
Declaration
Swift

public struct DeleteGlobalNetworkRequest : AWSShape
DeleteGlobalNetworkResponse
Undocumented
See more
Declaration
Swift

public struct DeleteGlobalNetworkResponse : AWSShape
DeleteLinkRequest
Undocumented
See more
Declaration
Swift

public struct DeleteLinkRequest : AWSShape
DeleteLinkResponse
Undocumented
See more
Declaration
Swift

public struct DeleteLinkResponse : AWSShape
DeleteSiteRequest
Undocumented
See more
Declaration
Swift

public struct DeleteSiteRequest : AWSShape
DeleteSiteResponse
Undocumented
See more
Declaration
Swift

public struct DeleteSiteResponse : AWSShape
DeregisterTransitGatewayRequest
Undocumented
See more
Declaration
Swift

public struct DeregisterTransitGatewayRequest : AWSShape
DeregisterTransitGatewayResponse
Undocumented
See more
Declaration
Swift

public struct DeregisterTransitGatewayResponse : AWSShape
DescribeGlobalNetworksResponse
Undocumented
See more
Declaration
Swift

public struct DescribeGlobalNetworksResponse : AWSShape
Device
Undocumented
See more
Declaration
Swift

public struct Device : AWSShape
DisassociateCustomerGatewayRequest
Undocumented
See more
Declaration
Swift

public struct DisassociateCustomerGatewayRequest : AWSShape
DisassociateCustomerGatewayResponse
Undocumented
See more
Declaration
Swift

public struct DisassociateCustomerGatewayResponse : AWSShape
DisassociateLinkRequest
Undocumented
See more
Declaration
Swift

public struct DisassociateLinkRequest : AWSShape
DisassociateLinkResponse
Undocumented
See more
Declaration
Swift

public struct DisassociateLinkResponse : AWSShape
GetCustomerGatewayAssociationsResponse
Undocumented
See more
Declaration
Swift

public struct GetCustomerGatewayAssociationsResponse : AWSShape
GetDevicesResponse
Undocumented
See more
Declaration
Swift

public struct GetDevicesResponse : AWSShape
GetLinkAssociationsResponse
Undocumented
See more
Declaration
Swift

public struct GetLinkAssociationsResponse : AWSShape
GetLinksResponse
Undocumented
See more
Declaration
Swift

public struct GetLinksResponse : AWSShape
GetSitesResponse
Undocumented
See more
Declaration
Swift

public struct GetSitesResponse : AWSShape
GetTransitGatewayRegistrationsResponse
Undocumented
See more
Declaration
Swift

public struct GetTransitGatewayRegistrationsResponse : AWSShape
GlobalNetwork
Undocumented
See more
Declaration
Swift

public struct GlobalNetwork : AWSShape
Link
Undocumented
See more
Declaration
Swift

public struct Link : AWSShape
LinkAssociation
Undocumented
See more
Declaration
Swift

public struct LinkAssociation : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
Location
Undocumented
See more
Declaration
Swift

public struct Location : AWSShape
RegisterTransitGatewayRequest
Undocumented
See more
Declaration
Swift

public struct RegisterTransitGatewayRequest : AWSShape
RegisterTransitGatewayResponse
Undocumented
See more
Declaration
Swift

public struct RegisterTransitGatewayResponse : AWSShape
Site
Undocumented
See more
Declaration
Swift

public struct Site : AWSShape
Tag
Undocumented
See more
Declaration
Swift

public struct Tag : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
TagResourceResponse
Undocumented
See more
Declaration
Swift

public struct TagResourceResponse : AWSShape
TransitGatewayRegistration
Undocumented
See more
Declaration
Swift

public struct TransitGatewayRegistration : AWSShape
TransitGatewayRegistrationStateReason
Undocumented
See more
Declaration
Swift

public struct TransitGatewayRegistrationStateReason : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UntagResourceResponse
Undocumented
See more
Declaration
Swift

public struct UntagResourceResponse : AWSShape
UpdateDeviceRequest
Undocumented
See more
Declaration
Swift

public struct UpdateDeviceRequest : AWSShape
UpdateDeviceResponse
Undocumented
See more
Declaration
Swift

public struct UpdateDeviceResponse : AWSShape
UpdateGlobalNetworkRequest
Undocumented
See more
Declaration
Swift

public struct UpdateGlobalNetworkRequest : AWSShape
UpdateGlobalNetworkResponse
Undocumented
See more
Declaration
Swift

public struct UpdateGlobalNetworkResponse : AWSShape
UpdateLinkRequest
Undocumented
See more
Declaration
Swift

public struct UpdateLinkRequest : AWSShape
UpdateLinkResponse
Undocumented
See more
Declaration
Swift

public struct UpdateLinkResponse : AWSShape
UpdateSiteRequest
Undocumented
See more
Declaration
Swift

public struct UpdateSiteRequest : AWSShape
UpdateSiteResponse
Undocumented
See more
Declaration
Swift

public struct UpdateSiteResponse : AWSShape

Enums


                    
                    
                    CustomerGatewayAssociationState

Undocumented

Declaration

Swift

public enum CustomerGatewayAssociationState : String, CustomStringConvertible, Codable


                    
                    
                    DeviceState

Undocumented

Declaration

Swift

public enum DeviceState : String, CustomStringConvertible, Codable


                    
                    
                    GlobalNetworkState

Undocumented

Declaration

Swift

public enum GlobalNetworkState : String, CustomStringConvertible, Codable


                    
                    
                    LinkAssociationState

Undocumented

Declaration

Swift

public enum LinkAssociationState : String, CustomStringConvertible, Codable


                    
                    
                    LinkState

Undocumented

Declaration

Swift

public enum LinkState : String, CustomStringConvertible, Codable


                    
                    
                    SiteState

Undocumented

Declaration

Swift

public enum SiteState : String, CustomStringConvertible, Codable


                    
                    
                    TransitGatewayRegistrationState

Undocumented

Declaration

Swift

public enum TransitGatewayRegistrationState : String, CustomStringConvertible, Codable