Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.NetworkManager.GetNetworkTelemetry

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the network telemetry of the specified global network.

This operation returns paginated results.

Synopsis

data GetNetworkTelemetry = GetNetworkTelemetry' {
- accountId :: Maybe Text
- awsRegion :: Maybe Text
- coreNetworkId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- registeredGatewayArn :: Maybe Text
- resourceArn :: Maybe Text
- resourceType :: Maybe Text
- globalNetworkId :: Text
}
newGetNetworkTelemetry :: Text -> GetNetworkTelemetry
getNetworkTelemetry_accountId :: Lens' GetNetworkTelemetry (Maybe Text)
getNetworkTelemetry_awsRegion :: Lens' GetNetworkTelemetry (Maybe Text)
getNetworkTelemetry_coreNetworkId :: Lens' GetNetworkTelemetry (Maybe Text)
getNetworkTelemetry_maxResults :: Lens' GetNetworkTelemetry (Maybe Natural)
getNetworkTelemetry_nextToken :: Lens' GetNetworkTelemetry (Maybe Text)
getNetworkTelemetry_registeredGatewayArn :: Lens' GetNetworkTelemetry (Maybe Text)
getNetworkTelemetry_resourceArn :: Lens' GetNetworkTelemetry (Maybe Text)
getNetworkTelemetry_resourceType :: Lens' GetNetworkTelemetry (Maybe Text)
getNetworkTelemetry_globalNetworkId :: Lens' GetNetworkTelemetry Text
data GetNetworkTelemetryResponse = GetNetworkTelemetryResponse' {
- networkTelemetry :: Maybe [NetworkTelemetry]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetNetworkTelemetryResponse :: Int -> GetNetworkTelemetryResponse
getNetworkTelemetryResponse_networkTelemetry :: Lens' GetNetworkTelemetryResponse (Maybe [NetworkTelemetry])
getNetworkTelemetryResponse_nextToken :: Lens' GetNetworkTelemetryResponse (Maybe Text)
getNetworkTelemetryResponse_httpStatus :: Lens' GetNetworkTelemetryResponse Int

Creating a Request

data GetNetworkTelemetry Source #

See: newGetNetworkTelemetry smart constructor.

Constructors

GetNetworkTelemetry'

Fields

accountId :: Maybe Text
The Amazon Web Services account ID.
awsRegion :: Maybe Text
The Amazon Web Services Region.
coreNetworkId :: Maybe Text
The ID of a core network.
maxResults :: Maybe Natural
The maximum number of results to return.
nextToken :: Maybe Text
The token for the next page of results.
registeredGatewayArn :: Maybe Text
The ARN of the gateway.
resourceArn :: Maybe Text
The ARN of the resource.
resourceType :: Maybe Text
The resource type.
The following are the supported resource types for Direct Connect:
- ```
dxcon
```
- ```
dx-gateway
```
- ```
dx-vif
```
The following are the supported resource types for Network Manager:
- ```
connection
```
- ```
device
```
- ```
link
```
- ```
site
```
The following are the supported resource types for Amazon VPC:
- ```
customer-gateway
```
- ```
transit-gateway
```
- ```
transit-gateway-attachment
```
- ```
transit-gateway-connect-peer
```
- ```
transit-gateway-route-table
```
- ```
vpn-connection
```
globalNetworkId :: Text
The ID of the global network.

Instances

Instances details

