libZSservicesZSamazonka-appmeshZSamazonka-appmesh
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppMesh.ListVirtualRouters

Description

Returns a list of existing virtual routers in a service mesh.

This operation returns paginated results.

Synopsis

Creating a Request

data ListVirtualRouters Source #

See: newListVirtualRouters smart constructor.

Constructors

ListVirtualRouters' 

Fields

  • meshOwner :: Maybe Text

    The AWS 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 ListVirtualRouters 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.

  • limit :: Maybe Natural

    The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters 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 ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

  • meshName :: Text

    The name of the service mesh to list virtual routers in.

Instances

Instances details
Eq ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Read ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Show ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Generic ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Associated Types

type Rep ListVirtualRouters :: Type -> Type #

NFData ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Methods

rnf :: ListVirtualRouters -> () #

Hashable ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

AWSPager ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

AWSRequest ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Associated Types

type AWSResponse ListVirtualRouters #

ToHeaders ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

ToPath ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

ToQuery ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

type Rep ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

type Rep ListVirtualRouters = D1 ('MetaData "ListVirtualRouters" "Amazonka.AppMesh.ListVirtualRouters" "libZSservicesZSamazonka-appmeshZSamazonka-appmesh" 'False) (C1 ('MetaCons "ListVirtualRouters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "meshOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "meshName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListVirtualRouters Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

newListVirtualRouters Source #

Create a value of ListVirtualRouters 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:meshOwner:ListVirtualRouters', listVirtualRouters_meshOwner - The AWS 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.

$sel:nextToken:ListVirtualRouters', listVirtualRouters_nextToken - The nextToken value returned from a previous paginated ListVirtualRouters 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.

$sel:limit:ListVirtualRouters', listVirtualRouters_limit - The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters 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 ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

$sel:meshName:ListVirtualRouters', listVirtualRouters_meshName - The name of the service mesh to list virtual routers in.

Request Lenses

listVirtualRouters_meshOwner :: Lens' ListVirtualRouters (Maybe Text) Source #

The AWS 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.

listVirtualRouters_nextToken :: Lens' ListVirtualRouters (Maybe Text) Source #

The nextToken value returned from a previous paginated ListVirtualRouters 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.

listVirtualRouters_limit :: Lens' ListVirtualRouters (Maybe Natural) Source #

The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters 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 ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

listVirtualRouters_meshName :: Lens' ListVirtualRouters Text Source #

The name of the service mesh to list virtual routers in.

Destructuring the Response

data ListVirtualRoutersResponse Source #

See: newListVirtualRoutersResponse smart constructor.

Constructors

ListVirtualRoutersResponse' 

Fields

  • nextToken :: Maybe Text

    The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters 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.

  • virtualRouters :: [VirtualRouterRef]

    The list of existing virtual routers for the specified service mesh.

Instances

Instances details
Eq ListVirtualRoutersResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Read ListVirtualRoutersResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Show ListVirtualRoutersResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Generic ListVirtualRoutersResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

Associated Types

type Rep ListVirtualRoutersResponse :: Type -> Type #

NFData ListVirtualRoutersResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

type Rep ListVirtualRoutersResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualRouters

type Rep ListVirtualRoutersResponse = D1 ('MetaData "ListVirtualRoutersResponse" "Amazonka.AppMesh.ListVirtualRouters" "libZSservicesZSamazonka-appmeshZSamazonka-appmesh" 'False) (C1 ('MetaCons "ListVirtualRoutersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "virtualRouters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [VirtualRouterRef]))))

newListVirtualRoutersResponse Source #

Create a value of ListVirtualRoutersResponse 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:nextToken:ListVirtualRouters', listVirtualRoutersResponse_nextToken - The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters 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:ListVirtualRoutersResponse', listVirtualRoutersResponse_httpStatus - The response's http status code.

$sel:virtualRouters:ListVirtualRoutersResponse', listVirtualRoutersResponse_virtualRouters - The list of existing virtual routers for the specified service mesh.

Response Lenses

listVirtualRoutersResponse_nextToken :: Lens' ListVirtualRoutersResponse (Maybe Text) Source #

The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters 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.

listVirtualRoutersResponse_virtualRouters :: Lens' ListVirtualRoutersResponse [VirtualRouterRef] Source #

The list of existing virtual routers for the specified service mesh.