describeDirectConnectGatewayAssociationProposals method

Future<DescribeDirectConnectGatewayAssociationProposalsResult> describeDirectConnectGatewayAssociationProposals({ String? associatedGatewayId, String? directConnectGatewayId, int? maxResults, String? nextToken, String? proposalId, })

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

May throw DirectConnectServerException. May throw DirectConnectClientException.

Parameter associatedGatewayId : The ID of the associated gateway.

Parameter directConnectGatewayId : The ID of the Direct Connect gateway.

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

Parameter nextToken : The token for the next page of results.

Parameter proposalId : The ID of the proposal.

Implementation

Future<DescribeDirectConnectGatewayAssociationProposalsResult>
    describeDirectConnectGatewayAssociationProposals({
  String? associatedGatewayId,
  String? directConnectGatewayId,
  int? maxResults,
  String? nextToken,
  String? proposalId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'OvertureService.DescribeDirectConnectGatewayAssociationProposals'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (associatedGatewayId != null)
        'associatedGatewayId': associatedGatewayId,
      if (directConnectGatewayId != null)
        'directConnectGatewayId': directConnectGatewayId,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
      if (proposalId != null) 'proposalId': proposalId,
    },
  );

  return DescribeDirectConnectGatewayAssociationProposalsResult.fromJson(
      jsonResponse.body);
}