update_portal ¶

def update_portal(
    self,
    portal_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    authorization: Optional[
        "capo_apigatewayv2.types.authorization.Authorization"
    ] = None,
    endpoint_configuration: Optional[
        "capo_apigatewayv2.types.endpoint_configuration_request.EndpointConfigurationRequest"
    ] = None,
    included_portal_product_arns: Optional[
        "capo_apigatewayv2.types.__list_of__string_min20_max2048.__listOf__stringMin20Max2048"
    ] = None,
    logo_uri: Optional[
        "capo_apigatewayv2.types.__string_min0_max1092.__stringMin0Max1092"
    ] = None,
    portal_content: Optional[
        "capo_apigatewayv2.types.portal_content.PortalContent"
    ] = None,
    rum_app_monitor_name: Optional[
        "capo_apigatewayv2.types.__string_min0_max255.__stringMin0Max255"
    ] = None,
) -> "capo_apigatewayv2.types.update_portal_response.UpdatePortalResponse":
    """<p>Updates a portal.</p>

    Args:
        authorization: <p>The authorization of the portal.</p>
        endpoint_configuration: <p>Represents an endpoint configuration.</p>
        included_portal_product_arns: <p>The ARNs of the portal products included in the portal.</p>
        logo_uri: <p>The logo URI.</p>
        portal_content: <p>Contains the content that is visible to portal consumers including the themes, display names, and description.</p>
        portal_id: <p>The portal identifier.</p>
        rum_app_monitor_name: <p>The CloudWatch RUM app monitor name.</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.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. 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.update_portal_request.UpdatePortalRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.update_portal_response.UpdatePortalResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.update_portal

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePortal")
    )
    input_: capo_apigatewayv2.types.update_portal_request.UpdatePortalRequest = {
        "portal_id": portal_id
    }
    if authorization is not None:
        input_["authorization"] = authorization
    if endpoint_configuration is not None:
        input_["endpoint_configuration"] = endpoint_configuration
    if included_portal_product_arns is not None:
        input_["included_portal_product_arns"] = included_portal_product_arns
    if logo_uri is not None:
        input_["logo_uri"] = logo_uri
    if portal_content is not None:
        input_["portal_content"] = portal_content
    if rum_app_monitor_name is not None:
        input_["rum_app_monitor_name"] = rum_app_monitor_name

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