Skip to content

deploy_workspace_applications

deploy_workspace_applications(
    workspace_id: WorkspaceId,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    force: Optional[BooleanObject] = None,
) -> DeployWorkspaceApplicationsResult

Deploys associated applications to the specified WorkSpace

Parameters:

  • workspace_id (WorkspaceId) –

    The identifier of the WorkSpace.

  • force (Optional[BooleanObject], default: None ) –

    Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.

Raises:

Source code in docs_src/capo_workspaces/_services/work_spaces.py
def deploy_workspace_applications(
    self,
    workspace_id: "capo_workspaces.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    force: Optional["capo_workspaces.types.boolean_object.BooleanObject"] = None,
) -> "capo_workspaces.types.deploy_workspace_applications_result.DeployWorkspaceApplicationsResult":
    """<p>Deploys associated applications to the specified WorkSpace</p>

    Args:
        workspace_id: <p>The identifier of the WorkSpace.</p>
        force: <p>Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.incompatible_applications_exception.IncompatibleApplicationsException: <p>The specified application is not compatible with the resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.operation_not_supported_exception.OperationNotSupportedException: <p>This operation is not supported.</p>
        capo_workspaces.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource is currently in use.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.deploy_workspace_applications_request.DeployWorkspaceApplicationsRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.deploy_workspace_applications_result.DeployWorkspaceApplicationsResult"
    ]:
        import capo_workspaces._operations.workspaces_service.deploy_workspace_applications

        output, http_response = (
            capo_workspaces._operations.workspaces_service.deploy_workspace_applications.deploy_workspace_applications(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeployWorkspaceApplications")
    )
    input_: capo_workspaces.types.deploy_workspace_applications_request.DeployWorkspaceApplicationsRequest = {
        "workspace_id": workspace_id
    }
    if force is not None:
        input_["force"] = force

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