Amazonka.AppMesh.ListRoutes

Returns a list of existing routes in a service mesh.

This operation returns paginated results.

Creating a Request

data ListRoutes

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

ToHeaders ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

toHeaders :: ListRoutes -> [Header]

ToPath ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

toPath :: ListRoutes -> ByteString

ToQuery ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

toQuery :: ListRoutes -> QueryString

AWSPager ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

page :: ListRoutes -> AWSResponse ListRoutes -> Maybe ListRoutes

AWSRequest ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Associated Types

type AWSResponse ListRoutes

Methods

request :: (Service -> Service) -> ListRoutes -> Request ListRoutes

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRoutes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRoutes)))

Generic ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Associated Types

type Rep ListRoutes :: Type -> Type

Methods

from :: ListRoutes -> Rep ListRoutes x

to :: Rep ListRoutes x -> ListRoutes

Read ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

readsPrec :: Int -> ReadS ListRoutes

readList :: ReadS [ListRoutes]

readPrec :: ReadPrec ListRoutes

readListPrec :: ReadPrec [ListRoutes]

Show ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

showsPrec :: Int -> ListRoutes -> ShowS

show :: ListRoutes -> String

showList :: [ListRoutes] -> ShowS

NFData ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

rnf :: ListRoutes -> ()

Eq ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

(==) :: ListRoutes -> ListRoutes -> Bool

(/=) :: ListRoutes -> ListRoutes -> Bool

Hashable ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

Methods

hashWithSalt :: Int -> ListRoutes -> Int

hash :: ListRoutes -> Int

type AWSResponse ListRoutes

Defined in Amazonka.AppMesh.ListRoutes

type AWSResponse ListRoutes = ListRoutesResponse

type Rep ListRoutes

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

Arguments

:: Text

ListRoutes

-> Text

ListRoutes

-> ListRoutes

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)

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)

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)

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

The name of the service mesh to list routes in.

listRoutes_virtualRouterName :: Lens' ListRoutes Text

The name of the virtual router to list routes in.

Destructuring the Response

data ListRoutesResponse

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

Generic ListRoutesResponse

Defined in Amazonka.AppMesh.ListRoutes

Associated Types

type Rep ListRoutesResponse :: Type -> Type

Methods

from :: ListRoutesResponse -> Rep ListRoutesResponse x

to :: Rep ListRoutesResponse x -> ListRoutesResponse

Read ListRoutesResponse

Defined in Amazonka.AppMesh.ListRoutes

Methods

readsPrec :: Int -> ReadS ListRoutesResponse

readList :: ReadS [ListRoutesResponse]

readPrec :: ReadPrec ListRoutesResponse

readListPrec :: ReadPrec [ListRoutesResponse]

Show ListRoutesResponse

Defined in Amazonka.AppMesh.ListRoutes

Methods

showsPrec :: Int -> ListRoutesResponse -> ShowS

show :: ListRoutesResponse -> String

showList :: [ListRoutesResponse] -> ShowS

NFData ListRoutesResponse

Defined in Amazonka.AppMesh.ListRoutes

Methods

rnf :: ListRoutesResponse -> ()

Eq ListRoutesResponse

Defined in Amazonka.AppMesh.ListRoutes

Methods

(==) :: ListRoutesResponse -> ListRoutesResponse -> Bool

(/=) :: ListRoutesResponse -> ListRoutesResponse -> Bool

type Rep ListRoutesResponse

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

Arguments

:: Int

$sel:httpStatus:ListRoutesResponse'

-> ListRoutesResponse

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)

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_httpStatus :: Lens' ListRoutesResponse Int

The response's http status code.

listRoutesResponse_routes :: Lens' ListRoutesResponse [RouteRef]

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