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

Description

Returns a list of existing virtual nodes.

This operation returns paginated results.

Synopsis

Creating a Request

data ListVirtualNodes Source #

See: newListVirtualNodes smart constructor.

Constructors

ListVirtualNodes' 

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

  • meshName :: Text

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

Instances

Instances details
Eq ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Read ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Show ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Generic ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Associated Types

type Rep ListVirtualNodes :: Type -> Type #

NFData ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Methods

rnf :: ListVirtualNodes -> () #

Hashable ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

AWSPager ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

AWSRequest ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Associated Types

type AWSResponse ListVirtualNodes #

ToHeaders ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

ToPath ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

ToQuery ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

type Rep ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

type Rep ListVirtualNodes = D1 ('MetaData "ListVirtualNodes" "Amazonka.AppMesh.ListVirtualNodes" "libZSservicesZSamazonka-appmeshZSamazonka-appmesh" 'False) (C1 ('MetaCons "ListVirtualNodes'" '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 ListVirtualNodes Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

newListVirtualNodes Source #

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

$sel:meshName:ListVirtualNodes', listVirtualNodes_meshName - The name of the service mesh to list virtual nodes in.

Request Lenses

listVirtualNodes_meshOwner :: Lens' ListVirtualNodes (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.

listVirtualNodes_nextToken :: Lens' ListVirtualNodes (Maybe Text) Source #

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

listVirtualNodes_limit :: Lens' ListVirtualNodes (Maybe Natural) Source #

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

listVirtualNodes_meshName :: Lens' ListVirtualNodes Text Source #

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

Destructuring the Response

data ListVirtualNodesResponse Source #

See: newListVirtualNodesResponse smart constructor.

Constructors

ListVirtualNodesResponse' 

Fields

  • nextToken :: Maybe Text

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

  • virtualNodes :: [VirtualNodeRef]

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

Instances

Instances details
Eq ListVirtualNodesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Read ListVirtualNodesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Show ListVirtualNodesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Generic ListVirtualNodesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

Associated Types

type Rep ListVirtualNodesResponse :: Type -> Type #

NFData ListVirtualNodesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

type Rep ListVirtualNodesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualNodes

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

newListVirtualNodesResponse Source #

Create a value of ListVirtualNodesResponse 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:ListVirtualNodes', listVirtualNodesResponse_nextToken - The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes 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:ListVirtualNodesResponse', listVirtualNodesResponse_httpStatus - The response's http status code.

$sel:virtualNodes:ListVirtualNodesResponse', listVirtualNodesResponse_virtualNodes - The list of existing virtual nodes for the specified service mesh.

Response Lenses

listVirtualNodesResponse_nextToken :: Lens' ListVirtualNodesResponse (Maybe Text) Source #

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

listVirtualNodesResponse_virtualNodes :: Lens' ListVirtualNodesResponse [VirtualNodeRef] Source #

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