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.DirectConnect.DescribeDirectConnectGatewayAttachments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDirectConnectGatewayAttachments Source #

See: newDescribeDirectConnectGatewayAttachments smart constructor.

Constructors

DescribeDirectConnectGatewayAttachments'

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.
virtualInterfaceId :: Maybe Text
The ID of the virtual interface.

Instances

Instances details

ToJSON DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods toJSON :: DescribeDirectConnectGatewayAttachments -> Value # toEncoding :: DescribeDirectConnectGatewayAttachments -> Encoding # toJSONList :: [DescribeDirectConnectGatewayAttachments] -> Value # toEncodingList :: [DescribeDirectConnectGatewayAttachments] -> Encoding #
ToHeaders DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods toHeaders :: DescribeDirectConnectGatewayAttachments -> [Header] #
ToPath DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods toPath :: DescribeDirectConnectGatewayAttachments -> ByteString #
ToQuery DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods toQuery :: DescribeDirectConnectGatewayAttachments -> QueryString #
AWSPager DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods page :: DescribeDirectConnectGatewayAttachments -> AWSResponse DescribeDirectConnectGatewayAttachments -> Maybe DescribeDirectConnectGatewayAttachments #
AWSRequest DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Associated Types type AWSResponse DescribeDirectConnectGatewayAttachments # Methods request :: (Service -> Service) -> DescribeDirectConnectGatewayAttachments -> Request DescribeDirectConnectGatewayAttachments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDirectConnectGatewayAttachments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDirectConnectGatewayAttachments))) #
Generic DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Associated Types type Rep DescribeDirectConnectGatewayAttachments :: Type -> Type # Methods from :: DescribeDirectConnectGatewayAttachments -> Rep DescribeDirectConnectGatewayAttachments x # to :: Rep DescribeDirectConnectGatewayAttachments x -> DescribeDirectConnectGatewayAttachments #
Read DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods readsPrec :: Int -> ReadS DescribeDirectConnectGatewayAttachments # readList :: ReadS [DescribeDirectConnectGatewayAttachments] # readPrec :: ReadPrec DescribeDirectConnectGatewayAttachments # readListPrec :: ReadPrec [DescribeDirectConnectGatewayAttachments] #
Show DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods showsPrec :: Int -> DescribeDirectConnectGatewayAttachments -> ShowS # show :: DescribeDirectConnectGatewayAttachments -> String # showList :: [DescribeDirectConnectGatewayAttachments] -> ShowS #
NFData DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods rnf :: DescribeDirectConnectGatewayAttachments -> () #
Eq DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods (==) :: DescribeDirectConnectGatewayAttachments -> DescribeDirectConnectGatewayAttachments -> Bool # (/=) :: DescribeDirectConnectGatewayAttachments -> DescribeDirectConnectGatewayAttachments -> Bool #
Hashable DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments Methods hashWithSalt :: Int -> DescribeDirectConnectGatewayAttachments -> Int # hash :: DescribeDirectConnectGatewayAttachments -> Int #
type AWSResponse DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments type AWSResponse DescribeDirectConnectGatewayAttachments = DescribeDirectConnectGatewayAttachmentsResponse
type Rep DescribeDirectConnectGatewayAttachments Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments type Rep DescribeDirectConnectGatewayAttachments = D1 ('MetaData "DescribeDirectConnectGatewayAttachments" "Amazonka.DirectConnect.DescribeDirectConnectGatewayAttachments" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "DescribeDirectConnectGatewayAttachments'" '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)) :*: S1 ('MetaSel ('Just "virtualInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeDirectConnectGatewayAttachments :: DescribeDirectConnectGatewayAttachments Source #

Create a value of DescribeDirectConnectGatewayAttachments 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:

DescribeDirectConnectGatewayAttachments, describeDirectConnectGatewayAttachments_directConnectGatewayId - The ID of the Direct Connect gateway.

$sel:maxResults:DescribeDirectConnectGatewayAttachments', describeDirectConnectGatewayAttachments_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.

DescribeDirectConnectGatewayAttachments, describeDirectConnectGatewayAttachments_nextToken - The token provided in the previous call to retrieve the next page.

DescribeDirectConnectGatewayAttachments, describeDirectConnectGatewayAttachments_virtualInterfaceId - The ID of the virtual interface.

Request Lenses

describeDirectConnectGatewayAttachments_directConnectGatewayId :: Lens' DescribeDirectConnectGatewayAttachments (Maybe Text) Source #

The ID of the Direct Connect gateway.

describeDirectConnectGatewayAttachments_maxResults :: Lens' DescribeDirectConnectGatewayAttachments (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.

describeDirectConnectGatewayAttachments_nextToken :: Lens' DescribeDirectConnectGatewayAttachments (Maybe Text) Source #

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

describeDirectConnectGatewayAttachments_virtualInterfaceId :: Lens' DescribeDirectConnectGatewayAttachments (Maybe Text) Source #

The ID of the virtual interface.

Destructuring the Response

data DescribeDirectConnectGatewayAttachmentsResponse Source #

See: newDescribeDirectConnectGatewayAttachmentsResponse smart constructor.

Constructors

DescribeDirectConnectGatewayAttachmentsResponse'
Fields directConnectGatewayAttachments :: Maybe [DirectConnectGatewayAttachment] The attachments. nextToken :: Maybe Text The token to retrieve the next page. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeDirectConnectGatewayAttachmentsResponse Source #

Arguments

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

Create a value of DescribeDirectConnectGatewayAttachmentsResponse 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:directConnectGatewayAttachments:DescribeDirectConnectGatewayAttachmentsResponse', describeDirectConnectGatewayAttachmentsResponse_directConnectGatewayAttachments - The attachments.

DescribeDirectConnectGatewayAttachments, describeDirectConnectGatewayAttachmentsResponse_nextToken - The token to retrieve the next page.

$sel:httpStatus:DescribeDirectConnectGatewayAttachmentsResponse', describeDirectConnectGatewayAttachmentsResponse_httpStatus - The response's http status code.

Response Lenses

describeDirectConnectGatewayAttachmentsResponse_directConnectGatewayAttachments :: Lens' DescribeDirectConnectGatewayAttachmentsResponse (Maybe [DirectConnectGatewayAttachment]) Source #

The attachments.

describeDirectConnectGatewayAttachmentsResponse_nextToken :: Lens' DescribeDirectConnectGatewayAttachmentsResponse (Maybe Text) Source #

The token to retrieve the next page.

describeDirectConnectGatewayAttachmentsResponse_httpStatus :: Lens' DescribeDirectConnectGatewayAttachmentsResponse Int Source #

The response's http status code.