Class: Aws::AppMesh::Types::ListRoutesInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb

Overview

Note:

When making an API call, you may pass ListRoutesInput data as a hash:

{
  limit: 1,
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  next_token: "String",
  virtual_router_name: "ResourceName", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

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

Returns:

  • (Integer)


4737
4738
4739
4740
4741
4742
4743
4744
4745
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4737

class ListRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_nameString

The name of the service mesh to list routes in.

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4737

class ListRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_ownerString

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.

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4737

class ListRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4737

class ListRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_router_nameString

The name of the virtual router to list routes in.

Returns:

  • (String)


4737
4738
4739
4740
4741
4742
4743
4744
4745
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4737

class ListRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end