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

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListVirtualServices Source #

See: newListVirtualServices smart constructor.

Constructors

ListVirtualServices' 

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

  • meshName :: Text

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

Instances

Instances details
Eq ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Read ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Show ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Generic ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Associated Types

type Rep ListVirtualServices :: Type -> Type #

NFData ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Methods

rnf :: ListVirtualServices -> () #

Hashable ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

AWSPager ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

AWSRequest ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Associated Types

type AWSResponse ListVirtualServices #

ToHeaders ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

ToPath ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

ToQuery ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

type Rep ListVirtualServices Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

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

Defined in Amazonka.AppMesh.ListVirtualServices

newListVirtualServices Source #

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

$sel:meshName:ListVirtualServices', listVirtualServices_meshName - The name of the service mesh to list virtual services in.

Request Lenses

listVirtualServices_meshOwner :: Lens' ListVirtualServices (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.

listVirtualServices_nextToken :: Lens' ListVirtualServices (Maybe Text) Source #

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

listVirtualServices_limit :: Lens' ListVirtualServices (Maybe Natural) Source #

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

listVirtualServices_meshName :: Lens' ListVirtualServices Text Source #

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

Destructuring the Response

data ListVirtualServicesResponse Source #

See: newListVirtualServicesResponse smart constructor.

Constructors

ListVirtualServicesResponse' 

Fields

  • nextToken :: Maybe Text

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

  • virtualServices :: [VirtualServiceRef]

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

Instances

Instances details
Eq ListVirtualServicesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Read ListVirtualServicesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Show ListVirtualServicesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Generic ListVirtualServicesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

Associated Types

type Rep ListVirtualServicesResponse :: Type -> Type #

NFData ListVirtualServicesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

type Rep ListVirtualServicesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualServices

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

newListVirtualServicesResponse Source #

Create a value of ListVirtualServicesResponse 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:ListVirtualServices', listVirtualServicesResponse_nextToken - The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices 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:ListVirtualServicesResponse', listVirtualServicesResponse_httpStatus - The response's http status code.

$sel:virtualServices:ListVirtualServicesResponse', listVirtualServicesResponse_virtualServices - The list of existing virtual services for the specified service mesh.

Response Lenses

listVirtualServicesResponse_nextToken :: Lens' ListVirtualServicesResponse (Maybe Text) Source #

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

listVirtualServicesResponse_virtualServices :: Lens' ListVirtualServicesResponse [VirtualServiceRef] Source #

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