APIPortal / Paginator / ListManagedApis
ListManagedApis¶
- class APIPortal.Paginator.ListManagedApis¶
paginator = client.get_paginator('list_managed_apis')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
APIPortal.Client.list_managed_apis().See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( productId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
productId (string) – Optional filter: when supplied, only Managed APIs associated with this product are returned.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextTokenwill be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextTokenfrom a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'items': [ { 'managedApiId': 'string', 'managedApiArn': 'string', 'apiSignature': { 'resourceArn': 'string', 'method': 'GET'|'POST'|'PUT'|'DELETE'|'PATCH'|'ANY'|'HEAD'|'OPTIONS', 'hostname': 'string', 'port': 123, 'path': 'string' }, 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
items (list) –
The Managed APIs in this page of results.
(dict) –
A summary of a Managed API.
managedApiId (string) –
The identifier of the Managed API.
managedApiArn (string) –
The ARN of the Managed API.
apiSignature (dict) –
The attributes that identify the API.
resourceArn (string) –
The ARN of the resource that serves the API.
method (string) –
The HTTP method of the API.
hostname (string) –
The host name the API is served on.
port (integer) –
The port the API listens on, from 0 to 65535.
path (string) –
The request path of the API.
createdAt (datetime) –
When the resource was created.
updatedAt (datetime) –
When the resource was last updated.
NextToken (string) –
A token to resume pagination.