amazonka-appmesh-2.0: Amazon App Mesh SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppMesh.ListGatewayRoutes

Description

Returns a list of existing gateway routes that are associated to a virtual gateway.

This operation returns paginated results.

Synopsis

Creating a Request

data ListGatewayRoutes Source #

See: newListGatewayRoutes smart constructor.

Constructors

ListGatewayRoutes' 

Fields

  • limit :: Maybe Natural

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

  • virtualGatewayName :: Text

    The name of the virtual gateway to list gateway routes in.

Instances

Instances details
ToHeaders ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

ToPath ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

ToQuery ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

AWSPager ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

AWSRequest ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Associated Types

type AWSResponse ListGatewayRoutes #

Generic ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Associated Types

type Rep ListGatewayRoutes :: Type -> Type #

Read ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Show ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

NFData ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Methods

rnf :: ListGatewayRoutes -> () #

Eq ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Hashable ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

type AWSResponse ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

type Rep ListGatewayRoutes Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

type Rep ListGatewayRoutes = D1 ('MetaData "ListGatewayRoutes" "Amazonka.AppMesh.ListGatewayRoutes" "amazonka-appmesh-2.0-GBIHUgXnP8s1LEJyvNe1ca" 'False) (C1 ('MetaCons "ListGatewayRoutes'" '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 "virtualGatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListGatewayRoutes Source #

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

ListGatewayRoutes, listGatewayRoutes_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.

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

ListGatewayRoutes, listGatewayRoutes_meshName - The name of the service mesh to list gateway routes in.

ListGatewayRoutes, listGatewayRoutes_virtualGatewayName - The name of the virtual gateway to list gateway routes in.

Request Lenses

listGatewayRoutes_limit :: Lens' ListGatewayRoutes (Maybe Natural) Source #

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

listGatewayRoutes_meshOwner :: Lens' ListGatewayRoutes (Maybe Text) Source #

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.

listGatewayRoutes_nextToken :: Lens' ListGatewayRoutes (Maybe Text) Source #

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

listGatewayRoutes_meshName :: Lens' ListGatewayRoutes Text Source #

The name of the service mesh to list gateway routes in.

listGatewayRoutes_virtualGatewayName :: Lens' ListGatewayRoutes Text Source #

The name of the virtual gateway to list gateway routes in.

Destructuring the Response

data ListGatewayRoutesResponse Source #

See: newListGatewayRoutesResponse smart constructor.

Constructors

ListGatewayRoutesResponse' 

Fields

  • nextToken :: Maybe Text

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

  • gatewayRoutes :: [GatewayRouteRef]

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

Instances

Instances details
Generic ListGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Associated Types

type Rep ListGatewayRoutesResponse :: Type -> Type #

Read ListGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Show ListGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

NFData ListGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

Eq ListGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

type Rep ListGatewayRoutesResponse Source # 
Instance details

Defined in Amazonka.AppMesh.ListGatewayRoutes

type Rep ListGatewayRoutesResponse = D1 ('MetaData "ListGatewayRoutesResponse" "Amazonka.AppMesh.ListGatewayRoutes" "amazonka-appmesh-2.0-GBIHUgXnP8s1LEJyvNe1ca" 'False) (C1 ('MetaCons "ListGatewayRoutesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "gatewayRoutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [GatewayRouteRef]))))

newListGatewayRoutesResponse Source #

Create a value of ListGatewayRoutesResponse 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:

ListGatewayRoutes, listGatewayRoutesResponse_nextToken - The nextToken value to include in a future ListGatewayRoutes request. When the results of a ListGatewayRoutes 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:ListGatewayRoutesResponse', listGatewayRoutesResponse_httpStatus - The response's http status code.

$sel:gatewayRoutes:ListGatewayRoutesResponse', listGatewayRoutesResponse_gatewayRoutes - The list of existing gateway routes for the specified service mesh and virtual gateway.

Response Lenses

listGatewayRoutesResponse_nextToken :: Lens' ListGatewayRoutesResponse (Maybe Text) Source #

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

listGatewayRoutesResponse_gatewayRoutes :: Lens' ListGatewayRoutesResponse [GatewayRouteRef] Source #

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