Amazonka.DirectConnect.DescribeDirectConnectGateways

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.

Creating a Request

data DescribeDirectConnectGateways

See: newDescribeDirectConnectGateways smart constructor.

Constructors

DescribeDirectConnectGateways'

Fields

• directConnectGatewayId :: Maybe Text

  The ID of the Direct Connect gateway.

• 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.

• nextToken :: Maybe Text

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

Instances

ToJSON DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

toJSON :: DescribeDirectConnectGateways -> Value

toEncoding :: DescribeDirectConnectGateways -> Encoding

toJSONList :: [DescribeDirectConnectGateways] -> Value

toEncodingList :: [DescribeDirectConnectGateways] -> Encoding

ToHeaders DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

toHeaders :: DescribeDirectConnectGateways -> [Header]

ToPath DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

toPath :: DescribeDirectConnectGateways -> ByteString

ToQuery DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

toQuery :: DescribeDirectConnectGateways -> QueryString

AWSPager DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

page :: DescribeDirectConnectGateways -> AWSResponse DescribeDirectConnectGateways -> Maybe DescribeDirectConnectGateways

AWSRequest DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Associated Types

type AWSResponse DescribeDirectConnectGateways

Methods

request :: (Service -> Service) -> DescribeDirectConnectGateways -> Request DescribeDirectConnectGateways

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDirectConnectGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDirectConnectGateways)))

Generic DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Associated Types

type Rep DescribeDirectConnectGateways :: Type -> Type

Methods

from :: DescribeDirectConnectGateways -> Rep DescribeDirectConnectGateways x

to :: Rep DescribeDirectConnectGateways x -> DescribeDirectConnectGateways

Read DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

readsPrec :: Int -> ReadS DescribeDirectConnectGateways

readList :: ReadS [DescribeDirectConnectGateways]

readPrec :: ReadPrec DescribeDirectConnectGateways

readListPrec :: ReadPrec [DescribeDirectConnectGateways]

Show DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

showsPrec :: Int -> DescribeDirectConnectGateways -> ShowS

show :: DescribeDirectConnectGateways -> String

showList :: [DescribeDirectConnectGateways] -> ShowS

NFData DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

rnf :: DescribeDirectConnectGateways -> ()

Eq DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

(==) :: DescribeDirectConnectGateways -> DescribeDirectConnectGateways -> Bool

(/=) :: DescribeDirectConnectGateways -> DescribeDirectConnectGateways -> Bool

Hashable DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

hashWithSalt :: Int -> DescribeDirectConnectGateways -> Int

hash :: DescribeDirectConnectGateways -> Int

type AWSResponse DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

type AWSResponse DescribeDirectConnectGateways = DescribeDirectConnectGatewaysResponse

type Rep DescribeDirectConnectGateways

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

type Rep DescribeDirectConnectGateways = D1 ('MetaData "DescribeDirectConnectGateways" "Amazonka.DirectConnect.DescribeDirectConnectGateways" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "DescribeDirectConnectGateways'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directConnectGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeDirectConnectGateways :: DescribeDirectConnectGateways

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:

DescribeDirectConnectGateways, describeDirectConnectGateways_directConnectGatewayId - The ID of the Direct Connect gateway.

$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.

DescribeDirectConnectGateways, describeDirectConnectGateways_nextToken - The token provided in the previous call to retrieve the next page.

Request Lenses

describeDirectConnectGateways_directConnectGatewayId :: Lens' DescribeDirectConnectGateways (Maybe Text)

The ID of the Direct Connect gateway.

describeDirectConnectGateways_maxResults :: Lens' DescribeDirectConnectGateways (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.

describeDirectConnectGateways_nextToken :: Lens' DescribeDirectConnectGateways (Maybe Text)

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

Destructuring the Response

data DescribeDirectConnectGatewaysResponse

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

Generic DescribeDirectConnectGatewaysResponse

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Associated Types

type Rep DescribeDirectConnectGatewaysResponse :: Type -> Type

Methods

from :: DescribeDirectConnectGatewaysResponse -> Rep DescribeDirectConnectGatewaysResponse x

to :: Rep DescribeDirectConnectGatewaysResponse x -> DescribeDirectConnectGatewaysResponse

Read DescribeDirectConnectGatewaysResponse

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

readsPrec :: Int -> ReadS DescribeDirectConnectGatewaysResponse

readList :: ReadS [DescribeDirectConnectGatewaysResponse]

readPrec :: ReadPrec DescribeDirectConnectGatewaysResponse

readListPrec :: ReadPrec [DescribeDirectConnectGatewaysResponse]

Show DescribeDirectConnectGatewaysResponse

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

showsPrec :: Int -> DescribeDirectConnectGatewaysResponse -> ShowS

show :: DescribeDirectConnectGatewaysResponse -> String

showList :: [DescribeDirectConnectGatewaysResponse] -> ShowS

NFData DescribeDirectConnectGatewaysResponse

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

rnf :: DescribeDirectConnectGatewaysResponse -> ()

Eq DescribeDirectConnectGatewaysResponse

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

Methods

(==) :: DescribeDirectConnectGatewaysResponse -> DescribeDirectConnectGatewaysResponse -> Bool

(/=) :: DescribeDirectConnectGatewaysResponse -> DescribeDirectConnectGatewaysResponse -> Bool

type Rep DescribeDirectConnectGatewaysResponse

Defined in Amazonka.DirectConnect.DescribeDirectConnectGateways

type Rep DescribeDirectConnectGatewaysResponse = D1 ('MetaData "DescribeDirectConnectGatewaysResponse" "Amazonka.DirectConnect.DescribeDirectConnectGateways" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" '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

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.

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])

The Direct Connect gateways.

describeDirectConnectGatewaysResponse_nextToken :: Lens' DescribeDirectConnectGatewaysResponse (Maybe Text)

The token to retrieve the next page.

describeDirectConnectGatewaysResponse_httpStatus :: Lens' DescribeDirectConnectGatewaysResponse Int

The response's http status code.