amazonka-appmesh-2.0: Amazon App Mesh SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppMesh.ListRoutes

Description

Returns a list of existing routes in a service mesh.

This operation returns paginated results.

Synopsis

Creating a Request

data ListRoutes Source #

See: newListRoutes smart constructor.

Constructors

ListRoutes' 

Fields

  • limit :: Maybe Natural

    The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

  • meshOwner :: Maybe Text

    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.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

  • meshName :: Text

    The name of the service mesh to list routes in.

  • virtualRouterName :: Text

    The name of the virtual router to list routes in.

Instances

Instances details
ToHeaders ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Methods

toHeaders :: ListRoutes -> [Header] #

ToPath ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

ToQuery ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

AWSPager ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

AWSRequest ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Associated Types

type AWSResponse ListRoutes #

Generic ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Associated Types

type Rep ListRoutes :: Type -> Type #

Read ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Show ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

NFData ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Methods

rnf :: ListRoutes -> () #

Eq ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Hashable ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

type AWSResponse ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

type Rep ListRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

type Rep ListRoutes = D1 ('MetaData "ListRoutes" "Amazonka.AppMesh.ListRoutes" "amazonka-appmesh-2.0-GBIHUgXnP8s1LEJyvNe1ca" 'False) (C1 ('MetaCons "ListRoutes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "meshOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "meshName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "virtualRouterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListRoutes Source #

Create a value of ListRoutes 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:limit:ListRoutes', listRoutes_limit - The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

ListRoutes, listRoutes_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.

ListRoutes, listRoutes_nextToken - The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

ListRoutes, listRoutes_meshName - The name of the service mesh to list routes in.

ListRoutes, listRoutes_virtualRouterName - The name of the virtual router to list routes in.

Request Lenses

listRoutes_limit :: Lens' ListRoutes (Maybe Natural) Source #

The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

listRoutes_meshOwner :: Lens' ListRoutes (Maybe Text) Source #

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.

listRoutes_nextToken :: Lens' ListRoutes (Maybe Text) Source #

The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listRoutes_meshName :: Lens' ListRoutes Text Source #

The name of the service mesh to list routes in.

listRoutes_virtualRouterName :: Lens' ListRoutes Text Source #

The name of the virtual router to list routes in.

Destructuring the Response

data ListRoutesResponse Source #

See: newListRoutesResponse smart constructor.

Constructors

ListRoutesResponse' 

Fields

  • nextToken :: Maybe Text

    The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • httpStatus :: Int

    The response's http status code.

  • routes :: [RouteRef]

    The list of existing routes for the specified service mesh and virtual router.

Instances

Instances details
Generic ListRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Associated Types

type Rep ListRoutesResponse :: Type -> Type #

Read ListRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Show ListRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

NFData ListRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

Methods

rnf :: ListRoutesResponse -> () #

Eq ListRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

type Rep ListRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListRoutes

type Rep ListRoutesResponse = D1 ('MetaData "ListRoutesResponse" "Amazonka.AppMesh.ListRoutes" "amazonka-appmesh-2.0-GBIHUgXnP8s1LEJyvNe1ca" 'False) (C1 ('MetaCons "ListRoutesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "routes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RouteRef]))))

newListRoutesResponse Source #

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

ListRoutes, listRoutesResponse_nextToken - The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:ListRoutesResponse', listRoutesResponse_httpStatus - The response's http status code.

$sel:routes:ListRoutesResponse', listRoutesResponse_routes - The list of existing routes for the specified service mesh and virtual router.

Response Lenses

listRoutesResponse_nextToken :: Lens' ListRoutesResponse (Maybe Text) Source #

The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listRoutesResponse_routes :: Lens' ListRoutesResponse [RouteRef] Source #

The list of existing routes for the specified service mesh and virtual router.