ToHeaders GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods toHeaders :: GetNetworkTelemetry -> [Header] #
ToPath GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods toPath :: GetNetworkTelemetry -> ByteString #
ToQuery GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods toQuery :: GetNetworkTelemetry -> QueryString #
AWSPager GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods page :: GetNetworkTelemetry -> AWSResponse GetNetworkTelemetry -> Maybe GetNetworkTelemetry #
AWSRequest GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Associated Types type AWSResponse GetNetworkTelemetry # Methods request :: (Service -> Service) -> GetNetworkTelemetry -> Request GetNetworkTelemetry # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetNetworkTelemetry -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetNetworkTelemetry))) #
Generic GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Associated Types type Rep GetNetworkTelemetry :: Type -> Type # Methods from :: GetNetworkTelemetry -> Rep GetNetworkTelemetry x # to :: Rep GetNetworkTelemetry x -> GetNetworkTelemetry #
Read GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods readsPrec :: Int -> ReadS GetNetworkTelemetry # readList :: ReadS [GetNetworkTelemetry] # readPrec :: ReadPrec GetNetworkTelemetry # readListPrec :: ReadPrec [GetNetworkTelemetry] #
Show GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods showsPrec :: Int -> GetNetworkTelemetry -> ShowS # show :: GetNetworkTelemetry -> String # showList :: [GetNetworkTelemetry] -> ShowS #
NFData GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods rnf :: GetNetworkTelemetry -> () #
Eq GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods (==) :: GetNetworkTelemetry -> GetNetworkTelemetry -> Bool # (/=) :: GetNetworkTelemetry -> GetNetworkTelemetry -> Bool #
Hashable GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods hashWithSalt :: Int -> GetNetworkTelemetry -> Int # hash :: GetNetworkTelemetry -> Int #
type AWSResponse GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry type AWSResponse GetNetworkTelemetry = GetNetworkTelemetryResponse
type Rep GetNetworkTelemetry Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry type Rep GetNetworkTelemetry = D1 ('MetaData "GetNetworkTelemetry" "Amazonka.NetworkManager.GetNetworkTelemetry" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "GetNetworkTelemetry'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "awsRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "coreNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "registeredGatewayArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "globalNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newGetNetworkTelemetry Source #

Arguments

:: Text	`GetNetworkTelemetry`
-> GetNetworkTelemetry

Create a value of GetNetworkTelemetry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetNetworkTelemetry, getNetworkTelemetry_accountId - The Amazon Web Services account ID.

GetNetworkTelemetry, getNetworkTelemetry_awsRegion - The Amazon Web Services Region.

GetNetworkTelemetry, getNetworkTelemetry_coreNetworkId - The ID of a core network.

$sel:maxResults:GetNetworkTelemetry', getNetworkTelemetry_maxResults - The maximum number of results to return.

GetNetworkTelemetry, getNetworkTelemetry_nextToken - The token for the next page of results.

GetNetworkTelemetry, getNetworkTelemetry_registeredGatewayArn - The ARN of the gateway.

GetNetworkTelemetry, getNetworkTelemetry_resourceArn - The ARN of the resource.

GetNetworkTelemetry, getNetworkTelemetry_resourceType - The resource type.

The following are the supported resource types for Direct Connect:

```
dxcon
```
```
dx-gateway
```
```
dx-vif
```

The following are the supported resource types for Network Manager:

```
connection
```
```
device
```
```
link
```
```
site
```

The following are the supported resource types for Amazon VPC:

```
customer-gateway
```
```
transit-gateway
```
```
transit-gateway-attachment
```
```
transit-gateway-connect-peer
```
```
transit-gateway-route-table
```
```
vpn-connection
```

GetNetworkTelemetry, getNetworkTelemetry_globalNetworkId - The ID of the global network.

Request Lenses

getNetworkTelemetry_accountId :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The Amazon Web Services account ID.

getNetworkTelemetry_awsRegion :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The Amazon Web Services Region.

getNetworkTelemetry_coreNetworkId :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The ID of a core network.

getNetworkTelemetry_maxResults :: Lens' GetNetworkTelemetry (Maybe Natural) Source #

The maximum number of results to return.

getNetworkTelemetry_nextToken :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The token for the next page of results.

getNetworkTelemetry_registeredGatewayArn :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The ARN of the gateway.

getNetworkTelemetry_resourceArn :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The ARN of the resource.

getNetworkTelemetry_resourceType :: Lens' GetNetworkTelemetry (Maybe Text) Source #

The resource type.

The following are the supported resource types for Direct Connect:

```
dxcon
```
```
dx-gateway
```
```
dx-vif
```

The following are the supported resource types for Network Manager:

```
connection
```
```
device
```
```
link
```
```
site
```

The following are the supported resource types for Amazon VPC:

```
customer-gateway
```
```
transit-gateway
```
```
transit-gateway-attachment
```
```
transit-gateway-connect-peer
```
```
transit-gateway-route-table
```
```
vpn-connection
```

getNetworkTelemetry_globalNetworkId :: Lens' GetNetworkTelemetry Text Source #

The ID of the global network.

Destructuring the Response

data GetNetworkTelemetryResponse Source #

See: newGetNetworkTelemetryResponse smart constructor.

Constructors

GetNetworkTelemetryResponse'
Fields networkTelemetry :: Maybe [NetworkTelemetry] The network telemetry. nextToken :: Maybe Text The token for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetNetworkTelemetryResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Associated Types type Rep GetNetworkTelemetryResponse :: Type -> Type # Methods from :: GetNetworkTelemetryResponse -> Rep GetNetworkTelemetryResponse x # to :: Rep GetNetworkTelemetryResponse x -> GetNetworkTelemetryResponse #
Read GetNetworkTelemetryResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods readsPrec :: Int -> ReadS GetNetworkTelemetryResponse # readList :: ReadS [GetNetworkTelemetryResponse] # readPrec :: ReadPrec GetNetworkTelemetryResponse # readListPrec :: ReadPrec [GetNetworkTelemetryResponse] #
Show GetNetworkTelemetryResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods showsPrec :: Int -> GetNetworkTelemetryResponse -> ShowS # show :: GetNetworkTelemetryResponse -> String # showList :: [GetNetworkTelemetryResponse] -> ShowS #
NFData GetNetworkTelemetryResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods rnf :: GetNetworkTelemetryResponse -> () #
Eq GetNetworkTelemetryResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry Methods (==) :: GetNetworkTelemetryResponse -> GetNetworkTelemetryResponse -> Bool # (/=) :: GetNetworkTelemetryResponse -> GetNetworkTelemetryResponse -> Bool #
type Rep GetNetworkTelemetryResponse Source #
Instance details Defined in Amazonka.NetworkManager.GetNetworkTelemetry type Rep GetNetworkTelemetryResponse = D1 ('MetaData "GetNetworkTelemetryResponse" "Amazonka.NetworkManager.GetNetworkTelemetry" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "GetNetworkTelemetryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "networkTelemetry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkTelemetry])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetNetworkTelemetryResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetNetworkTelemetryResponse'`
-> GetNetworkTelemetryResponse

Create a value of GetNetworkTelemetryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:networkTelemetry:GetNetworkTelemetryResponse', getNetworkTelemetryResponse_networkTelemetry - The network telemetry.

GetNetworkTelemetry, getNetworkTelemetryResponse_nextToken - The token for the next page of results.

$sel:httpStatus:GetNetworkTelemetryResponse', getNetworkTelemetryResponse_httpStatus - The response's http status code.

Response Lenses

getNetworkTelemetryResponse_networkTelemetry :: Lens' GetNetworkTelemetryResponse (Maybe [NetworkTelemetry]) Source #

The network telemetry.

getNetworkTelemetryResponse_nextToken :: Lens' GetNetworkTelemetryResponse (Maybe Text) Source #

The token for the next page of results.

getNetworkTelemetryResponse_httpStatus :: Lens' GetNetworkTelemetryResponse Int Source #

The response's http status code.