Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DirectConnect.DescribeDirectConnectGateways

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDirectConnectGateways Source #

See: newDescribeDirectConnectGateways smart constructor.

Constructors

DescribeDirectConnectGateways'

Fields

directConnectGatewayId :: Maybe Text
The ID of the Direct Connect gateway.
nextToken :: Maybe Text
The token provided in the previous call to retrieve the next page.
maxResults :: Maybe Int
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.

Instances

Instances details

Eq DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods (==) :: DescribeDirectConnectGateways -> DescribeDirectConnectGateways -> Bool # (/=) :: DescribeDirectConnectGateways -> DescribeDirectConnectGateways -> Bool #
Read DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods readsPrec :: Int -> ReadS DescribeDirectConnectGateways # readList :: ReadS [DescribeDirectConnectGateways] # readPrec :: ReadPrec DescribeDirectConnectGateways # readListPrec :: ReadPrec [DescribeDirectConnectGateways] #
Show DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods showsPrec :: Int -> DescribeDirectConnectGateways -> ShowS # show :: DescribeDirectConnectGateways -> String # showList :: [DescribeDirectConnectGateways] -> ShowS #
Generic DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Associated Types type Rep DescribeDirectConnectGateways :: Type -> Type # Methods from :: DescribeDirectConnectGateways -> Rep DescribeDirectConnectGateways x # to :: Rep DescribeDirectConnectGateways x -> DescribeDirectConnectGateways #
NFData DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods rnf :: DescribeDirectConnectGateways -> () #
Hashable DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods hashWithSalt :: Int -> DescribeDirectConnectGateways -> Int # hash :: DescribeDirectConnectGateways -> Int #
ToJSON DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods toJSON :: DescribeDirectConnectGateways -> Value # toEncoding :: DescribeDirectConnectGateways -> Encoding # toJSONList :: [DescribeDirectConnectGateways] -> Value # toEncodingList :: [DescribeDirectConnectGateways] -> Encoding #
AWSPager DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods page :: DescribeDirectConnectGateways -> AWSResponse DescribeDirectConnectGateways -> Maybe DescribeDirectConnectGateways #
AWSRequest DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Associated Types type AWSResponse DescribeDirectConnectGateways # Methods request :: DescribeDirectConnectGateways -> Request DescribeDirectConnectGateways # response :: MonadResource m => Logger -> Service -> Proxy DescribeDirectConnectGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDirectConnectGateways))) #
ToHeaders DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods toHeaders :: DescribeDirectConnectGateways -> [Header] #
ToPath DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods toPath :: DescribeDirectConnectGateways -> ByteString #
ToQuery DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods toQuery :: DescribeDirectConnectGateways -> QueryString #
type Rep DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways type Rep DescribeDirectConnectGateways = D1 ('MetaData "DescribeDirectConnectGateways" "Amazonka.DirectConnect.DescribeDirectConnectGateways" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "DescribeDirectConnectGateways'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directConnectGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeDirectConnectGateways Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways type AWSResponse DescribeDirectConnectGateways = DescribeDirectConnectGatewaysResponse

newDescribeDirectConnectGateways :: DescribeDirectConnectGateways Source #

Create a value of DescribeDirectConnectGateways 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:directConnectGatewayId:DescribeDirectConnectGateways', describeDirectConnectGateways_directConnectGatewayId - The ID of the Direct Connect gateway.

$sel:nextToken:DescribeDirectConnectGateways', describeDirectConnectGateways_nextToken - The token provided in the previous call to retrieve the next page.

$sel:maxResults:DescribeDirectConnectGateways', describeDirectConnectGateways_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

Request Lenses

describeDirectConnectGateways_directConnectGatewayId :: Lens' DescribeDirectConnectGateways (Maybe Text) Source #

The ID of the Direct Connect gateway.

describeDirectConnectGateways_nextToken :: Lens' DescribeDirectConnectGateways (Maybe Text) Source #

The token provided in the previous call to retrieve the next page.

describeDirectConnectGateways_maxResults :: Lens' DescribeDirectConnectGateways (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

Destructuring the Response

data DescribeDirectConnectGatewaysResponse Source #

See: newDescribeDirectConnectGatewaysResponse smart constructor.

Constructors

DescribeDirectConnectGatewaysResponse'
Fields directConnectGateways :: Maybe [DirectConnectGateway] The Direct Connect gateways. nextToken :: Maybe Text The token to retrieve the next page. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeDirectConnectGatewaysResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods (==) :: DescribeDirectConnectGatewaysResponse -> DescribeDirectConnectGatewaysResponse -> Bool # (/=) :: DescribeDirectConnectGatewaysResponse -> DescribeDirectConnectGatewaysResponse -> Bool #
Read DescribeDirectConnectGatewaysResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods readsPrec :: Int -> ReadS DescribeDirectConnectGatewaysResponse # readList :: ReadS [DescribeDirectConnectGatewaysResponse] # readPrec :: ReadPrec DescribeDirectConnectGatewaysResponse # readListPrec :: ReadPrec [DescribeDirectConnectGatewaysResponse] #
Show DescribeDirectConnectGatewaysResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods showsPrec :: Int -> DescribeDirectConnectGatewaysResponse -> ShowS # show :: DescribeDirectConnectGatewaysResponse -> String # showList :: [DescribeDirectConnectGatewaysResponse] -> ShowS #
Generic DescribeDirectConnectGatewaysResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Associated Types type Rep DescribeDirectConnectGatewaysResponse :: Type -> Type # Methods from :: DescribeDirectConnectGatewaysResponse -> Rep DescribeDirectConnectGatewaysResponse x # to :: Rep DescribeDirectConnectGatewaysResponse x -> DescribeDirectConnectGatewaysResponse #
NFData DescribeDirectConnectGatewaysResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways Methods rnf :: DescribeDirectConnectGatewaysResponse -> () #
type Rep DescribeDirectConnectGatewaysResponse Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways type Rep DescribeDirectConnectGatewaysResponse = D1 ('MetaData "DescribeDirectConnectGatewaysResponse" "Amazonka.DirectConnect.DescribeDirectConnectGateways" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "DescribeDirectConnectGatewaysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directConnectGateways") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DirectConnectGateway])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDirectConnectGatewaysResponse Source #

Arguments

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

Create a value of DescribeDirectConnectGatewaysResponse 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:directConnectGateways:DescribeDirectConnectGatewaysResponse', describeDirectConnectGatewaysResponse_directConnectGateways - The Direct Connect gateways.

$sel:nextToken:DescribeDirectConnectGateways', describeDirectConnectGatewaysResponse_nextToken - The token to retrieve the next page.

$sel:httpStatus:DescribeDirectConnectGatewaysResponse', describeDirectConnectGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

describeDirectConnectGatewaysResponse_directConnectGateways :: Lens' DescribeDirectConnectGatewaysResponse (Maybe [DirectConnectGateway]) Source #

The Direct Connect gateways.

describeDirectConnectGatewaysResponse_nextToken :: Lens' DescribeDirectConnectGatewaysResponse (Maybe Text) Source #

The token to retrieve the next page.

describeDirectConnectGatewaysResponse_httpStatus :: Lens' DescribeDirectConnectGatewaysResponse Int Source #

The response's http status code.