Skip to content

put_portal_product_sharing_policy

put_portal_product_sharing_policy(
    portal_product_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    policy_document: Optional[__stringMin1Max307200] = None,
) -> PutPortalProductSharingPolicyResponse

Updates the sharing policy for a portal product.

Parameters:

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 put_portal_product_sharing_policy(
    self,
    portal_product_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    policy_document: Optional[
        "capo_apigatewayv2.types.__string_min1_max307200.__stringMin1Max307200"
    ] = None,
) -> "capo_apigatewayv2.types.put_portal_product_sharing_policy_response.PutPortalProductSharingPolicyResponse":
    """<p>Updates the sharing policy for a portal product.</p>

    Args:
        policy_document: <p>The product sharing policy.</p>
        portal_product_id: <p>The portal product identifier.</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.put_portal_product_sharing_policy_request.PutPortalProductSharingPolicyRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.put_portal_product_sharing_policy_response.PutPortalProductSharingPolicyResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.put_portal_product_sharing_policy

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.put_portal_product_sharing_policy.put_portal_product_sharing_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutPortalProductSharingPolicy")
    )
    input_: capo_apigatewayv2.types.put_portal_product_sharing_policy_request.PutPortalProductSharingPolicyRequest = {
        "portal_product_id": portal_product_id
    }
    if policy_document is not None:
        input_["policy_document"] = policy_document

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output