APIPortal 2026-04-30
- Client: Aws\APIPortal\APIPortalClient
- Service ID: apiportal
- Version: 2026-04-30
This page describes the parameters and results for the operations of the APIPortal (2026-04-30), and shows how to use the Aws\APIPortal\APIPortalClient object to call the described operations. This documentation is specific to the 2026-04-30 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateManagedApis ( array $params = [] )
- Associate one or more Managed APIs with a product.
- CreateManagedApi ( array $params = [] )
- Promote a discovered API in the API inventory into the managed API list.
- CreatePortal ( array $params = [] )
- Creates a portal that publishes documentation for the products it includes.
- CreatePortalPreview ( array $params = [] )
- Starts building a preview of the portal's current content.
- CreateProduct ( array $params = [] )
- Creates a product.
- CreateProductApiPage ( array $params = [] )
- Creates an API page that documents a Managed API in a product.
- CreateProductPage ( array $params = [] )
- Creates a product page with free-form documentation.
- DeleteDiscoveryConfiguration ( array $params = [] )
- Deletes the discovery configuration and stops any running discovery.
- DeleteManagedApi ( array $params = [] )
- Deletes a Managed API.
- DeleteOrganizationDiscoveryConfiguration ( array $params = [] )
- Deletes the organization-wide discovery configuration and stops any running discovery across the organization.
- DeletePortal ( array $params = [] )
- Deletes a portal.
- DeleteProduct ( array $params = [] )
- Deletes a product.
- DeleteProductApiPage ( array $params = [] )
- Deletes an API page.
- DeleteProductPage ( array $params = [] )
- Deletes a product page.
- DeleteProductSharingPolicy ( array $params = [] )
- Deletes the sharing policy of a product.
- DisassociateManagedApis ( array $params = [] )
- Disassociate one or more Managed APIs from a product.
- GetApiInventoryItem ( array $params = [] )
- Gets full details of a single API inventory item.
- GetDiscoveryConfiguration ( array $params = [] )
- Retrieves the discovery configuration for the account and region.
- GetManagedApi ( array $params = [] )
- Returns a Managed API, including its security posture findings.
- GetOrganizationDiscoveryConfiguration ( array $params = [] )
- Retrieves the organization-wide discovery configuration.
- GetPortal ( array $params = [] )
- Returns the configuration, publish status, and preview status of a portal.
- GetProduct ( array $params = [] )
- Returns a product.
- GetProductApiPage ( array $params = [] )
- Returns an API page, including its body.
- GetProductPage ( array $params = [] )
- Returns a product page, including its body.
- GetProductSharingPolicy ( array $params = [] )
- Returns the sharing policy of a product.
- ListApiInventoryItems ( array $params = [] )
- Lists discovered API inventory items with filtering and pagination.
- ListDiscoveryStatuses ( array $params = [] )
- Lists discovery statuses for services.
- ListManagedApiEvents ( array $params = [] )
- Lists API-security events for a single managed API, most recent first.
- ListManagedApis ( array $params = [] )
- Lists the Managed APIs in your account.
- ListPortals ( array $params = [] )
- Lists the portals in your account.
- ListProductApiPages ( array $params = [] )
- Lists the API pages in a product.
- ListProductPages ( array $params = [] )
- Lists the product pages in a product.
- ListProducts ( array $params = [] )
- Lists products you own, products shared with you, or both.
- ListTagsForResource ( array $params = [] )
- Lists the tags for an API Portal resource.
- PutDiscoveryConfiguration ( array $params = [] )
- Creates or updates the discovery configuration
- PutOrganizationDiscoveryConfiguration ( array $params = [] )
- Creates or updates the organization-wide discovery configuration.
- PutProductSharingPolicy ( array $params = [] )
- Creates or replaces the sharing policy of a product.
- StartDiscovery ( array $params = [] )
- Starts the API discovery process.
- StopDiscovery ( array $params = [] )
- Stops the running API discovery process.
- TagResource ( array $params = [] )
- Adds or updates tags on an API Portal resource.
- UntagResource ( array $params = [] )
- Removes tags from an API Portal resource.
- UpdatePortal ( array $params = [] )
- Updates a portal.
- UpdatePortalPublishStatus ( array $params = [] )
- Publishes or disables a portal.
- UpdateProduct ( array $params = [] )
- Updates a product.
- UpdateProductApiPage ( array $params = [] )
- Updates an API page.
- UpdateProductPage ( array $params = [] )
- Updates a product page.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListApiInventoryItems
- ListDiscoveryStatuses
- ListManagedApiEvents
- ListManagedApis
- ListPortals
- ListProductApiPages
- ListProductPages
- ListProducts
Operations
AssociateManagedApis
$result = $client->associateManagedApis([/* ... */]); $promise = $client->associateManagedApisAsync([/* ... */]);
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).
Parameter Syntax
$result = $client->associateManagedApis([
'managedApiIds' => ['<string>', ...], // REQUIRED
'productId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- managedApiIds
-
- Required: Yes
- Type: Array of strings
Bounded list of Managed API IDs, used as the request payload for batch associate/disassociate.
- productId
-
- Required: Yes
- Type: string
The identifier of the product to associate the Managed APIs with.
Result Syntax
[
'failedItems' => [
[
'errorCode' => 'MANAGED_API_NOT_FOUND|INTERNAL_ERROR',
'errorMessage' => '<string>',
'managedApiId' => '<string>',
],
// ...
],
]
Result Details
Members
- failedItems
-
- Required: Yes
- Type: Array of FailedManagedApiItem structures
The Managed APIs that could not be processed. IDs not listed here succeeded.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
CreateManagedApi
$result = $client->createManagedApi([/* ... */]); $promise = $client->createManagedApiAsync([/* ... */]);
Promote a discovered API in the API inventory into the managed API list.
Parameter Syntax
$result = $client->createManagedApi([
'apiSignature' => [ // REQUIRED
'hostname' => '<string>', // REQUIRED
'method' => 'GET|POST|PUT|DELETE|PATCH|ANY|HEAD|OPTIONS', // REQUIRED
'path' => '<string>', // REQUIRED
'port' => <integer>, // REQUIRED
'resourceArn' => '<string>', // REQUIRED
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- apiSignature
-
- Required: Yes
- Type: ApiSignature structure
The resource, method, host, port, and path that identify the API.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[
'apiSignature' => [
'hostname' => '<string>',
'method' => 'GET|POST|PUT|DELETE|PATCH|ANY|HEAD|OPTIONS',
'path' => '<string>',
'port' => <integer>,
'resourceArn' => '<string>',
],
'createdAt' => <DateTime>,
'managedApiArn' => '<string>',
'managedApiId' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiSignature
-
- Required: Yes
- Type: ApiSignature structure
The attributes that identify the API.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was created.
- managedApiArn
-
- Required: Yes
- Type: string
The ARN of the Managed API.
- managedApiId
-
- Required: Yes
- Type: string
The identifier of the Managed API.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
CreatePortal
$result = $client->createPortal([/* ... */]); $promise = $client->createPortalAsync([/* ... */]);
Creates a portal that publishes documentation for the products it includes. Use UpdatePortalPublishStatus to publish it.
Parameter Syntax
$result = $client->createPortal([
'authorization' => [ // REQUIRED
'authorizationConfig' => [ // REQUIRED
'cognitoConfig' => [
'appClientId' => '<string>', // REQUIRED
'identityPoolId' => '<string>',
'userPoolArn' => '<string>', // REQUIRED
'userPoolDomain' => '<string>', // REQUIRED
],
'none' => [
],
],
'fineGrainedAccessControl' => 'ENABLED|DISABLED', // REQUIRED
],
'endpointConfiguration' => [ // REQUIRED
'acmManaged' => [
'certificateArn' => '<string>', // REQUIRED
'domainName' => '<string>', // REQUIRED
],
'none' => [
],
],
'includedProductArns' => ['<string>', ...],
'logoUri' => '<string>',
'portalContent' => [ // REQUIRED
'description' => '<string>',
'displayName' => '<string>', // REQUIRED
'theme' => [ // REQUIRED
'customColors' => [ // REQUIRED
'accentColor' => '<string>', // REQUIRED
'backgroundColor' => '<string>', // REQUIRED
'errorValidationColor' => '<string>', // REQUIRED
'headerColor' => '<string>', // REQUIRED
'navigationColor' => '<string>', // REQUIRED
'textColor' => '<string>', // REQUIRED
],
'logoUploadedAt' => <integer || string || DateTime>,
],
],
'rumAppMonitorName' => '<string>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- authorization
-
- Required: Yes
- Type: Authorization structure
How readers sign in to the portal, and whether fine-grained access control is on.
- endpointConfiguration
-
- Required: Yes
- Type: EndpointConfigurationRequest structure
Exactly one of the members is set:
nonefor no custom domain, oracmManagedto bring a domain + ACM certificate. Modeled as a union so the "exactly one" choice is enforced by type. - includedProductArns
-
- Type: Array of strings
The ARNs of the products the portal includes, up to 200.
- logoUri
-
- Type: string
The S3 location of the portal logo, in the form
s3://bucket/key. - portalContent
-
- Required: Yes
- Type: PortalContent structure
The portal's display name, description, and theme.
- rumAppMonitorName
-
- Type: string
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[
'authorization' => [
'authorizationConfig' => [
'cognitoConfig' => [
'appClientId' => '<string>',
'identityPoolId' => '<string>',
'userPoolArn' => '<string>',
'userPoolDomain' => '<string>',
],
'none' => [
],
],
'fineGrainedAccessControl' => 'ENABLED|DISABLED',
],
'endpointConfiguration' => [
'certificateArn' => '<string>',
'domainName' => '<string>',
'portalDefaultDomainName' => '<string>',
'portalDomainHostedZoneId' => '<string>',
],
'includedProductArns' => ['<string>', ...],
'portalArn' => '<string>',
'portalContent' => [
'description' => '<string>',
'displayName' => '<string>',
'theme' => [
'customColors' => [
'accentColor' => '<string>',
'backgroundColor' => '<string>',
'errorValidationColor' => '<string>',
'headerColor' => '<string>',
'navigationColor' => '<string>',
'textColor' => '<string>',
],
'logoUploadedAt' => <DateTime>,
],
],
'portalId' => '<string>',
'publishDescription' => '<string>',
'publishStatus' => 'PUBLISHED|PUBLISH_IN_PROGRESS|PUBLISH_FAILED|DISABLE_IN_PROGRESS|DISABLE_FAILED|DISABLED',
'publishedAt' => <DateTime>,
'rumAppMonitorName' => '<string>',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|UNSHARED_PRODUCT_EXCEPTION|CLOUDFRONT_DOMAIN_IN_USE|MISSING_CLOUDFRONT_PERMISSIONS',
'message' => '<string>',
],
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- authorization
-
- Required: Yes
- Type: Authorization structure
How readers sign in to the portal, and whether fine-grained access control is on.
- endpointConfiguration
-
- Required: Yes
- Type: EndpointConfigurationResponse structure
The domain configuration of the portal.
- includedProductArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the products the portal includes.
- portalArn
-
- Required: Yes
- Type: string
The ARN of the portal.
- portalContent
-
- Required: Yes
- Type: PortalContent structure
The portal's display name, description, and theme.
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
- publishDescription
-
- Type: string
The description supplied with the most recent publish request.
- publishStatus
-
- Type: string
The publish status of the portal. Absent if the portal has never been published.
- publishedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the portal was last published.
- rumAppMonitorName
-
- Type: string
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
- statusException
-
- Type: PortalStatusException structure
Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
CreatePortalPreview
$result = $client->createPortalPreview([/* ... */]); $promise = $client->createPortalPreviewAsync([/* ... */]);
Starts building a preview of the portal's current content. Use GetPortal to check the preview status and get the preview URL.
Parameter Syntax
$result = $client->createPortalPreview([
'portalId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
CreateProduct
$result = $client->createProduct([/* ... */]); $promise = $client->createProductAsync([/* ... */]);
Creates a product. A product groups Managed APIs with their API pages and product pages so a portal can publish them together.
Parameter Syntax
$result = $client->createProduct([
'apiSelectionConfiguration' => [
'apiSelectionMode' => 'CUSTOM|RULE_BASED', // REQUIRED
'ruleFilters' => [
[
'key' => 'RESOURCE_ARN|HOST|METHOD|PATH|PORT|ACCOUNT', // REQUIRED
'values' => ['<string>', ...], // REQUIRED
],
// ...
],
],
'description' => '<string>',
'displayName' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- apiSelectionConfiguration
-
- Type: ApiSelectionConfiguration structure
How Managed APIs are selected for the product. The selection mode can't be changed after the product is created.
- description
-
- Type: string
A description of the product, up to 1024 characters.
- displayName
-
- Required: Yes
- Type: string
The name of the product, from 1 to 255 characters.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[
'apiSelectionConfiguration' => [
'apiSelectionMode' => 'CUSTOM|RULE_BASED',
'ruleFilters' => [
[
'key' => 'RESOURCE_ARN|HOST|METHOD|PATH|PORT|ACCOUNT',
'values' => ['<string>', ...],
],
// ...
],
],
'description' => '<string>',
'displayName' => '<string>',
'displayOrder' => [
'contents' => [
[
'productApiPageArns' => ['<string>', ...],
'sectionName' => '<string>',
],
// ...
],
'overviewPageArn' => '<string>',
'productPageArns' => ['<string>', ...],
],
'failureReason' => 'API_PAGE_ATTACHED|EVALUATION_ERROR',
'productArn' => '<string>',
'productId' => '<string>',
'status' => 'ACTIVE|IN_PROGRESS|FAILED',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiSelectionConfiguration
-
- Type: ApiSelectionConfiguration structure
How Managed APIs are selected for the product.
- description
-
- Type: string
A description of the product, up to 1024 characters.
- displayName
-
- Required: Yes
- Type: string
The name of the product, from 1 to 255 characters.
- displayOrder
-
- Type: DisplayOrder structure
The order of the product's pages and API page sections in the portal navigation.
- failureReason
-
- Type: string
Reason a product's rules could not be fully applied, present only when
statusisFAILED. New reasons may be added over time, so clients MUST treat any unrecognized value asUNKNOWNand fall back to generic handling. - productArn
-
- Required: Yes
- Type: string
The ARN of the product.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- status
-
- Type: 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.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
CreateProductApiPage
$result = $client->createProductApiPage([/* ... */]); $promise = $client->createProductApiPageAsync([/* ... */]);
Creates an API page that documents a Managed API in a product. The page content is generated asynchronously. Use status to track it.
Parameter Syntax
$result = $client->createProductApiPage([
'displayContent' => [
'none' => [
],
'overrides' => [
'apiUrl' => '<string>',
'body' => '<string>',
'operationName' => '<string>',
],
],
'managedApiId' => '<string>', // REQUIRED
'productId' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
'tryItState' => 'ENABLED|DISABLED',
]);
Parameter Details
Members
- displayContent
-
- Type: ApiPageDisplayContent structure
Exactly one of the members is set:
noneto use default display content, oroverridesto customize it. Modeled as a union so the "exactly one" choice is enforced by type. - managedApiId
-
- Required: Yes
- Type: string
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.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- tryItState
-
- Type: string
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.
Result Syntax
[
'apiId' => [
'identifierParts' => [
'method' => '<string>',
'path' => '<string>',
'resourceArn' => '<string>',
],
],
'displayContent' => [
'apiUrl' => '<string>',
'body' => '<string>',
'operationName' => '<string>',
],
'productApiPageArn' => '<string>',
'productApiPageId' => '<string>',
'status' => 'AVAILABLE|IN_PROGRESS|FAILED',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|RESOURCE_DELETED|MEMBER_LEFT_ORG',
'message' => '<string>',
],
'tags' => ['<string>', ...],
'tryItState' => 'ENABLED|DISABLED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiId
-
- Required: Yes
- Type: ApiId structure
The API the page documents.
- displayContent
-
- Required: Yes
- Type: ApiPageDisplayContentResponse structure
The content shown on the page.
- productApiPageArn
-
- Required: Yes
- Type: string
The ARN of the API page.
- productApiPageId
-
- Required: Yes
- Type: string
The identifier of the API page.
- status
-
- Required: Yes
- Type: string
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED. - statusException
-
- Type: ProductApiPageStatusException structure
Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- tryItState
-
- Required: Yes
- Type: string
Whether Try-It is enabled on the page.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
CreateProductPage
$result = $client->createProductPage([/* ... */]); $promise = $client->createProductPageAsync([/* ... */]);
Creates a product page with free-form documentation. A product can have up to 40 pages.
Parameter Syntax
$result = $client->createProductPage([
'displayContent' => [ // REQUIRED
'body' => '<string>', // REQUIRED
'title' => '<string>', // REQUIRED
],
'productId' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- displayContent
-
- Required: Yes
- Type: DisplayContent structure
The title and body of the page.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[
'displayContent' => [
'body' => '<string>',
'title' => '<string>',
],
'productPageArn' => '<string>',
'productPageId' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- displayContent
-
- Type: DisplayContent structure
The title and body of the page.
- productPageArn
-
- Required: Yes
- Type: string
The ARN of the product page.
- productPageId
-
- Required: Yes
- Type: string
The identifier of the product page.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
DeleteDiscoveryConfiguration
$result = $client->deleteDiscoveryConfiguration([/* ... */]); $promise = $client->deleteDiscoveryConfigurationAsync([/* ... */]);
Deletes the discovery configuration and stops any running discovery.
Parameter Syntax
$result = $client->deleteDiscoveryConfiguration([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
DeleteManagedApi
$result = $client->deleteManagedApi([/* ... */]); $promise = $client->deleteManagedApiAsync([/* ... */]);
Deletes a Managed API.
Parameter Syntax
$result = $client->deleteManagedApi([
'managedApiId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- managedApiId
-
- Required: Yes
- Type: string
The identifier of the Managed API.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
DeleteOrganizationDiscoveryConfiguration
$result = $client->deleteOrganizationDiscoveryConfiguration([/* ... */]); $promise = $client->deleteOrganizationDiscoveryConfigurationAsync([/* ... */]);
Deletes the organization-wide discovery configuration and stops any running discovery across the organization. Only the organization management account may call this operation.
Parameter Syntax
$result = $client->deleteOrganizationDiscoveryConfiguration([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
DeletePortal
$result = $client->deletePortal([/* ... */]); $promise = $client->deletePortalAsync([/* ... */]);
Deletes a portal.
Parameter Syntax
$result = $client->deletePortal([
'portalId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
DeleteProduct
$result = $client->deleteProduct([/* ... */]); $promise = $client->deleteProductAsync([/* ... */]);
Deletes a product.
Parameter Syntax
$result = $client->deleteProduct([
'productId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
DeleteProductApiPage
$result = $client->deleteProductApiPage([/* ... */]); $promise = $client->deleteProductApiPageAsync([/* ... */]);
Deletes an API page.
Parameter Syntax
$result = $client->deleteProductApiPage([
'productApiPageId' => '<string>', // REQUIRED
'productId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- productApiPageId
-
- Required: Yes
- Type: string
The identifier of the API page.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
DeleteProductPage
$result = $client->deleteProductPage([/* ... */]); $promise = $client->deleteProductPageAsync([/* ... */]);
Deletes a product page.
Parameter Syntax
$result = $client->deleteProductPage([
'productId' => '<string>', // REQUIRED
'productPageId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- productPageId
-
- Required: Yes
- Type: string
The identifier of the product page.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
DeleteProductSharingPolicy
$result = $client->deleteProductSharingPolicy([/* ... */]); $promise = $client->deleteProductSharingPolicyAsync([/* ... */]);
Deletes the sharing policy of a product. The product is no longer shared.
Parameter Syntax
$result = $client->deleteProductSharingPolicy([
'productId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
DisassociateManagedApis
$result = $client->disassociateManagedApis([/* ... */]); $promise = $client->disassociateManagedApisAsync([/* ... */]);
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).
Parameter Syntax
$result = $client->disassociateManagedApis([
'managedApiIds' => ['<string>', ...], // REQUIRED
'productId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- managedApiIds
-
- Required: Yes
- Type: Array of strings
Bounded list of Managed API IDs, used as the request payload for batch associate/disassociate.
- productId
-
- Required: Yes
- Type: string
The identifier of the product to disassociate the Managed APIs from.
Result Syntax
[
'failedItems' => [
[
'errorCode' => 'MANAGED_API_NOT_FOUND|INTERNAL_ERROR',
'errorMessage' => '<string>',
'managedApiId' => '<string>',
],
// ...
],
]
Result Details
Members
- failedItems
-
- Required: Yes
- Type: Array of FailedManagedApiItem structures
The Managed APIs that could not be processed. IDs not listed here succeeded.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
GetApiInventoryItem
$result = $client->getApiInventoryItem([/* ... */]); $promise = $client->getApiInventoryItemAsync([/* ... */]);
Gets full details of a single API inventory item.
Parameter Syntax
$result = $client->getApiInventoryItem([
'host' => '<string>', // REQUIRED
'method' => 'GET|POST|PUT|DELETE|PATCH|ANY|HEAD|OPTIONS', // REQUIRED
'path' => '<string>', // REQUIRED
'port' => <integer>, // REQUIRED
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- host
-
- Required: Yes
- Type: 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. - method
-
- Required: Yes
- Type: string
The HTTP method of the API.
- path
-
- Required: Yes
- Type: string
The request path of the API.
- port
-
- Required: Yes
- Type: int
The port the API listens on, from 0 to 65535.
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.
Result Syntax
[
'item' => [
'accountId' => '<string>',
'classification' => 'SHADOW|MANAGED|MANAGED_ZOMBIE|MANAGED_ORPHANED',
'discoverySource' => 'API_GATEWAY|ELB|CLOUDFRONT',
'host' => '<string>',
'managedApiId' => '<string>',
'managedBy' => 'SELF|ORGANIZATION',
'method' => 'GET|POST|PUT|DELETE|PATCH|ANY|HEAD|OPTIONS',
'path' => '<string>',
'port' => <integer>,
'region' => '<string>',
'resourceArn' => '<string>',
'visibility' => 'PUBLIC|PRIVATE',
'wafStatus' => 'ENABLED|DISABLED',
'workloads' => ['<string>', ...],
],
]
Result Details
Members
- item
-
- Required: Yes
- Type: ApiInventoryItemDetail structure
The details of the API inventory item.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
GetDiscoveryConfiguration
$result = $client->getDiscoveryConfiguration([/* ... */]); $promise = $client->getDiscoveryConfigurationAsync([/* ... */]);
Retrieves the discovery configuration for the account and region.
Parameter Syntax
$result = $client->getDiscoveryConfiguration([ ]);
Parameter Details
Members
Result Syntax
[
'discoveryConfiguration' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'discoverySources' => ['<string>', ...],
'excludedResources' => ['<string>', ...],
'features' => ['<string>', ...],
'status' => 'DISABLED|ENABLED|UPDATING',
'updatedAt' => <DateTime>,
],
'tags' => ['<string>', ...],
]
Result Details
Members
- discoveryConfiguration
-
- Required: Yes
- Type: DiscoveryConfigurationData structure
The discovery configuration for the account.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
GetManagedApi
$result = $client->getManagedApi([/* ... */]); $promise = $client->getManagedApiAsync([/* ... */]);
Returns a Managed API, including its security posture findings.
Parameter Syntax
$result = $client->getManagedApi([
'managedApiId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- managedApiId
-
- Required: Yes
- Type: string
The identifier of the Managed API.
Result Syntax
[
'apiSignature' => [
'hostname' => '<string>',
'method' => 'GET|POST|PUT|DELETE|PATCH|ANY|HEAD|OPTIONS',
'path' => '<string>',
'port' => <integer>,
'resourceArn' => '<string>',
],
'createdAt' => <DateTime>,
'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>,
],
// ...
],
'managedApiArn' => '<string>',
'managedApiId' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiSignature
-
- Required: Yes
- Type: ApiSignature structure
The attributes that identify the API.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was created.
- findings
-
- Type: Array of ManagedApiFinding structures
The security posture findings for the API, up to 100.
- managedApiArn
-
- Required: Yes
- Type: string
The ARN of the Managed API.
- managedApiId
-
- Required: Yes
- Type: string
The identifier of the Managed API.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
GetOrganizationDiscoveryConfiguration
$result = $client->getOrganizationDiscoveryConfiguration([/* ... */]); $promise = $client->getOrganizationDiscoveryConfigurationAsync([/* ... */]);
Retrieves the organization-wide discovery configuration. Only the organization management account and registered delegated administrators may call this operation.
Parameter Syntax
$result = $client->getOrganizationDiscoveryConfiguration([ ]);
Parameter Details
Members
Result Syntax
[
'discoveryConfiguration' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'discoveryFilters' => [
'exclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
],
'inclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
],
],
'discoverySources' => ['<string>', ...],
'exclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
],
'features' => ['<string>', ...],
'status' => 'DISABLED|ENABLED|UPDATING',
'updatedAt' => <DateTime>,
],
'tags' => ['<string>', ...],
]
Result Details
Members
- discoveryConfiguration
-
- Required: Yes
- Type: OrganizationDiscoveryConfigurationData structure
The discovery configuration for the organization.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
GetPortal
$result = $client->getPortal([/* ... */]); $promise = $client->getPortalAsync([/* ... */]);
Returns the configuration, publish status, and preview status of a portal.
Parameter Syntax
$result = $client->getPortal([
'portalId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
Result Syntax
[
'authorization' => [
'authorizationConfig' => [
'cognitoConfig' => [
'appClientId' => '<string>',
'identityPoolId' => '<string>',
'userPoolArn' => '<string>',
'userPoolDomain' => '<string>',
],
'none' => [
],
],
'fineGrainedAccessControl' => 'ENABLED|DISABLED',
],
'endpointConfiguration' => [
'certificateArn' => '<string>',
'domainName' => '<string>',
'portalDefaultDomainName' => '<string>',
'portalDomainHostedZoneId' => '<string>',
],
'includedProductArns' => ['<string>', ...],
'portalArn' => '<string>',
'portalContent' => [
'description' => '<string>',
'displayName' => '<string>',
'theme' => [
'customColors' => [
'accentColor' => '<string>',
'backgroundColor' => '<string>',
'errorValidationColor' => '<string>',
'headerColor' => '<string>',
'navigationColor' => '<string>',
'textColor' => '<string>',
],
'logoUploadedAt' => <DateTime>,
],
],
'portalId' => '<string>',
'preview' => [
'previewStatus' => 'PREVIEW_IN_PROGRESS|PREVIEW_FAILED|PREVIEW_READY',
'previewUrl' => '<string>',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|UNSHARED_PRODUCT_EXCEPTION|CLOUDFRONT_DOMAIN_IN_USE|MISSING_CLOUDFRONT_PERMISSIONS',
'message' => '<string>',
],
],
'publishDescription' => '<string>',
'publishStatus' => 'PUBLISHED|PUBLISH_IN_PROGRESS|PUBLISH_FAILED|DISABLE_IN_PROGRESS|DISABLE_FAILED|DISABLED',
'publishedAt' => <DateTime>,
'rumAppMonitorName' => '<string>',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|UNSHARED_PRODUCT_EXCEPTION|CLOUDFRONT_DOMAIN_IN_USE|MISSING_CLOUDFRONT_PERMISSIONS',
'message' => '<string>',
],
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- authorization
-
- Required: Yes
- Type: Authorization structure
How readers sign in to the portal, and whether fine-grained access control is on.
- endpointConfiguration
-
- Required: Yes
- Type: EndpointConfigurationResponse structure
The domain configuration of the portal.
- includedProductArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the products the portal includes.
- portalArn
-
- Required: Yes
- Type: string
The ARN of the portal.
- portalContent
-
- Required: Yes
- Type: PortalContent structure
The portal's display name, description, and theme.
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
- preview
-
- Type: Preview structure
The most recent preview of the portal. Absent if no preview has been created.
- publishDescription
-
- Type: string
The description supplied with the most recent publish request.
- publishStatus
-
- Type: string
The publish status of the portal. Absent if the portal has never been published.
- publishedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the portal was last published.
- rumAppMonitorName
-
- Type: string
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
- statusException
-
- Type: PortalStatusException structure
Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
GetProduct
$result = $client->getProduct([/* ... */]); $promise = $client->getProductAsync([/* ... */]);
Returns a product. To read a product shared with you by another account, supply resourceOwnerAccountId.
Parameter Syntax
$result = $client->getProduct([
'productId' => '<string>', // REQUIRED
'resourceOwnerAccountId' => '<string>',
]);
Parameter Details
Members
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- resourceOwnerAccountId
-
- Type: string
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.
Result Syntax
[
'apiSelectionConfiguration' => [
'apiSelectionMode' => 'CUSTOM|RULE_BASED',
'ruleFilters' => [
[
'key' => 'RESOURCE_ARN|HOST|METHOD|PATH|PORT|ACCOUNT',
'values' => ['<string>', ...],
],
// ...
],
],
'description' => '<string>',
'displayName' => '<string>',
'displayOrder' => [
'contents' => [
[
'productApiPageArns' => ['<string>', ...],
'sectionName' => '<string>',
],
// ...
],
'overviewPageArn' => '<string>',
'productPageArns' => ['<string>', ...],
],
'failureReason' => 'API_PAGE_ATTACHED|EVALUATION_ERROR',
'productArn' => '<string>',
'productId' => '<string>',
'status' => 'ACTIVE|IN_PROGRESS|FAILED',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiSelectionConfiguration
-
- Type: ApiSelectionConfiguration structure
How Managed APIs are selected for the product.
- description
-
- Required: Yes
- Type: string
A description of the product, up to 1024 characters.
- displayName
-
- Required: Yes
- Type: string
The name of the product, from 1 to 255 characters.
- displayOrder
-
- Required: Yes
- Type: DisplayOrder structure
The order of the product's pages and API page sections in the portal navigation.
- failureReason
-
- Type: string
Reason a product's rules could not be fully applied, present only when
statusisFAILED. New reasons may be added over time, so clients MUST treat any unrecognized value asUNKNOWNand fall back to generic handling. - productArn
-
- Required: Yes
- Type: string
The ARN of the product.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- status
-
- Type: 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.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
GetProductApiPage
$result = $client->getProductApiPage([/* ... */]); $promise = $client->getProductApiPageAsync([/* ... */]);
Returns an API page, including its body.
Parameter Syntax
$result = $client->getProductApiPage([
'includeRawDisplayContent' => true || false,
'productApiPageId' => '<string>', // REQUIRED
'productId' => '<string>', // REQUIRED
'resourceOwnerAccountId' => '<string>',
]);
Parameter Details
Members
- includeRawDisplayContent
-
- Type: boolean
Set to
trueto also return the page body inrawDisplayContent. - productApiPageId
-
- Required: Yes
- Type: string
The identifier of the API page.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- resourceOwnerAccountId
-
- Type: string
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.
Result Syntax
[
'apiId' => [
'identifierParts' => [
'method' => '<string>',
'path' => '<string>',
'resourceArn' => '<string>',
],
],
'displayContent' => [
'apiUrl' => '<string>',
'body' => '<string>',
'operationName' => '<string>',
],
'productApiPageArn' => '<string>',
'productApiPageId' => '<string>',
'rawDisplayContent' => '<string>',
'status' => 'AVAILABLE|IN_PROGRESS|FAILED',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|RESOURCE_DELETED|MEMBER_LEFT_ORG',
'message' => '<string>',
],
'tags' => ['<string>', ...],
'tryItState' => 'ENABLED|DISABLED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiId
-
- Required: Yes
- Type: ApiId structure
The API the page documents.
- displayContent
-
- Required: Yes
- Type: ApiPageDisplayContentResponse structure
The content shown on the page.
- productApiPageArn
-
- Required: Yes
- Type: string
The ARN of the API page.
- productApiPageId
-
- Required: Yes
- Type: string
The identifier of the API page.
- rawDisplayContent
-
- Type: string
The Markdown body of the page. Returned only when
includeRawDisplayContentistrue. - status
-
- Required: Yes
- Type: string
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED. - statusException
-
- Type: ProductApiPageStatusException structure
Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- tryItState
-
- Required: Yes
- Type: string
Whether Try-It is enabled on the page.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
GetProductPage
$result = $client->getProductPage([/* ... */]); $promise = $client->getProductPageAsync([/* ... */]);
Returns a product page, including its body.
Parameter Syntax
$result = $client->getProductPage([
'productId' => '<string>', // REQUIRED
'productPageId' => '<string>', // REQUIRED
'resourceOwnerAccountId' => '<string>',
]);
Parameter Details
Members
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- productPageId
-
- Required: Yes
- Type: string
The identifier of the product page.
- resourceOwnerAccountId
-
- Type: string
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.
Result Syntax
[
'displayContent' => [
'body' => '<string>',
'title' => '<string>',
],
'productPageArn' => '<string>',
'productPageId' => '<string>',
'tags' => ['<string>', ...],
'updatedAt' => <DateTime>,
]
Result Details
Members
- displayContent
-
- Required: Yes
- Type: DisplayContent structure
The title and body of the page.
- productPageArn
-
- Required: Yes
- Type: string
The ARN of the product page.
- productPageId
-
- Required: Yes
- Type: string
The identifier of the product page.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
GetProductSharingPolicy
$result = $client->getProductSharingPolicy([/* ... */]); $promise = $client->getProductSharingPolicyAsync([/* ... */]);
Returns the sharing policy of a product.
Parameter Syntax
$result = $client->getProductSharingPolicy([
'productId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
Result Syntax
[
'policyDocument' => '<string>',
'productId' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
- policyDocument
-
- Required: Yes
- Type: string
The sharing policy as a JSON resource policy document.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
ListApiInventoryItems
$result = $client->listApiInventoryItems([/* ... */]); $promise = $client->listApiInventoryItemsAsync([/* ... */]);
Lists discovered API inventory items with filtering and pagination.
Parameter Syntax
$result = $client->listApiInventoryItems([
'filters' => [
'discoverySource' => 'API_GATEWAY|ELB|CLOUDFRONT',
'resourceArn' => '<string>',
],
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- filters
-
- Type: ApiInventoryFilters structure
Filters that limit the results. Omit it to list every discovered API.
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 100.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
Result Syntax
[
'items' => [
[
'accountId' => '<string>',
'classification' => 'SHADOW|MANAGED|MANAGED_ZOMBIE|MANAGED_ORPHANED',
'discoverySource' => 'API_GATEWAY|ELB|CLOUDFRONT',
'firstSeen' => <DateTime>,
'host' => '<string>',
'lastSeen' => <DateTime>,
'managedBy' => 'SELF|ORGANIZATION',
'method' => 'GET|POST|PUT|DELETE|PATCH|ANY|HEAD|OPTIONS',
'path' => '<string>',
'port' => <integer>,
'region' => '<string>',
'resourceArn' => '<string>',
'visibility' => 'PUBLIC|PRIVATE',
'wafStatus' => 'ENABLED|DISABLED',
'workloads' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of ApiInventoryItem structures
The discovered APIs in this page of results.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
ListDiscoveryStatuses
$result = $client->listDiscoveryStatuses([/* ... */]); $promise = $client->listDiscoveryStatusesAsync([/* ... */]);
Lists discovery statuses for services.
Parameter Syntax
$result = $client->listDiscoveryStatuses([
'discoverySource' => 'API_GATEWAY|ELB|CLOUDFRONT',
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- discoverySource
-
- Type: 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.
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 100.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
Result Syntax
[
'items' => [
[
'accountId' => '<string>',
'discoverySource' => 'API_GATEWAY|ELB|CLOUDFRONT',
'failureReason' => 'ACCESS_DENIED|DEPENDENCY_ERROR|THROTTLED|INVALID_CONFIGURATION|INTERNAL_ERROR',
'status' => 'STOPPED|PROVISIONING|RUNNING|FAILED',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of DiscoveryStatus structures
The discovery status for each account and discovery source.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
ListManagedApiEvents
$result = $client->listManagedApiEvents([/* ... */]); $promise = $client->listManagedApiEventsAsync([/* ... */]);
Lists API-security events for a single managed API, most recent first. Returns up to 20 of the most recent events (not paginated).
Parameter Syntax
$result = $client->listManagedApiEvents([
'managedApiId' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'startedAfter' => <integer || string || DateTime>,
'startedBefore' => <integer || string || DateTime>,
]);
Parameter Details
Members
- managedApiId
-
- Required: Yes
- Type: string
The identifier of the Managed API.
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 20.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
- startedAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- startedBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Exclusive upper bound on each event's start time; only events that started before this time are returned. Optional; defaults to the current time.
Result Syntax
[
'items' => [
[
'endedAt' => <DateTime>,
'eventId' => '<string>',
'eventType' => 'WAF_API_SECURITY',
'startedAt' => <DateTime>,
'status' => 'EVENT_STARTED|EVENT_IN_PROGRESS|EVENT_ENDED',
'updatedAt' => <DateTime>,
'wafApiSecurityEventDetail' => [
'category' => '<string>',
'confidence' => 'LOW|MEDIUM|HIGH',
'label' => '<string>',
'webAclArn' => '<string>',
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of ManagedApiEventSummary structures
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.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
ListManagedApis
$result = $client->listManagedApis([/* ... */]); $promise = $client->listManagedApisAsync([/* ... */]);
Lists the Managed APIs in your account.
Parameter Syntax
$result = $client->listManagedApis([
'maxResults' => <integer>,
'nextToken' => '<string>',
'productId' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 100.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
- productId
-
- Type: string
Optional filter: when supplied, only Managed APIs associated with this product are returned.
Result Syntax
[
'items' => [
[
'apiSignature' => [
'hostname' => '<string>',
'method' => 'GET|POST|PUT|DELETE|PATCH|ANY|HEAD|OPTIONS',
'path' => '<string>',
'port' => <integer>,
'resourceArn' => '<string>',
],
'createdAt' => <DateTime>,
'managedApiArn' => '<string>',
'managedApiId' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of ManagedApiSummary structures
The Managed APIs in this page of results.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
ListPortals
$result = $client->listPortals([/* ... */]); $promise = $client->listPortalsAsync([/* ... */]);
Lists the portals in your account.
Parameter Syntax
$result = $client->listPortals([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 100.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
Result Syntax
[
'items' => [
[
'authorization' => [
'authorizationConfig' => [
'cognitoConfig' => [
'appClientId' => '<string>',
'identityPoolId' => '<string>',
'userPoolArn' => '<string>',
'userPoolDomain' => '<string>',
],
'none' => [
],
],
'fineGrainedAccessControl' => 'ENABLED|DISABLED',
],
'endpointConfiguration' => [
'certificateArn' => '<string>',
'domainName' => '<string>',
'portalDefaultDomainName' => '<string>',
'portalDomainHostedZoneId' => '<string>',
],
'includedProductArns' => ['<string>', ...],
'portalArn' => '<string>',
'portalContent' => [
'description' => '<string>',
'displayName' => '<string>',
'theme' => [
'customColors' => [
'accentColor' => '<string>',
'backgroundColor' => '<string>',
'errorValidationColor' => '<string>',
'headerColor' => '<string>',
'navigationColor' => '<string>',
'textColor' => '<string>',
],
'logoUploadedAt' => <DateTime>,
],
],
'portalId' => '<string>',
'preview' => [
'previewStatus' => 'PREVIEW_IN_PROGRESS|PREVIEW_FAILED|PREVIEW_READY',
'previewUrl' => '<string>',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|UNSHARED_PRODUCT_EXCEPTION|CLOUDFRONT_DOMAIN_IN_USE|MISSING_CLOUDFRONT_PERMISSIONS',
'message' => '<string>',
],
],
'publishDescription' => '<string>',
'publishStatus' => 'PUBLISHED|PUBLISH_IN_PROGRESS|PUBLISH_FAILED|DISABLE_IN_PROGRESS|DISABLE_FAILED|DISABLED',
'publishedAt' => <DateTime>,
'rumAppMonitorName' => '<string>',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|UNSHARED_PRODUCT_EXCEPTION|CLOUDFRONT_DOMAIN_IN_USE|MISSING_CLOUDFRONT_PERMISSIONS',
'message' => '<string>',
],
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of PortalSummary structures
The portals in this page of results.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
ListProductApiPages
$result = $client->listProductApiPages([/* ... */]); $promise = $client->listProductApiPagesAsync([/* ... */]);
Lists the API pages in a product. The results do not include page bodies.
Parameter Syntax
$result = $client->listProductApiPages([
'maxResults' => <integer>,
'nextToken' => '<string>',
'productId' => '<string>', // REQUIRED
'resourceOwnerAccountId' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 100.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- resourceOwnerAccountId
-
- Type: string
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.
Result Syntax
[
'items' => [
[
'apiId' => [
'identifierParts' => [
'method' => '<string>',
'path' => '<string>',
'resourceArn' => '<string>',
],
],
'apiUrl' => '<string>',
'operationName' => '<string>',
'productApiPageArn' => '<string>',
'productApiPageId' => '<string>',
'status' => 'AVAILABLE|IN_PROGRESS|FAILED',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|RESOURCE_DELETED|MEMBER_LEFT_ORG',
'message' => '<string>',
],
'tryItState' => 'ENABLED|DISABLED',
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of ProductApiPageSummaryNoBody structures
The API pages in this page of results.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
ListProductPages
$result = $client->listProductPages([/* ... */]); $promise = $client->listProductPagesAsync([/* ... */]);
Lists the product pages in a product. The results do not include page bodies.
Parameter Syntax
$result = $client->listProductPages([
'maxResults' => <integer>,
'nextToken' => '<string>',
'productId' => '<string>', // REQUIRED
'resourceOwnerAccountId' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 100.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- resourceOwnerAccountId
-
- Type: string
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.
Result Syntax
[
'items' => [
[
'pageTitle' => '<string>',
'productPageArn' => '<string>',
'productPageId' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Required: Yes
- Type: Array of ProductPageSummaryNoBody structures
The product pages in this page of results.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
ListProducts
$result = $client->listProducts([/* ... */]); $promise = $client->listProductsAsync([/* ... */]);
Lists products you own, products shared with you, or both.
Parameter Syntax
$result = $client->listProducts([
'managedApiId' => '<string>',
'maxResults' => <integer>,
'nextToken' => '<string>',
'resourceOwner' => 'ALL|SELF|OTHER_ACCOUNTS',
]);
Parameter Details
Members
- managedApiId
-
- Type: string
Optional filter: when supplied, only Products this Managed API is associated with are returned.
- maxResults
-
- Type: int
The maximum number of results to return in one page, from 1 to 100.
- nextToken
-
- Type: string
The pagination token returned by a previous call. Omit it to get the first page.
- resourceOwner
-
- Type: string
Whose products to return:
SELFfor your own,OTHER_ACCOUNTSfor products shared with you, orALL. Defaults toALL, or toSELFwhenmanagedApiIdis supplied.
Result Syntax
[
'items' => [
[
'apiSelectionConfiguration' => [
'apiSelectionMode' => 'CUSTOM|RULE_BASED',
'ruleFilters' => [
[
'key' => 'RESOURCE_ARN|HOST|METHOD|PATH|PORT|ACCOUNT',
'values' => ['<string>', ...],
],
// ...
],
],
'description' => '<string>',
'displayName' => '<string>',
'failureReason' => 'API_PAGE_ATTACHED|EVALUATION_ERROR',
'productArn' => '<string>',
'productId' => '<string>',
'status' => 'ACTIVE|IN_PROGRESS|FAILED',
'updatedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- items
-
- Type: Array of ProductSummary structures
The products in this page of results.
- nextToken
-
- Type: string
The token to pass in the next request to get the next page. Absent when there are no more results.
Errors
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags for an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
PutDiscoveryConfiguration
$result = $client->putDiscoveryConfiguration([/* ... */]); $promise = $client->putDiscoveryConfigurationAsync([/* ... */]);
Creates or updates the discovery configuration
Parameter Syntax
$result = $client->putDiscoveryConfiguration([
'discoverySources' => ['<string>', ...],
'excludedResources' => ['<string>', ...],
'features' => ['<string>', ...],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- discoverySources
-
- Type: Array of strings
The sources to discover APIs from. Omitting it removes all sources, which stops discovery for this configuration.
- excludedResources
-
- Type: Array of strings
The ARNs of resources to leave out of discovery, up to 50.
- features
-
- Type: Array of strings
Optional capabilities to enable. Omitting it disables all of them, as with the other fields.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[
'discoveryConfiguration' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'discoverySources' => ['<string>', ...],
'excludedResources' => ['<string>', ...],
'features' => ['<string>', ...],
'status' => 'DISABLED|ENABLED|UPDATING',
'updatedAt' => <DateTime>,
],
'tags' => ['<string>', ...],
]
Result Details
Members
- discoveryConfiguration
-
- Required: Yes
- Type: DiscoveryConfigurationData structure
The discovery configuration for the account.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Errors
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
PutOrganizationDiscoveryConfiguration
$result = $client->putOrganizationDiscoveryConfiguration([/* ... */]); $promise = $client->putOrganizationDiscoveryConfigurationAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->putOrganizationDiscoveryConfiguration([
'discoveryFilters' => [
'exclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
],
'inclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
],
],
'discoverySources' => ['<string>', ...],
'exclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
],
'features' => ['<string>', ...],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- discoveryFilters
-
- Type: OrganizationDiscoveryFilters structure
The accounts or organizational units to include in or exclude from discovery.
- discoverySources
-
- Type: Array of strings
The sources to discover APIs from. Omitting it removes all sources, which stops discovery for this configuration.
- exclusionFilters
-
- Type: DiscoveryExclusionFilters structure
Exclusion filters for organization-scoped discovery. @deprecated. Remove this once client (Console) moves to discoveryFilters
- features
-
- Type: Array of strings
Optional capabilities to enable. Omitting it disables all of them, as with the other fields.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[
'discoveryConfiguration' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'discoveryFilters' => [
'exclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
],
'inclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
],
],
'discoverySources' => ['<string>', ...],
'exclusionFilters' => [
'accountIds' => ['<string>', ...],
'organizationalUnitIds' => ['<string>', ...],
'resourceArns' => ['<string>', ...],
],
'features' => ['<string>', ...],
'status' => 'DISABLED|ENABLED|UPDATING',
'updatedAt' => <DateTime>,
],
'tags' => ['<string>', ...],
]
Result Details
Members
- discoveryConfiguration
-
- Required: Yes
- Type: OrganizationDiscoveryConfigurationData structure
The discovery configuration for the organization.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Errors
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
PutProductSharingPolicy
$result = $client->putProductSharingPolicy([/* ... */]); $promise = $client->putProductSharingPolicyAsync([/* ... */]);
Creates or replaces the sharing policy of a product. The policy controls which other accounts can read the product.
Parameter Syntax
$result = $client->putProductSharingPolicy([
'policyDocument' => '<string>', // REQUIRED
'productId' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- policyDocument
-
- Required: Yes
- Type: string
The sharing policy as a JSON resource policy document.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
StartDiscovery
$result = $client->startDiscovery([/* ... */]); $promise = $client->startDiscoveryAsync([/* ... */]);
Starts the API discovery process.
Parameter Syntax
$result = $client->startDiscovery([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- id
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
StopDiscovery
$result = $client->stopDiscovery([/* ... */]); $promise = $client->stopDiscoveryAsync([/* ... */]);
Stops the running API discovery process.
Parameter Syntax
$result = $client->stopDiscovery([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- id
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
- InternalServerException:
The service encountered an internal error. Try the request again.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds or updates tags on an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
Up to 50 tags per request, matching API Gateway's limit of 50 tags per resource.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the tags to remove, up to 50.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
UpdatePortal
$result = $client->updatePortal([/* ... */]); $promise = $client->updatePortalAsync([/* ... */]);
Updates a portal. Only the fields supplied in the request are changed.
Parameter Syntax
$result = $client->updatePortal([
'authorization' => [
'authorizationConfig' => [ // REQUIRED
'cognitoConfig' => [
'appClientId' => '<string>', // REQUIRED
'identityPoolId' => '<string>',
'userPoolArn' => '<string>', // REQUIRED
'userPoolDomain' => '<string>', // REQUIRED
],
'none' => [
],
],
'fineGrainedAccessControl' => 'ENABLED|DISABLED', // REQUIRED
],
'endpointConfiguration' => [
'acmManaged' => [
'certificateArn' => '<string>', // REQUIRED
'domainName' => '<string>', // REQUIRED
],
'none' => [
],
],
'includedProductArns' => ['<string>', ...],
'logoUri' => '<string>',
'portalContent' => [
'description' => '<string>',
'displayName' => '<string>', // REQUIRED
'theme' => [ // REQUIRED
'customColors' => [ // REQUIRED
'accentColor' => '<string>', // REQUIRED
'backgroundColor' => '<string>', // REQUIRED
'errorValidationColor' => '<string>', // REQUIRED
'headerColor' => '<string>', // REQUIRED
'navigationColor' => '<string>', // REQUIRED
'textColor' => '<string>', // REQUIRED
],
'logoUploadedAt' => <integer || string || DateTime>,
],
],
'portalId' => '<string>', // REQUIRED
'rumAppMonitorName' => '<string>',
]);
Parameter Details
Members
- authorization
-
- Type: Authorization structure
The new authorization settings. Omit it to keep the current settings.
- endpointConfiguration
-
- Type: EndpointConfigurationRequest structure
Exactly one of the members is set:
nonefor no custom domain, oracmManagedto bring a domain + ACM certificate. Modeled as a union so the "exactly one" choice is enforced by type. - includedProductArns
-
- Type: Array of strings
The new list of product ARNs, up to 200. It replaces the current list. Omit it to keep the current list.
- logoUri
-
- Type: string
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. - portalContent
-
- Type: PortalContent structure
The new display name, description, and theme. Omit it to keep the current values.
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
- rumAppMonitorName
-
- Type: string
The new CloudWatch RUM app monitor name. Omit it to keep the current value.
Result Syntax
[
'authorization' => [
'authorizationConfig' => [
'cognitoConfig' => [
'appClientId' => '<string>',
'identityPoolId' => '<string>',
'userPoolArn' => '<string>',
'userPoolDomain' => '<string>',
],
'none' => [
],
],
'fineGrainedAccessControl' => 'ENABLED|DISABLED',
],
'endpointConfiguration' => [
'certificateArn' => '<string>',
'domainName' => '<string>',
'portalDefaultDomainName' => '<string>',
'portalDomainHostedZoneId' => '<string>',
],
'includedProductArns' => ['<string>', ...],
'portalArn' => '<string>',
'portalContent' => [
'description' => '<string>',
'displayName' => '<string>',
'theme' => [
'customColors' => [
'accentColor' => '<string>',
'backgroundColor' => '<string>',
'errorValidationColor' => '<string>',
'headerColor' => '<string>',
'navigationColor' => '<string>',
'textColor' => '<string>',
],
'logoUploadedAt' => <DateTime>,
],
],
'portalId' => '<string>',
'preview' => [
'previewStatus' => 'PREVIEW_IN_PROGRESS|PREVIEW_FAILED|PREVIEW_READY',
'previewUrl' => '<string>',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|UNSHARED_PRODUCT_EXCEPTION|CLOUDFRONT_DOMAIN_IN_USE|MISSING_CLOUDFRONT_PERMISSIONS',
'message' => '<string>',
],
],
'publishDescription' => '<string>',
'publishStatus' => 'PUBLISHED|PUBLISH_IN_PROGRESS|PUBLISH_FAILED|DISABLE_IN_PROGRESS|DISABLE_FAILED|DISABLED',
'publishedAt' => <DateTime>,
'rumAppMonitorName' => '<string>',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|UNSHARED_PRODUCT_EXCEPTION|CLOUDFRONT_DOMAIN_IN_USE|MISSING_CLOUDFRONT_PERMISSIONS',
'message' => '<string>',
],
'updatedAt' => <DateTime>,
]
Result Details
Members
- authorization
-
- Required: Yes
- Type: Authorization structure
How readers sign in to the portal, and whether fine-grained access control is on.
- endpointConfiguration
-
- Required: Yes
- Type: EndpointConfigurationResponse structure
The domain configuration of the portal.
- includedProductArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the products the portal includes.
- portalArn
-
- Required: Yes
- Type: string
The ARN of the portal.
- portalContent
-
- Required: Yes
- Type: PortalContent structure
The portal's display name, description, and theme.
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
- preview
-
- Type: Preview structure
The most recent preview of the portal. Absent if no preview has been created.
- publishDescription
-
- Type: string
The description supplied with the most recent publish request.
- publishStatus
-
- Type: string
The publish status of the portal. Absent if the portal has never been published.
- publishedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the portal was last published.
- rumAppMonitorName
-
- Type: string
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
- statusException
-
- Type: PortalStatusException structure
Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
UpdatePortalPublishStatus
$result = $client->updatePortalPublishStatus([/* ... */]); $promise = $client->updatePortalPublishStatusAsync([/* ... */]);
Publishes or disables a portal. The change runs asynchronously. Use GetPortal to track publishStatus.
Parameter Syntax
$result = $client->updatePortalPublishStatus([
'description' => '<string>',
'portalId' => '<string>', // REQUIRED
'status' => 'PUBLISHED|DISABLED', // REQUIRED
]);
Parameter Details
Members
- description
-
- Type: string
A description of this publish request, up to 1024 characters.
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
- status
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- ConflictException:
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
UpdateProduct
$result = $client->updateProduct([/* ... */]); $promise = $client->updateProductAsync([/* ... */]);
Updates a product. Only the fields supplied in the request are changed.
Parameter Syntax
$result = $client->updateProduct([
'apiSelectionConfiguration' => [
'apiSelectionMode' => 'CUSTOM|RULE_BASED', // REQUIRED
'ruleFilters' => [
[
'key' => 'RESOURCE_ARN|HOST|METHOD|PATH|PORT|ACCOUNT', // REQUIRED
'values' => ['<string>', ...], // REQUIRED
],
// ...
],
],
'description' => '<string>',
'displayName' => '<string>',
'displayOrder' => [
'contents' => [
[
'productApiPageArns' => ['<string>', ...],
'sectionName' => '<string>',
],
// ...
],
'overviewPageArn' => '<string>',
'productPageArns' => ['<string>', ...],
],
'productId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- apiSelectionConfiguration
-
- Type: ApiSelectionConfiguration structure
The new API selection settings. The selection mode must match the mode the product was created with. Omit it to keep the current settings.
- description
-
- Type: string
The new description of the product. Omit it to keep the current description.
- displayName
-
- Type: string
The new name of the product. Omit it to keep the current name.
- displayOrder
-
- Type: DisplayOrder structure
The new page order. Omit it to keep the current order.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
Result Syntax
[
'apiSelectionConfiguration' => [
'apiSelectionMode' => 'CUSTOM|RULE_BASED',
'ruleFilters' => [
[
'key' => 'RESOURCE_ARN|HOST|METHOD|PATH|PORT|ACCOUNT',
'values' => ['<string>', ...],
],
// ...
],
],
'description' => '<string>',
'displayName' => '<string>',
'displayOrder' => [
'contents' => [
[
'productApiPageArns' => ['<string>', ...],
'sectionName' => '<string>',
],
// ...
],
'overviewPageArn' => '<string>',
'productPageArns' => ['<string>', ...],
],
'failureReason' => 'API_PAGE_ATTACHED|EVALUATION_ERROR',
'productArn' => '<string>',
'productId' => '<string>',
'status' => 'ACTIVE|IN_PROGRESS|FAILED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiSelectionConfiguration
-
- Type: ApiSelectionConfiguration structure
How Managed APIs are selected for the product.
- description
-
- Type: string
A description of the product, up to 1024 characters.
- displayName
-
- Required: Yes
- Type: string
The name of the product, from 1 to 255 characters.
- displayOrder
-
- Type: DisplayOrder structure
The order of the product's pages and API page sections in the portal navigation.
- failureReason
-
- Type: string
Reason a product's rules could not be fully applied, present only when
statusisFAILED. New reasons may be added over time, so clients MUST treat any unrecognized value asUNKNOWNand fall back to generic handling. - productArn
-
- Required: Yes
- Type: string
The ARN of the product.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- status
-
- Type: 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.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
UpdateProductApiPage
$result = $client->updateProductApiPage([/* ... */]); $promise = $client->updateProductApiPageAsync([/* ... */]);
Updates an API page. Only the fields supplied in the request are changed.
Parameter Syntax
$result = $client->updateProductApiPage([
'displayContent' => [
'none' => [
],
'overrides' => [
'apiUrl' => '<string>',
'body' => '<string>',
'operationName' => '<string>',
],
],
'productApiPageId' => '<string>', // REQUIRED
'productId' => '<string>', // REQUIRED
'tryItState' => 'ENABLED|DISABLED',
]);
Parameter Details
Members
- displayContent
-
- Type: ApiPageDisplayContent structure
Exactly one of the members is set:
noneto use default display content, oroverridesto customize it. Modeled as a union so the "exactly one" choice is enforced by type. - productApiPageId
-
- Required: Yes
- Type: string
The identifier of the API page.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- tryItState
-
- Type: string
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.
Result Syntax
[
'apiId' => [
'identifierParts' => [
'method' => '<string>',
'path' => '<string>',
'resourceArn' => '<string>',
],
],
'displayContent' => [
'apiUrl' => '<string>',
'body' => '<string>',
'operationName' => '<string>',
],
'productApiPageArn' => '<string>',
'productApiPageId' => '<string>',
'status' => 'AVAILABLE|IN_PROGRESS|FAILED',
'statusException' => [
'exception' => 'INTERNAL_FAILURE|RESOURCE_DELETED|MEMBER_LEFT_ORG',
'message' => '<string>',
],
'tryItState' => 'ENABLED|DISABLED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- apiId
-
- Required: Yes
- Type: ApiId structure
The API the page documents.
- displayContent
-
- Required: Yes
- Type: ApiPageDisplayContentResponse structure
The content shown on the page.
- productApiPageArn
-
- Required: Yes
- Type: string
The ARN of the API page.
- productApiPageId
-
- Required: Yes
- Type: string
The identifier of the API page.
- status
-
- Required: Yes
- Type: string
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED. - statusException
-
- Type: ProductApiPageStatusException structure
Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.
- tryItState
-
- Required: Yes
- Type: string
Whether Try-It is enabled on the page.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
UpdateProductPage
$result = $client->updateProductPage([/* ... */]); $promise = $client->updateProductPageAsync([/* ... */]);
Updates a product page.
Parameter Syntax
$result = $client->updateProductPage([
'displayContent' => [
'body' => '<string>', // REQUIRED
'title' => '<string>', // REQUIRED
],
'productId' => '<string>', // REQUIRED
'productPageId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- displayContent
-
- Type: DisplayContent structure
The new title and body of the page. Omit it to keep the current content.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- productPageId
-
- Required: Yes
- Type: string
The identifier of the product page.
Result Syntax
[
'displayContent' => [
'body' => '<string>',
'title' => '<string>',
],
'productPageArn' => '<string>',
'productPageId' => '<string>',
'updatedAt' => <DateTime>,
]
Result Details
Members
- displayContent
-
- Type: DisplayContent structure
The title and body of the page.
- productPageArn
-
- Required: Yes
- Type: string
The ARN of the product page.
- productPageId
-
- Required: Yes
- Type: string
The identifier of the product page.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
Errors
- ResourceNotFoundException:
The requested resource does not exist, or you do not have access to it.
- LimitExceededException:
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
- BadRequestException:
The request is not valid. The message identifies the field or value that failed validation.
- AccessDeniedException:
You do not have permission to perform this operation.
Shapes
ACMManaged
Description
A custom domain for the portal and the ACM certificate that covers it.
Members
- certificateArn
-
- Required: Yes
- Type: string
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.
- domainName
-
- Required: Yes
- Type: string
The custom domain name for the portal.
AccessDeniedException
Description
You do not have permission to perform this operation.
Members
- message
-
- Required: Yes
- Type: string
ApiId
Description
Identifies the API an API page documents.
Members
- identifierParts
-
- Type: IdentifierParts structure
The resource, method, and path that identify the API.
ApiInventoryFilters
Description
Filters for listing API inventory items. All supplied filters must match.
Members
- discoverySource
-
- Type: 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
-
- Type: string
Return only APIs served by this resource.
ApiInventoryItem
Description
An API found by discovery.
Members
- accountId
-
- Required: Yes
- Type: string
The AWS account ID that owns the API.
- classification
-
- Type: 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.
- discoverySource
-
- Required: Yes
- Type: 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
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When discovery first observed the API.
- host
-
- Required: Yes
- Type: 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. - lastSeen
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When discovery most recently observed the API.
- managedBy
-
- Type: 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.
- method
-
- Required: Yes
- Type: string
The HTTP method of the API.
- path
-
- Required: Yes
- Type: string
The request path of the API.
- port
-
- Required: Yes
- Type: int
The port the API listens on, from 0 to 65535.
- region
-
- Required: Yes
- Type: string
The AWS Region the API was discovered in.
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.
- visibility
-
- Type: string
Whether a discovered API is reachable publicly or only from within a private network.
- wafStatus
-
- Type: string
Whether a WAF web ACL is attached to the API's front-door service.
- workloads
-
- Type: Array of strings
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.
ApiInventoryItemDetail
Description
The full details of an API found by discovery.
Members
- accountId
-
- Required: Yes
- Type: string
The AWS account ID that owns the API.
- classification
-
- Type: 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.
- discoverySource
-
- Required: Yes
- Type: 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.
- host
-
- Required: Yes
- Type: 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. - managedApiId
-
- Type: string
The identifier of the Managed API created from this API. Absent if there is none.
- managedBy
-
- Type: 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.
- method
-
- Required: Yes
- Type: string
The HTTP method of the API.
- path
-
- Required: Yes
- Type: string
The request path of the API.
- port
-
- Required: Yes
- Type: int
The port the API listens on, from 0 to 65535.
- region
-
- Required: Yes
- Type: string
The AWS Region the API was discovered in.
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.
- visibility
-
- Type: string
Whether a discovered API is reachable publicly or only from within a private network.
- wafStatus
-
- Type: string
Whether a WAF web ACL is attached to the API's front-door service.
- workloads
-
- Type: Array of strings
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.
ApiPageDisplayContent
Description
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.
Members
- none
-
- Type: None structure
Use the content generated from the Managed API.
- overrides
-
- Type: DisplayContentOverrides structure
Replace the generated content with your own.
ApiPageDisplayContentResponse
Description
The content shown on an API page.
Members
- apiUrl
-
- Required: Yes
- Type: string
The invoke URL shown on the page and used by Try-It.
- body
-
- Type: string
The Markdown body of the page. Absent while the page is
IN_PROGRESS. - operationName
-
- Type: string
The operation name shown as the page title.
ApiSelectionConfiguration
Description
How Managed APIs are selected for a product. With CUSTOM, you associate APIs yourself. With RULE_BASED, the APIs that match ruleFilters are selected.
Members
- apiSelectionMode
-
- Required: Yes
- Type: 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
-
- Type: Array of RuleFilter structures
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.
ApiSignature
Description
The attributes that identify an API.
Members
- hostname
-
- Required: Yes
- Type: string
The host name the API is served on.
- method
-
- Required: Yes
- Type: string
The HTTP method of the API.
- path
-
- Required: Yes
- Type: string
The request path of the API.
- port
-
- Required: Yes
- Type: int
The port the API listens on, from 0 to 65535.
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that serves the API.
Authorization
Description
How readers sign in to a portal.
Members
- authorizationConfig
-
- Required: Yes
- Type: AuthorizationConfig structure
Exactly one of the members is set:
nonefor no authorization, orcognitoConfigfor Cognito. Modeled as a union so the "exactly one" choice is enforced by type. - fineGrainedAccessControl
-
- Required: Yes
- Type: string
Whether access to individual products in the portal is controlled per reader.
AuthorizationConfig
Description
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.
Members
- cognitoConfig
-
- Type: CognitoConfig structure
Readers sign in through an Amazon Cognito user pool.
- none
-
- Type: None structure
The portal is public and readers do not sign in.
BadRequestException
Description
The request is not valid. The message identifies the field or value that failed validation.
Members
- message
-
- Required: Yes
- Type: string
CognitoConfig
Description
The Amazon Cognito resources readers use to sign in to a portal.
Members
- appClientId
-
- Required: Yes
- Type: string
The ID of the user pool app client the portal uses.
- identityPoolId
-
- Type: string
The ID of the Cognito identity pool. Required only for fine-grained access control.
- userPoolArn
-
- Required: Yes
- Type: string
The ARN of the Cognito user pool.
- userPoolDomain
-
- Required: Yes
- Type: string
The domain of the user pool's hosted sign-in pages.
ConflictException
Description
The request conflicts with the current state of the resource, for example because another operation on it is still in progress.
Members
- message
-
- Required: Yes
- Type: string
CustomColors
Description
The colors of a portal. Each value is a color string of up to 16 characters.
Members
- accentColor
-
- Required: Yes
- Type: string
The color of links, buttons, and other highlighted elements.
- backgroundColor
-
- Required: Yes
- Type: string
The page background color.
- errorValidationColor
-
- Required: Yes
- Type: string
The color of error and validation messages.
- headerColor
-
- Required: Yes
- Type: string
The header color.
- navigationColor
-
- Required: Yes
- Type: string
The navigation pane color.
- textColor
-
- Required: Yes
- Type: string
The text color.
DiscoveryConfigurationData
Description
An account-level discovery configuration.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the discovery configuration.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was created.
- discoverySources
-
- Type: Array of strings
The sources APIs are discovered from.
- excludedResources
-
- Type: Array of strings
The ARNs of resources left out of discovery.
- features
-
- Type: Array of strings
Optional capabilities enabled for this configuration. Absent when none are.
- status
-
- Type: string
The current status of the discovery configuration.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
DiscoveryExclusionFilters
Description
Exclusion filters for organization-scoped discovery. Resources matching any of these filters are excluded from discovery.
Members
- accountIds
-
- Type: Array of strings
List of AWS account IDs to exclude from discovery.
- organizationalUnitIds
-
- Type: Array of strings
List of organizational unit IDs to exclude from discovery.
- resourceArns
-
- Type: Array of strings
List of resource ARNs to exclude. Only ELB and CloudFront resource ARNs are supported.
DiscoveryInclusionFilters
Description
Inclusion filters for organization-scoped discovery. Only Resources matching any of these filters are included in discovery.
Members
- accountIds
-
- Type: Array of strings
List of AWS account IDs to include in discovery.
- organizationalUnitIds
-
- Type: Array of strings
List of organizational unit IDs to include in discovery.
DiscoveryStatus
Description
The state of API discovery for one discovery source.
Members
- accountId
-
- Type: string
The AWS account ID the status applies to.
- discoverySource
-
- Required: Yes
- Type: 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.
- failureReason
-
- Type: string
Typed reason for failure, present only when
statusisFAILED - status
-
- Required: Yes
- Type: string
The current state of discovery for this source.
DisplayContent
Description
The content of a product page.
Members
- body
-
- Required: Yes
- Type: string
The Markdown body of the page, from 1 to 32,768 characters.
- title
-
- Required: Yes
- Type: string
The page title, from 1 to 255 characters.
DisplayContentOverrides
Description
Content that replaces the defaults generated for an API page.
Members
- apiUrl
-
- Type: 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
-
- Type: string
The Markdown body of the page, from 1 to 32,768 characters.
- operationName
-
- Type: string
The operation name shown as the page title, from 1 to 255 characters.
DisplayOrder
Description
The order of a product's content in the portal navigation.
Members
- contents
-
- Type: Array of Section structures
Sections in a product's navigation. No service-side limit exists today; this bound caps request size.
- overviewPageArn
-
- Type: string
The ARN of the product page shown as the product overview.
- productPageArns
-
- Type: Array of strings
A product has at most DocHubLimits.DEFAULT_PAGES_PER_PRODUCT_LIMIT (40) pages, enforced by LimitsHelper.
EndpointConfigurationRequest
Description
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.
Members
- acmManaged
-
- Type: ACMManaged structure
Serve the portal on your own domain, using a certificate from AWS Certificate Manager.
- none
-
- Type: None structure
Serve the portal only on its default domain.
EndpointConfigurationResponse
Description
The domains a portal is served on.
Members
- certificateArn
-
- Type: string
The ARN of the ACM certificate for the custom domain. Absent if the portal has no custom domain.
- domainName
-
- Type: string
The custom domain name of the portal. Absent if the portal has no custom domain.
- portalDefaultDomainName
-
- Required: Yes
- Type: string
The default domain name assigned to the portal.
- portalDomainHostedZoneId
-
- Required: Yes
- Type: string
The ID of the hosted zone for the portal's distribution. Use it to create an alias record for a custom domain.
FailedManagedApiItem
Description
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.
Members
- errorCode
-
- Required: Yes
- Type: 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
-
- Required: Yes
- Type: string
A description of the failure.
- managedApiId
-
- Required: Yes
- Type: string
The identifier of the Managed API that could not be processed.
IdentifierParts
Description
The parts that together identify an API.
Members
- method
-
- Required: Yes
- Type: string
The HTTP method of the API.
- path
-
- Required: Yes
- Type: string
The request path of the API.
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that serves the API.
InternalServerException
Description
The service encountered an internal error. Try the request again.
Members
- message
-
- Required: Yes
- Type: string
LimitExceededException
Description
The request rate or a service quota was exceeded. Reduce the request rate or the number of resources and try again.
Members
- message
-
- Required: Yes
- Type: string
ManagedApiEventSummary
Description
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.
Members
- endedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the event completed; absent while it is still in progress.
- eventId
-
- Required: Yes
- Type: string
Event identifier; row identity and input to GetManagedApiEvent.
- eventType
-
- Type: string
Always WAF_API_SECURITY today.
- startedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the event was first observed.
- status
-
- Type: string
Lifecycle status of a security event.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the event was last updated.
- wafApiSecurityEventDetail
-
- Type: WafApiSecurityEventDetail structure
Detail specific to a WAF API-security event; populated when eventType is WAF_API_SECURITY.
ManagedApiFinding
Description
Security posture finding attached to this API. Shape mirrors the inventory's Finding sub-document.
Members
- postureId
-
- Type: string
The identifier of the posture check that produced the finding.
- postureStatus
-
- Type: 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
-
- Type: string
Why a posture is not satisfied, or why no verdict was reached. Present only when
postureStatusisFALSEorINSUFFICIENT_DATA. New reasons may be added over time, so clients MUST treat any unrecognized value asUNKNOWNand fall back to generic handling. - updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the finding was last updated.
ManagedApiSummary
Description
A summary of a Managed API.
Members
- apiSignature
-
- Required: Yes
- Type: ApiSignature structure
The attributes that identify the API.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was created.
- managedApiArn
-
- Required: Yes
- Type: string
The ARN of the Managed API.
- managedApiId
-
- Required: Yes
- Type: string
The identifier of the Managed API.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
None
Description
An empty value, used in a union to choose the option that has no settings.
Members
OrganizationDiscoveryConfigurationData
Description
An organization-level discovery configuration.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the organization discovery configuration.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was created.
- discoveryFilters
-
- Type: OrganizationDiscoveryFilters structure
The accounts or organizational units included in or excluded from discovery.
- discoverySources
-
- Type: Array of strings
The sources APIs are discovered from.
- exclusionFilters
-
- Type: DiscoveryExclusionFilters structure
Exclusion filters for organization-scoped discovery. @deprecated. Remove this once client (Console) moves to discoveryFilters
- features
-
- Type: Array of strings
Optional capabilities enabled for this configuration. Absent when none are.
- status
-
- Type: string
The current status of the discovery configuration.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
OrganizationDiscoveryFilters
Description
Limits organization-scoped discovery. Set exactly one member: inclusionFilters to discover only the matching targets, or exclusionFilters to discover everything except them.
Members
- exclusionFilters
-
- Type: DiscoveryExclusionFilters structure
Exclusion filters for organization-scoped discovery. Resources matching any of these filters are excluded from discovery.
- inclusionFilters
-
- Type: DiscoveryInclusionFilters structure
Inclusion filters for organization-scoped discovery. Only Resources matching any of these filters are included in discovery.
PortalContent
Description
The display settings of a portal.
Members
- description
-
- Type: string
A description of the portal, up to 1024 characters.
- displayName
-
- Required: Yes
- Type: string
The name shown in the portal, from 3 to 255 characters.
- theme
-
- Required: Yes
- Type: PortalTheme structure
The colors and logo of the portal.
PortalStatusException
Description
Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.
Members
- exception
-
- Type: string
Treat any unrecognized value as INTERNAL_FAILURE.
- message
-
- Type: string
A description of the failure.
PortalSummary
Description
A summary of a portal.
Members
- authorization
-
- Required: Yes
- Type: Authorization structure
How readers sign in to the portal, and whether fine-grained access control is on.
- endpointConfiguration
-
- Required: Yes
- Type: EndpointConfigurationResponse structure
The domain configuration of the portal.
- includedProductArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the products the portal includes.
- portalArn
-
- Required: Yes
- Type: string
The ARN of the portal.
- portalContent
-
- Required: Yes
- Type: PortalContent structure
The portal's display name, description, and theme.
- portalId
-
- Required: Yes
- Type: string
The identifier of the portal.
- preview
-
- Type: Preview structure
The most recent preview of the portal. Absent if no preview has been created.
- publishDescription
-
- Type: string
The description supplied with the most recent publish request.
- publishStatus
-
- Type: string
The publish status of the portal. Absent if the portal has never been published.
- publishedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the portal was last published.
- rumAppMonitorName
-
- Type: string
The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
- statusException
-
- Type: PortalStatusException structure
Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
PortalTheme
Description
The visual theme of a portal.
Members
- customColors
-
- Required: Yes
- Type: CustomColors structure
The colors used in the portal.
- logoUploadedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the portal logo was last uploaded. Absent if the portal has no logo.
Preview
Description
A preview of a portal.
Members
- previewStatus
-
- Required: Yes
- Type: string
The status of the preview.
- previewUrl
-
- Type: string
The URL to view the preview. Present when
previewStatusisPREVIEW_READY. - statusException
-
- Type: PortalStatusException structure
Failure detail attached to a Portal's publish/preview status: a typed reason plus an optional human-readable message.
ProductApiPageStatusException
Description
Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.
Members
- exception
-
- Type: string
treat any unrecognized value as INTERNAL_FAILURE.
- message
-
- Type: string
A description of the failure.
ProductApiPageSummaryNoBody
Description
A summary of an API page, without its body.
Members
- apiId
-
- Required: Yes
- Type: ApiId structure
The API the page documents.
- apiUrl
-
- Required: Yes
- Type: string
The invoke URL shown on the page and used by Try-It.
- operationName
-
- Type: string
The operation name shown as the page title.
- productApiPageArn
-
- Required: Yes
- Type: string
The ARN of the API page.
- productApiPageId
-
- Required: Yes
- Type: string
The identifier of the API page.
- status
-
- Required: Yes
- Type: string
The status of the page content:
IN_PROGRESSwhile it is generated, thenAVAILABLEorFAILED. - statusException
-
- Type: ProductApiPageStatusException structure
Failure detail attached to a ProductApiPage's status: a typed reason plus an optional human-readable message.
- tryItState
-
- Required: Yes
- Type: string
Whether Try-It is enabled on the page.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
ProductPageSummaryNoBody
Description
A summary of a product page, without its body.
Members
- pageTitle
-
- Required: Yes
- Type: string
The page title.
- productPageArn
-
- Required: Yes
- Type: string
The ARN of the product page.
- productPageId
-
- Required: Yes
- Type: string
The identifier of the product page.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
ProductSummary
Description
A summary of a product.
Members
- apiSelectionConfiguration
-
- Type: ApiSelectionConfiguration structure
How Managed APIs are selected for the product.
- description
-
- Required: Yes
- Type: string
A description of the product, up to 1024 characters.
- displayName
-
- Required: Yes
- Type: string
The name of the product, from 1 to 255 characters.
- failureReason
-
- Type: string
Reason a product's rules could not be fully applied, present only when
statusisFAILED. New reasons may be added over time, so clients MUST treat any unrecognized value asUNKNOWNand fall back to generic handling. - productArn
-
- Required: Yes
- Type: string
The ARN of the product.
- productId
-
- Required: Yes
- Type: string
The identifier of the product.
- status
-
- Type: 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.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the resource was last updated.
ResourceNotFoundException
Description
The requested resource does not exist, or you do not have access to it.
Members
- message
-
- Required: Yes
- Type: string
RuleFilter
Description
Values are compared to the attribute as literals: exact and case-sensitive, no wildcards.
Members
- key
-
- Required: Yes
- Type: 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
-
- Required: Yes
- Type: Array of strings
The values to match. The filter matches when the attribute equals any of them.
Section
Description
A named group of API pages in the portal navigation.
Members
- productApiPageArns
-
- Type: Array of strings
API pages in one section. No service-side limit exists today; this bound caps request size.
- sectionName
-
- Type: string
Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).
WafApiSecurityEventDetail
Description
Detail specific to a WAF API-security event.
Members
- category
-
- Type: string
OWASP class — the primary display value (e.g. "API2:2023").
- confidence
-
- Type: string
Confidence tier of the detection.
- label
-
- Type: string
Detection label (attack type + confidence tier).
- webAclArn
-
- Type: string
WebACL that produced the event.