APIPortal / Client / list_managed_apis

list_managed_apis

APIPortal.Client.list_managed_apis(**kwargs)

Lists the Managed APIs in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_managed_apis(
    maxResults=123,
    nextToken='string',
    productId='string'
)
Parameters:
  • maxResults (integer) – The maximum number of results to return in one page, from 1 to 100.

  • nextToken (string) – The pagination token returned by a previous call. Omit it to get the first page.

  • productId (string) – Optional filter: when supplied, only Managed APIs associated with this product are returned.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token to pass in the next request to get the next page. Absent when there are no more results.

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

Exceptions

  • APIPortal.Client.exceptions.LimitExceededException

  • APIPortal.Client.exceptions.BadRequestException

  • APIPortal.Client.exceptions.AccessDeniedException