APIPortal / Client / put_discovery_configuration
put_discovery_configuration¶
- APIPortal.Client.put_discovery_configuration(**kwargs)¶
Creates or updates the discovery configuration
See also: AWS API Documentation
Request Syntax
response = client.put_discovery_configuration( discoverySources=[ 'API_GATEWAY'|'ELB'|'CLOUDFRONT', ], excludedResources=[ 'string', ], features=[ 'AI_DISCOVERY', ], tags={ 'string': 'string' } )
- Parameters:
discoverySources (list) –
The sources to discover APIs from. Omitting it removes all sources, which stops discovery for this configuration.
(string) –
The AWS service that is the SOURCE of discovered APIs — i.e. the front-door service type whose resources discovery crawls to find APIs. New source services may be added over time, so clients MUST treat any unrecognized value gracefully.
excludedResources (list) –
The ARNs of resources to leave out of discovery, up to 50.
(string) –
features (list) –
Optional capabilities to enable. Omitting it disables all of them, as with the other fields.
(string) –
An optional discovery capability, enabled per discovery configuration. AI_DISCOVERY - also identify AI protocols (MCP, LLM, A2A) in each API’s traffic and report them as the API’s workloads.
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
{ 'discoveryConfiguration': { 'arn': 'string', 'status': 'DISABLED'|'ENABLED'|'UPDATING', 'discoverySources': [ 'API_GATEWAY'|'ELB'|'CLOUDFRONT', ], 'excludedResources': [ 'string', ], 'features': [ 'AI_DISCOVERY', ], 'createdAt': datetime(2015, 1, 1), 'updatedAt': datetime(2015, 1, 1) }, 'tags': { 'string': 'string' } }
Response Structure
(dict) –
discoveryConfiguration (dict) –
The discovery configuration for the account.
arn (string) –
The ARN of the discovery configuration.
status (string) –
The current status of the discovery configuration.
discoverySources (list) –
The sources APIs are discovered from.
(string) –
The AWS service that is the SOURCE of discovered APIs — i.e. the front-door service type whose resources discovery crawls to find APIs. New source services may be added over time, so clients MUST treat any unrecognized value gracefully.
excludedResources (list) –
The ARNs of resources left out of discovery.
(string) –
features (list) –
Optional capabilities enabled for this configuration. Absent when none are.
(string) –
An optional discovery capability, enabled per discovery configuration. AI_DISCOVERY - also identify AI protocols (MCP, LLM, A2A) in each API’s traffic and report them as the API’s workloads.
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