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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:

A Direct Connect gateway
The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.
A virtual private gateway
The response contains the Direct Connect gateway.
A transit gateway
The response contains the Direct Connect gateway.
A Direct Connect gateway and a virtual private gateway
The response contains the association between the Direct Connect gateway and virtual private gateway.
A Direct Connect gateway and a transit gateway
The response contains the association between the Direct Connect gateway and transit gateway.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDirectConnectGatewayAssociations Source #

See: newDescribeDirectConnectGatewayAssociations smart constructor.

Constructors

DescribeDirectConnectGatewayAssociations'

Fields

virtualGatewayId :: Maybe Text
The ID of the virtual private gateway or transit gateway.
associationId :: Maybe Text
The ID of the Direct Connect gateway association.
associatedGatewayId :: Maybe Text
The ID of the associated gateway.
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 DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods (==) :: DescribeDirectConnectGatewayAssociations -> DescribeDirectConnectGatewayAssociations -> Bool # (/=) :: DescribeDirectConnectGatewayAssociations -> DescribeDirectConnectGatewayAssociations -> Bool #
Read DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods readsPrec :: Int -> ReadS DescribeDirectConnectGatewayAssociations # readList :: ReadS [DescribeDirectConnectGatewayAssociations] # readPrec :: ReadPrec DescribeDirectConnectGatewayAssociations # readListPrec :: ReadPrec [DescribeDirectConnectGatewayAssociations] #
Show DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods showsPrec :: Int -> DescribeDirectConnectGatewayAssociations -> ShowS # show :: DescribeDirectConnectGatewayAssociations -> String # showList :: [DescribeDirectConnectGatewayAssociations] -> ShowS #
Generic DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Associated Types type Rep DescribeDirectConnectGatewayAssociations :: Type -> Type # Methods from :: DescribeDirectConnectGatewayAssociations -> Rep DescribeDirectConnectGatewayAssociations x # to :: Rep DescribeDirectConnectGatewayAssociations x -> DescribeDirectConnectGatewayAssociations #
NFData DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods rnf :: DescribeDirectConnectGatewayAssociations -> () #
Hashable DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods hashWithSalt :: Int -> DescribeDirectConnectGatewayAssociations -> Int # hash :: DescribeDirectConnectGatewayAssociations -> Int #
ToJSON DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods toJSON :: DescribeDirectConnectGatewayAssociations -> Value # toEncoding :: DescribeDirectConnectGatewayAssociations -> Encoding # toJSONList :: [DescribeDirectConnectGatewayAssociations] -> Value # toEncodingList :: [DescribeDirectConnectGatewayAssociations] -> Encoding #
AWSPager DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods page :: DescribeDirectConnectGatewayAssociations -> AWSResponse DescribeDirectConnectGatewayAssociations -> Maybe DescribeDirectConnectGatewayAssociations #
AWSRequest DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Associated Types type AWSResponse DescribeDirectConnectGatewayAssociations # Methods request :: DescribeDirectConnectGatewayAssociations -> Request DescribeDirectConnectGatewayAssociations # response :: MonadResource m => Logger -> Service -> Proxy DescribeDirectConnectGatewayAssociations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDirectConnectGatewayAssociations))) #
ToHeaders DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods toHeaders :: DescribeDirectConnectGatewayAssociations -> [Header] #
ToPath DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods toPath :: DescribeDirectConnectGatewayAssociations -> ByteString #
ToQuery DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations Methods toQuery :: DescribeDirectConnectGatewayAssociations -> QueryString #
type Rep DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations type Rep DescribeDirectConnectGatewayAssociations = D1 ('MetaData "DescribeDirectConnectGatewayAssociations" "Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "DescribeDirectConnectGatewayAssociations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "virtualGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "associationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "associatedGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (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 DescribeDirectConnectGatewayAssociations Source #
Instance details Defined in Amazonka.DirectConnect.DescribeDirectConnectGatewayAssociations type AWSResponse DescribeDirectConnectGatewayAssociations = DescribeDirectConnectGatewayAssociationsResponse

newDescribeDirectConnectGatewayAssociations :: DescribeDirectConnectGatewayAssociations Source #

Create a value of DescribeDirectConnectGatewayAssociations 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:virtualGatewayId:DescribeDirectConnectGatewayAssociations', describeDirectConnectGatewayAssociations_virtualGatewayId - The ID of the virtual private gateway or transit gateway.

$sel:associationId:DescribeDirectConnectGatewayAssociations', describeDirectConnectGatewayAssociations_associationId - The ID of the Direct Connect gateway association.

$sel:associatedGatewayId:DescribeDirectConnectGatewayAssociations', describeDirectConnectGatewayAssociations_associatedGatewayId - The ID of the associated gateway.

$sel:directConnectGatewayId:DescribeDirectConnectGatewayAssociations', describeDirectConnectGatewayAssociations_directConnectGatewayId - The ID of the Direct Connect gateway.

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

$sel:maxResults:DescribeDirectConnectGatewayAssociations', describeDirectConnectGatewayAssociations_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

describeDirectConnectGatewayAssociations_virtualGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #

The ID of the virtual private gateway or transit gateway.

describeDirectConnectGatewayAssociations_associationId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #

The ID of the Direct Connect gateway association.

describeDirectConnectGatewayAssociations_associatedGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #

The ID of the associated gateway.

describeDirectConnectGatewayAssociations_directConnectGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #

The ID of the Direct Connect gateway.

describeDirectConnectGatewayAssociations_nextToken :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #

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

describeDirectConnectGatewayAssociations_maxResults :: Lens' DescribeDirectConnectGatewayAssociations (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 DescribeDirectConnectGatewayAssociationsResponse Source #

See: newDescribeDirectConnectGatewayAssociationsResponse smart constructor.

Constructors

DescribeDirectConnectGatewayAssociationsResponse'
Fields nextToken :: Maybe Text The token to retrieve the next page. directConnectGatewayAssociations :: Maybe [DirectConnectGatewayAssociation] Information about the associations. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeDirectConnectGatewayAssociationsResponse Source #

Arguments

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

Create a value of DescribeDirectConnectGatewayAssociationsResponse 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:nextToken:DescribeDirectConnectGatewayAssociations', describeDirectConnectGatewayAssociationsResponse_nextToken - The token to retrieve the next page.

$sel:directConnectGatewayAssociations:DescribeDirectConnectGatewayAssociationsResponse', describeDirectConnectGatewayAssociationsResponse_directConnectGatewayAssociations - Information about the associations.

$sel:httpStatus:DescribeDirectConnectGatewayAssociationsResponse', describeDirectConnectGatewayAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

describeDirectConnectGatewayAssociationsResponse_nextToken :: Lens' DescribeDirectConnectGatewayAssociationsResponse (Maybe Text) Source #

The token to retrieve the next page.

describeDirectConnectGatewayAssociationsResponse_directConnectGatewayAssociations :: Lens' DescribeDirectConnectGatewayAssociationsResponse (Maybe [DirectConnectGatewayAssociation]) Source #

Information about the associations.

describeDirectConnectGatewayAssociationsResponse_httpStatus :: Lens' DescribeDirectConnectGatewayAssociationsResponse Int Source #

The response's http status code.