Lists the product pages for a portal product.
Parameters:
-
max_results
(Optional[__string], default:
None
)
–
The maximum number of elements to be returned for this resource.
-
next_token
(Optional[__string], default:
None
)
–
The next page of elements from this collection. Not valid for the last element of the collection.
-
portal_product_id
(__string)
–
The portal product identifier.
-
resource_owner_account_id
(Optional[__string], default:
None
)
–
The account ID of the resource owner of the portal product.
Raises:
-
BadRequestException
–
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
NotFoundException
–
The resource specified in the request was not found. See the message field for more information.
-
TooManyRequestsException
–
A limit has been exceeded. See the accompanying error message for details.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_apigatewayv2/_services/api_gateway_v2.py
| def list_product_pages(
self,
portal_product_id: "capo_apigatewayv2.types.__string.__string",
*,
config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
max_results: Optional["capo_apigatewayv2.types.__string.__string"] = None,
next_token: Optional["capo_apigatewayv2.types.__string.__string"] = None,
resource_owner_account_id: Optional[
"capo_apigatewayv2.types.__string.__string"
] = None,
) -> "capo_apigatewayv2.types.list_product_pages_response.ListProductPagesResponse":
"""<p>Lists the product pages for a portal product.</p>
Args:
max_results: <p>The maximum number of elements to be returned for this resource.</p>
next_token: <p>The next page of elements from this collection. Not valid for the last element of the collection.</p>
portal_product_id: <p>The portal product identifier.</p>
resource_owner_account_id: <p>The account ID of the resource owner of the portal product.</p>
Raises:
capo_apigatewayv2.errors.access_denied_exception.AccessDeniedException
capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_apigatewayv2.types.list_product_pages_request.ListProductPagesRequest]",
) -> OperationResponse[
"capo_apigatewayv2.types.list_product_pages_response.ListProductPagesResponse"
]:
import capo_apigatewayv2._operations.api_gateway_v2.list_product_pages
output, http_response = (
capo_apigatewayv2._operations.api_gateway_v2.list_product_pages.list_product_pages(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListProductPages")
)
input_: capo_apigatewayv2.types.list_product_pages_request.ListProductPagesRequest = {
"portal_product_id": portal_product_id
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if resource_owner_account_id is not None:
input_["resource_owner_account_id"] = resource_owner_account_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|