| 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.DescribeDirectConnectGatewayAssociations
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
- data DescribeDirectConnectGatewayAssociations = DescribeDirectConnectGatewayAssociations' {}
- newDescribeDirectConnectGatewayAssociations :: DescribeDirectConnectGatewayAssociations
- describeDirectConnectGatewayAssociations_associatedGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text)
- describeDirectConnectGatewayAssociations_associationId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text)
- describeDirectConnectGatewayAssociations_directConnectGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text)
- describeDirectConnectGatewayAssociations_maxResults :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Int)
- describeDirectConnectGatewayAssociations_nextToken :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text)
- describeDirectConnectGatewayAssociations_virtualGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text)
- data DescribeDirectConnectGatewayAssociationsResponse = DescribeDirectConnectGatewayAssociationsResponse' {}
- newDescribeDirectConnectGatewayAssociationsResponse :: Int -> DescribeDirectConnectGatewayAssociationsResponse
- describeDirectConnectGatewayAssociationsResponse_directConnectGatewayAssociations :: Lens' DescribeDirectConnectGatewayAssociationsResponse (Maybe [DirectConnectGatewayAssociation])
- describeDirectConnectGatewayAssociationsResponse_nextToken :: Lens' DescribeDirectConnectGatewayAssociationsResponse (Maybe Text)
- describeDirectConnectGatewayAssociationsResponse_httpStatus :: Lens' DescribeDirectConnectGatewayAssociationsResponse Int
Creating a Request
data DescribeDirectConnectGatewayAssociations Source #
See: newDescribeDirectConnectGatewayAssociations smart constructor.
Constructors
| DescribeDirectConnectGatewayAssociations' | |
Fields
| |
Instances
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:associatedGatewayId:DescribeDirectConnectGatewayAssociations', describeDirectConnectGatewayAssociations_associatedGatewayId - The ID of the associated gateway.
DescribeDirectConnectGatewayAssociations, describeDirectConnectGatewayAssociations_associationId - The ID of the Direct Connect gateway association.
DescribeDirectConnectGatewayAssociations, describeDirectConnectGatewayAssociations_directConnectGatewayId - The ID of the Direct Connect gateway.
$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.
DescribeDirectConnectGatewayAssociations, describeDirectConnectGatewayAssociations_nextToken - The token provided in the previous call to retrieve the next page.
DescribeDirectConnectGatewayAssociations, describeDirectConnectGatewayAssociations_virtualGatewayId - The ID of the virtual private gateway or transit gateway.
Request Lenses
describeDirectConnectGatewayAssociations_associatedGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #
The ID of the associated gateway.
describeDirectConnectGatewayAssociations_associationId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #
The ID of the Direct Connect gateway association.
describeDirectConnectGatewayAssociations_directConnectGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #
The ID of the Direct Connect gateway.
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.
describeDirectConnectGatewayAssociations_nextToken :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #
The token provided in the previous call to retrieve the next page.
describeDirectConnectGatewayAssociations_virtualGatewayId :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #
The ID of the virtual private gateway or transit gateway.
Destructuring the Response
data DescribeDirectConnectGatewayAssociationsResponse Source #
See: newDescribeDirectConnectGatewayAssociationsResponse smart constructor.
Constructors
| DescribeDirectConnectGatewayAssociationsResponse' | |
Fields
| |
Instances
newDescribeDirectConnectGatewayAssociationsResponse Source #
Arguments
| :: Int |
|
| -> 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:directConnectGatewayAssociations:DescribeDirectConnectGatewayAssociationsResponse', describeDirectConnectGatewayAssociationsResponse_directConnectGatewayAssociations - Information about the associations.
DescribeDirectConnectGatewayAssociations, describeDirectConnectGatewayAssociationsResponse_nextToken - The token to retrieve the next page.
$sel:httpStatus:DescribeDirectConnectGatewayAssociationsResponse', describeDirectConnectGatewayAssociationsResponse_httpStatus - The response's http status code.
Response Lenses
describeDirectConnectGatewayAssociationsResponse_directConnectGatewayAssociations :: Lens' DescribeDirectConnectGatewayAssociationsResponse (Maybe [DirectConnectGatewayAssociation]) Source #
Information about the associations.
describeDirectConnectGatewayAssociationsResponse_nextToken :: Lens' DescribeDirectConnectGatewayAssociationsResponse (Maybe Text) Source #
The token to retrieve the next page.
describeDirectConnectGatewayAssociationsResponse_httpStatus :: Lens' DescribeDirectConnectGatewayAssociationsResponse Int Source #
The response's http status code.