publish_portal ¶

publish_portal(
    portal_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    description: Optional[__stringMin0Max1024] = None,
) -> PublishPortalResponse

Publishes a portal.

Parameters:

description (Optional[__stringMin0Max1024], default: None ) –

The description of the portal. When the portal is published, this description becomes the last published description.
portal_id (__string) –

The portal identifier.

Raises:

BadRequestException –

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException –

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.
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 publish_portal(
    self,
    portal_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    description: Optional[
        "capo_apigatewayv2.types.__string_min0_max1024.__stringMin0Max1024"
    ] = None,
) -> "capo_apigatewayv2.types.publish_portal_response.PublishPortalResponse":
    """<p>Publishes a portal.</p>

    Args:
        description: <p>The description of the portal. When the portal is published, this description becomes the last published description.</p>
        portal_id: <p>The portal 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.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.publish_portal_request.PublishPortalRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.publish_portal_response.PublishPortalResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.publish_portal

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PublishPortal")
    )
    input_: capo_apigatewayv2.types.publish_portal_request.PublishPortalRequest = {
        "portal_id": portal_id
    }
    if description is not None:
        input_["description"] = description

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