APIPortal

2026/11/20 - APIPortal - 46 new api methods

Changes  Adds support for API Portal, a new Amazon API Gateway feature that discovers the APIs running behind API Gateway, Application Load Balancer, and CloudFront across an AWS Organization, evaluates their security posture, and publishes documentation portals for them.

DisassociateManagedApis (new) Link ¶

Disassociate one or more Managed APIs from a product. Best-effort — IDs that fail are returned in {@link DisassociateManagedApisResponse#failedItems}; IDs that succeed are omitted. Disassociating an unmapped Managed API is a no-op (not reported as failure).

See also: AWS API Documentation

Request Syntax

client.disassociate_managed_apis(
    productId='string',
    managedApiIds=[
        'string',
    ]
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product to disassociate the Managed APIs from.

type managedApiIds:

list

param managedApiIds:

[REQUIRED]

Bounded list of Managed API IDs, used as the request payload for batch associate/disassociate.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'failedItems': [
        {
            'managedApiId': 'string',
            'errorCode': 'MANAGED_API_NOT_FOUND'|'INTERNAL_ERROR',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • failedItems (list) --

      The Managed APIs that could not be processed. IDs not listed here succeeded.

      • (dict) --

        One entry per Managed API ID that could not be processed in a batch call. Ids that succeed are omitted from the response — callers infer success by absence.

        • managedApiId (string) --

          The identifier of the Managed API that could not be processed.

        • errorCode (string) --

          Machine-readable reason a Managed API ID couldn't be processed in a batch call. Clients should key retry logic off this enum rather than parsing errorMessage.

        • errorMessage (string) --

          A description of the failure.

ListTagsForResource (new) Link ¶

Lists the tags for an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

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

DeleteManagedApi (new) Link ¶

Deletes a Managed API.

See also: AWS API Documentation

Request Syntax

client.delete_managed_api(
    managedApiId='string'
)
type managedApiId:

string

param managedApiId:

[REQUIRED]

The identifier of the Managed API.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DeleteDiscoveryConfiguration (new) Link ¶

Deletes the discovery configuration and stops any running discovery.

See also: AWS API Documentation

Request Syntax

client.delete_discovery_configuration()
returns:

None

GetPortal (new) Link ¶

Returns the configuration, publish status, and preview status of a portal.

See also: AWS API Documentation

Request Syntax

client.get_portal(
    portalId='string'
)
type portalId:

string

param portalId:

[REQUIRED]

The identifier of the portal.

rtype:

dict

returns:

Response Syntax

{
    'portalId': 'string',
    'portalArn': 'string',
    'endpointConfiguration': {
        'domainName': 'string',
        'certificateArn': 'string',
        'portalDomainHostedZoneId': 'string',
        'portalDefaultDomainName': 'string'
    },
    'authorization': {
        'authorizationConfig': {
            'none': {},
            'cognitoConfig': {
                'userPoolArn': 'string',
                'appClientId': 'string',
                'userPoolDomain': 'string',
                'identityPoolId': 'string'
            }
        },
        'fineGrainedAccessControl': 'ENABLED'|'DISABLED'
    },
    'portalContent': {
        'displayName': 'string',
        'description': 'string',
        'theme': {
            'customColors': {
                'backgroundColor': 'string',
                'navigationColor': 'string',
                'headerColor': 'string',
                'textColor': 'string',
                'accentColor': 'string',
                'errorValidationColor': 'string'
            },
            'logoUploadedAt': datetime(2015, 1, 1)
        }
    },
    'includedProductArns': [
        'string',
    ],
    'publishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
    'statusException': {
        'exception': 'INTERNAL_FAILURE'|'UNSHARED_PRODUCT_EXCEPTION'|'CLOUDFRONT_DOMAIN_IN_USE'|'MISSING_CLOUDFRONT_PERMISSIONS',
        'message': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'publishedAt': datetime(2015, 1, 1),
    'publishDescription': 'string',
    'rumAppMonitorName': 'string',
    'preview': {
        'previewStatus': 'PREVIEW_IN_PROGRESS'|'PREVIEW_FAILED'|'PREVIEW_READY',
        'statusException': {
            'exception': 'INTERNAL_FAILURE'|'UNSHARED_PRODUCT_EXCEPTION'|'CLOUDFRONT_DOMAIN_IN_USE'|'MISSING_CLOUDFRONT_PERMISSIONS',
            'message': 'string'
        },
        'previewUrl': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • portalId (string) --

      The identifier of the portal.

    • portalArn (string) --

      The ARN of the portal.

    • endpointConfiguration (dict) --

      The domain configuration of the portal.

      • domainName (string) --

        The custom domain name of the portal. Absent if the portal has no custom domain.

      • certificateArn (string) --

        The ARN of the ACM certificate for the custom domain. Absent if the portal has no custom domain.

      • portalDomainHostedZoneId (string) --

        The ID of the hosted zone for the portal's distribution. Use it to create an alias record for a custom domain.

      • portalDefaultDomainName (string) --

        The default domain name assigned to the portal.

    • authorization (dict) --

      How readers sign in to the portal, and whether fine-grained access control is on.

      • authorizationConfig (dict) --

        Exactly one of the members is set: none for no authorization, or cognitoConfig for Cognito. Modeled as a union so the "exactly one" choice is enforced by type.

        • none (dict) --

          The portal is public and readers do not sign in.

        • cognitoConfig (dict) --

          Readers sign in through an Amazon Cognito user pool.

          • userPoolArn (string) --

            The ARN of the Cognito user pool.

          • appClientId (string) --

            The ID of the user pool app client the portal uses.

          • userPoolDomain (string) --

            The domain of the user pool's hosted sign-in pages.

          • identityPoolId (string) --

            The ID of the Cognito identity pool. Required only for fine-grained access control.

      • fineGrainedAccessControl (string) --

        Whether access to individual products in the portal is controlled per reader.

    • portalContent (dict) --

      The portal's display name, description, and theme.

      • displayName (string) --

        The name shown in the portal, from 3 to 255 characters.

      • description (string) --

        A description of the portal, up to 1024 characters.

      • theme (dict) --

        The colors and logo of the portal.

        • customColors (dict) --

          The colors used in the portal.

          • backgroundColor (string) --

            The page background color.

          • navigationColor (string) --

            The navigation pane color.

          • headerColor (string) --

            The header color.

          • textColor (string) --

            The text color.

          • accentColor (string) --

            The color of links, buttons, and other highlighted elements.

          • errorValidationColor (string) --

            The color of error and validation messages.

        • logoUploadedAt (datetime) --

          When the portal logo was last uploaded. Absent if the portal has no logo.

    • includedProductArns (list) --

      The ARNs of the products the portal includes.

      • (string) --

    • publishStatus (string) --

      The publish status of the portal. Absent if the portal has never been published.

    • statusException (dict) --

      Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.

      • exception (string) --

        Treat any unrecognized value as INTERNAL_FAILURE.

      • message (string) --

        A description of the failure.

    • updatedAt (datetime) --

      When the resource was last updated.

    • publishedAt (datetime) --

      When the portal was last published.

    • publishDescription (string) --

      The description supplied with the most recent publish request.

    • rumAppMonitorName (string) --

      The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.

    • preview (dict) --

      The most recent preview of the portal. Absent if no preview has been created.

      • previewStatus (string) --

        The status of the preview.

      • statusException (dict) --

        Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.

        • exception (string) --

          Treat any unrecognized value as INTERNAL_FAILURE.

        • message (string) --

          A description of the failure.

      • previewUrl (string) --

        The URL to view the preview. Present when previewStatus is PREVIEW_READY.

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

CreateProduct (new) Link ¶

Creates a product. A product groups Managed APIs with their API pages and product pages so a portal can publish them together.

See also: AWS API Documentation

Request Syntax

client.create_product(
    displayName='string',
    description='string',
    tags={
        'string': 'string'
    },
    apiSelectionConfiguration={
        'apiSelectionMode': 'CUSTOM'|'RULE_BASED',
        'ruleFilters': [
            {
                'key': 'RESOURCE_ARN'|'HOST'|'METHOD'|'PATH'|'PORT'|'ACCOUNT',
                'values': [
                    'string',
                ]
            },
        ]
    }
)
type displayName:

string

param displayName:

[REQUIRED]

The name of the product, from 1 to 255 characters.

type description:

string

param description:

A description of the product, up to 1024 characters.

type tags:

dict

param tags:

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.

type apiSelectionConfiguration:

dict

param apiSelectionConfiguration:

How Managed APIs are selected for the product. The selection mode can't be changed after the product is created.

  • apiSelectionMode (string) -- [REQUIRED]

    How a product's member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

    Fixed at create time. UpdateProduct cannot change the mode of an existing product.

  • ruleFilters (list) --

    Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account's Managed APIs. Replaced as a whole on update, not merged.

    • (dict) --

      Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

      • key (string) -- [REQUIRED]

        The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

      • values (list) -- [REQUIRED]

        The values to match. The filter matches when the attribute equals any of them.

        • (string) --

          Bounded by the longest matchable attribute, apiSignature.path.

          No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

rtype:

dict

returns:

Response Syntax

{
    'productId': 'string',
    'productArn': 'string',
    'displayName': 'string',
    'displayOrder': {
        'overviewPageArn': 'string',
        'productPageArns': [
            'string',
        ],
        'contents': [
            {
                'sectionName': 'string',
                'productApiPageArns': [
                    'string',
                ]
            },
        ]
    },
    'description': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'apiSelectionConfiguration': {
        'apiSelectionMode': 'CUSTOM'|'RULE_BASED',
        'ruleFilters': [
            {
                'key': 'RESOURCE_ARN'|'HOST'|'METHOD'|'PATH'|'PORT'|'ACCOUNT',
                'values': [
                    'string',
                ]
            },
        ]
    },
    'status': 'ACTIVE'|'IN_PROGRESS'|'FAILED',
    'failureReason': 'API_PAGE_ATTACHED'|'EVALUATION_ERROR'
}

Response Structure

  • (dict) --

    • productId (string) --

      The identifier of the product.

    • productArn (string) --

      The ARN of the product.

    • displayName (string) --

      The name of the product, from 1 to 255 characters.

    • displayOrder (dict) --

      The order of the product's pages and API page sections in the portal navigation.

      • overviewPageArn (string) --

        The ARN of the product page shown as the product overview.

      • productPageArns (list) --

        A product has at most DocHubLimits.DEFAULT_PAGES_PER_PRODUCT_LIMIT (40) pages, enforced by LimitsHelper.

        • (string) --

      • contents (list) --

        Sections in a product's navigation. No service-side limit exists today; this bound caps request size.

        • (dict) --

          A named group of API pages in the portal navigation.

          • sectionName (string) --

            Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).

          • productApiPageArns (list) --

            API pages in one section. No service-side limit exists today; this bound caps request size.

            • (string) --

    • description (string) --

      A description of the product, up to 1024 characters.

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

    • apiSelectionConfiguration (dict) --

      How Managed APIs are selected for the product.

      • apiSelectionMode (string) --

        How a product's member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

        Fixed at create time. UpdateProduct cannot change the mode of an existing product.

      • ruleFilters (list) --

        Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account's Managed APIs. Replaced as a whole on update, not merged.

        • (dict) --

          Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

          • key (string) --

            The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

          • values (list) --

            The values to match. The filter matches when the attribute equals any of them.

            • (string) --

              Bounded by the longest matchable attribute, apiSignature.path.

              No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

    • status (string) --

      Whether the product's member APIs match its apiSelectionConfiguration. ACTIVE - membership matches. The only status a CUSTOM product reports. IN_PROGRESS - ruleFilters changed and membership is still being evaluated. FAILED - evaluation could not finish and membership is incomplete; failureReason says why.

    • failureReason (string) --

      Reason a product's rules could not be fully applied, present only when status is FAILED. New reasons may be added over time, so clients MUST treat any unrecognized value as UNKNOWN and fall back to generic handling.

PutDiscoveryConfiguration (new) Link ¶

Creates or updates the discovery configuration

See also: AWS API Documentation

Request Syntax

client.put_discovery_configuration(
    discoverySources=[
        'API_GATEWAY'|'ELB'|'CLOUDFRONT',
    ],
    excludedResources=[
        'string',
    ],
    features=[
        'AI_DISCOVERY',
    ],
    tags={
        'string': 'string'
    }
)
type discoverySources:

list

param discoverySources:

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.

type excludedResources:

list

param excludedResources:

The ARNs of resources to leave out of discovery, up to 50.

  • (string) --

type features:

list

param features:

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.

type tags:

dict

param tags:

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.

rtype:

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.

ListDiscoveryStatuses (new) Link ¶

Lists discovery statuses for services.

See also: AWS API Documentation

Request Syntax

client.list_discovery_statuses(
    discoverySource='API_GATEWAY'|'ELB'|'CLOUDFRONT',
    maxResults=123,
    nextToken='string'
)
type discoverySource:

string

param discoverySource:

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.

type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 100.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'accountId': 'string',
            'discoverySource': 'API_GATEWAY'|'ELB'|'CLOUDFRONT',
            'status': 'STOPPED'|'PROVISIONING'|'RUNNING'|'FAILED',
            'failureReason': 'ACCESS_DENIED'|'DEPENDENCY_ERROR'|'THROTTLED'|'INVALID_CONFIGURATION'|'INTERNAL_ERROR'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The discovery status for each account and discovery source.

      • (dict) --

        The state of API discovery for one discovery source.

        • accountId (string) --

          The AWS account ID the status applies to.

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

        • status (string) --

          The current state of discovery for this source.

        • failureReason (string) --

          Typed reason for failure, present only when status is FAILED

    • nextToken (string) --

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

StartDiscovery (new) Link ¶

Starts the API discovery process.

See also: AWS API Documentation

Request Syntax

client.start_discovery(
    id='string'
)
type id:

string

param id:

[REQUIRED]

Identifier of the discovery configuration to start. Required. Today this is the configuration ARN, which carries the owner account id so a delegated admin or org admin can start an org-scoped configuration that lives in a different account.

returns:

None

GetManagedApi (new) Link ¶

Returns a Managed API, including its security posture findings.

See also: AWS API Documentation

Request Syntax

client.get_managed_api(
    managedApiId='string'
)
type managedApiId:

string

param managedApiId:

[REQUIRED]

The identifier of the Managed API.

rtype:

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),
    'findings': [
        {
            'postureId': 'string',
            'postureStatus': 'TRUE'|'FALSE'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
            'reason': 'AUTHENTICATION_NOT_CONFIGURED'|'REQUEST_VALIDATION_NOT_ENABLED'|'API_KEY_NOT_CONFIGURED'|'THROTTLING_NOT_ENABLED'|'THROTTLING_RATE_LIMIT_NOT_SET'|'THROTTLING_BURST_LIMIT_NOT_SET'|'RESPONSE_CACHING_NOT_ENABLED'|'STAGE_WAF_NOT_ASSOCIATED'|'STAGE_ACCESS_LOGGING_NOT_ENABLED'|'PRIVATE_API_RESOURCE_POLICY_MISSING'|'REST_API_TLS_BELOW_1_2'|'LOAD_BALANCER_WAF_NOT_ASSOCIATED'|'LISTENER_TLS_BELOW_1_2'|'DISTRIBUTION_TLS_BELOW_1_2'|'DISTRIBUTION_WAF_NOT_ASSOCIATED'|'DISTRIBUTION_SERVES_PLAINTEXT_HTTP'|'DISTRIBUTION_ACCESS_LOGGING_NOT_ENABLED'|'GEO_RESTRICTION_NOT_CONFIGURED'|'UNKNOWN',
            '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.

    • findings (list) --

      The security posture findings for the API, up to 100.

      • (dict) --

        Security posture finding attached to this API. Shape mirrors the inventory's Finding sub-document.

        • postureId (string) --

          The identifier of the posture check that produced the finding.

        • postureStatus (string) --

          Values are spelled exactly as the inventory document stores them, so the same string means the same thing at both layers and no second translation sits between the index and the wire.

        • reason (string) --

          Why a posture is not satisfied, or why no verdict was reached. Present only when postureStatus is FALSE or INSUFFICIENT_DATA. New reasons may be added over time, so clients MUST treat any unrecognized value as UNKNOWN and fall back to generic handling.

        • updatedAt (datetime) --

          When the finding 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.

GetOrganizationDiscoveryConfiguration (new) Link ¶

Retrieves the organization-wide discovery configuration. Only the organization management account and registered delegated administrators may call this operation.

See also: AWS API Documentation

Request Syntax

client.get_organization_discovery_configuration()
rtype:

dict

returns:

Response Syntax

{
    'discoveryConfiguration': {
        'arn': 'string',
        'status': 'DISABLED'|'ENABLED'|'UPDATING',
        'discoverySources': [
            'API_GATEWAY'|'ELB'|'CLOUDFRONT',
        ],
        'exclusionFilters': {
            'organizationalUnitIds': [
                'string',
            ],
            'accountIds': [
                'string',
            ],
            'resourceArns': [
                'string',
            ]
        },
        'discoveryFilters': {
            'exclusionFilters': {
                'organizationalUnitIds': [
                    'string',
                ],
                'accountIds': [
                    'string',
                ],
                'resourceArns': [
                    'string',
                ]
            },
            'inclusionFilters': {
                'organizationalUnitIds': [
                    'string',
                ],
                'accountIds': [
                    '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 organization.

      • arn (string) --

        The ARN of the organization 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.

      • exclusionFilters (dict) --

        Exclusion filters for organization-scoped discovery. @deprecated. Remove this once client (Console) moves to discoveryFilters

        • organizationalUnitIds (list) --

          List of organizational unit IDs to exclude from discovery.

          • (string) --

        • accountIds (list) --

          List of AWS account IDs to exclude from discovery.

          • (string) --

        • resourceArns (list) --

          List of resource ARNs to exclude. Only ELB and CloudFront resource ARNs are supported.

          • (string) --

      • discoveryFilters (dict) --

        The accounts or organizational units included in or excluded from discovery.

        • exclusionFilters (dict) --

          Exclusion filters for organization-scoped discovery. Resources matching any of these filters are excluded from discovery.

          • organizationalUnitIds (list) --

            List of organizational unit IDs to exclude from discovery.

            • (string) --

          • accountIds (list) --

            List of AWS account IDs to exclude from discovery.

            • (string) --

          • resourceArns (list) --

            List of resource ARNs to exclude. Only ELB and CloudFront resource ARNs are supported.

            • (string) --

        • inclusionFilters (dict) --

          Inclusion filters for organization-scoped discovery. Only Resources matching any of these filters are included in discovery.

          • organizationalUnitIds (list) --

            List of organizational unit IDs to include in discovery.

            • (string) --

          • accountIds (list) --

            List of AWS account IDs to include in 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.

ListPortals (new) Link ¶

Lists the portals in your account.

See also: AWS API Documentation

Request Syntax

client.list_portals(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 100.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'portalId': 'string',
            'portalArn': 'string',
            'endpointConfiguration': {
                'domainName': 'string',
                'certificateArn': 'string',
                'portalDomainHostedZoneId': 'string',
                'portalDefaultDomainName': 'string'
            },
            'authorization': {
                'authorizationConfig': {
                    'none': {},
                    'cognitoConfig': {
                        'userPoolArn': 'string',
                        'appClientId': 'string',
                        'userPoolDomain': 'string',
                        'identityPoolId': 'string'
                    }
                },
                'fineGrainedAccessControl': 'ENABLED'|'DISABLED'
            },
            'portalContent': {
                'displayName': 'string',
                'description': 'string',
                'theme': {
                    'customColors': {
                        'backgroundColor': 'string',
                        'navigationColor': 'string',
                        'headerColor': 'string',
                        'textColor': 'string',
                        'accentColor': 'string',
                        'errorValidationColor': 'string'
                    },
                    'logoUploadedAt': datetime(2015, 1, 1)
                }
            },
            'includedProductArns': [
                'string',
            ],
            'publishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
            'statusException': {
                'exception': 'INTERNAL_FAILURE'|'UNSHARED_PRODUCT_EXCEPTION'|'CLOUDFRONT_DOMAIN_IN_USE'|'MISSING_CLOUDFRONT_PERMISSIONS',
                'message': 'string'
            },
            'updatedAt': datetime(2015, 1, 1),
            'publishedAt': datetime(2015, 1, 1),
            'publishDescription': 'string',
            'rumAppMonitorName': 'string',
            'preview': {
                'previewStatus': 'PREVIEW_IN_PROGRESS'|'PREVIEW_FAILED'|'PREVIEW_READY',
                'statusException': {
                    'exception': 'INTERNAL_FAILURE'|'UNSHARED_PRODUCT_EXCEPTION'|'CLOUDFRONT_DOMAIN_IN_USE'|'MISSING_CLOUDFRONT_PERMISSIONS',
                    'message': 'string'
                },
                'previewUrl': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The portals in this page of results.

      • (dict) --

        A summary of a portal.

        • portalId (string) --

          The identifier of the portal.

        • portalArn (string) --

          The ARN of the portal.

        • endpointConfiguration (dict) --

          The domain configuration of the portal.

          • domainName (string) --

            The custom domain name of the portal. Absent if the portal has no custom domain.

          • certificateArn (string) --

            The ARN of the ACM certificate for the custom domain. Absent if the portal has no custom domain.

          • portalDomainHostedZoneId (string) --

            The ID of the hosted zone for the portal's distribution. Use it to create an alias record for a custom domain.

          • portalDefaultDomainName (string) --

            The default domain name assigned to the portal.

        • authorization (dict) --

          How readers sign in to the portal, and whether fine-grained access control is on.

          • authorizationConfig (dict) --

            Exactly one of the members is set: none for no authorization, or cognitoConfig for Cognito. Modeled as a union so the "exactly one" choice is enforced by type.

            • none (dict) --

              The portal is public and readers do not sign in.

            • cognitoConfig (dict) --

              Readers sign in through an Amazon Cognito user pool.

              • userPoolArn (string) --

                The ARN of the Cognito user pool.

              • appClientId (string) --

                The ID of the user pool app client the portal uses.

              • userPoolDomain (string) --

                The domain of the user pool's hosted sign-in pages.

              • identityPoolId (string) --

                The ID of the Cognito identity pool. Required only for fine-grained access control.

          • fineGrainedAccessControl (string) --

            Whether access to individual products in the portal is controlled per reader.

        • portalContent (dict) --

          The portal's display name, description, and theme.

          • displayName (string) --

            The name shown in the portal, from 3 to 255 characters.

          • description (string) --

            A description of the portal, up to 1024 characters.

          • theme (dict) --

            The colors and logo of the portal.

            • customColors (dict) --

              The colors used in the portal.

              • backgroundColor (string) --

                The page background color.

              • navigationColor (string) --

                The navigation pane color.

              • headerColor (string) --

                The header color.

              • textColor (string) --

                The text color.

              • accentColor (string) --

                The color of links, buttons, and other highlighted elements.

              • errorValidationColor (string) --

                The color of error and validation messages.

            • logoUploadedAt (datetime) --

              When the portal logo was last uploaded. Absent if the portal has no logo.

        • includedProductArns (list) --

          The ARNs of the products the portal includes.

          • (string) --

        • publishStatus (string) --

          The publish status of the portal. Absent if the portal has never been published.

        • statusException (dict) --

          Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.

          • exception (string) --

            Treat any unrecognized value as INTERNAL_FAILURE.

          • message (string) --

            A description of the failure.

        • updatedAt (datetime) --

          When the resource was last updated.

        • publishedAt (datetime) --

          When the portal was last published.

        • publishDescription (string) --

          The description supplied with the most recent publish request.

        • rumAppMonitorName (string) --

          The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.

        • preview (dict) --

          The most recent preview of the portal. Absent if no preview has been created.

          • previewStatus (string) --

            The status of the preview.

          • statusException (dict) --

            Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.

            • exception (string) --

              Treat any unrecognized value as INTERNAL_FAILURE.

            • message (string) --

              A description of the failure.

          • previewUrl (string) --

            The URL to view the preview. Present when previewStatus is PREVIEW_READY.

    • nextToken (string) --

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

UpdatePortalPublishStatus (new) Link ¶

Publishes or disables a portal. The change runs asynchronously. Use GetPortal to track publishStatus.

See also: AWS API Documentation

Request Syntax

client.update_portal_publish_status(
    portalId='string',
    status='PUBLISHED'|'DISABLED',
    description='string'
)
type portalId:

string

param portalId:

[REQUIRED]

The identifier of the portal.

type status:

string

param status:

[REQUIRED]

The terminal publish state a caller can request for a portal via UpdatePortalPublishStatus. Only the two client-requestable targets are modeled here; the transient and failed states in PublishStatus are set by the service and are not valid caller input.

type description:

string

param description:

A description of this publish request, up to 1024 characters.

returns:

None

PutProductSharingPolicy (new) Link ¶

Creates or replaces the sharing policy of a product. The policy controls which other accounts can read the product.

See also: AWS API Documentation

Request Syntax

client.put_product_sharing_policy(
    productId='string',
    policyDocument='string',
    tags={
        'string': 'string'
    }
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type policyDocument:

string

param policyDocument:

[REQUIRED]

The sharing policy as a JSON resource policy document.

type tags:

dict

param tags:

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.

returns:

None

ListApiInventoryItems (new) Link ¶

Lists discovered API inventory items with filtering and pagination.

See also: AWS API Documentation

Request Syntax

client.list_api_inventory_items(
    filters={
        'discoverySource': 'API_GATEWAY'|'ELB'|'CLOUDFRONT',
        'resourceArn': 'string'
    },
    maxResults=123,
    nextToken='string'
)
type filters:

dict

param filters:

Filters that limit the results. Omit it to list every discovered API.

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

  • resourceArn (string) --

    Return only APIs served by this resource.

type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 100.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'method': 'GET'|'POST'|'PUT'|'DELETE'|'PATCH'|'ANY'|'HEAD'|'OPTIONS',
            'host': 'string',
            'port': 123,
            'path': 'string',
            'accountId': 'string',
            'resourceArn': 'string',
            'region': 'string',
            'discoverySource': 'API_GATEWAY'|'ELB'|'CLOUDFRONT',
            'firstSeen': datetime(2015, 1, 1),
            'lastSeen': datetime(2015, 1, 1),
            'visibility': 'PUBLIC'|'PRIVATE',
            'wafStatus': 'ENABLED'|'DISABLED',
            'classification': 'SHADOW'|'MANAGED'|'MANAGED_ZOMBIE'|'MANAGED_ORPHANED',
            'managedBy': 'SELF'|'ORGANIZATION',
            'workloads': [
                'MCP'|'LLM'|'A2A',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      The discovered APIs in this page of results.

      • (dict) --

        An API found by discovery.

        • method (string) --

          The HTTP method of the API.

        • host (string) --

          A discovered API's front-door hostname (e.g. an ALB, CloudFront, or API Gateway DNS name), bounded by the DNS name limit (RFC 1035). Usually literal, but may contain placeholders: <> - stands for one dot-separated part of the hostname. When 10 or more hosts differ only in that part, they fold into one, e.g. a.example.com, b.example.com, ... become "<>.example.com". Deeper levels fold the same way ("<>.<>.example.com"). The registrable domain never folds. - an IP-literal host.

        • port (integer) --

          The port the API listens on, from 0 to 65535.

        • path (string) --

          The request path of the API.

        • accountId (string) --

          The AWS account ID that owns the API.

        • resourceArn (string) --

          The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.

        • region (string) --

          The AWS Region the API was discovered in.

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

        • firstSeen (datetime) --

          When discovery first observed the API.

        • lastSeen (datetime) --

          When discovery most recently observed the API.

        • visibility (string) --

          Whether a discovered API is reachable publicly or only from within a private network.

        • wafStatus (string) --

          Whether a WAF web ACL is attached to the API's front-door service.

        • classification (string) --

          Whether any account has created a ManagedApi for a discovered API, and for a managed API whether it is unused or no longer in the caller's organization. SHADOW - no account has created a ManagedApi for this item. MANAGED - some account in the caller's organization has created a ManagedApi for this item. MANAGED_ZOMBIE - managed and unused: no traffic for at least the account's no-traffic window. The API is still reachable, so this clears once traffic resumes. MANAGED_ORPHANED - managed, but the account hosting the API has left the caller's organization or been closed. The item is a last-known snapshot: it is no longer rediscovered, and its findings are not authorized for the caller. An organizational unit move is not a trigger.

          MANAGED_ZOMBIE and MANAGED_ORPHANED add detail to a MANAGED item, so neither is returned for an item the caller does not manage, and MANAGED_ORPHANED takes priority over MANAGED_ZOMBIE. Both are derived per request rather than stored, so neither expires on its own.

        • managedBy (string) --

          Who manages a MANAGED item, relative to the caller. Absent when the item is SHADOW. SELF - the caller account has created the ManagedApi. ORGANIZATION - some other account in the caller's organization has, but the caller has not.

        • workloads (list) --

          AI protocols seen in this API's traffic, each listed at most once. Absent when none has been reported, which includes an account that has not enabled AI discovery.

          • (string) --

            An AI protocol seen in an API's traffic, detected by the front door from request or response headers (and, for A2A, a query parameter). MCP - Model Context Protocol. LLM - traffic to or from an LLM inference server or gateway. A2A - Agent2Agent protocol.

    • nextToken (string) --

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

CreatePortal (new) Link ¶

Creates a portal that publishes documentation for the products it includes. Use UpdatePortalPublishStatus to publish it.

See also: AWS API Documentation

Request Syntax

client.create_portal(
    portalContent={
        'displayName': 'string',
        'description': 'string',
        'theme': {
            'customColors': {
                'backgroundColor': 'string',
                'navigationColor': 'string',
                'headerColor': 'string',
                'textColor': 'string',
                'accentColor': 'string',
                'errorValidationColor': 'string'
            },
            'logoUploadedAt': datetime(2015, 1, 1)
        }
    },
    endpointConfiguration={
        'none': {}
        ,
        'acmManaged': {
            'domainName': 'string',
            'certificateArn': 'string'
        }
    },
    authorization={
        'authorizationConfig': {
            'none': {}
            ,
            'cognitoConfig': {
                'userPoolArn': 'string',
                'appClientId': 'string',
                'userPoolDomain': 'string',
                'identityPoolId': 'string'
            }
        },
        'fineGrainedAccessControl': 'ENABLED'|'DISABLED'
    },
    includedProductArns=[
        'string',
    ],
    logoUri='string',
    rumAppMonitorName='string',
    tags={
        'string': 'string'
    }
)
type portalContent:

dict

param portalContent:

[REQUIRED]

The portal's display name, description, and theme.

  • displayName (string) -- [REQUIRED]

    The name shown in the portal, from 3 to 255 characters.

  • description (string) --

    A description of the portal, up to 1024 characters.

  • theme (dict) -- [REQUIRED]

    The colors and logo of the portal.

    • customColors (dict) -- [REQUIRED]

      The colors used in the portal.

      • backgroundColor (string) -- [REQUIRED]

        The page background color.

      • navigationColor (string) -- [REQUIRED]

        The navigation pane color.

      • headerColor (string) -- [REQUIRED]

        The header color.

      • textColor (string) -- [REQUIRED]

        The text color.

      • accentColor (string) -- [REQUIRED]

        The color of links, buttons, and other highlighted elements.

      • errorValidationColor (string) -- [REQUIRED]

        The color of error and validation messages.

    • logoUploadedAt (datetime) --

      When the portal logo was last uploaded. Absent if the portal has no logo.

type endpointConfiguration:

dict

param endpointConfiguration:

[REQUIRED]

Exactly one of the members is set: none for no custom domain, or acmManaged to bring a domain + ACM certificate. Modeled as a union so the "exactly one" choice is enforced by type.

  • none (dict) --

    Serve the portal only on its default domain.

  • acmManaged (dict) --

    Serve the portal on your own domain, using a certificate from AWS Certificate Manager.

    • domainName (string) -- [REQUIRED]

      The custom domain name for the portal.

    • certificateArn (string) -- [REQUIRED]

      The ARN of the ACM certificate for the domain. The certificate must be in us-east-1, issued, not private, and must cover the domain name.

type authorization:

dict

param authorization:

[REQUIRED]

How readers sign in to the portal, and whether fine-grained access control is on.

  • authorizationConfig (dict) -- [REQUIRED]

    Exactly one of the members is set: none for no authorization, or cognitoConfig for Cognito. Modeled as a union so the "exactly one" choice is enforced by type.

    • none (dict) --

      The portal is public and readers do not sign in.

    • cognitoConfig (dict) --

      Readers sign in through an Amazon Cognito user pool.

      • userPoolArn (string) -- [REQUIRED]

        The ARN of the Cognito user pool.

      • appClientId (string) -- [REQUIRED]

        The ID of the user pool app client the portal uses.

      • userPoolDomain (string) -- [REQUIRED]

        The domain of the user pool's hosted sign-in pages.

      • identityPoolId (string) --

        The ID of the Cognito identity pool. Required only for fine-grained access control.

  • fineGrainedAccessControl (string) -- [REQUIRED]

    Whether access to individual products in the portal is controlled per reader.

type includedProductArns:

list

param includedProductArns:

The ARNs of the products the portal includes, up to 200.

  • (string) --

type logoUri:

string

param logoUri:

The S3 location of the portal logo, in the form s3://bucket/key.

type rumAppMonitorName:

string

param rumAppMonitorName:

The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.

type tags:

dict

param tags:

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.

rtype:

dict

returns:

Response Syntax

{
    'portalId': 'string',
    'portalArn': 'string',
    'endpointConfiguration': {
        'domainName': 'string',
        'certificateArn': 'string',
        'portalDomainHostedZoneId': 'string',
        'portalDefaultDomainName': 'string'
    },
    'authorization': {
        'authorizationConfig': {
            'none': {},
            'cognitoConfig': {
                'userPoolArn': 'string',
                'appClientId': 'string',
                'userPoolDomain': 'string',
                'identityPoolId': 'string'
            }
        },
        'fineGrainedAccessControl': 'ENABLED'|'DISABLED'
    },
    'portalContent': {
        'displayName': 'string',
        'description': 'string',
        'theme': {
            'customColors': {
                'backgroundColor': 'string',
                'navigationColor': 'string',
                'headerColor': 'string',
                'textColor': 'string',
                'accentColor': 'string',
                'errorValidationColor': 'string'
            },
            'logoUploadedAt': datetime(2015, 1, 1)
        }
    },
    'includedProductArns': [
        'string',
    ],
    'publishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
    'statusException': {
        'exception': 'INTERNAL_FAILURE'|'UNSHARED_PRODUCT_EXCEPTION'|'CLOUDFRONT_DOMAIN_IN_USE'|'MISSING_CLOUDFRONT_PERMISSIONS',
        'message': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'publishedAt': datetime(2015, 1, 1),
    'publishDescription': 'string',
    'rumAppMonitorName': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • portalId (string) --

      The identifier of the portal.

    • portalArn (string) --

      The ARN of the portal.

    • endpointConfiguration (dict) --

      The domain configuration of the portal.

      • domainName (string) --

        The custom domain name of the portal. Absent if the portal has no custom domain.

      • certificateArn (string) --

        The ARN of the ACM certificate for the custom domain. Absent if the portal has no custom domain.

      • portalDomainHostedZoneId (string) --

        The ID of the hosted zone for the portal's distribution. Use it to create an alias record for a custom domain.

      • portalDefaultDomainName (string) --

        The default domain name assigned to the portal.

    • authorization (dict) --

      How readers sign in to the portal, and whether fine-grained access control is on.

      • authorizationConfig (dict) --

        Exactly one of the members is set: none for no authorization, or cognitoConfig for Cognito. Modeled as a union so the "exactly one" choice is enforced by type.

        • none (dict) --

          The portal is public and readers do not sign in.

        • cognitoConfig (dict) --

          Readers sign in through an Amazon Cognito user pool.

          • userPoolArn (string) --

            The ARN of the Cognito user pool.

          • appClientId (string) --

            The ID of the user pool app client the portal uses.

          • userPoolDomain (string) --

            The domain of the user pool's hosted sign-in pages.

          • identityPoolId (string) --

            The ID of the Cognito identity pool. Required only for fine-grained access control.

      • fineGrainedAccessControl (string) --

        Whether access to individual products in the portal is controlled per reader.

    • portalContent (dict) --

      The portal's display name, description, and theme.

      • displayName (string) --

        The name shown in the portal, from 3 to 255 characters.

      • description (string) --

        A description of the portal, up to 1024 characters.

      • theme (dict) --

        The colors and logo of the portal.

        • customColors (dict) --

          The colors used in the portal.

          • backgroundColor (string) --

            The page background color.

          • navigationColor (string) --

            The navigation pane color.

          • headerColor (string) --

            The header color.

          • textColor (string) --

            The text color.

          • accentColor (string) --

            The color of links, buttons, and other highlighted elements.

          • errorValidationColor (string) --

            The color of error and validation messages.

        • logoUploadedAt (datetime) --

          When the portal logo was last uploaded. Absent if the portal has no logo.

    • includedProductArns (list) --

      The ARNs of the products the portal includes.

      • (string) --

    • publishStatus (string) --

      The publish status of the portal. Absent if the portal has never been published.

    • statusException (dict) --

      Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.

      • exception (string) --

        Treat any unrecognized value as INTERNAL_FAILURE.

      • message (string) --

        A description of the failure.

    • updatedAt (datetime) --

      When the resource was last updated.

    • publishedAt (datetime) --

      When the portal was last published.

    • publishDescription (string) --

      The description supplied with the most recent publish request.

    • rumAppMonitorName (string) --

      The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.

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

UpdatePortal (new) Link ¶

Updates a portal. Only the fields supplied in the request are changed.

See also: AWS API Documentation

Request Syntax

client.update_portal(
    portalId='string',
    portalContent={
        'displayName': 'string',
        'description': 'string',
        'theme': {
            'customColors': {
                'backgroundColor': 'string',
                'navigationColor': 'string',
                'headerColor': 'string',
                'textColor': 'string',
                'accentColor': 'string',
                'errorValidationColor': 'string'
            },
            'logoUploadedAt': datetime(2015, 1, 1)
        }
    },
    endpointConfiguration={
        'none': {}
        ,
        'acmManaged': {
            'domainName': 'string',
            'certificateArn': 'string'
        }
    },
    authorization={
        'authorizationConfig': {
            'none': {}
            ,
            'cognitoConfig': {
                'userPoolArn': 'string',
                'appClientId': 'string',
                'userPoolDomain': 'string',
                'identityPoolId': 'string'
            }
        },
        'fineGrainedAccessControl': 'ENABLED'|'DISABLED'
    },
    rumAppMonitorName='string',
    includedProductArns=[
        'string',
    ],
    logoUri='string'
)
type portalId:

string

param portalId:

[REQUIRED]

The identifier of the portal.

type portalContent:

dict

param portalContent:

The new display name, description, and theme. Omit it to keep the current values.

  • displayName (string) -- [REQUIRED]

    The name shown in the portal, from 3 to 255 characters.

  • description (string) --

    A description of the portal, up to 1024 characters.

  • theme (dict) -- [REQUIRED]

    The colors and logo of the portal.

    • customColors (dict) -- [REQUIRED]

      The colors used in the portal.

      • backgroundColor (string) -- [REQUIRED]

        The page background color.

      • navigationColor (string) -- [REQUIRED]

        The navigation pane color.

      • headerColor (string) -- [REQUIRED]

        The header color.

      • textColor (string) -- [REQUIRED]

        The text color.

      • accentColor (string) -- [REQUIRED]

        The color of links, buttons, and other highlighted elements.

      • errorValidationColor (string) -- [REQUIRED]

        The color of error and validation messages.

    • logoUploadedAt (datetime) --

      When the portal logo was last uploaded. Absent if the portal has no logo.

type endpointConfiguration:

dict

param endpointConfiguration:

Exactly one of the members is set: none for no custom domain, or acmManaged to bring a domain + ACM certificate. Modeled as a union so the "exactly one" choice is enforced by type.

  • none (dict) --

    Serve the portal only on its default domain.

  • acmManaged (dict) --

    Serve the portal on your own domain, using a certificate from AWS Certificate Manager.

    • domainName (string) -- [REQUIRED]

      The custom domain name for the portal.

    • certificateArn (string) -- [REQUIRED]

      The ARN of the ACM certificate for the domain. The certificate must be in us-east-1, issued, not private, and must cover the domain name.

type authorization:

dict

param authorization:

The new authorization settings. Omit it to keep the current settings.

  • authorizationConfig (dict) -- [REQUIRED]

    Exactly one of the members is set: none for no authorization, or cognitoConfig for Cognito. Modeled as a union so the "exactly one" choice is enforced by type.

    • none (dict) --

      The portal is public and readers do not sign in.

    • cognitoConfig (dict) --

      Readers sign in through an Amazon Cognito user pool.

      • userPoolArn (string) -- [REQUIRED]

        The ARN of the Cognito user pool.

      • appClientId (string) -- [REQUIRED]

        The ID of the user pool app client the portal uses.

      • userPoolDomain (string) -- [REQUIRED]

        The domain of the user pool's hosted sign-in pages.

      • identityPoolId (string) --

        The ID of the Cognito identity pool. Required only for fine-grained access control.

  • fineGrainedAccessControl (string) -- [REQUIRED]

    Whether access to individual products in the portal is controlled per reader.

type rumAppMonitorName:

string

param rumAppMonitorName:

The new CloudWatch RUM app monitor name. Omit it to keep the current value.

type includedProductArns:

list

param includedProductArns:

The new list of product ARNs, up to 200. It replaces the current list. Omit it to keep the current list.

  • (string) --

type logoUri:

string

param logoUri:

The new S3 location of the portal logo, in the form s3://bucket/key. An empty string removes the logo. Omit it to keep the current logo.

rtype:

dict

returns:

Response Syntax

{
    'portalId': 'string',
    'portalArn': 'string',
    'endpointConfiguration': {
        'domainName': 'string',
        'certificateArn': 'string',
        'portalDomainHostedZoneId': 'string',
        'portalDefaultDomainName': 'string'
    },
    'authorization': {
        'authorizationConfig': {
            'none': {},
            'cognitoConfig': {
                'userPoolArn': 'string',
                'appClientId': 'string',
                'userPoolDomain': 'string',
                'identityPoolId': 'string'
            }
        },
        'fineGrainedAccessControl': 'ENABLED'|'DISABLED'
    },
    'portalContent': {
        'displayName': 'string',
        'description': 'string',
        'theme': {
            'customColors': {
                'backgroundColor': 'string',
                'navigationColor': 'string',
                'headerColor': 'string',
                'textColor': 'string',
                'accentColor': 'string',
                'errorValidationColor': 'string'
            },
            'logoUploadedAt': datetime(2015, 1, 1)
        }
    },
    'includedProductArns': [
        'string',
    ],
    'publishStatus': 'PUBLISHED'|'PUBLISH_IN_PROGRESS'|'PUBLISH_FAILED'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED'|'DISABLED',
    'statusException': {
        'exception': 'INTERNAL_FAILURE'|'UNSHARED_PRODUCT_EXCEPTION'|'CLOUDFRONT_DOMAIN_IN_USE'|'MISSING_CLOUDFRONT_PERMISSIONS',
        'message': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'publishedAt': datetime(2015, 1, 1),
    'publishDescription': 'string',
    'rumAppMonitorName': 'string',
    'preview': {
        'previewStatus': 'PREVIEW_IN_PROGRESS'|'PREVIEW_FAILED'|'PREVIEW_READY',
        'statusException': {
            'exception': 'INTERNAL_FAILURE'|'UNSHARED_PRODUCT_EXCEPTION'|'CLOUDFRONT_DOMAIN_IN_USE'|'MISSING_CLOUDFRONT_PERMISSIONS',
            'message': 'string'
        },
        'previewUrl': 'string'
    }
}

Response Structure

  • (dict) --

    • portalId (string) --

      The identifier of the portal.

    • portalArn (string) --

      The ARN of the portal.

    • endpointConfiguration (dict) --

      The domain configuration of the portal.

      • domainName (string) --

        The custom domain name of the portal. Absent if the portal has no custom domain.

      • certificateArn (string) --

        The ARN of the ACM certificate for the custom domain. Absent if the portal has no custom domain.

      • portalDomainHostedZoneId (string) --

        The ID of the hosted zone for the portal's distribution. Use it to create an alias record for a custom domain.

      • portalDefaultDomainName (string) --

        The default domain name assigned to the portal.

    • authorization (dict) --

      How readers sign in to the portal, and whether fine-grained access control is on.

      • authorizationConfig (dict) --

        Exactly one of the members is set: none for no authorization, or cognitoConfig for Cognito. Modeled as a union so the "exactly one" choice is enforced by type.

        • none (dict) --

          The portal is public and readers do not sign in.

        • cognitoConfig (dict) --

          Readers sign in through an Amazon Cognito user pool.

          • userPoolArn (string) --

            The ARN of the Cognito user pool.

          • appClientId (string) --

            The ID of the user pool app client the portal uses.

          • userPoolDomain (string) --

            The domain of the user pool's hosted sign-in pages.

          • identityPoolId (string) --

            The ID of the Cognito identity pool. Required only for fine-grained access control.

      • fineGrainedAccessControl (string) --

        Whether access to individual products in the portal is controlled per reader.

    • portalContent (dict) --

      The portal's display name, description, and theme.

      • displayName (string) --

        The name shown in the portal, from 3 to 255 characters.

      • description (string) --

        A description of the portal, up to 1024 characters.

      • theme (dict) --

        The colors and logo of the portal.

        • customColors (dict) --

          The colors used in the portal.

          • backgroundColor (string) --

            The page background color.

          • navigationColor (string) --

            The navigation pane color.

          • headerColor (string) --

            The header color.

          • textColor (string) --

            The text color.

          • accentColor (string) --

            The color of links, buttons, and other highlighted elements.

          • errorValidationColor (string) --

            The color of error and validation messages.

        • logoUploadedAt (datetime) --

          When the portal logo was last uploaded. Absent if the portal has no logo.

    • includedProductArns (list) --

      The ARNs of the products the portal includes.

      • (string) --

    • publishStatus (string) --

      The publish status of the portal. Absent if the portal has never been published.

    • statusException (dict) --

      Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.

      • exception (string) --

        Treat any unrecognized value as INTERNAL_FAILURE.

      • message (string) --

        A description of the failure.

    • updatedAt (datetime) --

      When the resource was last updated.

    • publishedAt (datetime) --

      When the portal was last published.

    • publishDescription (string) --

      The description supplied with the most recent publish request.

    • rumAppMonitorName (string) --

      The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.

    • preview (dict) --

      The most recent preview of the portal. Absent if no preview has been created.

      • previewStatus (string) --

        The status of the preview.

      • statusException (dict) --

        Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.

        • exception (string) --

          Treat any unrecognized value as INTERNAL_FAILURE.

        • message (string) --

          A description of the failure.

      • previewUrl (string) --

        The URL to view the preview. Present when previewStatus is PREVIEW_READY.

GetApiInventoryItem (new) Link ¶

Gets full details of a single API inventory item.

See also: AWS API Documentation

Request Syntax

client.get_api_inventory_item(
    method='GET'|'POST'|'PUT'|'DELETE'|'PATCH'|'ANY'|'HEAD'|'OPTIONS',
    host='string',
    port=123,
    path='string',
    resourceArn='string'
)
type method:

string

param method:

[REQUIRED]

The HTTP method of the API.

type host:

string

param host:

[REQUIRED]

A discovered API's front-door hostname (e.g. an ALB, CloudFront, or API Gateway DNS name), bounded by the DNS name limit (RFC 1035). Usually literal, but may contain placeholders: <> - stands for one dot-separated part of the hostname. When 10 or more hosts differ only in that part, they fold into one, e.g. a.example.com, b.example.com, ... become "<>.example.com". Deeper levels fold the same way ("<>.<>.example.com"). The registrable domain never folds. - an IP-literal host.

type port:

integer

param port:

[REQUIRED]

The port the API listens on, from 0 to 65535.

type path:

string

param path:

[REQUIRED]

The request path of the API.

type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.

rtype:

dict

returns:

Response Syntax

{
    'item': {
        'method': 'GET'|'POST'|'PUT'|'DELETE'|'PATCH'|'ANY'|'HEAD'|'OPTIONS',
        'host': 'string',
        'port': 123,
        'path': 'string',
        'accountId': 'string',
        'resourceArn': 'string',
        'region': 'string',
        'discoverySource': 'API_GATEWAY'|'ELB'|'CLOUDFRONT',
        'visibility': 'PUBLIC'|'PRIVATE',
        'wafStatus': 'ENABLED'|'DISABLED',
        'classification': 'SHADOW'|'MANAGED'|'MANAGED_ZOMBIE'|'MANAGED_ORPHANED',
        'managedBy': 'SELF'|'ORGANIZATION',
        'workloads': [
            'MCP'|'LLM'|'A2A',
        ],
        'managedApiId': 'string'
    }
}

Response Structure

  • (dict) --

    • item (dict) --

      The details of the API inventory item.

      • method (string) --

        The HTTP method of the API.

      • host (string) --

        A discovered API's front-door hostname (e.g. an ALB, CloudFront, or API Gateway DNS name), bounded by the DNS name limit (RFC 1035). Usually literal, but may contain placeholders: <> - stands for one dot-separated part of the hostname. When 10 or more hosts differ only in that part, they fold into one, e.g. a.example.com, b.example.com, ... become "<>.example.com". Deeper levels fold the same way ("<>.<>.example.com"). The registrable domain never folds. - an IP-literal host.

      • port (integer) --

        The port the API listens on, from 0 to 65535.

      • path (string) --

        The request path of the API.

      • accountId (string) --

        The AWS account ID that owns the API.

      • resourceArn (string) --

        The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.

      • region (string) --

        The AWS Region the API was discovered in.

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

      • visibility (string) --

        Whether a discovered API is reachable publicly or only from within a private network.

      • wafStatus (string) --

        Whether a WAF web ACL is attached to the API's front-door service.

      • classification (string) --

        Whether any account has created a ManagedApi for a discovered API, and for a managed API whether it is unused or no longer in the caller's organization. SHADOW - no account has created a ManagedApi for this item. MANAGED - some account in the caller's organization has created a ManagedApi for this item. MANAGED_ZOMBIE - managed and unused: no traffic for at least the account's no-traffic window. The API is still reachable, so this clears once traffic resumes. MANAGED_ORPHANED - managed, but the account hosting the API has left the caller's organization or been closed. The item is a last-known snapshot: it is no longer rediscovered, and its findings are not authorized for the caller. An organizational unit move is not a trigger.

        MANAGED_ZOMBIE and MANAGED_ORPHANED add detail to a MANAGED item, so neither is returned for an item the caller does not manage, and MANAGED_ORPHANED takes priority over MANAGED_ZOMBIE. Both are derived per request rather than stored, so neither expires on its own.

      • managedBy (string) --

        Who manages a MANAGED item, relative to the caller. Absent when the item is SHADOW. SELF - the caller account has created the ManagedApi. ORGANIZATION - some other account in the caller's organization has, but the caller has not.

      • workloads (list) --

        AI protocols seen in this API's traffic, each listed at most once. Absent when none has been reported, which includes an account that has not enabled AI discovery.

        • (string) --

          An AI protocol seen in an API's traffic, detected by the front door from request or response headers (and, for A2A, a query parameter). MCP - Model Context Protocol. LLM - traffic to or from an LLM inference server or gateway. A2A - Agent2Agent protocol.

      • managedApiId (string) --

        The identifier of the Managed API created from this API. Absent if there is none.

DeleteProductPage (new) Link ¶

Deletes a product page.

See also: AWS API Documentation

Request Syntax

client.delete_product_page(
    productId='string',
    productPageId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type productPageId:

string

param productPageId:

[REQUIRED]

The identifier of the product page.

returns:

None

UpdateProduct (new) Link ¶

Updates a product. Only the fields supplied in the request are changed.

See also: AWS API Documentation

Request Syntax

client.update_product(
    productId='string',
    displayName='string',
    description='string',
    displayOrder={
        'overviewPageArn': 'string',
        'productPageArns': [
            'string',
        ],
        'contents': [
            {
                'sectionName': 'string',
                'productApiPageArns': [
                    'string',
                ]
            },
        ]
    },
    apiSelectionConfiguration={
        'apiSelectionMode': 'CUSTOM'|'RULE_BASED',
        'ruleFilters': [
            {
                'key': 'RESOURCE_ARN'|'HOST'|'METHOD'|'PATH'|'PORT'|'ACCOUNT',
                'values': [
                    'string',
                ]
            },
        ]
    }
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type displayName:

string

param displayName:

The new name of the product. Omit it to keep the current name.

type description:

string

param description:

The new description of the product. Omit it to keep the current description.

type displayOrder:

dict

param displayOrder:

The new page order. Omit it to keep the current order.

  • overviewPageArn (string) --

    The ARN of the product page shown as the product overview.

  • productPageArns (list) --

    A product has at most DocHubLimits.DEFAULT_PAGES_PER_PRODUCT_LIMIT (40) pages, enforced by LimitsHelper.

    • (string) --

  • contents (list) --

    Sections in a product's navigation. No service-side limit exists today; this bound caps request size.

    • (dict) --

      A named group of API pages in the portal navigation.

      • sectionName (string) --

        Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).

      • productApiPageArns (list) --

        API pages in one section. No service-side limit exists today; this bound caps request size.

        • (string) --

type apiSelectionConfiguration:

dict

param apiSelectionConfiguration:

The new API selection settings. The selection mode must match the mode the product was created with. Omit it to keep the current settings.

  • apiSelectionMode (string) -- [REQUIRED]

    How a product's member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

    Fixed at create time. UpdateProduct cannot change the mode of an existing product.

  • ruleFilters (list) --

    Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account's Managed APIs. Replaced as a whole on update, not merged.

    • (dict) --

      Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

      • key (string) -- [REQUIRED]

        The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

      • values (list) -- [REQUIRED]

        The values to match. The filter matches when the attribute equals any of them.

        • (string) --

          Bounded by the longest matchable attribute, apiSignature.path.

          No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

rtype:

dict

returns:

Response Syntax

{
    'productId': 'string',
    'productArn': 'string',
    'displayName': 'string',
    'displayOrder': {
        'overviewPageArn': 'string',
        'productPageArns': [
            'string',
        ],
        'contents': [
            {
                'sectionName': 'string',
                'productApiPageArns': [
                    'string',
                ]
            },
        ]
    },
    'description': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'apiSelectionConfiguration': {
        'apiSelectionMode': 'CUSTOM'|'RULE_BASED',
        'ruleFilters': [
            {
                'key': 'RESOURCE_ARN'|'HOST'|'METHOD'|'PATH'|'PORT'|'ACCOUNT',
                'values': [
                    'string',
                ]
            },
        ]
    },
    'status': 'ACTIVE'|'IN_PROGRESS'|'FAILED',
    'failureReason': 'API_PAGE_ATTACHED'|'EVALUATION_ERROR'
}

Response Structure

  • (dict) --

    • productId (string) --

      The identifier of the product.

    • productArn (string) --

      The ARN of the product.

    • displayName (string) --

      The name of the product, from 1 to 255 characters.

    • displayOrder (dict) --

      The order of the product's pages and API page sections in the portal navigation.

      • overviewPageArn (string) --

        The ARN of the product page shown as the product overview.

      • productPageArns (list) --

        A product has at most DocHubLimits.DEFAULT_PAGES_PER_PRODUCT_LIMIT (40) pages, enforced by LimitsHelper.

        • (string) --

      • contents (list) --

        Sections in a product's navigation. No service-side limit exists today; this bound caps request size.

        • (dict) --

          A named group of API pages in the portal navigation.

          • sectionName (string) --

            Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).

          • productApiPageArns (list) --

            API pages in one section. No service-side limit exists today; this bound caps request size.

            • (string) --

    • description (string) --

      A description of the product, up to 1024 characters.

    • updatedAt (datetime) --

      When the resource was last updated.

    • apiSelectionConfiguration (dict) --

      How Managed APIs are selected for the product.

      • apiSelectionMode (string) --

        How a product's member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

        Fixed at create time. UpdateProduct cannot change the mode of an existing product.

      • ruleFilters (list) --

        Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account's Managed APIs. Replaced as a whole on update, not merged.

        • (dict) --

          Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

          • key (string) --

            The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

          • values (list) --

            The values to match. The filter matches when the attribute equals any of them.

            • (string) --

              Bounded by the longest matchable attribute, apiSignature.path.

              No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

    • status (string) --

      Whether the product's member APIs match its apiSelectionConfiguration. ACTIVE - membership matches. The only status a CUSTOM product reports. IN_PROGRESS - ruleFilters changed and membership is still being evaluated. FAILED - evaluation could not finish and membership is incomplete; failureReason says why.

    • failureReason (string) --

      Reason a product's rules could not be fully applied, present only when status is FAILED. New reasons may be added over time, so clients MUST treat any unrecognized value as UNKNOWN and fall back to generic handling.

ListProducts (new) Link ¶

Lists products you own, products shared with you, or both.

See also: AWS API Documentation

Request Syntax

client.list_products(
    maxResults=123,
    nextToken='string',
    resourceOwner='ALL'|'SELF'|'OTHER_ACCOUNTS',
    managedApiId='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 100.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

type resourceOwner:

string

param resourceOwner:

Whose products to return: SELF for your own, OTHER_ACCOUNTS for products shared with you, or ALL. Defaults to ALL, or to SELF when managedApiId is supplied.

type managedApiId:

string

param managedApiId:

Optional filter: when supplied, only Products this Managed API is associated with are returned.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'productId': 'string',
            'productArn': 'string',
            'displayName': 'string',
            'description': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'apiSelectionConfiguration': {
                'apiSelectionMode': 'CUSTOM'|'RULE_BASED',
                'ruleFilters': [
                    {
                        'key': 'RESOURCE_ARN'|'HOST'|'METHOD'|'PATH'|'PORT'|'ACCOUNT',
                        'values': [
                            'string',
                        ]
                    },
                ]
            },
            'status': 'ACTIVE'|'IN_PROGRESS'|'FAILED',
            'failureReason': 'API_PAGE_ATTACHED'|'EVALUATION_ERROR'
        },
    ]
}

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 products in this page of results.

      • (dict) --

        A summary of a product.

        • productId (string) --

          The identifier of the product.

        • productArn (string) --

          The ARN of the product.

        • displayName (string) --

          The name of the product, from 1 to 255 characters.

        • description (string) --

          A description of the product, up to 1024 characters.

        • updatedAt (datetime) --

          When the resource was last updated.

        • apiSelectionConfiguration (dict) --

          How Managed APIs are selected for the product.

          • apiSelectionMode (string) --

            How a product's member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

            Fixed at create time. UpdateProduct cannot change the mode of an existing product.

          • ruleFilters (list) --

            Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account's Managed APIs. Replaced as a whole on update, not merged.

            • (dict) --

              Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

              • key (string) --

                The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

              • values (list) --

                The values to match. The filter matches when the attribute equals any of them.

                • (string) --

                  Bounded by the longest matchable attribute, apiSignature.path.

                  No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

        • status (string) --

          Whether the product's member APIs match its apiSelectionConfiguration. ACTIVE - membership matches. The only status a CUSTOM product reports. IN_PROGRESS - ruleFilters changed and membership is still being evaluated. FAILED - evaluation could not finish and membership is incomplete; failureReason says why.

        • failureReason (string) --

          Reason a product's rules could not be fully applied, present only when status is FAILED. New reasons may be added over time, so clients MUST treat any unrecognized value as UNKNOWN and fall back to generic handling.

StopDiscovery (new) Link ¶

Stops the running API discovery process.

See also: AWS API Documentation

Request Syntax

client.stop_discovery(
    id='string'
)
type id:

string

param id:

[REQUIRED]

Identifier of the discovery configuration to stop. Required. Today this is the configuration ARN, which carries the owner account id so a delegated admin or org admin can stop an org-scoped configuration that lives in a different account.

returns:

None

GetProductSharingPolicy (new) Link ¶

Returns the sharing policy of a product.

See also: AWS API Documentation

Request Syntax

client.get_product_sharing_policy(
    productId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

rtype:

dict

returns:

Response Syntax

{
    'productId': 'string',
    'policyDocument': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • productId (string) --

      The identifier of the product.

    • policyDocument (string) --

      The sharing policy as a JSON resource policy document.

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

ListManagedApiEvents (new) Link ¶

Lists API-security events for a single managed API, most recent first. Returns up to 20 of the most recent events (not paginated).

See also: AWS API Documentation

Request Syntax

client.list_managed_api_events(
    managedApiId='string',
    startedAfter=datetime(2015, 1, 1),
    startedBefore=datetime(2015, 1, 1),
    maxResults=123,
    nextToken='string'
)
type managedApiId:

string

param managedApiId:

[REQUIRED]

The identifier of the Managed API.

type startedAfter:

datetime

param startedAfter:

Inclusive lower bound on each event's start time; only events that started at or after this time are returned. Optional; defaults to 30 days before the current time.

type startedBefore:

datetime

param startedBefore:

Exclusive upper bound on each event's start time; only events that started before this time are returned. Optional; defaults to the current time.

type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 20.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

rtype:

dict

returns:

Response Syntax

{
    'items': [
        {
            'eventId': 'string',
            'eventType': 'WAF_API_SECURITY',
            'status': 'EVENT_STARTED'|'EVENT_IN_PROGRESS'|'EVENT_ENDED',
            'wafApiSecurityEventDetail': {
                'label': 'string',
                'category': 'string',
                'confidence': 'LOW'|'MEDIUM'|'HIGH',
                'webAclArn': 'string'
            },
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A page of security events for a managed API. Page size is bounded by the operation's maxResults; callers retrieve all events by following nextToken.

      • (dict) --

        Summary of a single security event attributed to a managed API. This is the list view; full per-event detail will come from GetManagedApiEvent in future.

        • eventId (string) --

          Event identifier; row identity and input to GetManagedApiEvent.

        • eventType (string) --

          Always WAF_API_SECURITY today.

        • status (string) --

          Lifecycle status of a security event.

        • wafApiSecurityEventDetail (dict) --

          Detail specific to a WAF API-security event; populated when eventType is WAF_API_SECURITY.

          • label (string) --

            Detection label (attack type + confidence tier).

          • category (string) --

            OWASP class — the primary display value (e.g. "API2:2023").

          • confidence (string) --

            Confidence tier of the detection.

          • webAclArn (string) --

            WebACL that produced the event.

        • startedAt (datetime) --

          When the event was first observed.

        • endedAt (datetime) --

          When the event completed; absent while it is still in progress.

        • updatedAt (datetime) --

          When the event was last updated.

    • nextToken (string) --

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

CreateProductPage (new) Link ¶

Creates a product page with free-form documentation. A product can have up to 40 pages.

See also: AWS API Documentation

Request Syntax

client.create_product_page(
    productId='string',
    displayContent={
        'title': 'string',
        'body': 'string'
    },
    tags={
        'string': 'string'
    }
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type displayContent:

dict

param displayContent:

[REQUIRED]

The title and body of the page.

  • title (string) -- [REQUIRED]

    The page title, from 1 to 255 characters.

  • body (string) -- [REQUIRED]

    The Markdown body of the page, from 1 to 32,768 characters.

type tags:

dict

param tags:

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.

rtype:

dict

returns:

Response Syntax

{
    'productPageId': 'string',
    'productPageArn': 'string',
    'displayContent': {
        'title': 'string',
        'body': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • productPageId (string) --

      The identifier of the product page.

    • productPageArn (string) --

      The ARN of the product page.

    • displayContent (dict) --

      The title and body of the page.

      • title (string) --

        The page title, from 1 to 255 characters.

      • body (string) --

        The Markdown body of the page, from 1 to 32,768 characters.

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

ListManagedApis (new) Link ¶

Lists the Managed APIs in your account.

See also: AWS API Documentation

Request Syntax

client.list_managed_apis(
    maxResults=123,
    nextToken='string',
    productId='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 100.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

type productId:

string

param productId:

Optional filter: when supplied, only Managed APIs associated with this product are returned.

rtype:

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.

CreateProductApiPage (new) Link ¶

Creates an API page that documents a Managed API in a product. The page content is generated asynchronously. Use status to track it.

See also: AWS API Documentation

Request Syntax

client.create_product_api_page(
    productId='string',
    managedApiId='string',
    displayContent={
        'none': {}
        ,
        'overrides': {
            'operationName': 'string',
            'apiUrl': 'string',
            'body': 'string'
        }
    },
    tryItState='ENABLED'|'DISABLED',
    tags={
        'string': 'string'
    }
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type managedApiId:

string

param managedApiId:

[REQUIRED]

The Managed API this page documents. It must already be associated with the product, and the page's API identifier is taken from the Managed API rather than supplied by the caller.

type displayContent:

dict

param displayContent:

Exactly one of the members is set: none to use default display content, or overrides to customize it. Modeled as a union so the "exactly one" choice is enforced by type.

  • none (dict) --

    Use the content generated from the Managed API.

  • overrides (dict) --

    Replace the generated content with your own.

    • operationName (string) --

      The operation name shown as the page title, from 1 to 255 characters.

    • apiUrl (string) --

      The invoke URL shown on the page and used for Try-It and the portal's allowed-domain list: http(s)://host[:port][/path], with no whitespace, quotes or angle brackets. On this request member only, as ApiEndpoint is also returned in responses.

    • body (string) --

      The Markdown body of the page, from 1 to 32,768 characters.

type tryItState:

string

param tryItState:

Whether readers can call the API from the page with Try-It. Defaults to DISABLED. To enable it, the page's API URL must use HTTPS on a domain that supports Try-It.

type tags:

dict

param tags:

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.

rtype:

dict

returns:

Response Syntax

{
    'productApiPageId': 'string',
    'productApiPageArn': 'string',
    'apiId': {
        'identifierParts': {
            'path': 'string',
            'method': 'string',
            'resourceArn': 'string'
        }
    },
    'displayContent': {
        'operationName': 'string',
        'apiUrl': 'string',
        'body': 'string'
    },
    'tryItState': 'ENABLED'|'DISABLED',
    'updatedAt': datetime(2015, 1, 1),
    'status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
    'statusException': {
        'exception': 'INTERNAL_FAILURE'|'RESOURCE_DELETED'|'MEMBER_LEFT_ORG',
        'message': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • productApiPageId (string) --

      The identifier of the API page.

    • productApiPageArn (string) --

      The ARN of the API page.

    • apiId (dict) --

      The API the page documents.

      • identifierParts (dict) --

        The resource, method, and path that identify the API.

        • path (string) --

          The request path of the API.

        • method (string) --

          The HTTP method of the API.

        • resourceArn (string) --

          The ARN of the resource that serves the API.

    • displayContent (dict) --

      The content shown on the page.

      • operationName (string) --

        The operation name shown as the page title.

      • apiUrl (string) --

        The invoke URL shown on the page and used by Try-It.

      • body (string) --

        The Markdown body of the page. Absent while the page is IN_PROGRESS.

    • tryItState (string) --

      Whether Try-It is enabled on the page.

    • updatedAt (datetime) --

      When the resource was last updated.

    • status (string) --

      The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.

    • statusException (dict) --

      Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.

      • exception (string) --

        treat any unrecognized value as INTERNAL_FAILURE.

      • message (string) --

        A description of the failure.

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

UpdateProductPage (new) Link ¶

Updates a product page.

See also: AWS API Documentation

Request Syntax

client.update_product_page(
    productId='string',
    productPageId='string',
    displayContent={
        'title': 'string',
        'body': 'string'
    }
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type productPageId:

string

param productPageId:

[REQUIRED]

The identifier of the product page.

type displayContent:

dict

param displayContent:

The new title and body of the page. Omit it to keep the current content.

  • title (string) -- [REQUIRED]

    The page title, from 1 to 255 characters.

  • body (string) -- [REQUIRED]

    The Markdown body of the page, from 1 to 32,768 characters.

rtype:

dict

returns:

Response Syntax

{
    'productPageId': 'string',
    'productPageArn': 'string',
    'displayContent': {
        'title': 'string',
        'body': 'string'
    },
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • productPageId (string) --

      The identifier of the product page.

    • productPageArn (string) --

      The ARN of the product page.

    • displayContent (dict) --

      The title and body of the page.

      • title (string) --

        The page title, from 1 to 255 characters.

      • body (string) --

        The Markdown body of the page, from 1 to 32,768 characters.

    • updatedAt (datetime) --

      When the resource was last updated.

CreatePortalPreview (new) Link ¶

Starts building a preview of the portal's current content. Use GetPortal to check the preview status and get the preview URL.

See also: AWS API Documentation

Request Syntax

client.create_portal_preview(
    portalId='string'
)
type portalId:

string

param portalId:

[REQUIRED]

The identifier of the portal.

returns:

None

GetDiscoveryConfiguration (new) Link ¶

Retrieves the discovery configuration for the account and region.

See also: AWS API Documentation

Request Syntax

client.get_discovery_configuration()
rtype:

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.

DeleteOrganizationDiscoveryConfiguration (new) Link ¶

Deletes the organization-wide discovery configuration and stops any running discovery across the organization. Only the organization management account may call this operation.

See also: AWS API Documentation

Request Syntax

client.delete_organization_discovery_configuration()
returns:

None

AssociateManagedApis (new) Link ¶

Associate one or more Managed APIs with a product. Best-effort — IDs that fail are returned in {@link AssociateManagedApisResponse#failedItems}; IDs that succeed are omitted. Associating an already-associated Managed API is a no-op (not reported as failure).

See also: AWS API Documentation

Request Syntax

client.associate_managed_apis(
    productId='string',
    managedApiIds=[
        'string',
    ]
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product to associate the Managed APIs with.

type managedApiIds:

list

param managedApiIds:

[REQUIRED]

Bounded list of Managed API IDs, used as the request payload for batch associate/disassociate.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'failedItems': [
        {
            'managedApiId': 'string',
            'errorCode': 'MANAGED_API_NOT_FOUND'|'INTERNAL_ERROR',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • failedItems (list) --

      The Managed APIs that could not be processed. IDs not listed here succeeded.

      • (dict) --

        One entry per Managed API ID that could not be processed in a batch call. Ids that succeed are omitted from the response — callers infer success by absence.

        • managedApiId (string) --

          The identifier of the Managed API that could not be processed.

        • errorCode (string) --

          Machine-readable reason a Managed API ID couldn't be processed in a batch call. Clients should key retry logic off this enum rather than parsing errorMessage.

        • errorMessage (string) --

          A description of the failure.

UntagResource (new) Link ¶

Removes tags from an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).

tagKeys is a query string parameter: for tag-based access control (TBAC/ABAC) to work correctly, API Gateway requires the keys to be removed to be passed as a query string parameter.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource.

type tagKeys:

list

param tagKeys:

[REQUIRED]

The keys of the tags to remove, up to 50.

  • (string) --

    A tag key of 1-128 Unicode characters, per the AWS tagging limits.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

CreateManagedApi (new) Link ¶

Promote a discovered API in the API inventory into the managed API list.

See also: AWS API Documentation

Request Syntax

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'
    }
)
type apiSignature:

dict

param apiSignature:

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

type tags:

dict

param tags:

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.

rtype:

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.

UpdateProductApiPage (new) Link ¶

Updates an API page. Only the fields supplied in the request are changed.

See also: AWS API Documentation

Request Syntax

client.update_product_api_page(
    productId='string',
    productApiPageId='string',
    displayContent={
        'none': {}
        ,
        'overrides': {
            'operationName': 'string',
            'apiUrl': 'string',
            'body': 'string'
        }
    },
    tryItState='ENABLED'|'DISABLED'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type productApiPageId:

string

param productApiPageId:

[REQUIRED]

The identifier of the API page.

type displayContent:

dict

param displayContent:

Exactly one of the members is set: none to use default display content, or overrides to customize it. Modeled as a union so the "exactly one" choice is enforced by type.

  • none (dict) --

    Use the content generated from the Managed API.

  • overrides (dict) --

    Replace the generated content with your own.

    • operationName (string) --

      The operation name shown as the page title, from 1 to 255 characters.

    • apiUrl (string) --

      The invoke URL shown on the page and used for Try-It and the portal's allowed-domain list: http(s)://host[:port][/path], with no whitespace, quotes or angle brackets. On this request member only, as ApiEndpoint is also returned in responses.

    • body (string) --

      The Markdown body of the page, from 1 to 32,768 characters.

type tryItState:

string

param tryItState:

The new Try-It setting. Omit it to keep the current setting. To enable it, the page's API URL must use HTTPS on a domain that supports Try-It.

rtype:

dict

returns:

Response Syntax

{
    'productApiPageId': 'string',
    'productApiPageArn': 'string',
    'apiId': {
        'identifierParts': {
            'path': 'string',
            'method': 'string',
            'resourceArn': 'string'
        }
    },
    'displayContent': {
        'operationName': 'string',
        'apiUrl': 'string',
        'body': 'string'
    },
    'tryItState': 'ENABLED'|'DISABLED',
    'updatedAt': datetime(2015, 1, 1),
    'status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
    'statusException': {
        'exception': 'INTERNAL_FAILURE'|'RESOURCE_DELETED'|'MEMBER_LEFT_ORG',
        'message': 'string'
    }
}

Response Structure

  • (dict) --

    • productApiPageId (string) --

      The identifier of the API page.

    • productApiPageArn (string) --

      The ARN of the API page.

    • apiId (dict) --

      The API the page documents.

      • identifierParts (dict) --

        The resource, method, and path that identify the API.

        • path (string) --

          The request path of the API.

        • method (string) --

          The HTTP method of the API.

        • resourceArn (string) --

          The ARN of the resource that serves the API.

    • displayContent (dict) --

      The content shown on the page.

      • operationName (string) --

        The operation name shown as the page title.

      • apiUrl (string) --

        The invoke URL shown on the page and used by Try-It.

      • body (string) --

        The Markdown body of the page. Absent while the page is IN_PROGRESS.

    • tryItState (string) --

      Whether Try-It is enabled on the page.

    • updatedAt (datetime) --

      When the resource was last updated.

    • status (string) --

      The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.

    • statusException (dict) --

      Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.

      • exception (string) --

        treat any unrecognized value as INTERNAL_FAILURE.

      • message (string) --

        A description of the failure.

GetProductApiPage (new) Link ¶

Returns an API page, including its body.

See also: AWS API Documentation

Request Syntax

client.get_product_api_page(
    productId='string',
    productApiPageId='string',
    resourceOwnerAccountId='string',
    includeRawDisplayContent=True|False
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type productApiPageId:

string

param productApiPageId:

[REQUIRED]

The identifier of the API page.

type resourceOwnerAccountId:

string

param resourceOwnerAccountId:

The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.

type includeRawDisplayContent:

boolean

param includeRawDisplayContent:

Set to true to also return the page body in rawDisplayContent.

rtype:

dict

returns:

Response Syntax

{
    'productApiPageId': 'string',
    'productApiPageArn': 'string',
    'apiId': {
        'identifierParts': {
            'path': 'string',
            'method': 'string',
            'resourceArn': 'string'
        }
    },
    'displayContent': {
        'operationName': 'string',
        'apiUrl': 'string',
        'body': 'string'
    },
    'tryItState': 'ENABLED'|'DISABLED',
    'updatedAt': datetime(2015, 1, 1),
    'status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
    'rawDisplayContent': 'string',
    'statusException': {
        'exception': 'INTERNAL_FAILURE'|'RESOURCE_DELETED'|'MEMBER_LEFT_ORG',
        'message': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • productApiPageId (string) --

      The identifier of the API page.

    • productApiPageArn (string) --

      The ARN of the API page.

    • apiId (dict) --

      The API the page documents.

      • identifierParts (dict) --

        The resource, method, and path that identify the API.

        • path (string) --

          The request path of the API.

        • method (string) --

          The HTTP method of the API.

        • resourceArn (string) --

          The ARN of the resource that serves the API.

    • displayContent (dict) --

      The content shown on the page.

      • operationName (string) --

        The operation name shown as the page title.

      • apiUrl (string) --

        The invoke URL shown on the page and used by Try-It.

      • body (string) --

        The Markdown body of the page. Absent while the page is IN_PROGRESS.

    • tryItState (string) --

      Whether Try-It is enabled on the page.

    • updatedAt (datetime) --

      When the resource was last updated.

    • status (string) --

      The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.

    • rawDisplayContent (string) --

      The Markdown body of the page. Returned only when includeRawDisplayContent is true.

    • statusException (dict) --

      Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.

      • exception (string) --

        treat any unrecognized value as INTERNAL_FAILURE.

      • message (string) --

        A description of the failure.

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

DeletePortal (new) Link ¶

Deletes a portal.

See also: AWS API Documentation

Request Syntax

client.delete_portal(
    portalId='string'
)
type portalId:

string

param portalId:

[REQUIRED]

The identifier of the portal.

returns:

None

TagResource (new) Link ¶

Adds or updates tags on an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

The ARN of the resource.

type tags:

dict

param tags:

[REQUIRED]

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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListProductApiPages (new) Link ¶

Lists the API pages in a product. The results do not include page bodies.

See also: AWS API Documentation

Request Syntax

client.list_product_api_pages(
    productId='string',
    nextToken='string',
    maxResults=123,
    resourceOwnerAccountId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 100.

type resourceOwnerAccountId:

string

param resourceOwnerAccountId:

The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'productApiPageId': 'string',
            'productApiPageArn': 'string',
            'apiId': {
                'identifierParts': {
                    'path': 'string',
                    'method': 'string',
                    'resourceArn': 'string'
                }
            },
            'operationName': 'string',
            'apiUrl': 'string',
            'tryItState': 'ENABLED'|'DISABLED',
            'updatedAt': datetime(2015, 1, 1),
            'status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
            'statusException': {
                'exception': 'INTERNAL_FAILURE'|'RESOURCE_DELETED'|'MEMBER_LEFT_ORG',
                'message': 'string'
            }
        },
    ]
}

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 API pages in this page of results.

      • (dict) --

        A summary of an API page, without its body.

        • productApiPageId (string) --

          The identifier of the API page.

        • productApiPageArn (string) --

          The ARN of the API page.

        • apiId (dict) --

          The API the page documents.

          • identifierParts (dict) --

            The resource, method, and path that identify the API.

            • path (string) --

              The request path of the API.

            • method (string) --

              The HTTP method of the API.

            • resourceArn (string) --

              The ARN of the resource that serves the API.

        • operationName (string) --

          The operation name shown as the page title.

        • apiUrl (string) --

          The invoke URL shown on the page and used by Try-It.

        • tryItState (string) --

          Whether Try-It is enabled on the page.

        • updatedAt (datetime) --

          When the resource was last updated.

        • status (string) --

          The status of the page content: IN_PROGRESS while it is generated, then AVAILABLE or FAILED.

        • statusException (dict) --

          Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.

          • exception (string) --

            treat any unrecognized value as INTERNAL_FAILURE.

          • message (string) --

            A description of the failure.

DeleteProduct (new) Link ¶

Deletes a product.

See also: AWS API Documentation

Request Syntax

client.delete_product(
    productId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

returns:

None

ListProductPages (new) Link ¶

Lists the product pages in a product. The results do not include page bodies.

See also: AWS API Documentation

Request Syntax

client.list_product_pages(
    productId='string',
    nextToken='string',
    maxResults=123,
    resourceOwnerAccountId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type nextToken:

string

param nextToken:

The pagination token returned by a previous call. Omit it to get the first page.

type maxResults:

integer

param maxResults:

The maximum number of results to return in one page, from 1 to 100.

type resourceOwnerAccountId:

string

param resourceOwnerAccountId:

The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'productPageId': 'string',
            'productPageArn': 'string',
            'pageTitle': 'string',
            '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 product pages in this page of results.

      • (dict) --

        A summary of a product page, without its body.

        • productPageId (string) --

          The identifier of the product page.

        • productPageArn (string) --

          The ARN of the product page.

        • pageTitle (string) --

          The page title.

        • updatedAt (datetime) --

          When the resource was last updated.

PutOrganizationDiscoveryConfiguration (new) Link ¶

Creates or updates the organization-wide discovery configuration. This is a singleton per organization. Only the organization management account and registered delegated administrators may call this operation.

See also: AWS API Documentation

Request Syntax

client.put_organization_discovery_configuration(
    discoverySources=[
        'API_GATEWAY'|'ELB'|'CLOUDFRONT',
    ],
    exclusionFilters={
        'organizationalUnitIds': [
            'string',
        ],
        'accountIds': [
            'string',
        ],
        'resourceArns': [
            'string',
        ]
    },
    discoveryFilters={
        'exclusionFilters': {
            'organizationalUnitIds': [
                'string',
            ],
            'accountIds': [
                'string',
            ],
            'resourceArns': [
                'string',
            ]
        },
        'inclusionFilters': {
            'organizationalUnitIds': [
                'string',
            ],
            'accountIds': [
                'string',
            ]
        }
    },
    features=[
        'AI_DISCOVERY',
    ],
    tags={
        'string': 'string'
    }
)
type discoverySources:

list

param discoverySources:

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.

type exclusionFilters:

dict

param exclusionFilters:

Exclusion filters for organization-scoped discovery. @deprecated. Remove this once client (Console) moves to discoveryFilters

  • organizationalUnitIds (list) --

    List of organizational unit IDs to exclude from discovery.

    • (string) --

  • accountIds (list) --

    List of AWS account IDs to exclude from discovery.

    • (string) --

  • resourceArns (list) --

    List of resource ARNs to exclude. Only ELB and CloudFront resource ARNs are supported.

    • (string) --

type discoveryFilters:

dict

param discoveryFilters:

The accounts or organizational units to include in or exclude from discovery.

  • exclusionFilters (dict) --

    Exclusion filters for organization-scoped discovery. Resources matching any of these filters are excluded from discovery.

    • organizationalUnitIds (list) --

      List of organizational unit IDs to exclude from discovery.

      • (string) --

    • accountIds (list) --

      List of AWS account IDs to exclude from discovery.

      • (string) --

    • resourceArns (list) --

      List of resource ARNs to exclude. Only ELB and CloudFront resource ARNs are supported.

      • (string) --

  • inclusionFilters (dict) --

    Inclusion filters for organization-scoped discovery. Only Resources matching any of these filters are included in discovery.

    • organizationalUnitIds (list) --

      List of organizational unit IDs to include in discovery.

      • (string) --

    • accountIds (list) --

      List of AWS account IDs to include in discovery.

      • (string) --

type features:

list

param features:

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.

type tags:

dict

param tags:

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.

rtype:

dict

returns:

Response Syntax

{
    'discoveryConfiguration': {
        'arn': 'string',
        'status': 'DISABLED'|'ENABLED'|'UPDATING',
        'discoverySources': [
            'API_GATEWAY'|'ELB'|'CLOUDFRONT',
        ],
        'exclusionFilters': {
            'organizationalUnitIds': [
                'string',
            ],
            'accountIds': [
                'string',
            ],
            'resourceArns': [
                'string',
            ]
        },
        'discoveryFilters': {
            'exclusionFilters': {
                'organizationalUnitIds': [
                    'string',
                ],
                'accountIds': [
                    'string',
                ],
                'resourceArns': [
                    'string',
                ]
            },
            'inclusionFilters': {
                'organizationalUnitIds': [
                    'string',
                ],
                'accountIds': [
                    '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 organization.

      • arn (string) --

        The ARN of the organization 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.

      • exclusionFilters (dict) --

        Exclusion filters for organization-scoped discovery. @deprecated. Remove this once client (Console) moves to discoveryFilters

        • organizationalUnitIds (list) --

          List of organizational unit IDs to exclude from discovery.

          • (string) --

        • accountIds (list) --

          List of AWS account IDs to exclude from discovery.

          • (string) --

        • resourceArns (list) --

          List of resource ARNs to exclude. Only ELB and CloudFront resource ARNs are supported.

          • (string) --

      • discoveryFilters (dict) --

        The accounts or organizational units included in or excluded from discovery.

        • exclusionFilters (dict) --

          Exclusion filters for organization-scoped discovery. Resources matching any of these filters are excluded from discovery.

          • organizationalUnitIds (list) --

            List of organizational unit IDs to exclude from discovery.

            • (string) --

          • accountIds (list) --

            List of AWS account IDs to exclude from discovery.

            • (string) --

          • resourceArns (list) --

            List of resource ARNs to exclude. Only ELB and CloudFront resource ARNs are supported.

            • (string) --

        • inclusionFilters (dict) --

          Inclusion filters for organization-scoped discovery. Only Resources matching any of these filters are included in discovery.

          • organizationalUnitIds (list) --

            List of organizational unit IDs to include in discovery.

            • (string) --

          • accountIds (list) --

            List of AWS account IDs to include in 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.

GetProduct (new) Link ¶

Returns a product. To read a product shared with you by another account, supply resourceOwnerAccountId.

See also: AWS API Documentation

Request Syntax

client.get_product(
    productId='string',
    resourceOwnerAccountId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type resourceOwnerAccountId:

string

param resourceOwnerAccountId:

The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.

rtype:

dict

returns:

Response Syntax

{
    'productId': 'string',
    'productArn': 'string',
    'displayName': 'string',
    'displayOrder': {
        'overviewPageArn': 'string',
        'productPageArns': [
            'string',
        ],
        'contents': [
            {
                'sectionName': 'string',
                'productApiPageArns': [
                    'string',
                ]
            },
        ]
    },
    'description': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'apiSelectionConfiguration': {
        'apiSelectionMode': 'CUSTOM'|'RULE_BASED',
        'ruleFilters': [
            {
                'key': 'RESOURCE_ARN'|'HOST'|'METHOD'|'PATH'|'PORT'|'ACCOUNT',
                'values': [
                    'string',
                ]
            },
        ]
    },
    'status': 'ACTIVE'|'IN_PROGRESS'|'FAILED',
    'failureReason': 'API_PAGE_ATTACHED'|'EVALUATION_ERROR'
}

Response Structure

  • (dict) --

    • productId (string) --

      The identifier of the product.

    • productArn (string) --

      The ARN of the product.

    • displayName (string) --

      The name of the product, from 1 to 255 characters.

    • displayOrder (dict) --

      The order of the product's pages and API page sections in the portal navigation.

      • overviewPageArn (string) --

        The ARN of the product page shown as the product overview.

      • productPageArns (list) --

        A product has at most DocHubLimits.DEFAULT_PAGES_PER_PRODUCT_LIMIT (40) pages, enforced by LimitsHelper.

        • (string) --

      • contents (list) --

        Sections in a product's navigation. No service-side limit exists today; this bound caps request size.

        • (dict) --

          A named group of API pages in the portal navigation.

          • sectionName (string) --

            Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).

          • productApiPageArns (list) --

            API pages in one section. No service-side limit exists today; this bound caps request size.

            • (string) --

    • description (string) --

      A description of the product, up to 1024 characters.

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

    • apiSelectionConfiguration (dict) --

      How Managed APIs are selected for the product.

      • apiSelectionMode (string) --

        How a product's member Managed APIs are chosen. CUSTOM - the customer associates and disassociates Managed APIs explicitly. RULE_BASED - membership is derived from ruleFilters: every Managed API in the account that matches is associated, and nothing else is. BatchAssociateManagedApi and BatchDisassociateManagedApi are rejected for these products.

        Fixed at create time. UpdateProduct cannot change the mode of an existing product.

      • ruleFilters (list) --

        Required for RULE_BASED, rejected for CUSTOM. Filters are combined with AND, the values within one filter with OR, and evaluated only over the account's Managed APIs. Replaced as a whole on update, not merged.

        • (dict) --

          Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.

          • key (string) --

            The Managed API attribute a RuleFilter compares against. RESOURCE_ARN - apiSignature.resourceArn HOST - apiSignature.hostname METHOD - apiSignature.method, so values must be HttpMethod names PATH - apiSignature.path PORT - apiSignature.port, compared as its decimal string, so values must be 0-65535 with no leading zeros ACCOUNT - the account hosting the API, which for an ORGANIZATION-scoped Managed API is the member account rather than the account that created it

          • values (list) --

            The values to match. The filter matches when the attribute equals any of them.

            • (string) --

              Bounded by the longest matchable attribute, apiSignature.path.

              No whitespace: none of the matchable attributes (ARN, hostname, method, path, port, account) contain any. Per-key formats (METHOD, PORT, ACCOUNT) are enforced in ProductValidator.validateRuleFilterValue, since one pattern cannot express them for a value shared by every key.

    • status (string) --

      Whether the product's member APIs match its apiSelectionConfiguration. ACTIVE - membership matches. The only status a CUSTOM product reports. IN_PROGRESS - ruleFilters changed and membership is still being evaluated. FAILED - evaluation could not finish and membership is incomplete; failureReason says why.

    • failureReason (string) --

      Reason a product's rules could not be fully applied, present only when status is FAILED. New reasons may be added over time, so clients MUST treat any unrecognized value as UNKNOWN and fall back to generic handling.

GetProductPage (new) Link ¶

Returns a product page, including its body.

See also: AWS API Documentation

Request Syntax

client.get_product_page(
    productId='string',
    productPageId='string',
    resourceOwnerAccountId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type productPageId:

string

param productPageId:

[REQUIRED]

The identifier of the product page.

type resourceOwnerAccountId:

string

param resourceOwnerAccountId:

The AWS account ID that owns the product. Supply it to read a product shared with you by another account. Omit it for products in your own account.

rtype:

dict

returns:

Response Syntax

{
    'productPageId': 'string',
    'productPageArn': 'string',
    'displayContent': {
        'title': 'string',
        'body': 'string'
    },
    'updatedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • productPageId (string) --

      The identifier of the product page.

    • productPageArn (string) --

      The ARN of the product page.

    • displayContent (dict) --

      The title and body of the page.

      • title (string) --

        The page title, from 1 to 255 characters.

      • body (string) --

        The Markdown body of the page, from 1 to 32,768 characters.

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

DeleteProductApiPage (new) Link ¶

Deletes an API page.

See also: AWS API Documentation

Request Syntax

client.delete_product_api_page(
    productId='string',
    productApiPageId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

type productApiPageId:

string

param productApiPageId:

[REQUIRED]

The identifier of the API page.

returns:

None

DeleteProductSharingPolicy (new) Link ¶

Deletes the sharing policy of a product. The product is no longer shared.

See also: AWS API Documentation

Request Syntax

client.delete_product_sharing_policy(
    productId='string'
)
type productId:

string

param productId:

[REQUIRED]

The identifier of the product.

returns:

None