python-botocore/botocore/data/networkmanager/2019-07-05/service-2.json

3719 lines
126 KiB
JSON
Raw Normal View History

2019-12-12 10:04:05 +01:00
{
"version":"2.0",
"metadata":{
"apiVersion":"2019-07-05",
"endpointPrefix":"networkmanager",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceAbbreviation":"NetworkManager",
"serviceFullName":"AWS Network Manager",
"serviceId":"NetworkManager",
"signatureVersion":"v4",
"signingName":"networkmanager",
"uid":"networkmanager-2019-07-05"
},
"operations":{
"AssociateCustomerGateway":{
"name":"AssociateCustomerGateway",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/customer-gateway-associations"
},
"input":{"shape":"AssociateCustomerGatewayRequest"},
"output":{"shape":"AssociateCustomerGatewayResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>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. </p> <p>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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnConnections.html\">DescribeVpnConnections</a> EC2 API and filter by <code>transit-gateway-id</code>.</p> <p>You cannot associate a customer gateway with more than one device and link. </p>"
},
"AssociateLink":{
"name":"AssociateLink",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/link-associations"
},
"input":{"shape":"AssociateLinkRequest"},
"output":{"shape":"AssociateLinkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>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.</p>"
},
2021-01-26 16:12:20 +01:00
"AssociateTransitGatewayConnectPeer":{
"name":"AssociateTransitGatewayConnectPeer",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations"
},
"input":{"shape":"AssociateTransitGatewayConnectPeerRequest"},
"output":{"shape":"AssociateTransitGatewayConnectPeerResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device. </p> <p>You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.</p> <p>You cannot associate a transit gateway Connect peer with more than one device and link. </p>"
},
"CreateConnection":{
"name":"CreateConnection",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/connections"
},
"input":{"shape":"CreateConnectionRequest"},
"output":{"shape":"CreateConnectionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.</p>"
},
2019-12-12 10:04:05 +01:00
"CreateDevice":{
"name":"CreateDevice",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/devices"
},
"input":{"shape":"CreateDeviceRequest"},
"output":{"shape":"CreateDeviceResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>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.</p>"
},
"CreateGlobalNetwork":{
"name":"CreateGlobalNetwork",
"http":{
"method":"POST",
"requestUri":"/global-networks"
},
"input":{"shape":"CreateGlobalNetworkRequest"},
"output":{"shape":"CreateGlobalNetworkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Creates a new, empty global network.</p>"
},
"CreateLink":{
"name":"CreateLink",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/links"
},
"input":{"shape":"CreateLinkRequest"},
"output":{"shape":"CreateLinkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Creates a new link for a specified site.</p>"
},
"CreateSite":{
"name":"CreateSite",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/sites"
},
"input":{"shape":"CreateSiteRequest"},
"output":{"shape":"CreateSiteResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Creates a new site in a global network.</p>"
},
2021-01-26 16:12:20 +01:00
"DeleteConnection":{
"name":"DeleteConnection",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/connections/{connectionId}"
},
"input":{"shape":"DeleteConnectionRequest"},
"output":{"shape":"DeleteConnectionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Deletes the specified connection in your global network.</p>"
},
2019-12-12 10:04:05 +01:00
"DeleteDevice":{
"name":"DeleteDevice",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/devices/{deviceId}"
},
"input":{"shape":"DeleteDeviceRequest"},
"output":{"shape":"DeleteDeviceResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Deletes an existing device. You must first disassociate the device from any links and customer gateways.</p>"
},
"DeleteGlobalNetwork":{
"name":"DeleteGlobalNetwork",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}"
},
"input":{"shape":"DeleteGlobalNetworkRequest"},
"output":{"shape":"DeleteGlobalNetworkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.</p>"
},
"DeleteLink":{
"name":"DeleteLink",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/links/{linkId}"
},
"input":{"shape":"DeleteLinkRequest"},
"output":{"shape":"DeleteLinkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Deletes an existing link. You must first disassociate the link from any devices and customer gateways.</p>"
},
"DeleteSite":{
"name":"DeleteSite",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/sites/{siteId}"
},
"input":{"shape":"DeleteSiteRequest"},
"output":{"shape":"DeleteSiteResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Deletes an existing site. The site cannot be associated with any device or link.</p>"
},
"DeregisterTransitGateway":{
"name":"DeregisterTransitGateway",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/transit-gateway-registrations/{transitGatewayArn}"
},
"input":{"shape":"DeregisterTransitGatewayRequest"},
"output":{"shape":"DeregisterTransitGatewayResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>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.</p>"
},
"DescribeGlobalNetworks":{
"name":"DescribeGlobalNetworks",
"http":{
"method":"GET",
"requestUri":"/global-networks"
},
"input":{"shape":"DescribeGlobalNetworksRequest"},
"output":{"shape":"DescribeGlobalNetworksResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>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 <code>Get*</code> action. For example, to list the transit gateways in your global network, use <a>GetTransitGatewayRegistrations</a>.</p>"
},
"DisassociateCustomerGateway":{
"name":"DisassociateCustomerGateway",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/customer-gateway-associations/{customerGatewayArn}"
},
"input":{"shape":"DisassociateCustomerGatewayRequest"},
"output":{"shape":"DisassociateCustomerGatewayResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Disassociates a customer gateway from a device and a link.</p>"
},
"DisassociateLink":{
"name":"DisassociateLink",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/link-associations"
},
"input":{"shape":"DisassociateLinkRequest"},
"output":{"shape":"DisassociateLinkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.</p>"
},
2021-01-26 16:12:20 +01:00
"DisassociateTransitGatewayConnectPeer":{
"name":"DisassociateTransitGatewayConnectPeer",
"http":{
"method":"DELETE",
"requestUri":"/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations/{transitGatewayConnectPeerArn}"
},
"input":{"shape":"DisassociateTransitGatewayConnectPeerRequest"},
"output":{"shape":"DisassociateTransitGatewayConnectPeerResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Disassociates a transit gateway Connect peer from a device and link.</p>"
},
"GetConnections":{
"name":"GetConnections",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/connections"
},
"input":{"shape":"GetConnectionsRequest"},
"output":{"shape":"GetConnectionsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets information about one or more of your connections in a global network.</p>"
},
2019-12-12 10:04:05 +01:00
"GetCustomerGatewayAssociations":{
"name":"GetCustomerGatewayAssociations",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/customer-gateway-associations"
},
"input":{"shape":"GetCustomerGatewayAssociationsRequest"},
"output":{"shape":"GetCustomerGatewayAssociationsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the association information for customer gateways that are associated with devices and links in your global network.</p>"
},
"GetDevices":{
"name":"GetDevices",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/devices"
},
"input":{"shape":"GetDevicesRequest"},
"output":{"shape":"GetDevicesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets information about one or more of your devices in a global network.</p>"
},
"GetLinkAssociations":{
"name":"GetLinkAssociations",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/link-associations"
},
"input":{"shape":"GetLinkAssociationsRequest"},
"output":{"shape":"GetLinkAssociationsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.</p>"
},
"GetLinks":{
"name":"GetLinks",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/links"
},
"input":{"shape":"GetLinksRequest"},
"output":{"shape":"GetLinksResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets information about one or more links in a specified global network.</p> <p>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.</p>"
},
2021-11-03 18:14:15 +01:00
"GetNetworkResourceCounts":{
"name":"GetNetworkResourceCounts",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/network-resource-count"
},
"input":{"shape":"GetNetworkResourceCountsRequest"},
"output":{"shape":"GetNetworkResourceCountsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the count of network resources, by resource type, for the specified global network.</p>"
},
"GetNetworkResourceRelationships":{
"name":"GetNetworkResourceRelationships",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/network-resource-relationships"
},
"input":{"shape":"GetNetworkResourceRelationshipsRequest"},
"output":{"shape":"GetNetworkResourceRelationshipsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the network resource relationships for the specified global network.</p>"
},
"GetNetworkResources":{
"name":"GetNetworkResources",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/network-resources"
},
"input":{"shape":"GetNetworkResourcesRequest"},
"output":{"shape":"GetNetworkResourcesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Describes the network resources for the specified global network.</p> <p>The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.</p>"
},
"GetNetworkRoutes":{
"name":"GetNetworkRoutes",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/network-routes"
},
"input":{"shape":"GetNetworkRoutesRequest"},
"output":{"shape":"GetNetworkRoutesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the network routes of the specified global network.</p>"
},
"GetNetworkTelemetry":{
"name":"GetNetworkTelemetry",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/network-telemetry"
},
"input":{"shape":"GetNetworkTelemetryRequest"},
"output":{"shape":"GetNetworkTelemetryResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the network telemetry of the specified global network.</p>"
},
"GetRouteAnalysis":{
"name":"GetRouteAnalysis",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/route-analyses/{routeAnalysisId}"
},
"input":{"shape":"GetRouteAnalysisRequest"},
"output":{"shape":"GetRouteAnalysisResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets information about the specified route analysis.</p>"
},
2019-12-12 10:04:05 +01:00
"GetSites":{
"name":"GetSites",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/sites"
},
"input":{"shape":"GetSitesRequest"},
"output":{"shape":"GetSitesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets information about one or more of your sites in a global network.</p>"
},
2021-01-26 16:12:20 +01:00
"GetTransitGatewayConnectPeerAssociations":{
"name":"GetTransitGatewayConnectPeerAssociations",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations"
},
"input":{"shape":"GetTransitGatewayConnectPeerAssociationsRequest"},
"output":{"shape":"GetTransitGatewayConnectPeerAssociationsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets information about one or more of your transit gateway Connect peer associations in a global network.</p>"
},
2019-12-12 10:04:05 +01:00
"GetTransitGatewayRegistrations":{
"name":"GetTransitGatewayRegistrations",
"http":{
"method":"GET",
"requestUri":"/global-networks/{globalNetworkId}/transit-gateway-registrations"
},
"input":{"shape":"GetTransitGatewayRegistrationsRequest"},
"output":{"shape":"GetTransitGatewayRegistrationsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets information about the transit gateway registrations in a specified global network.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Lists the tags for a specified resource.</p>"
},
"RegisterTransitGateway":{
"name":"RegisterTransitGateway",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/transit-gateway-registrations"
},
"input":{"shape":"RegisterTransitGatewayRequest"},
"output":{"shape":"RegisterTransitGatewayResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
2021-11-03 18:14:15 +01:00
"documentation":"<p>Registers a transit gateway in your global network. The transit gateway can be in any Amazon Web Services Region, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.</p>"
},
"StartRouteAnalysis":{
"name":"StartRouteAnalysis",
"http":{
"method":"POST",
"requestUri":"/global-networks/{globalNetworkId}/route-analyses"
},
"input":{"shape":"StartRouteAnalysisRequest"},
"output":{"shape":"StartRouteAnalysisResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts analyzing the routing path between the specified source and destination. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/tgw/route-analyzer.html\">Route Analyzer</a>.</p>"
2019-12-12 10:04:05 +01:00
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Tags a specified resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Removes tags from a specified resource.</p>"
},
2021-01-26 16:12:20 +01:00
"UpdateConnection":{
"name":"UpdateConnection",
"http":{
"method":"PATCH",
"requestUri":"/global-networks/{globalNetworkId}/connections/{connectionId}"
},
"input":{"shape":"UpdateConnectionRequest"},
"output":{"shape":"UpdateConnectionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.</p>"
},
2019-12-12 10:04:05 +01:00
"UpdateDevice":{
"name":"UpdateDevice",
"http":{
"method":"PATCH",
"requestUri":"/global-networks/{globalNetworkId}/devices/{deviceId}"
},
"input":{"shape":"UpdateDeviceRequest"},
"output":{"shape":"UpdateDeviceResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.</p>"
},
"UpdateGlobalNetwork":{
"name":"UpdateGlobalNetwork",
"http":{
"method":"PATCH",
"requestUri":"/global-networks/{globalNetworkId}"
},
"input":{"shape":"UpdateGlobalNetworkRequest"},
"output":{"shape":"UpdateGlobalNetworkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Updates an existing global network. To remove information for any of the parameters, specify an empty string.</p>"
},
"UpdateLink":{
"name":"UpdateLink",
"http":{
"method":"PATCH",
"requestUri":"/global-networks/{globalNetworkId}/links/{linkId}"
},
"input":{"shape":"UpdateLinkRequest"},
"output":{"shape":"UpdateLinkResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.</p>"
},
2021-11-03 18:14:15 +01:00
"UpdateNetworkResourceMetadata":{
"name":"UpdateNetworkResourceMetadata",
"http":{
"method":"PATCH",
"requestUri":"/global-networks/{globalNetworkId}/network-resources/{resourceArn}/metadata"
},
"input":{"shape":"UpdateNetworkResourceMetadataRequest"},
"output":{"shape":"UpdateNetworkResourceMetadataResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Updates the resource metadata for the specified global network.</p>"
},
2019-12-12 10:04:05 +01:00
"UpdateSite":{
"name":"UpdateSite",
"http":{
"method":"PATCH",
"requestUri":"/global-networks/{globalNetworkId}/sites/{siteId}"
},
"input":{"shape":"UpdateSiteRequest"},
"output":{"shape":"UpdateSiteResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.</p>"
}
},
"shapes":{
2021-01-26 16:12:20 +01:00
"AWSLocation":{
"type":"structure",
"members":{
"Zone":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.</p>"
2021-01-26 16:12:20 +01:00
},
"SubnetArn":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Amazon Resource Name (ARN) of the subnet that the device is located in.</p>"
2021-01-26 16:12:20 +01:00
}
},
2021-11-03 18:14:15 +01:00
"documentation":"<p>Specifies a location in Amazon Web Services.</p>"
2021-01-26 16:12:20 +01:00
},
2019-12-12 10:04:05 +01:00
"AccessDeniedException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>You do not have sufficient access to perform this action.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"AssociateCustomerGatewayRequest":{
"type":"structure",
"required":[
"CustomerGatewayArn",
"GlobalNetworkId",
"DeviceId"
],
"members":{
"CustomerGatewayArn":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Amazon Resource Name (ARN) of the customer gateway.</p>"
2019-12-12 10:04:05 +01:00
},
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>"
}
}
},
"AssociateCustomerGatewayResponse":{
"type":"structure",
"members":{
"CustomerGatewayAssociation":{
"shape":"CustomerGatewayAssociation",
"documentation":"<p>The customer gateway association.</p>"
}
}
},
"AssociateLinkRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"DeviceId",
"LinkId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>"
}
}
},
"AssociateLinkResponse":{
"type":"structure",
"members":{
"LinkAssociation":{
"shape":"LinkAssociation",
"documentation":"<p>The link association.</p>"
}
}
},
2021-01-26 16:12:20 +01:00
"AssociateTransitGatewayConnectPeerRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"TransitGatewayConnectPeerArn",
"DeviceId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"TransitGatewayConnectPeerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Connect peer.</p>"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>"
}
}
},
"AssociateTransitGatewayConnectPeerResponse":{
"type":"structure",
"members":{
"TransitGatewayConnectPeerAssociation":{
"shape":"TransitGatewayConnectPeerAssociation",
"documentation":"<p>The transit gateway Connect peer association.</p>"
}
}
},
2019-12-12 10:04:05 +01:00
"Bandwidth":{
"type":"structure",
"members":{
"UploadSpeed":{
"shape":"Integer",
"documentation":"<p>Upload speed in Mbps.</p>"
},
"DownloadSpeed":{
"shape":"Integer",
"documentation":"<p>Download speed in Mbps.</p>"
}
},
"documentation":"<p>Describes bandwidth information.</p>"
},
2021-11-03 18:14:15 +01:00
"Boolean":{"type":"boolean"},
2019-12-12 10:04:05 +01:00
"ConflictException":{
"type":"structure",
"required":[
"Message",
"ResourceId",
"ResourceType"
],
"members":{
"Message":{"shape":"String"},
"ResourceId":{
"shape":"String",
"documentation":"<p>The ID of the resource.</p>"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
}
},
"documentation":"<p>There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
2021-01-26 16:12:20 +01:00
"Connection":{
"type":"structure",
"members":{
"ConnectionId":{
"shape":"String",
"documentation":"<p>The ID of the connection.</p>"
},
"ConnectionArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the connection.</p>"
},
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the first device in the connection.</p>"
},
"ConnectedDeviceId":{
"shape":"String",
"documentation":"<p>The ID of the second device in the connection.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link for the first device in the connection.</p>"
},
"ConnectedLinkId":{
"shape":"String",
"documentation":"<p>The ID of the link for the second device in the connection.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description of the connection.</p>"
},
"CreatedAt":{
"shape":"DateTime",
"documentation":"<p>The date and time that the connection was created.</p>"
},
"State":{
"shape":"ConnectionState",
"documentation":"<p>The state of the connection.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags for the connection.</p>"
}
},
"documentation":"<p>Describes a connection.</p>"
},
2021-11-03 18:14:15 +01:00
"ConnectionHealth":{
"type":"structure",
"members":{
"Type":{
"shape":"ConnectionType",
"documentation":"<p>The connection type.</p>"
},
"Status":{
"shape":"ConnectionStatus",
"documentation":"<p>The connection status.</p>"
},
"Timestamp":{
"shape":"DateTime",
"documentation":"<p>The time the status was last updated.</p>"
}
},
"documentation":"<p>Describes connection health.</p>"
},
2021-01-26 16:12:20 +01:00
"ConnectionList":{
"type":"list",
"member":{"shape":"Connection"}
},
"ConnectionState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"UPDATING"
]
},
2021-11-03 18:14:15 +01:00
"ConnectionStatus":{
"type":"string",
"enum":[
"UP",
"DOWN"
]
},
"ConnectionType":{
"type":"string",
"enum":[
"BGP",
"IPSEC"
]
},
2021-01-26 16:12:20 +01:00
"CreateConnectionRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"DeviceId",
"ConnectedDeviceId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the first device in the connection.</p>"
},
"ConnectedDeviceId":{
"shape":"String",
"documentation":"<p>The ID of the second device in the connection.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link for the first device.</p>"
},
"ConnectedLinkId":{
"shape":"String",
"documentation":"<p>The ID of the link for the second device.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>A description of the connection.</p> <p>Length Constraints: Maximum length of 256 characters.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to apply to the resource during creation.</p>"
}
}
},
"CreateConnectionResponse":{
"type":"structure",
"members":{
"Connection":{
"shape":"Connection",
"documentation":"<p>Information about the connection.</p>"
}
}
},
2019-12-12 10:04:05 +01:00
"CreateDeviceRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
2021-01-26 16:12:20 +01:00
"AWSLocation":{
"shape":"AWSLocation",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.</p>"
2021-01-26 16:12:20 +01:00
},
2019-12-12 10:04:05 +01:00
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of the device.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Type":{
"shape":"String",
"documentation":"<p>The type of the device.</p>"
},
"Vendor":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The vendor of the device.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Model":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The model of the device.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"SerialNumber":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The serial number of the device.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Location":{
"shape":"Location",
"documentation":"<p>The location of the device.</p>"
},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to apply to the resource during creation.</p>"
}
}
},
"CreateDeviceResponse":{
"type":"structure",
"members":{
"Device":{
"shape":"Device",
"documentation":"<p>Information about the device.</p>"
}
}
},
"CreateGlobalNetworkRequest":{
"type":"structure",
"members":{
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of the global network.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to apply to the resource during creation.</p>"
}
}
},
"CreateGlobalNetworkResponse":{
"type":"structure",
"members":{
"GlobalNetwork":{
"shape":"GlobalNetwork",
"documentation":"<p>Information about the global network object.</p>"
}
}
},
"CreateLinkRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"Bandwidth",
"SiteId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of the link.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Type":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The type of the link.</p> <p>Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^</p>"
2019-12-12 10:04:05 +01:00
},
"Bandwidth":{
"shape":"Bandwidth",
"documentation":"<p> The upload speed and download speed in Mbps. </p>"
},
"Provider":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The provider of the link.</p> <p>Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^</p>"
2019-12-12 10:04:05 +01:00
},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to apply to the resource during creation.</p>"
}
}
},
"CreateLinkResponse":{
"type":"structure",
"members":{
"Link":{
"shape":"Link",
"documentation":"<p>Information about the link.</p>"
}
}
},
"CreateSiteRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of your site.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Location":{
"shape":"Location",
"documentation":"<p>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.</p> <ul> <li> <p> <code>Address</code>: The physical address of the site.</p> </li> <li> <p> <code>Latitude</code>: The latitude of the site. </p> </li> <li> <p> <code>Longitude</code>: The longitude of the site.</p> </li> </ul>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to apply to the resource during creation.</p>"
}
}
},
"CreateSiteResponse":{
"type":"structure",
"members":{
"Site":{
"shape":"Site",
"documentation":"<p>Information about the site.</p>"
}
}
},
"CustomerGatewayAssociation":{
"type":"structure",
"members":{
"CustomerGatewayArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the customer gateway.</p>"
},
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>"
},
"State":{
"shape":"CustomerGatewayAssociationState",
"documentation":"<p>The association state.</p>"
}
},
"documentation":"<p>Describes the association between a customer gateway, a device, and a link.</p>"
},
"CustomerGatewayAssociationList":{
"type":"list",
"member":{"shape":"CustomerGatewayAssociation"}
},
"CustomerGatewayAssociationState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"DELETED"
]
},
"DateTime":{"type":"timestamp"},
2021-01-26 16:12:20 +01:00
"DeleteConnectionRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"ConnectionId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"ConnectionId":{
"shape":"String",
"documentation":"<p>The ID of the connection.</p>",
"location":"uri",
"locationName":"connectionId"
}
}
},
"DeleteConnectionResponse":{
"type":"structure",
"members":{
"Connection":{
"shape":"Connection",
"documentation":"<p>Information about the connection.</p>"
}
}
},
2019-12-12 10:04:05 +01:00
"DeleteDeviceRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"DeviceId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>",
"location":"uri",
"locationName":"deviceId"
}
}
},
"DeleteDeviceResponse":{
"type":"structure",
"members":{
"Device":{
"shape":"Device",
"documentation":"<p>Information about the device.</p>"
}
}
},
"DeleteGlobalNetworkRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
}
}
},
"DeleteGlobalNetworkResponse":{
"type":"structure",
"members":{
"GlobalNetwork":{
"shape":"GlobalNetwork",
"documentation":"<p>Information about the global network.</p>"
}
}
},
"DeleteLinkRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"LinkId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>",
"location":"uri",
"locationName":"linkId"
}
}
},
"DeleteLinkResponse":{
"type":"structure",
"members":{
"Link":{
"shape":"Link",
"documentation":"<p>Information about the link.</p>"
}
}
},
"DeleteSiteRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"SiteId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>",
"location":"uri",
"locationName":"siteId"
}
}
},
"DeleteSiteResponse":{
"type":"structure",
"members":{
"Site":{
"shape":"Site",
"documentation":"<p>Information about the site.</p>"
}
}
},
"DeregisterTransitGatewayRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"TransitGatewayArn"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"TransitGatewayArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the transit gateway.</p>",
"location":"uri",
"locationName":"transitGatewayArn"
}
}
},
"DeregisterTransitGatewayResponse":{
"type":"structure",
"members":{
"TransitGatewayRegistration":{
"shape":"TransitGatewayRegistration",
"documentation":"<p>The transit gateway registration information.</p>"
}
}
},
"DescribeGlobalNetworksRequest":{
"type":"structure",
"members":{
"GlobalNetworkIds":{
"shape":"StringList",
"documentation":"<p>The IDs of one or more global networks. The maximum is 10.</p>",
"location":"querystring",
"locationName":"globalNetworkIds"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"DescribeGlobalNetworksResponse":{
"type":"structure",
"members":{
"GlobalNetworks":{
"shape":"GlobalNetworkList",
"documentation":"<p>Information about the global networks.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
"Device":{
"type":"structure",
"members":{
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>"
},
"DeviceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the device.</p>"
},
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
2021-01-26 16:12:20 +01:00
"AWSLocation":{
"shape":"AWSLocation",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Amazon Web Services location of the device.</p>"
2021-01-26 16:12:20 +01:00
},
2019-12-12 10:04:05 +01:00
"Description":{
"shape":"String",
"documentation":"<p>The description of the device.</p>"
},
"Type":{
"shape":"String",
"documentation":"<p>The device type.</p>"
},
"Vendor":{
"shape":"String",
"documentation":"<p>The device vendor.</p>"
},
"Model":{
"shape":"String",
"documentation":"<p>The device model.</p>"
},
"SerialNumber":{
"shape":"String",
"documentation":"<p>The device serial number.</p>"
},
"Location":{
"shape":"Location",
"documentation":"<p>The site location.</p>"
},
"SiteId":{
"shape":"String",
"documentation":"<p>The site ID.</p>"
},
"CreatedAt":{
"shape":"DateTime",
"documentation":"<p>The date and time that the site was created.</p>"
},
"State":{
"shape":"DeviceState",
"documentation":"<p>The device state.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags for the device.</p>"
}
},
"documentation":"<p>Describes a device.</p>"
},
"DeviceList":{
"type":"list",
"member":{"shape":"Device"}
},
"DeviceState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"UPDATING"
]
},
"DisassociateCustomerGatewayRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"CustomerGatewayArn"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"CustomerGatewayArn":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Amazon Resource Name (ARN) of the customer gateway.</p>",
2019-12-12 10:04:05 +01:00
"location":"uri",
"locationName":"customerGatewayArn"
}
}
},
"DisassociateCustomerGatewayResponse":{
"type":"structure",
"members":{
"CustomerGatewayAssociation":{
"shape":"CustomerGatewayAssociation",
"documentation":"<p>Information about the customer gateway association.</p>"
}
}
},
"DisassociateLinkRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"DeviceId",
"LinkId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>",
"location":"querystring",
"locationName":"deviceId"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>",
"location":"querystring",
"locationName":"linkId"
}
}
},
"DisassociateLinkResponse":{
"type":"structure",
"members":{
"LinkAssociation":{
"shape":"LinkAssociation",
"documentation":"<p>Information about the link association.</p>"
}
}
},
2021-01-26 16:12:20 +01:00
"DisassociateTransitGatewayConnectPeerRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"TransitGatewayConnectPeerArn"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"TransitGatewayConnectPeerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the transit gateway Connect peer.</p>",
"location":"uri",
"locationName":"transitGatewayConnectPeerArn"
}
}
},
"DisassociateTransitGatewayConnectPeerResponse":{
"type":"structure",
"members":{
"TransitGatewayConnectPeerAssociation":{
"shape":"TransitGatewayConnectPeerAssociation",
"documentation":"<p>The transit gateway Connect peer association.</p>"
}
}
},
2021-11-03 18:14:15 +01:00
"ExceptionContextKey":{"type":"string"},
"ExceptionContextMap":{
"type":"map",
"key":{"shape":"ExceptionContextKey"},
"value":{"shape":"ExceptionContextValue"}
},
"ExceptionContextValue":{"type":"string"},
"FilterMap":{
"type":"map",
"key":{"shape":"FilterName"},
"value":{"shape":"FilterValues"}
},
"FilterName":{
"type":"string",
"max":128,
"pattern":"^[0-9a-zA-Z\\.-]*$"
},
"FilterValue":{
"type":"string",
"max":255,
"pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?-]*$"
},
"FilterValues":{
"type":"list",
"member":{"shape":"FilterValue"}
},
2021-01-26 16:12:20 +01:00
"GetConnectionsRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"ConnectionIds":{
"shape":"StringList",
"documentation":"<p>One or more connection IDs.</p>",
"location":"querystring",
"locationName":"connectionIds"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>",
"location":"querystring",
"locationName":"deviceId"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetConnectionsResponse":{
"type":"structure",
"members":{
"Connections":{
"shape":"ConnectionList",
"documentation":"<p>Information about the connections.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token to use for the next page of results.</p>"
}
}
},
2019-12-12 10:04:05 +01:00
"GetCustomerGatewayAssociationsRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"CustomerGatewayArns":{
"shape":"StringList",
2021-11-03 18:14:15 +01:00
"documentation":"<p>One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.</p>",
2019-12-12 10:04:05 +01:00
"location":"querystring",
"locationName":"customerGatewayArns"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetCustomerGatewayAssociationsResponse":{
"type":"structure",
"members":{
"CustomerGatewayAssociations":{
"shape":"CustomerGatewayAssociationList",
"documentation":"<p>The customer gateway associations.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
"GetDevicesRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceIds":{
"shape":"StringList",
"documentation":"<p>One or more device IDs. The maximum is 10.</p>",
"location":"querystring",
"locationName":"deviceIds"
},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>",
"location":"querystring",
"locationName":"siteId"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetDevicesResponse":{
"type":"structure",
"members":{
"Devices":{
"shape":"DeviceList",
"documentation":"<p>The devices.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
"GetLinkAssociationsRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>",
"location":"querystring",
"locationName":"deviceId"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>",
"location":"querystring",
"locationName":"linkId"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetLinkAssociationsResponse":{
"type":"structure",
"members":{
"LinkAssociations":{
"shape":"LinkAssociationList",
"documentation":"<p>The link associations.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
"GetLinksRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"LinkIds":{
"shape":"StringList",
"documentation":"<p>One or more link IDs. The maximum is 10.</p>",
"location":"querystring",
"locationName":"linkIds"
},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>",
"location":"querystring",
"locationName":"siteId"
},
"Type":{
"shape":"String",
"documentation":"<p>The link type.</p>",
"location":"querystring",
"locationName":"type"
},
"Provider":{
"shape":"String",
"documentation":"<p>The link provider.</p>",
"location":"querystring",
"locationName":"provider"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetLinksResponse":{
"type":"structure",
"members":{
"Links":{
"shape":"LinkList",
"documentation":"<p>The links.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
2021-11-03 18:14:15 +01:00
"GetNetworkResourceCountsRequest":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
2021-11-03 18:14:15 +01:00
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul> <li> <p> <code>dxcon</code> </p> </li> <li> <p> <code>dx-gateway</code> </p> </li> <li> <p> <code>dx-vif</code> </p> </li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul> <li> <p> <code>connection</code> </p> </li> <li> <p> <code>device</code> </p> </li> <li> <p> <code>link</code> </p> </li> <li> <p> <code>site</code> </p> </li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul> <li> <p> <code>customer-gateway</code> </p> </li> <li> <p> <code>transit-gateway</code> </p> </li> <li> <p> <code>transit-gateway-attachment</code> </p> </li> <li> <p> <code>transit-gateway-connect-peer</code> </p> </li> <li> <p> <code>transit-gateway-route-table</code> </p> </li> <li> <p> <code>vpn-connection</code> </p> </li> </ul>",
2019-12-12 10:04:05 +01:00
"location":"querystring",
2021-11-03 18:14:15 +01:00
"locationName":"resourceType"
2019-12-12 10:04:05 +01:00
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
2021-11-03 18:14:15 +01:00
"GetNetworkResourceCountsResponse":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"members":{
2021-11-03 18:14:15 +01:00
"NetworkResourceCounts":{
"shape":"NetworkResourceCountList",
"documentation":"<p>The count of resources.</p>"
2019-12-12 10:04:05 +01:00
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
2021-11-03 18:14:15 +01:00
"GetNetworkResourceRelationshipsRequest":{
2021-01-26 16:12:20 +01:00
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
2021-11-03 18:14:15 +01:00
"RegisteredGatewayArn":{
"shape":"String",
"documentation":"<p>The ARN of the registered gateway.</p>",
2021-01-26 16:12:20 +01:00
"location":"querystring",
2021-11-03 18:14:15 +01:00
"locationName":"registeredGatewayArn"
},
"AwsRegion":{
"shape":"String",
"documentation":"<p>The Amazon Web Services Region.</p>",
"location":"querystring",
"locationName":"awsRegion"
},
"AccountId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"querystring",
"locationName":"accountId"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul> <li> <p> <code>dxcon</code> </p> </li> <li> <p> <code>dx-gateway</code> </p> </li> <li> <p> <code>dx-vif</code> </p> </li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul> <li> <p> <code>connection</code> </p> </li> <li> <p> <code>device</code> </p> </li> <li> <p> <code>link</code> </p> </li> <li> <p> <code>site</code> </p> </li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul> <li> <p> <code>customer-gateway</code> </p> </li> <li> <p> <code>transit-gateway</code> </p> </li> <li> <p> <code>transit-gateway-attachment</code> </p> </li> <li> <p> <code>transit-gateway-connect-peer</code> </p> </li> <li> <p> <code>transit-gateway-route-table</code> </p> </li> <li> <p> <code>vpn-connection</code> </p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
"ResourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the gateway.</p>",
"location":"querystring",
"locationName":"resourceArn"
2021-01-26 16:12:20 +01:00
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
2021-11-03 18:14:15 +01:00
"GetNetworkResourceRelationshipsResponse":{
2021-01-26 16:12:20 +01:00
"type":"structure",
"members":{
2021-11-03 18:14:15 +01:00
"Relationships":{
"shape":"RelationshipList",
"documentation":"<p>The resource relationships.</p>"
2021-01-26 16:12:20 +01:00
},
"NextToken":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The token for the next page of results.</p>"
2021-01-26 16:12:20 +01:00
}
}
},
2021-11-03 18:14:15 +01:00
"GetNetworkResourcesRequest":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
2021-11-03 18:14:15 +01:00
"RegisteredGatewayArn":{
"shape":"String",
"documentation":"<p>The ARN of the gateway.</p>",
2019-12-12 10:04:05 +01:00
"location":"querystring",
2021-11-03 18:14:15 +01:00
"locationName":"registeredGatewayArn"
},
"AwsRegion":{
"shape":"String",
"documentation":"<p>The Amazon Web Services Region.</p>",
"location":"querystring",
"locationName":"awsRegion"
},
"AccountId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"querystring",
"locationName":"accountId"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul> <li> <p> <code>dxcon</code> - The definition model is <a href=\"https://docs.aws.amazon.com/directconnect/latest/APIReference/API_Connection.html\">Connection</a>.</p> </li> <li> <p> <code>dx-gateway</code> - The definition model is <a href=\"https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DirectConnectGateway.html\">DirectConnectGateway</a>.</p> </li> <li> <p> <code>dx-vif</code> - The definition model is <a href=\"https://docs.aws.amazon.com/directconnect/latest/APIReference/API_VirtualInterface.html\">VirtualInterface</a>.</p> </li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul> <li> <p> <code>connection</code> - The definition model is <a href=\"https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Connection.html\">Connection</a>.</p> </li> <li> <p> <code>device</code> - The definition model is <a href=\"https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Device.html\">Device</a>.</p> </li> <li> <p> <code>link</code> - The definition model is <a href=\"https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Link.html\">Link</a>.</p> </li> <li> <p> <code>site</code> - The definition model is <a href=\"https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_Site.html\">Site</a>.</p> </li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul> <li> <p> <code>customer-gateway</code> - The definition model is <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CustomerGateway.html\">CustomerGateway</a>.</p> </li> <li> <p> <code>transit-gateway</code> - The definition model is <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGateway.html\">TransitGateway</a>.</p> </li> <li> <p> <code>transit-gateway-attachment</code> - The definition model is <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayAttachment.html\">TransitGatewayAttachment</a>.</p> </li> <li> <p> <code>transit-gateway-connect-peer</code> - The definition model is <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayConnectPeer.html\">TransitGatewayConnectPeer</a>.</p> </li> <li> <p> <code>transit-gateway-route-table</code> - The definition model is <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TransitGatewayRouteTable.html\">TransitGatewayRouteTable</a>.</p> </li> <li> <p> <code>vpn-connection</code> - The definition model is <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_VpnConnection.html\">VpnConnection</a>.</p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
"ResourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>",
"location":"querystring",
"locationName":"resourceArn"
2019-12-12 10:04:05 +01:00
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
2021-11-03 18:14:15 +01:00
"GetNetworkResourcesResponse":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"members":{
2021-11-03 18:14:15 +01:00
"NetworkResources":{
"shape":"NetworkResourceList",
"documentation":"<p>The network resources.</p>"
2019-12-12 10:04:05 +01:00
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
2021-11-03 18:14:15 +01:00
"GetNetworkRoutesRequest":{
2019-12-12 10:04:05 +01:00
"type":"structure",
2021-11-03 18:14:15 +01:00
"required":[
"GlobalNetworkId",
"RouteTableIdentifier"
],
2019-12-12 10:04:05 +01:00
"members":{
"GlobalNetworkId":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"RouteTableIdentifier":{
"shape":"RouteTableIdentifier",
"documentation":"<p>The ID of the route table.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"ExactCidrMatches":{
"shape":"StringList",
"documentation":"<p>An exact CIDR block.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"LongestPrefixMatches":{
"shape":"StringList",
"documentation":"<p>The most specific route that matches the traffic (longest prefix match).</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"SubnetOfMatches":{
"shape":"StringList",
"documentation":"<p>The routes with a subnet that match the specified CIDR filter.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"SupernetOfMatches":{
"shape":"StringList",
"documentation":"<p>The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.</p>"
},
"PrefixListIds":{
"shape":"StringList",
"documentation":"<p>The IDs of the prefix lists.</p>"
},
"States":{
"shape":"RouteStateList",
"documentation":"<p>The route states.</p>"
},
"Types":{
"shape":"RouteTypeList",
"documentation":"<p>The route types.</p>"
},
"DestinationFilters":{
"shape":"FilterMap",
"documentation":"<p>Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.</p>"
2019-12-12 10:04:05 +01:00
}
2021-11-03 18:14:15 +01:00
}
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"GetNetworkRoutesResponse":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"members":{
2021-11-03 18:14:15 +01:00
"RouteTableArn":{
"shape":"String",
"documentation":"<p>The ARN of the route table.</p>"
},
"RouteTableType":{
"shape":"RouteTableType",
"documentation":"<p>The route table type.</p>"
},
"RouteTableTimestamp":{
"shape":"DateTime",
"documentation":"<p>The route table creation time.</p>"
},
"NetworkRoutes":{
"shape":"NetworkRouteList",
"documentation":"<p>The network routes.</p>"
2019-12-12 10:04:05 +01:00
}
2021-11-03 18:14:15 +01:00
}
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"GetNetworkTelemetryRequest":{
2019-12-12 10:04:05 +01:00
"type":"structure",
2021-11-03 18:14:15 +01:00
"required":["GlobalNetworkId"],
2019-12-12 10:04:05 +01:00
"members":{
2021-11-03 18:14:15 +01:00
"GlobalNetworkId":{
2019-12-12 10:04:05 +01:00
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"RegisteredGatewayArn":{
2019-12-12 10:04:05 +01:00
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The ARN of the gateway.</p>",
"location":"querystring",
"locationName":"registeredGatewayArn"
},
"AwsRegion":{
"shape":"String",
"documentation":"<p>The Amazon Web Services Region.</p>",
"location":"querystring",
"locationName":"awsRegion"
},
"AccountId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"querystring",
"locationName":"accountId"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul> <li> <p> <code>dxcon</code> </p> </li> <li> <p> <code>dx-gateway</code> </p> </li> <li> <p> <code>dx-vif</code> </p> </li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul> <li> <p> <code>connection</code> </p> </li> <li> <p> <code>device</code> </p> </li> <li> <p> <code>link</code> </p> </li> <li> <p> <code>site</code> </p> </li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul> <li> <p> <code>customer-gateway</code> </p> </li> <li> <p> <code>transit-gateway</code> </p> </li> <li> <p> <code>transit-gateway-attachment</code> </p> </li> <li> <p> <code>transit-gateway-connect-peer</code> </p> </li> <li> <p> <code>transit-gateway-route-table</code> </p> </li> <li> <p> <code>vpn-connection</code> </p> </li> </ul>",
"location":"querystring",
"locationName":"resourceType"
},
"ResourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>",
"location":"querystring",
"locationName":"resourceArn"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetNetworkTelemetryResponse":{
"type":"structure",
"members":{
"NetworkTelemetry":{
"shape":"NetworkTelemetryList",
"documentation":"<p>The network telemetry.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
"GetRouteAnalysisRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"RouteAnalysisId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"RouteAnalysisId":{
"shape":"String",
"documentation":"<p>The ID of the route analysis.</p>",
"location":"uri",
"locationName":"routeAnalysisId"
}
}
},
"GetRouteAnalysisResponse":{
"type":"structure",
"members":{
"RouteAnalysis":{
"shape":"RouteAnalysis",
"documentation":"<p>The route analysis.</p>"
}
}
},
"GetSitesRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"SiteIds":{
"shape":"StringList",
"documentation":"<p>One or more site IDs. The maximum is 10.</p>",
"location":"querystring",
"locationName":"siteIds"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetSitesResponse":{
"type":"structure",
"members":{
"Sites":{
"shape":"SiteList",
"documentation":"<p>The sites.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
"GetTransitGatewayConnectPeerAssociationsRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"TransitGatewayConnectPeerArns":{
"shape":"StringList",
"documentation":"<p>One or more transit gateway Connect peer Amazon Resource Names (ARNs).</p>",
"location":"querystring",
"locationName":"transitGatewayConnectPeerArns"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetTransitGatewayConnectPeerAssociationsResponse":{
"type":"structure",
"members":{
"TransitGatewayConnectPeerAssociations":{
"shape":"TransitGatewayConnectPeerAssociationList",
"documentation":"<p>Information about the transit gateway Connect peer associations.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token to use for the next page of results.</p>"
}
}
},
"GetTransitGatewayRegistrationsRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"TransitGatewayArns":{
"shape":"StringList",
"documentation":"<p>The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.</p>",
"location":"querystring",
"locationName":"transitGatewayArns"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"GetTransitGatewayRegistrationsResponse":{
"type":"structure",
"members":{
"TransitGatewayRegistrations":{
"shape":"TransitGatewayRegistrationList",
"documentation":"<p>The transit gateway registrations.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
}
}
},
"GlobalNetwork":{
"type":"structure",
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"GlobalNetworkArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the global network.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description of the global network.</p>"
},
"CreatedAt":{
"shape":"DateTime",
"documentation":"<p>The date and time that the global network was created.</p>"
},
"State":{
"shape":"GlobalNetworkState",
"documentation":"<p>The state of the global network.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags for the global network.</p>"
}
},
"documentation":"<p>Describes a global network.</p>"
},
"GlobalNetworkList":{
"type":"list",
"member":{"shape":"GlobalNetwork"}
},
"GlobalNetworkState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"UPDATING"
]
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"String"},
"RetryAfterSeconds":{
"shape":"RetryAfterSeconds",
"documentation":"<p>Indicates when to retry the request.</p>",
"location":"header",
"locationName":"Retry-After"
}
},
"documentation":"<p>The request has failed due to an internal error.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"Link":{
"type":"structure",
"members":{
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>"
},
"LinkArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the link.</p>"
2019-12-12 10:04:05 +01:00
},
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description of the link.</p>"
},
"Type":{
"shape":"String",
"documentation":"<p>The type of the link.</p>"
},
"Bandwidth":{
"shape":"Bandwidth",
"documentation":"<p>The bandwidth for the link.</p>"
},
"Provider":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The provider of the link.</p>"
},
"CreatedAt":{
"shape":"DateTime",
"documentation":"<p>The date and time that the link was created.</p>"
},
"State":{
"shape":"LinkState",
"documentation":"<p>The state of the link.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags for the link.</p>"
}
},
"documentation":"<p>Describes a link.</p>"
},
"LinkAssociation":{
"type":"structure",
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The device ID for the link association.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>"
},
"LinkAssociationState":{
"shape":"LinkAssociationState",
"documentation":"<p>The state of the association.</p>"
}
},
"documentation":"<p>Describes the association between a device and a link.</p>"
},
"LinkAssociationList":{
"type":"list",
"member":{"shape":"LinkAssociation"}
},
"LinkAssociationState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"DELETED"
]
},
"LinkList":{
"type":"list",
"member":{"shape":"Link"}
},
"LinkState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"UPDATING"
]
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"ResourceARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"TagList":{
"shape":"TagList",
"documentation":"<p>The list of tags.</p>"
}
}
},
"Location":{
"type":"structure",
"members":{
"Address":{
"shape":"String",
"documentation":"<p>The physical address.</p>"
},
"Latitude":{
"shape":"String",
"documentation":"<p>The latitude.</p>"
},
"Longitude":{
"shape":"String",
"documentation":"<p>The longitude.</p>"
}
},
"documentation":"<p>Describes a location.</p>",
"sensitive":true
},
"MaxResults":{
"type":"integer",
"max":500,
"min":1
},
"NetworkResource":{
"type":"structure",
"members":{
"RegisteredGatewayArn":{
"shape":"String",
"documentation":"<p>The ARN of the gateway.</p>"
},
"AwsRegion":{
"shape":"String",
"documentation":"<p>The Amazon Web Services Region.</p>"
},
"AccountId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services account ID.</p>"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul> <li> <p> <code>dxcon</code> </p> </li> <li> <p> <code>dx-gateway</code> </p> </li> <li> <p> <code>dx-vif</code> </p> </li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul> <li> <p> <code>connection</code> </p> </li> <li> <p> <code>device</code> </p> </li> <li> <p> <code>link</code> </p> </li> <li> <p> <code>site</code> </p> </li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul> <li> <p> <code>customer-gateway</code> </p> </li> <li> <p> <code>transit-gateway</code> </p> </li> <li> <p> <code>transit-gateway-attachment</code> </p> </li> <li> <p> <code>transit-gateway-connect-peer</code> </p> </li> <li> <p> <code>transit-gateway-route-table</code> </p> </li> <li> <p> <code>vpn-connection</code> </p> </li> </ul>"
},
"ResourceId":{
"shape":"String",
"documentation":"<p>The ID of the resource.</p>"
},
"ResourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>"
},
"Definition":{
"shape":"String",
"documentation":"<p>Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.</p>"
},
"DefinitionTimestamp":{
"shape":"DateTime",
"documentation":"<p>The time that the resource definition was retrieved.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags.</p>"
},
"Metadata":{
"shape":"NetworkResourceMetadataMap",
"documentation":"<p>The resource metadata.</p>"
}
},
"documentation":"<p>Describes a network resource.</p>"
},
"NetworkResourceCount":{
"type":"structure",
"members":{
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
},
"Count":{
"shape":"Integer",
"documentation":"<p>The resource count.</p>"
}
},
"documentation":"<p>Describes a resource count.</p>"
},
"NetworkResourceCountList":{
"type":"list",
"member":{"shape":"NetworkResourceCount"}
},
"NetworkResourceList":{
"type":"list",
"member":{"shape":"NetworkResource"}
},
"NetworkResourceMetadataKey":{"type":"string"},
"NetworkResourceMetadataMap":{
"type":"map",
"key":{"shape":"NetworkResourceMetadataKey"},
"value":{"shape":"NetworkResourceMetadataValue"}
},
"NetworkResourceMetadataValue":{"type":"string"},
"NetworkResourceSummary":{
"type":"structure",
"members":{
"RegisteredGatewayArn":{
"shape":"String",
"documentation":"<p>The ARN of the gateway.</p>"
},
"ResourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
},
"Definition":{
"shape":"String",
"documentation":"<p>Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.</p>"
},
"NameTag":{
"shape":"String",
"documentation":"<p>The value for the Name tag.</p>"
},
"IsMiddlebox":{
"shape":"Boolean",
"documentation":"<p>Indicates whether this is a middlebox appliance.</p>"
}
},
"documentation":"<p>Describes a network resource.</p>"
},
"NetworkRoute":{
"type":"structure",
"members":{
"DestinationCidrBlock":{
"shape":"String",
"documentation":"<p>A unique identifier for the route, such as a CIDR block.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"Destinations":{
"shape":"NetworkRouteDestinationList",
"documentation":"<p>The destinations.</p>"
},
"PrefixListId":{
"shape":"String",
"documentation":"<p>The ID of the prefix list.</p>"
2019-12-12 10:04:05 +01:00
},
"State":{
2021-11-03 18:14:15 +01:00
"shape":"RouteState",
"documentation":"<p>The route state. The possible values are <code>active</code> and <code>blackhole</code>.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"Type":{
"shape":"RouteType",
"documentation":"<p>The route type. The possible values are <code>propagated</code> and <code>static</code>.</p>"
2019-12-12 10:04:05 +01:00
}
},
2021-11-03 18:14:15 +01:00
"documentation":"<p>Describes a network route.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"NetworkRouteDestination":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"members":{
2021-11-03 18:14:15 +01:00
"TransitGatewayAttachmentId":{
2019-12-12 10:04:05 +01:00
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The ID of the transit gateway attachment.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"ResourceType":{
2019-12-12 10:04:05 +01:00
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The resource type.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"ResourceId":{
2019-12-12 10:04:05 +01:00
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The ID of the resource.</p>"
2019-12-12 10:04:05 +01:00
}
},
2021-11-03 18:14:15 +01:00
"documentation":"<p>Describes the destination of a network route.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"NetworkRouteDestinationList":{
2019-12-12 10:04:05 +01:00
"type":"list",
2021-11-03 18:14:15 +01:00
"member":{"shape":"NetworkRouteDestination"}
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"NetworkRouteList":{
2019-12-12 10:04:05 +01:00
"type":"list",
2021-11-03 18:14:15 +01:00
"member":{"shape":"NetworkRoute"}
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"NetworkTelemetry":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"members":{
2021-11-03 18:14:15 +01:00
"RegisteredGatewayArn":{
"shape":"String",
"documentation":"<p>The ARN of the gateway.</p>"
},
"AwsRegion":{
"shape":"String",
"documentation":"<p>The Amazon Web Services Region.</p>"
},
"AccountId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services account ID.</p>"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
},
"ResourceId":{
"shape":"String",
"documentation":"<p>The ID of the resource.</p>"
},
2019-12-12 10:04:05 +01:00
"ResourceArn":{
2021-11-03 18:14:15 +01:00
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>"
},
"Address":{
"shape":"String",
"documentation":"<p>The address.</p>"
},
"Health":{
"shape":"ConnectionHealth",
"documentation":"<p>The connection health.</p>"
2019-12-12 10:04:05 +01:00
}
2021-11-03 18:14:15 +01:00
},
"documentation":"<p>Describes the telemetry information for a resource.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"NetworkTelemetryList":{
"type":"list",
"member":{"shape":"NetworkTelemetry"}
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"PathComponent":{
2019-12-12 10:04:05 +01:00
"type":"structure",
"members":{
2021-11-03 18:14:15 +01:00
"Sequence":{
"shape":"Integer",
"documentation":"<p>The sequence number in the path. The destination is 0.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"Resource":{
"shape":"NetworkResourceSummary",
"documentation":"<p>The resource.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"DestinationCidrBlock":{
2019-12-12 10:04:05 +01:00
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The destination CIDR block in the route table.</p>"
2019-12-12 10:04:05 +01:00
}
},
2021-11-03 18:14:15 +01:00
"documentation":"<p>Describes a path component.</p>"
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"PathComponentList":{
"type":"list",
"member":{"shape":"PathComponent"}
2019-12-12 10:04:05 +01:00
},
2021-11-03 18:14:15 +01:00
"ReasonContextKey":{"type":"string"},
"ReasonContextMap":{
"type":"map",
"key":{"shape":"ReasonContextKey"},
"value":{"shape":"ReasonContextValue"}
},
"ReasonContextValue":{"type":"string"},
2019-12-12 10:04:05 +01:00
"RegisterTransitGatewayRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"TransitGatewayArn"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"TransitGatewayArn":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Amazon Resource Name (ARN) of the transit gateway.</p>"
2019-12-12 10:04:05 +01:00
}
}
},
"RegisterTransitGatewayResponse":{
"type":"structure",
"members":{
"TransitGatewayRegistration":{
"shape":"TransitGatewayRegistration",
"documentation":"<p>Information about the transit gateway registration.</p>"
}
}
},
2021-11-03 18:14:15 +01:00
"Relationship":{
"type":"structure",
"members":{
"From":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>"
},
"To":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>"
}
},
"documentation":"<p>Describes a resource relationship.</p>"
},
"RelationshipList":{
"type":"list",
"member":{"shape":"Relationship"}
},
2019-12-12 10:04:05 +01:00
"ResourceARN":{"type":"string"},
"ResourceNotFoundException":{
"type":"structure",
"required":[
"Message",
"ResourceId",
"ResourceType"
],
"members":{
"Message":{"shape":"String"},
"ResourceId":{
"shape":"String",
"documentation":"<p>The ID of the resource.</p>"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
2021-11-03 18:14:15 +01:00
},
"Context":{"shape":"ExceptionContextMap"}
2019-12-12 10:04:05 +01:00
},
"documentation":"<p>The specified resource could not be found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"RetryAfterSeconds":{"type":"integer"},
2021-11-03 18:14:15 +01:00
"RouteAnalysis":{
"type":"structure",
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"OwnerAccountId":{
"shape":"String",
"documentation":"<p>The ID of the AWS account that created the route analysis.</p>"
},
"RouteAnalysisId":{
"shape":"String",
"documentation":"<p>The ID of the route analysis.</p>"
},
"StartTimestamp":{
"shape":"DateTime",
"documentation":"<p>The time that the analysis started.</p>"
},
"Status":{
"shape":"RouteAnalysisStatus",
"documentation":"<p>The status of the route analysis.</p>"
},
"Source":{
"shape":"RouteAnalysisEndpointOptions",
"documentation":"<p>The source.</p>"
},
"Destination":{
"shape":"RouteAnalysisEndpointOptions",
"documentation":"<p>The destination.</p>"
},
"IncludeReturnPath":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.</p>"
},
"UseMiddleboxes":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to include the location of middlebox appliances in the route analysis.</p>"
},
"ForwardPath":{
"shape":"RouteAnalysisPath",
"documentation":"<p>The forward path.</p>"
},
"ReturnPath":{
"shape":"RouteAnalysisPath",
"documentation":"<p>The return path.</p>"
}
},
"documentation":"<p>Describes a route analysis.</p>"
},
"RouteAnalysisCompletion":{
"type":"structure",
"members":{
"ResultCode":{
"shape":"RouteAnalysisCompletionResultCode",
"documentation":"<p>The result of the analysis. If the status is <code>NOT_CONNECTED</code>, check the reason code.</p>"
},
"ReasonCode":{
"shape":"RouteAnalysisCompletionReasonCode",
"documentation":"<p>The reason code. Available only if a connection is not found.</p> <ul> <li> <p> <code>BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND</code> - Found a black hole route with the destination CIDR block.</p> </li> <li> <p> <code>CYCLIC_PATH_DETECTED</code> - Found the same resource multiple times while traversing the path.</p> </li> <li> <p> <code>INACTIVE_ROUTE_FOR_DESTINATION_FOUND</code> - Found an inactive route with the destination CIDR block.</p> </li> <li> <p> <code>MAX_HOPS_EXCEEDED</code> - Analysis exceeded 64 hops without finding the destination.</p> </li> <li> <p> <code>ROUTE_NOT_FOUND</code> - Cannot find a route table with the destination CIDR block.</p> </li> <li> <p> <code>TGW_ATTACH_ARN_NO_MATCH</code> - Found an attachment, but not with the correct destination ARN.</p> </li> <li> <p> <code>TGW_ATTACH_NOT_FOUND</code> - Cannot find an attachment.</p> </li> <li> <p> <code>TGW_ATTACH_NOT_IN_TGW</code> - Found an attachment, but not to the correct transit gateway.</p> </li> <li> <p> <code>TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND</code> - The state of the route table association is not associated.</p> </li> </ul>"
},
"ReasonContext":{
"shape":"ReasonContextMap",
"documentation":"<p>Additional information about the path. Available only if a connection is not found.</p>"
}
},
"documentation":"<p>Describes the status of an analysis at completion.</p>"
},
"RouteAnalysisCompletionReasonCode":{
"type":"string",
"enum":[
"TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND",
"TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY",
"CYCLIC_PATH_DETECTED",
"TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND",
"ROUTE_NOT_FOUND",
"BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND",
"INACTIVE_ROUTE_FOR_DESTINATION_FOUND",
"TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH",
"MAX_HOPS_EXCEEDED",
"POSSIBLE_MIDDLEBOX",
"NO_DESTINATION_ARN_PROVIDED"
]
},
"RouteAnalysisCompletionResultCode":{
"type":"string",
"enum":[
"CONNECTED",
"NOT_CONNECTED"
]
},
"RouteAnalysisEndpointOptions":{
"type":"structure",
"members":{
"TransitGatewayAttachmentArn":{
"shape":"String",
"documentation":"<p>The ARN of the transit gateway attachment.</p>"
},
"TransitGatewayArn":{
"shape":"String",
"documentation":"<p>The ARN of the transit gateway.</p>"
},
"IpAddress":{
"shape":"String",
"documentation":"<p>The IP address.</p>"
}
},
"documentation":"<p>Describes a source or a destination.</p>"
},
"RouteAnalysisEndpointOptionsSpecification":{
"type":"structure",
"members":{
"TransitGatewayAttachmentArn":{
"shape":"String",
"documentation":"<p>The ARN of the transit gateway attachment.</p>"
},
"IpAddress":{
"shape":"String",
"documentation":"<p>The IP address.</p>"
}
},
"documentation":"<p>Describes a source or a destination.</p>"
},
"RouteAnalysisPath":{
"type":"structure",
"members":{
"CompletionStatus":{
"shape":"RouteAnalysisCompletion",
"documentation":"<p>The status of the analysis at completion.</p>"
},
"Path":{
"shape":"PathComponentList",
"documentation":"<p>The route analysis path.</p>"
}
},
"documentation":"<p>Describes a route analysis path.</p>"
},
"RouteAnalysisStatus":{
"type":"string",
"enum":[
"RUNNING",
"COMPLETED",
"FAILED"
]
},
"RouteState":{
"type":"string",
"enum":[
"ACTIVE",
"BLACKHOLE"
]
},
"RouteStateList":{
"type":"list",
"member":{"shape":"RouteState"}
},
"RouteTableIdentifier":{
"type":"structure",
"members":{
"TransitGatewayRouteTableArn":{
"shape":"String",
"documentation":"<p>The ARN of the transit gateway route table.</p>"
}
},
"documentation":"<p>Describes a route table.</p>"
},
"RouteTableType":{
"type":"string",
"enum":["TRANSIT_GATEWAY_ROUTE_TABLE"]
},
"RouteType":{
"type":"string",
"enum":[
"PROPAGATED",
"STATIC"
]
},
"RouteTypeList":{
"type":"list",
"member":{"shape":"RouteType"}
},
2019-12-12 10:04:05 +01:00
"ServiceQuotaExceededException":{
"type":"structure",
"required":[
"Message",
"LimitCode",
"ServiceCode"
],
"members":{
"Message":{
"shape":"String",
"documentation":"<p>The error message.</p>"
},
"ResourceId":{
"shape":"String",
"documentation":"<p>The ID of the resource.</p>"
},
"ResourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
},
"LimitCode":{
"shape":"String",
"documentation":"<p>The limit code.</p>"
},
"ServiceCode":{
"shape":"String",
"documentation":"<p>The service code.</p>"
}
},
"documentation":"<p>A service limit was exceeded.</p>",
"error":{"httpStatusCode":402},
"exception":true
},
"Site":{
"type":"structure",
"members":{
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>"
},
"SiteArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the site.</p>"
},
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>The description of the site.</p>"
},
"Location":{
"shape":"Location",
"documentation":"<p>The location of the site.</p>"
},
"CreatedAt":{
"shape":"DateTime",
"documentation":"<p>The date and time that the site was created.</p>"
},
"State":{
"shape":"SiteState",
"documentation":"<p>The state of the site.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags for the site.</p>"
}
},
"documentation":"<p>Describes a site.</p>"
},
"SiteList":{
"type":"list",
"member":{"shape":"Site"}
},
"SiteState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"UPDATING"
]
},
2021-11-03 18:14:15 +01:00
"StartRouteAnalysisRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"Source",
"Destination"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"Source":{
"shape":"RouteAnalysisEndpointOptionsSpecification",
"documentation":"<p>The source from which traffic originates.</p>"
},
"Destination":{
"shape":"RouteAnalysisEndpointOptionsSpecification",
"documentation":"<p>The destination.</p>"
},
"IncludeReturnPath":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to analyze the return path. The default is <code>false</code>.</p>"
},
"UseMiddleboxes":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to include the location of middlebox appliances in the route analysis. The default is <code>false</code>.</p>"
}
}
},
"StartRouteAnalysisResponse":{
"type":"structure",
"members":{
"RouteAnalysis":{
"shape":"RouteAnalysis",
"documentation":"<p>The route analysis.</p>"
}
}
},
2019-12-12 10:04:05 +01:00
"String":{"type":"string"},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The tag key.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Value":{
"shape":"TagValue",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The tag value.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
}
},
"documentation":"<p>Describes a tag.</p>"
},
"TagKey":{"type":"string"},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"ResourceARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to apply to the specified resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{"type":"string"},
"ThrottlingException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"String"},
"RetryAfterSeconds":{
"shape":"RetryAfterSeconds",
"documentation":"<p>Indicates when to retry the request.</p>",
"location":"header",
"locationName":"Retry-After"
}
},
"documentation":"<p>The request was denied due to request throttling.</p>",
"error":{"httpStatusCode":429},
"exception":true
},
2021-01-26 16:12:20 +01:00
"TransitGatewayConnectPeerAssociation":{
"type":"structure",
"members":{
"TransitGatewayConnectPeerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the transit gateway Connect peer.</p>"
},
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>"
},
"State":{
"shape":"TransitGatewayConnectPeerAssociationState",
"documentation":"<p>The state of the association.</p>"
}
},
"documentation":"<p>Describes a transit gateway Connect peer association.</p>"
},
"TransitGatewayConnectPeerAssociationList":{
"type":"list",
"member":{"shape":"TransitGatewayConnectPeerAssociation"}
},
"TransitGatewayConnectPeerAssociationState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"DELETED"
]
},
2019-12-12 10:04:05 +01:00
"TransitGatewayRegistration":{
"type":"structure",
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>"
},
"TransitGatewayArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the transit gateway.</p>"
},
"State":{
"shape":"TransitGatewayRegistrationStateReason",
"documentation":"<p>The state of the transit gateway registration.</p>"
}
},
"documentation":"<p>Describes the registration of a transit gateway to a global network.</p>"
},
"TransitGatewayRegistrationList":{
"type":"list",
"member":{"shape":"TransitGatewayRegistration"}
},
"TransitGatewayRegistrationState":{
"type":"string",
"enum":[
"PENDING",
"AVAILABLE",
"DELETING",
"DELETED",
"FAILED"
]
},
"TransitGatewayRegistrationStateReason":{
"type":"structure",
"members":{
"Code":{
"shape":"TransitGatewayRegistrationState",
"documentation":"<p>The code for the state reason.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>The message for the state reason.</p>"
}
},
"documentation":"<p>Describes the status of a transit gateway registration.</p>"
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"ResourceARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys to remove from the specified resource.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
2021-01-26 16:12:20 +01:00
"UpdateConnectionRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"ConnectionId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"ConnectionId":{
"shape":"String",
"documentation":"<p>The ID of the connection.</p>",
"location":"uri",
"locationName":"connectionId"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link for the first device in the connection.</p>"
},
"ConnectedLinkId":{
"shape":"String",
"documentation":"<p>The ID of the link for the second device in the connection.</p>"
},
"Description":{
"shape":"String",
"documentation":"<p>A description of the connection.</p> <p>Length Constraints: Maximum length of 256 characters.</p>"
}
}
},
"UpdateConnectionResponse":{
"type":"structure",
"members":{
"Connection":{
"shape":"Connection",
"documentation":"<p>Information about the connection.</p>"
}
}
},
2019-12-12 10:04:05 +01:00
"UpdateDeviceRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"DeviceId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"DeviceId":{
"shape":"String",
"documentation":"<p>The ID of the device.</p>",
"location":"uri",
"locationName":"deviceId"
},
2021-01-26 16:12:20 +01:00
"AWSLocation":{
"shape":"AWSLocation",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.</p>"
2021-01-26 16:12:20 +01:00
},
2019-12-12 10:04:05 +01:00
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of the device.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Type":{
"shape":"String",
"documentation":"<p>The type of the device.</p>"
},
"Vendor":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The vendor of the device.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Model":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The model of the device.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"SerialNumber":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The serial number of the device.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Location":{"shape":"Location"},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of the site.</p>"
}
}
},
"UpdateDeviceResponse":{
"type":"structure",
"members":{
"Device":{
"shape":"Device",
"documentation":"<p>Information about the device.</p>"
}
}
},
"UpdateGlobalNetworkRequest":{
"type":"structure",
"required":["GlobalNetworkId"],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of your global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of the global network.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
}
}
},
"UpdateGlobalNetworkResponse":{
"type":"structure",
"members":{
"GlobalNetwork":{
"shape":"GlobalNetwork",
"documentation":"<p>Information about the global network object.</p>"
}
}
},
"UpdateLinkRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"LinkId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"LinkId":{
"shape":"String",
"documentation":"<p>The ID of the link.</p>",
"location":"uri",
"locationName":"linkId"
},
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of the link.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Type":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The type of the link.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Bandwidth":{
"shape":"Bandwidth",
"documentation":"<p>The upload and download speed in Mbps. </p>"
},
"Provider":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>The provider of the link.</p> <p>Constraints: Maximum length of 128 characters.</p>"
2019-12-12 10:04:05 +01:00
}
}
},
"UpdateLinkResponse":{
"type":"structure",
"members":{
"Link":{
"shape":"Link",
"documentation":"<p>Information about the link.</p>"
}
}
},
2021-11-03 18:14:15 +01:00
"UpdateNetworkResourceMetadataRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"ResourceArn",
"Metadata"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"ResourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"Metadata":{
"shape":"NetworkResourceMetadataMap",
"documentation":"<p>The resource metadata.</p>"
}
}
},
"UpdateNetworkResourceMetadataResponse":{
"type":"structure",
"members":{
"ResourceArn":{
"shape":"String",
"documentation":"<p>The ARN of the resource.</p>"
},
"Metadata":{
"shape":"NetworkResourceMetadataMap",
"documentation":"<p>The updated resource metadata.</p>"
}
}
},
2019-12-12 10:04:05 +01:00
"UpdateSiteRequest":{
"type":"structure",
"required":[
"GlobalNetworkId",
"SiteId"
],
"members":{
"GlobalNetworkId":{
"shape":"String",
"documentation":"<p>The ID of the global network.</p>",
"location":"uri",
"locationName":"globalNetworkId"
},
"SiteId":{
"shape":"String",
"documentation":"<p>The ID of your site.</p>",
"location":"uri",
"locationName":"siteId"
},
"Description":{
"shape":"String",
2021-11-03 18:14:15 +01:00
"documentation":"<p>A description of your site.</p> <p>Constraints: Maximum length of 256 characters.</p>"
2019-12-12 10:04:05 +01:00
},
"Location":{
"shape":"Location",
"documentation":"<p>The site location:</p> <ul> <li> <p> <code>Address</code>: The physical address of the site.</p> </li> <li> <p> <code>Latitude</code>: The latitude of the site. </p> </li> <li> <p> <code>Longitude</code>: The longitude of the site.</p> </li> </ul>"
}
}
},
"UpdateSiteResponse":{
"type":"structure",
"members":{
"Site":{
"shape":"Site",
"documentation":"<p>Information about the site.</p>"
}
}
},
"ValidationException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"String"},
"Reason":{
"shape":"ValidationExceptionReason",
"documentation":"<p>The reason for the error.</p>"
},
"Fields":{
"shape":"ValidationExceptionFieldList",
"documentation":"<p>The fields that caused the error, if applicable.</p>"
}
},
"documentation":"<p>The input fails to satisfy the constraints.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ValidationExceptionField":{
"type":"structure",
"required":[
"Name",
"Message"
],
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the field.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>The message for the field.</p>"
}
},
"documentation":"<p>Describes a validation exception for a field.</p>"
},
"ValidationExceptionFieldList":{
"type":"list",
"member":{"shape":"ValidationExceptionField"}
},
"ValidationExceptionReason":{
"type":"string",
"enum":[
"UnknownOperation",
"CannotParse",
"FieldValidationFailed",
"Other"
]
}
},
2021-11-03 18:14:15 +01:00
"documentation":"<p>Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your Amazon Web Services and on-premises networks that are built around transit gateways.</p>"
2019-12-12 10:04:05 +01:00
}