describeRoute method

Future<DescribeRouteOutput> describeRoute({ required String meshName, required String routeName, required String virtualRouterName, String? meshOwner, })

Describes an existing route.

May throw BadRequestException. May throw ForbiddenException. May throw InternalServerErrorException. May throw NotFoundException. May throw ServiceUnavailableException. May throw TooManyRequestsException.

Parameter meshName : The name of the service mesh that the route resides in.

Parameter routeName : The name of the route to describe.

Parameter virtualRouterName : The name of the virtual router that the route is associated with.

Parameter meshOwner : The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

Implementation

Future<DescribeRouteOutput> describeRoute({
  required String meshName,
  required String routeName,
  required String virtualRouterName,
  String? meshOwner,
}) async {
  final $query = <String, List<String>>{
    if (meshOwner != null) 'meshOwner': [meshOwner],
  };
  final response = await _protocol.sendRaw(
    payload: null,
    method: 'GET',
    requestUri:
        '/v20190125/meshes/${Uri.encodeComponent(meshName)}/virtualRouter/${Uri.encodeComponent(virtualRouterName)}/routes/${Uri.encodeComponent(routeName)}',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  final $json = await _s.jsonFromResponse(response);
  return DescribeRouteOutput(
    route: RouteData.fromJson($json),
  );
}