APIPortal / Client / create_managed_api
create_managed_api¶
- APIPortal.Client.create_managed_api(**kwargs)¶
Promote a discovered API in the API inventory into the managed API list.
See also: AWS API Documentation
Request Syntax
response = client.create_managed_api( apiSignature={ 'resourceArn': 'string', 'method': 'GET'|'POST'|'PUT'|'DELETE'|'PATCH'|'ANY'|'HEAD'|'OPTIONS', 'hostname': 'string', 'port': 123, 'path': 'string' }, tags={ 'string': 'string' } )
- Parameters:
apiSignature (dict) –
[REQUIRED]
The resource, method, host, port, and path that identify the API.
resourceArn (string) – [REQUIRED]
The ARN of the resource that serves the API.
method (string) – [REQUIRED]
The HTTP method of the API.
hostname (string) – [REQUIRED]
The host name the API is served on.
port (integer) – [REQUIRED]
The port the API listens on, from 0 to 65535.
path (string) – [REQUIRED]
The request path of the API.
tags (dict) –
Up to 50 tags per request, matching API Gateway’s limit of 50 tags per resource.
(string) –
A tag key of 1-128 Unicode characters, per the AWS tagging limits.
(string) –
A tag value of 0-256 Unicode characters, per the AWS tagging limits; an empty value is valid.
- Return type:
dict
- Returns:
Response Syntax
{ '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), 'tags': { 'string': 'string' } }
Response Structure
(dict) –
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.
tags (dict) –
Up to 50 tags per request, matching API Gateway’s limit of 50 tags per resource.
(string) –
A tag key of 1-128 Unicode characters, per the AWS tagging limits.
(string) –
A tag value of 0-256 Unicode characters, per the AWS tagging limits; an empty value is valid.
Exceptions