AWS API Changes

2020/05/20 - AWS App Mesh - 5 updated api methods

Changes Update appmesh client to latest version

ListMeshes (updated)

Link ¶
Changes (response)

{'meshes': {'createdAt': 'timestamp',
            'lastUpdatedAt': 'timestamp',
            'version': 'long'}}

Returns a list of existing service meshes.

See also: AWS API Documentation

Request Syntax

client.list_meshes(
    limit=123,
    nextToken='string'
)

type limit:

integer

param limit:

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

ListMeshes returns up to 100 results and a nextToken value if applicable.

type nextToken:

string

param nextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'meshes': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshName': 'string',
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'version': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- meshes (list) --
  
  The list of existing service meshes.
  - (dict) --
    
    An object that represents a service mesh returned by a list operation.
    - arn (string) --
      
      The full Amazon Resource Name (ARN) of the service mesh.
    - createdAt (datetime) --
    - lastUpdatedAt (datetime) --
    - meshName (string) --
      
      The name of the service mesh.
    - meshOwner (string) --
      
      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.
    - resourceOwner (string) --
      
      The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes.
    - version (integer) --
- nextToken (string) --
  
  The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes 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.

ListRoutes (updated)

Link ¶
Changes (response)

{'routes': {'createdAt': 'timestamp',
            'lastUpdatedAt': 'timestamp',
            'version': 'long'}}

Returns a list of existing routes in a service mesh.

See also: AWS API Documentation

Request Syntax

client.list_routes(
    limit=123,
    meshName='string',
    meshOwner='string',
    nextToken='string',
    virtualRouterName='string'
)

type limit:

integer

param limit:

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.

type meshName:

string

param meshName:

[REQUIRED]

The name of the service mesh to list routes in.

type meshOwner:

string

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

type nextToken:

string

param nextToken:

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.

type virtualRouterName:

string

param virtualRouterName:

[REQUIRED]

The name of the virtual router to list routes in.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'routes': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshName': 'string',
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'routeName': 'string',
            'version': 123,
            'virtualRouterName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes 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.
- routes (list) --
  
  The list of existing routes for the specified service mesh and virtual router.
  - (dict) --
    
    An object that represents a route returned by a list operation.
    - arn (string) --
      
      The full Amazon Resource Name (ARN) for the route.
    - createdAt (datetime) --
    - lastUpdatedAt (datetime) --
    - meshName (string) --
      
      The name of the service mesh that the route resides in.
    - meshOwner (string) --
      
      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.
    - resourceOwner (string) --
      
      The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes.
    - routeName (string) --
      
      The name of the route.
    - version (integer) --
    - virtualRouterName (string) --
      
      The virtual router that the route is associated with.

ListVirtualNodes (updated)

Link ¶
Changes (response)

{'virtualNodes': {'createdAt': 'timestamp',
                  'lastUpdatedAt': 'timestamp',
                  'version': 'long'}}

Returns a list of existing virtual nodes.

See also: AWS API Documentation

Request Syntax

client.list_virtual_nodes(
    limit=123,
    meshName='string',
    meshOwner='string',
    nextToken='string'
)

type limit:

integer

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

type meshName:

string

param meshName:

[REQUIRED]

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

type meshOwner:

string

param meshOwner:

type nextToken:

string

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

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'virtualNodes': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshName': 'string',
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'version': 123,
            'virtualNodeName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  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.
- virtualNodes (list) --
  
  The list of existing virtual nodes for the specified service mesh.
  - (dict) --
    
    An object that represents a virtual node returned by a list operation.
    - arn (string) --
      
      The full Amazon Resource Name (ARN) for the virtual node.
    - createdAt (datetime) --
    - lastUpdatedAt (datetime) --
    - meshName (string) --
      
      The name of the service mesh that the virtual node resides in.
    - meshOwner (string) --
      
      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.
    - resourceOwner (string) --
      
      The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes.
    - version (integer) --
    - virtualNodeName (string) --
      
      The name of the virtual node.

ListVirtualRouters (updated)

Link ¶
Changes (response)

{'virtualRouters': {'createdAt': 'timestamp',
                    'lastUpdatedAt': 'timestamp',
                    'version': 'long'}}

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

See also: AWS API Documentation

Request Syntax

client.list_virtual_routers(
    limit=123,
    meshName='string',
    meshOwner='string',
    nextToken='string'
)

type limit:

integer

param limit:

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

type meshName:

string

param meshName:

[REQUIRED]

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

type meshOwner:

string

param meshOwner:

type nextToken:

string

param nextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'virtualRouters': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshName': 'string',
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'version': 123,
            'virtualRouterName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The nextToken value to include in a future ListVirtualRouters
  
  request. When the results of a ListVirtualRouters 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.
- virtualRouters (list) --
  
  The list of existing virtual routers for the specified service mesh.
  - (dict) --
    
    An object that represents a virtual router returned by a list operation.
    - arn (string) --
      
      The full Amazon Resource Name (ARN) for the virtual router.
    - createdAt (datetime) --
    - lastUpdatedAt (datetime) --
    - meshName (string) --
      
      The name of the service mesh that the virtual router resides in.
    - meshOwner (string) --
      
      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.
    - resourceOwner (string) --
      
      The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes.
    - version (integer) --
    - virtualRouterName (string) --
      
      The name of the virtual router.

ListVirtualServices (updated)

Link ¶
Changes (response)

{'virtualServices': {'createdAt': 'timestamp',
                     'lastUpdatedAt': 'timestamp',
                     'version': 'long'}}

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

See also: AWS API Documentation

Request Syntax

client.list_virtual_services(
    limit=123,
    meshName='string',
    meshOwner='string',
    nextToken='string'
)

type limit:

integer

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

type meshName:

string

param meshName:

[REQUIRED]

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

type meshOwner:

string

param meshOwner:

type nextToken:

string

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

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'virtualServices': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'meshName': 'string',
            'meshOwner': 'string',
            'resourceOwner': 'string',
            'version': 123,
            'virtualServiceName': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  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.
- virtualServices (list) --
  
  The list of existing virtual services for the specified service mesh.
  - (dict) --
    
    An object that represents a virtual service returned by a list operation.
    - arn (string) --
      
      The full Amazon Resource Name (ARN) for the virtual service.
    - createdAt (datetime) --
    - lastUpdatedAt (datetime) --
    - meshName (string) --
      
      The name of the service mesh that the virtual service resides in.
    - meshOwner (string) --
      
      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.
    - resourceOwner (string) --
      
      The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes.
    - version (integer) --
    - virtualServiceName (string) --
      
      The name of the virtual service.