Creates a new portal product.
Parameters:
-
description
(Optional[__stringMin0Max1024], default:
None
)
–
A description of the portal product.
-
display_name
(Optional[__stringMin1Max255], default:
None
)
–
The name of the portal product as it appears in a published portal.
-
tags
(Optional[Tags], default:
None
)
–
The collection of tags. Each tag element is associated with a given resource.
Raises:
-
BadRequestException
–
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
-
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 create_portal_product(
self,
*,
config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
description: Optional[
"capo_apigatewayv2.types.__string_min0_max1024.__stringMin0Max1024"
] = None,
display_name: Optional[
"capo_apigatewayv2.types.__string_min1_max255.__stringMin1Max255"
] = None,
tags: Optional["capo_apigatewayv2.types.tags.Tags"] = None,
) -> "capo_apigatewayv2.types.create_portal_product_response.CreatePortalProductResponse":
"""<p>Creates a new portal product.</p>
Args:
description: <p>A description of the portal product.</p>
display_name: <p>The name of the portal product as it appears in a published portal.</p>
tags: <p>The collection of tags. Each tag element is associated with a given resource.</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.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.create_portal_product_request.CreatePortalProductRequest]",
) -> OperationResponse[
"capo_apigatewayv2.types.create_portal_product_response.CreatePortalProductResponse"
]:
import capo_apigatewayv2._operations.api_gateway_v2.create_portal_product
output, http_response = (
capo_apigatewayv2._operations.api_gateway_v2.create_portal_product.create_portal_product(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreatePortalProduct")
)
input_: capo_apigatewayv2.types.create_portal_product_request.CreatePortalProductRequest = {}
if description is not None:
input_["description"] = description
if display_name is not None:
input_["display_name"] = display_name
if tags is not None:
input_["tags"] = tags
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|