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

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListVirtualGateways Source #

See: newListVirtualGateways smart constructor.

Constructors

ListVirtualGateways' 

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

  • meshName :: Text

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

Instances

Instances details
Eq ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Read ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Show ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Generic ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Associated Types

type Rep ListVirtualGateways :: Type -> Type #

NFData ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Methods

rnf :: ListVirtualGateways -> () #

Hashable ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

AWSPager ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

AWSRequest ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Associated Types

type AWSResponse ListVirtualGateways #

ToHeaders ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

ToPath ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

ToQuery ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

type Rep ListVirtualGateways Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

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

Defined in Amazonka.AppMesh.ListVirtualGateways

newListVirtualGateways Source #

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

$sel:meshName:ListVirtualGateways', listVirtualGateways_meshName - The name of the service mesh to list virtual gateways in.

Request Lenses

listVirtualGateways_meshOwner :: Lens' ListVirtualGateways (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.

listVirtualGateways_nextToken :: Lens' ListVirtualGateways (Maybe Text) Source #

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

listVirtualGateways_limit :: Lens' ListVirtualGateways (Maybe Natural) Source #

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

listVirtualGateways_meshName :: Lens' ListVirtualGateways Text Source #

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

Destructuring the Response

data ListVirtualGatewaysResponse Source #

See: newListVirtualGatewaysResponse smart constructor.

Constructors

ListVirtualGatewaysResponse' 

Fields

  • nextToken :: Maybe Text

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

  • virtualGateways :: [VirtualGatewayRef]

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

Instances

Instances details
Eq ListVirtualGatewaysResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Read ListVirtualGatewaysResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Show ListVirtualGatewaysResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Generic ListVirtualGatewaysResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

Associated Types

type Rep ListVirtualGatewaysResponse :: Type -> Type #

NFData ListVirtualGatewaysResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

type Rep ListVirtualGatewaysResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListVirtualGateways

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

newListVirtualGatewaysResponse Source #

Create a value of ListVirtualGatewaysResponse 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:ListVirtualGateways', listVirtualGatewaysResponse_nextToken - The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways 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:ListVirtualGatewaysResponse', listVirtualGatewaysResponse_httpStatus - The response's http status code.

$sel:virtualGateways:ListVirtualGatewaysResponse', listVirtualGatewaysResponse_virtualGateways - The list of existing virtual gateways for the specified service mesh.

Response Lenses

listVirtualGatewaysResponse_nextToken :: Lens' ListVirtualGatewaysResponse (Maybe Text) Source #

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

listVirtualGatewaysResponse_virtualGateways :: Lens' ListVirtualGatewaysResponse [VirtualGatewayRef] Source #

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